# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [AssociateOpsItemRelatedItem](API_AssociateOpsItemRelatedItem.md) 
+  [CancelCommand](API_CancelCommand.md) 
+  [CancelMaintenanceWindowExecution](API_CancelMaintenanceWindowExecution.md) 
+  [CreateActivation](API_CreateActivation.md) 
+  [CreateAssociation](API_CreateAssociation.md) 
+  [CreateAssociationBatch](API_CreateAssociationBatch.md) 
+  [CreateDocument](API_CreateDocument.md) 
+  [CreateMaintenanceWindow](API_CreateMaintenanceWindow.md) 
+  [CreateOpsItem](API_CreateOpsItem.md) 
+  [CreateOpsMetadata](API_CreateOpsMetadata.md) 
+  [CreatePatchBaseline](API_CreatePatchBaseline.md) 
+  [CreateResourceDataSync](API_CreateResourceDataSync.md) 
+  [DeleteActivation](API_DeleteActivation.md) 
+  [DeleteAssociation](API_DeleteAssociation.md) 
+  [DeleteDocument](API_DeleteDocument.md) 
+  [DeleteInventory](API_DeleteInventory.md) 
+  [DeleteMaintenanceWindow](API_DeleteMaintenanceWindow.md) 
+  [DeleteOpsItem](API_DeleteOpsItem.md) 
+  [DeleteOpsMetadata](API_DeleteOpsMetadata.md) 
+  [DeleteParameter](API_DeleteParameter.md) 
+  [DeleteParameters](API_DeleteParameters.md) 
+  [DeletePatchBaseline](API_DeletePatchBaseline.md) 
+  [DeleteResourceDataSync](API_DeleteResourceDataSync.md) 
+  [DeleteResourcePolicy](API_DeleteResourcePolicy.md) 
+  [DeregisterManagedInstance](API_DeregisterManagedInstance.md) 
+  [DeregisterPatchBaselineForPatchGroup](API_DeregisterPatchBaselineForPatchGroup.md) 
+  [DeregisterTargetFromMaintenanceWindow](API_DeregisterTargetFromMaintenanceWindow.md) 
+  [DeregisterTaskFromMaintenanceWindow](API_DeregisterTaskFromMaintenanceWindow.md) 
+  [DescribeActivations](API_DescribeActivations.md) 
+  [DescribeAssociation](API_DescribeAssociation.md) 
+  [DescribeAssociationExecutions](API_DescribeAssociationExecutions.md) 
+  [DescribeAssociationExecutionTargets](API_DescribeAssociationExecutionTargets.md) 
+  [DescribeAutomationExecutions](API_DescribeAutomationExecutions.md) 
+  [DescribeAutomationStepExecutions](API_DescribeAutomationStepExecutions.md) 
+  [DescribeAvailablePatches](API_DescribeAvailablePatches.md) 
+  [DescribeDocument](API_DescribeDocument.md) 
+  [DescribeDocumentPermission](API_DescribeDocumentPermission.md) 
+  [DescribeEffectiveInstanceAssociations](API_DescribeEffectiveInstanceAssociations.md) 
+  [DescribeEffectivePatchesForPatchBaseline](API_DescribeEffectivePatchesForPatchBaseline.md) 
+  [DescribeInstanceAssociationsStatus](API_DescribeInstanceAssociationsStatus.md) 
+  [DescribeInstanceInformation](API_DescribeInstanceInformation.md) 
+  [DescribeInstancePatches](API_DescribeInstancePatches.md) 
+  [DescribeInstancePatchStates](API_DescribeInstancePatchStates.md) 
+  [DescribeInstancePatchStatesForPatchGroup](API_DescribeInstancePatchStatesForPatchGroup.md) 
+  [DescribeInstanceProperties](API_DescribeInstanceProperties.md) 
+  [DescribeInventoryDeletions](API_DescribeInventoryDeletions.md) 
+  [DescribeMaintenanceWindowExecutions](API_DescribeMaintenanceWindowExecutions.md) 
+  [DescribeMaintenanceWindowExecutionTaskInvocations](API_DescribeMaintenanceWindowExecutionTaskInvocations.md) 
+  [DescribeMaintenanceWindowExecutionTasks](API_DescribeMaintenanceWindowExecutionTasks.md) 
+  [DescribeMaintenanceWindows](API_DescribeMaintenanceWindows.md) 
+  [DescribeMaintenanceWindowSchedule](API_DescribeMaintenanceWindowSchedule.md) 
+  [DescribeMaintenanceWindowsForTarget](API_DescribeMaintenanceWindowsForTarget.md) 
+  [DescribeMaintenanceWindowTargets](API_DescribeMaintenanceWindowTargets.md) 
+  [DescribeMaintenanceWindowTasks](API_DescribeMaintenanceWindowTasks.md) 
+  [DescribeOpsItems](API_DescribeOpsItems.md) 
+  [DescribeParameters](API_DescribeParameters.md) 
+  [DescribePatchBaselines](API_DescribePatchBaselines.md) 
+  [DescribePatchGroups](API_DescribePatchGroups.md) 
+  [DescribePatchGroupState](API_DescribePatchGroupState.md) 
+  [DescribePatchProperties](API_DescribePatchProperties.md) 
+  [DescribeSessions](API_DescribeSessions.md) 
+  [DisassociateOpsItemRelatedItem](API_DisassociateOpsItemRelatedItem.md) 
+  [GetAccessToken](API_GetAccessToken.md) 
+  [GetAutomationExecution](API_GetAutomationExecution.md) 
+  [GetCalendarState](API_GetCalendarState.md) 
+  [GetCommandInvocation](API_GetCommandInvocation.md) 
+  [GetConnectionStatus](API_GetConnectionStatus.md) 
+  [GetDefaultPatchBaseline](API_GetDefaultPatchBaseline.md) 
+  [GetDeployablePatchSnapshotForInstance](API_GetDeployablePatchSnapshotForInstance.md) 
+  [GetDocument](API_GetDocument.md) 
+  [GetExecutionPreview](API_GetExecutionPreview.md) 
+  [GetInventory](API_GetInventory.md) 
+  [GetInventorySchema](API_GetInventorySchema.md) 
+  [GetMaintenanceWindow](API_GetMaintenanceWindow.md) 
+  [GetMaintenanceWindowExecution](API_GetMaintenanceWindowExecution.md) 
+  [GetMaintenanceWindowExecutionTask](API_GetMaintenanceWindowExecutionTask.md) 
+  [GetMaintenanceWindowExecutionTaskInvocation](API_GetMaintenanceWindowExecutionTaskInvocation.md) 
+  [GetMaintenanceWindowTask](API_GetMaintenanceWindowTask.md) 
+  [GetOpsItem](API_GetOpsItem.md) 
+  [GetOpsMetadata](API_GetOpsMetadata.md) 
+  [GetOpsSummary](API_GetOpsSummary.md) 
+  [GetParameter](API_GetParameter.md) 
+  [GetParameterHistory](API_GetParameterHistory.md) 
+  [GetParameters](API_GetParameters.md) 
+  [GetParametersByPath](API_GetParametersByPath.md) 
+  [GetPatchBaseline](API_GetPatchBaseline.md) 
+  [GetPatchBaselineForPatchGroup](API_GetPatchBaselineForPatchGroup.md) 
+  [GetResourcePolicies](API_GetResourcePolicies.md) 
+  [GetServiceSetting](API_GetServiceSetting.md) 
+  [LabelParameterVersion](API_LabelParameterVersion.md) 
+  [ListAssociations](API_ListAssociations.md) 
+  [ListAssociationVersions](API_ListAssociationVersions.md) 
+  [ListCommandInvocations](API_ListCommandInvocations.md) 
+  [ListCommands](API_ListCommands.md) 
+  [ListComplianceItems](API_ListComplianceItems.md) 
+  [ListComplianceSummaries](API_ListComplianceSummaries.md) 
+  [ListDocumentMetadataHistory](API_ListDocumentMetadataHistory.md) 
+  [ListDocuments](API_ListDocuments.md) 
+  [ListDocumentVersions](API_ListDocumentVersions.md) 
+  [ListInventoryEntries](API_ListInventoryEntries.md) 
+  [ListNodes](API_ListNodes.md) 
+  [ListNodesSummary](API_ListNodesSummary.md) 
+  [ListOpsItemEvents](API_ListOpsItemEvents.md) 
+  [ListOpsItemRelatedItems](API_ListOpsItemRelatedItems.md) 
+  [ListOpsMetadata](API_ListOpsMetadata.md) 
+  [ListResourceComplianceSummaries](API_ListResourceComplianceSummaries.md) 
+  [ListResourceDataSync](API_ListResourceDataSync.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDocumentPermission](API_ModifyDocumentPermission.md) 
+  [PutComplianceItems](API_PutComplianceItems.md) 
+  [PutInventory](API_PutInventory.md) 
+  [PutParameter](API_PutParameter.md) 
+  [PutResourcePolicy](API_PutResourcePolicy.md) 
+  [RegisterDefaultPatchBaseline](API_RegisterDefaultPatchBaseline.md) 
+  [RegisterPatchBaselineForPatchGroup](API_RegisterPatchBaselineForPatchGroup.md) 
+  [RegisterTargetWithMaintenanceWindow](API_RegisterTargetWithMaintenanceWindow.md) 
+  [RegisterTaskWithMaintenanceWindow](API_RegisterTaskWithMaintenanceWindow.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetServiceSetting](API_ResetServiceSetting.md) 
+  [ResumeSession](API_ResumeSession.md) 
+  [SendAutomationSignal](API_SendAutomationSignal.md) 
+  [SendCommand](API_SendCommand.md) 
+  [StartAccessRequest](API_StartAccessRequest.md) 
+  [StartAssociationsOnce](API_StartAssociationsOnce.md) 
+  [StartAutomationExecution](API_StartAutomationExecution.md) 
+  [StartChangeRequestExecution](API_StartChangeRequestExecution.md) 
+  [StartExecutionPreview](API_StartExecutionPreview.md) 
+  [StartSession](API_StartSession.md) 
+  [StopAutomationExecution](API_StopAutomationExecution.md) 
+  [TerminateSession](API_TerminateSession.md) 
+  [UnlabelParameterVersion](API_UnlabelParameterVersion.md) 
+  [UpdateAssociation](API_UpdateAssociation.md) 
+  [UpdateAssociationStatus](API_UpdateAssociationStatus.md) 
+  [UpdateDocument](API_UpdateDocument.md) 
+  [UpdateDocumentDefaultVersion](API_UpdateDocumentDefaultVersion.md) 
+  [UpdateDocumentMetadata](API_UpdateDocumentMetadata.md) 
+  [UpdateMaintenanceWindow](API_UpdateMaintenanceWindow.md) 
+  [UpdateMaintenanceWindowTarget](API_UpdateMaintenanceWindowTarget.md) 
+  [UpdateMaintenanceWindowTask](API_UpdateMaintenanceWindowTask.md) 
+  [UpdateManagedInstanceRole](API_UpdateManagedInstanceRole.md) 
+  [UpdateOpsItem](API_UpdateOpsItem.md) 
+  [UpdateOpsMetadata](API_UpdateOpsMetadata.md) 
+  [UpdatePatchBaseline](API_UpdatePatchBaseline.md) 
+  [UpdateResourceDataSync](API_UpdateResourceDataSync.md) 
+  [UpdateServiceSetting](API_UpdateServiceSetting.md) 

# AddTagsToResource
<a name="API_AddTagsToResource"></a>

Adds or overwrites one or more tags for the specified resource. *Tags* are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:
+  `Key=Owner,Value=DbAdmin` 
+  `Key=Owner,Value=SysAdmin` 
+  `Key=Owner,Value=Dev` 
+  `Key=Stack,Value=Production` 
+  `Key=Stack,Value=Pre-Production` 
+  `Key=Stack,Value=Test` 

Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see [Tag your Amazon EC2 resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the *Amazon EC2 User Guide*.

## Request Syntax
<a name="API_AddTagsToResource_RequestSyntax"></a>

```
{
   "ResourceId": "string",
   "ResourceType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_AddTagsToResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceId](#API_AddTagsToResource_RequestSyntax) **   <a name="systemsmanager-AddTagsToResource-request-ResourceId"></a>
The resource ID you want to tag.  
Use the ID of the resource. Here are some examples:  
 `MaintenanceWindow`: `mw-012345abcde`   
 `PatchBaseline`: `pb-012345abcde`   
 `Automation`: `example-c160-4567-8519-012345abcde`   
 `OpsMetadata` object: `ResourceID` for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, `ResourceID` is created from the strings that come after the word `opsmetadata` in the ARN. For example, an OpsMetadata object with an ARN of `arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager` has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or `/aws/ssm/MyGroup/appmanager`.  
For the `Document` and `Parameter` values, use the name of the resource. If you're tagging a shared document, you must use the full ARN of the document.  
 `ManagedInstance`: `mi-012345abcde`   
The `ManagedInstance` type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`.
Type: String  
Required: Yes

 ** [ResourceType](#API_AddTagsToResource_RequestSyntax) **   <a name="systemsmanager-AddTagsToResource-request-ResourceType"></a>
Specifies the type of resource you are tagging.  
The `ManagedInstance` type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`.
Type: String  
Valid Values: `Document | ManagedInstance | MaintenanceWindow | Parameter | PatchBaseline | OpsItem | OpsMetadata | Automation | Association`   
Required: Yes

 ** [Tags](#API_AddTagsToResource_RequestSyntax) **   <a name="systemsmanager-AddTagsToResource-request-Tags"></a>
One or more tags. The value parameter is required.  
Don't enter personally identifiable information in this field.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: Yes

## Response Elements
<a name="API_AddTagsToResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AddTagsToResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidResourceId **   
The resource ID isn't valid. Verify that you entered the correct ID and try again.  
HTTP Status Code: 400

 ** InvalidResourceType **   
The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.  
HTTP Status Code: 400

 ** TooManyTagsError **   
The `Targets` parameter includes too many tags. Remove one or more tags and try the command again.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_AddTagsToResource_Examples"></a>

### Example
<a name="API_AddTagsToResource_Example_1"></a>

This example illustrates one usage of AddTagsToResource.

#### Sample Request
<a name="API_AddTagsToResource_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.AddTagsToResource
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240220T232503Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240220/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 122

{
    "ResourceType": "PatchBaseline",
    "ResourceId": "pb-0c10e65780EXAMPLE",
    "Tags": [
        {
            "Key": "Stack",
            "Value": "Production"
        }
    ]
}
```

#### Sample Response
<a name="API_AddTagsToResource_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_AddTagsToResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/AddTagsToResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/AddTagsToResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/AddTagsToResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/AddTagsToResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/AddTagsToResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/AddTagsToResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/AddTagsToResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/AddTagsToResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/AddTagsToResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/AddTagsToResource) 

# AssociateOpsItemRelatedItem
<a name="API_AssociateOpsItemRelatedItem"></a>

Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in AWS Systems Manager.

## Request Syntax
<a name="API_AssociateOpsItemRelatedItem_RequestSyntax"></a>

```
{
   "AssociationType": "string",
   "OpsItemId": "string",
   "ResourceType": "string",
   "ResourceUri": "string"
}
```

## Request Parameters
<a name="API_AssociateOpsItemRelatedItem_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AssociationType](#API_AssociateOpsItemRelatedItem_RequestSyntax) **   <a name="systemsmanager-AssociateOpsItemRelatedItem-request-AssociationType"></a>
The type of association that you want to create between an OpsItem and a resource. OpsCenter supports `IsParentOf` and `RelatesTo` association types.  
Type: String  
Required: Yes

 ** [OpsItemId](#API_AssociateOpsItemRelatedItem_RequestSyntax) **   <a name="systemsmanager-AssociateOpsItemRelatedItem-request-OpsItemId"></a>
The ID of the OpsItem to which you want to associate a resource as a related item.  
Type: String  
Pattern: `^(oi)-[0-9a-f]{12}$`   
Required: Yes

 ** [ResourceType](#API_AssociateOpsItemRelatedItem_RequestSyntax) **   <a name="systemsmanager-AssociateOpsItemRelatedItem-request-ResourceType"></a>
The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:  
 `AWS::SSMIncidents::IncidentRecord`: an Incident Manager incident.   
 `AWS::SSM::Document`: a Systems Manager (SSM) document.  
Type: String  
Required: Yes

 ** [ResourceUri](#API_AssociateOpsItemRelatedItem_RequestSyntax) **   <a name="systemsmanager-AssociateOpsItemRelatedItem-request-ResourceUri"></a>
The Amazon Resource Name (ARN) of the AWS resource that you want to associate with the OpsItem.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_AssociateOpsItemRelatedItem_ResponseSyntax"></a>

```
{
   "AssociationId": "string"
}
```

## Response Elements
<a name="API_AssociateOpsItemRelatedItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociationId](#API_AssociateOpsItemRelatedItem_ResponseSyntax) **   <a name="systemsmanager-AssociateOpsItemRelatedItem-response-AssociationId"></a>
The association ID.  
Type: String

## Errors
<a name="API_AssociateOpsItemRelatedItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsItemConflictException **   
The specified OpsItem is in the process of being deleted.  
HTTP Status Code: 400

 ** OpsItemInvalidParameterException **   
A specified parameter argument isn't valid. Verify the available arguments and try again.  
HTTP Status Code: 400

 ** OpsItemLimitExceededException **   
The request caused OpsItems to exceed one or more quotas.  
HTTP Status Code: 400

 ** OpsItemNotFoundException **   
The specified OpsItem ID doesn't exist. Verify the ID and try again.  
HTTP Status Code: 400

 ** OpsItemRelatedItemAlreadyExistsException **   
The Amazon Resource Name (ARN) is already associated with the OpsItem.  
HTTP Status Code: 400

## Examples
<a name="API_AssociateOpsItemRelatedItem_Examples"></a>

### Example
<a name="API_AssociateOpsItemRelatedItem_Example_1"></a>

This example illustrates one usage of AssociateOpsItemRelatedItem.

#### Sample Request
<a name="API_AssociateOpsItemRelatedItem_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.AssociateOpsItemRelatedItem
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm.associate-ops-item-related-item
X-Amz-Date: 20240804T181929Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240804/us-east-1/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 229

{
  "OpsItemId": "oi-649fExample",
  "AssociationType": "RelatesTo",
  "ResourceType": "AWS::SSMIncidents::IncidentRecord",
  "ResourceUri": "arn:aws:ssm-incidents::111122223333:incident-record/Test/c6bd8931-efae-a4ff-7f98-4490Example"
}
```

#### Sample Response
<a name="API_AssociateOpsItemRelatedItem_Example_1_Response"></a>

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

## See Also
<a name="API_AssociateOpsItemRelatedItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/AssociateOpsItemRelatedItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/AssociateOpsItemRelatedItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/AssociateOpsItemRelatedItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/AssociateOpsItemRelatedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/AssociateOpsItemRelatedItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/AssociateOpsItemRelatedItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/AssociateOpsItemRelatedItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/AssociateOpsItemRelatedItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/AssociateOpsItemRelatedItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/AssociateOpsItemRelatedItem) 

# CancelCommand
<a name="API_CancelCommand"></a>

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

## Request Syntax
<a name="API_CancelCommand_RequestSyntax"></a>

```
{
   "CommandId": "string",
   "InstanceIds": [ "string" ]
}
```

## Request Parameters
<a name="API_CancelCommand_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CommandId](#API_CancelCommand_RequestSyntax) **   <a name="systemsmanager-CancelCommand-request-CommandId"></a>
The ID of the command you want to cancel.  
Type: String  
Length Constraints: Fixed length of 36.  
Required: Yes

 ** [InstanceIds](#API_CancelCommand_RequestSyntax) **   <a name="systemsmanager-CancelCommand-request-InstanceIds"></a>
(Optional) A list of managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node on which it was requested.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: No

## Response Elements
<a name="API_CancelCommand_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CancelCommand_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DuplicateInstanceId **   
You can't specify a managed node ID in more than one association.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidCommandId **   
The specified command ID isn't valid. Verify the ID and try again.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

## Examples
<a name="API_CancelCommand_Examples"></a>

### Example
<a name="API_CancelCommand_Example_1"></a>

This example illustrates one usage of CancelCommand.

#### Sample Request
<a name="API_CancelCommand_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.CancelCommand
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240220T233525Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240220/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 53

{
    "CommandId": "25173b39-c88d-4459-ba3d-8704aEXAMPLE"
}
```

#### Sample Response
<a name="API_CancelCommand_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_CancelCommand_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CancelCommand) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CancelCommand) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CancelCommand) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CancelCommand) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CancelCommand) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CancelCommand) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CancelCommand) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CancelCommand) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CancelCommand) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CancelCommand) 

# CancelMaintenanceWindowExecution
<a name="API_CancelMaintenanceWindowExecution"></a>

Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.

## Request Syntax
<a name="API_CancelMaintenanceWindowExecution_RequestSyntax"></a>

```
{
   "WindowExecutionId": "string"
}
```

## Request Parameters
<a name="API_CancelMaintenanceWindowExecution_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [WindowExecutionId](#API_CancelMaintenanceWindowExecution_RequestSyntax) **   <a name="systemsmanager-CancelMaintenanceWindowExecution-request-WindowExecutionId"></a>
The ID of the maintenance window execution to stop.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_CancelMaintenanceWindowExecution_ResponseSyntax"></a>

```
{
   "WindowExecutionId": "string"
}
```

## Response Elements
<a name="API_CancelMaintenanceWindowExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [WindowExecutionId](#API_CancelMaintenanceWindowExecution_ResponseSyntax) **   <a name="systemsmanager-CancelMaintenanceWindowExecution-response-WindowExecutionId"></a>
The ID of the maintenance window execution that has been stopped.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_CancelMaintenanceWindowExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_CancelMaintenanceWindowExecution_Examples"></a>

### Example
<a name="API_CancelMaintenanceWindowExecution_Example_1"></a>

This example illustrates one usage of CancelMaintenanceWindowExecution.

#### Sample Request
<a name="API_CancelMaintenanceWindowExecution_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.CancelMaintenanceWindowExecution
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T010054Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 61

{
    "WindowExecutionId": "02f05632-d0bc-470d-b1e5-c59a8EXAMPLE"
}
```

#### Sample Response
<a name="API_CancelMaintenanceWindowExecution_Example_1_Response"></a>

```
{
    "WindowExecutionId": "02f05632-d0bc-470d-b1e5-c59a8EXAMPLE"
}
```

## See Also
<a name="API_CancelMaintenanceWindowExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CancelMaintenanceWindowExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CancelMaintenanceWindowExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CancelMaintenanceWindowExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CancelMaintenanceWindowExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CancelMaintenanceWindowExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CancelMaintenanceWindowExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CancelMaintenanceWindowExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CancelMaintenanceWindowExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CancelMaintenanceWindowExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CancelMaintenanceWindowExecution) 

# CreateActivation
<a name="API_CreateActivation"></a>

Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with AWS Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager tools. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see [Using AWS Systems Manager in hybrid and multicloud environments](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-hybrid-multicloud.html) in the * AWS Systems Manager User Guide*. 

**Note**  
Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called *managed nodes*.

## Request Syntax
<a name="API_CreateActivation_RequestSyntax"></a>

```
{
   "DefaultInstanceName": "string",
   "Description": "string",
   "ExpirationDate": number,
   "IamRole": "string",
   "RegistrationLimit": number,
   "RegistrationMetadata": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateActivation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DefaultInstanceName](#API_CreateActivation_RequestSyntax) **   <a name="systemsmanager-CreateActivation-request-DefaultInstanceName"></a>
The name of the registered, managed node as it will appear in the AWS Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.  
Don't enter personally identifiable information in this field.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

 ** [Description](#API_CreateActivation_RequestSyntax) **   <a name="systemsmanager-CreateActivation-request-Description"></a>
A user-defined description of the resource that you want to register with Systems Manager.   
Don't enter personally identifiable information in this field.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [ExpirationDate](#API_CreateActivation_RequestSyntax) **   <a name="systemsmanager-CreateActivation-request-ExpirationDate"></a>
The date by which this activation request should expire, in timestamp format, such as "2024-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.  
Type: Timestamp  
Required: No

 ** [IamRole](#API_CreateActivation_RequestSyntax) **   <a name="systemsmanager-CreateActivation-request-IamRole"></a>
The name of the AWS Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the AWS Systems Manager service principal `ssm.amazonaws.com`. For more information, see [Create the IAM service role required for Systems Manager in a hybrid and multicloud environments](https://docs.aws.amazon.com/systems-manager/latest/userguide/hybrid-multicloud-service-role.html) in the * AWS Systems Manager User Guide*.  
You can't specify an IAM service-linked role for this parameter. You must create a unique role.
Type: String  
Length Constraints: Maximum length of 64.  
Required: Yes

 ** [RegistrationLimit](#API_CreateActivation_RequestSyntax) **   <a name="systemsmanager-CreateActivation-request-RegistrationLimit"></a>
Specify the maximum number of managed nodes you want to register. The default value is `1`.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [RegistrationMetadata](#API_CreateActivation_RequestSyntax) **   <a name="systemsmanager-CreateActivation-request-RegistrationMetadata"></a>
Reserved for internal use.  
Type: Array of [RegistrationMetadataItem](API_RegistrationMetadataItem.md) objects  
Required: No

 ** [Tags](#API_CreateActivation_RequestSyntax) **   <a name="systemsmanager-CreateActivation-request-Tags"></a>
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:  
+  `Key=OS,Value=Windows` 
+  `Key=Environment,Value=Production` 
When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.
You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see [AddTagsToResource](API_AddTagsToResource.md). For information about how to remove tags from your managed nodes, see [RemoveTagsFromResource](API_RemoveTagsFromResource.md).  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

## Response Syntax
<a name="API_CreateActivation_ResponseSyntax"></a>

```
{
   "ActivationCode": "string",
   "ActivationId": "string"
}
```

## Response Elements
<a name="API_CreateActivation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ActivationCode](#API_CreateActivation_ResponseSyntax) **   <a name="systemsmanager-CreateActivation-response-ActivationCode"></a>
The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 250.

 ** [ActivationId](#API_CreateActivation_ResponseSyntax) **   <a name="systemsmanager-CreateActivation-response-ActivationId"></a>
The ID number generated by the system when it processed the activation. The activation ID functions like a user name.  
Type: String  
Pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_CreateActivation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidParameters **   
You must specify values for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.  
HTTP Status Code: 400

## Examples
<a name="API_CreateActivation_Examples"></a>

### Example
<a name="API_CreateActivation_Example_1"></a>

This example illustrates one usage of CreateActivation.

#### Sample Request
<a name="API_CreateActivation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.CreateActivation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T135329Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 70

{
    "IamRole": "service-role/role_name"
}
```

#### Sample Response
<a name="API_CreateActivation_Example_1_Response"></a>

```
{
    "ActivationCode": "Fjz3/sZfSvv78EXAMPLE",
    "ActivationId": "e488f2f6-e686-4afb-8a04-ef6dfEXAMPLE"
}
```

## See Also
<a name="API_CreateActivation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CreateActivation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CreateActivation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CreateActivation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CreateActivation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateActivation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CreateActivation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CreateActivation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CreateActivation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateActivation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CreateActivation) 

# CreateAssociation
<a name="API_CreateAssociation"></a>

A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS resource group or an AWS autoscaling group, State Manager, a tool in AWS Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service. 

## Request Syntax
<a name="API_CreateAssociation_RequestSyntax"></a>

```
{
   "AlarmConfiguration": { 
      "Alarms": [ 
         { 
            "Name": "string"
         }
      ],
      "IgnorePollAlarmFailure": boolean
   },
   "ApplyOnlyAtCronInterval": boolean,
   "AssociationName": "string",
   "AutomationTargetParameterName": "string",
   "CalendarNames": [ "string" ],
   "ComplianceSeverity": "string",
   "DocumentVersion": "string",
   "Duration": number,
   "InstanceId": "string",
   "MaxConcurrency": "string",
   "MaxErrors": "string",
   "Name": "string",
   "OutputLocation": { 
      "S3Location": { 
         "OutputS3BucketName": "string",
         "OutputS3KeyPrefix": "string",
         "OutputS3Region": "string"
      }
   },
   "Parameters": { 
      "string" : [ "string" ]
   },
   "ScheduleExpression": "string",
   "ScheduleOffset": number,
   "SyncCompliance": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TargetLocations": [ 
      { 
         "Accounts": [ "string" ],
         "ExcludeAccounts": [ "string" ],
         "ExecutionRoleName": "string",
         "IncludeChildOrganizationUnits": boolean,
         "Regions": [ "string" ],
         "TargetLocationAlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "TargetLocationMaxConcurrency": "string",
         "TargetLocationMaxErrors": "string",
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "TargetsMaxConcurrency": "string",
         "TargetsMaxErrors": "string"
      }
   ],
   "TargetMaps": [ 
      { 
         "string" : [ "string" ]
      }
   ],
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ]
}
```

## Request Parameters
<a name="API_CreateAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AlarmConfiguration](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-AlarmConfiguration"></a>
The details for the CloudWatch alarm you want to apply to an automation or command.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object  
Required: No

 ** [ApplyOnlyAtCronInterval](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-ApplyOnlyAtCronInterval"></a>
By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified and when target changes are detected. Specify `true` for `ApplyOnlyAtCronInterval`if you want the association to run only according to the schedule you specified.  
For more information, see [Understanding when associations are applied to resources](https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#state-manager-about-scheduling) and [>About target updates with Automation runbooks](https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#runbook-target-updates) in the * AWS Systems Manager User Guide*.  
This parameter isn't supported for rate expressions.  
Type: Boolean  
Required: No

 ** [AssociationName](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-AssociationName"></a>
Specify a descriptive name for the association.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: No

 ** [AutomationTargetParameterName](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-AutomationTargetParameterName"></a>
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in AWS Systems Manager.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

 ** [CalendarNames](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-CalendarNames"></a>
The names of Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see [AWS Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) in the * AWS Systems Manager User Guide*.  
Type: Array of strings  
Required: No

 ** [ComplianceSeverity](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-ComplianceSeverity"></a>
The severity level to assign to the association.  
Type: String  
Valid Values: `CRITICAL | HIGH | MEDIUM | LOW | UNSPECIFIED`   
Required: No

 ** [DocumentVersion](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-DocumentVersion"></a>
The document version you want to associate with the targets. Can be a specific version or the default version.  
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the `default` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to `default`.
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [Duration](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-Duration"></a>
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.   
The `Duration` parameter applies only when both these conditions are true:  
+ The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution. 
+ The command specifies the ` [ApplyOnlyAtCronInterval](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociation.html#systemsmanager-CreateAssociation-request-ApplyOnlyAtCronInterval) ` parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 24.  
Required: No

 ** [InstanceId](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-InstanceId"></a>
The managed node ID.  
 `InstanceId` has been deprecated. To specify a managed node ID for an association, use the `Targets` parameter. Requests that include the parameter `InstanceID` with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter `InstanceId`, you can't use the parameters `AssociationName`, `DocumentVersion`, `MaxErrors`, `MaxConcurrency`, `OutputLocation`, or `ScheduleExpression`. To use these parameters, you must use the `Targets` parameter.
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: No

 ** [MaxConcurrency](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-MaxConcurrency"></a>
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.  
If a new managed node starts and attempts to run an association while Systems Manager is running `MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$`   
Required: No

 ** [MaxErrors](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-MaxErrors"></a>
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set `MaxError` to 10%, then the system stops sending the request when the sixth error is received.  
Executions that are already running an association when `MaxErrors` is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set `MaxConcurrency` to 1 so that executions proceed one at a time.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$`   
Required: No

 ** [Name](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-Name"></a>
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.  
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another AWS account.  
For Systems Manager documents (SSM documents) that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:  
 `arn:partition:ssm:region:account-id:document/document-name `   
For example:  
 `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`   
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, `AWS-ApplyPatchBaseline` or `My-Document`.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: Yes

 ** [OutputLocation](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-OutputLocation"></a>
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.  
Type: [InstanceAssociationOutputLocation](API_InstanceAssociationOutputLocation.md) object  
Required: No

 ** [Parameters](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-Parameters"></a>
The parameters for the runtime configuration of the document.  
Type: String to array of strings map  
Required: No

 ** [ScheduleExpression](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-ScheduleExpression"></a>
A cron expression when the association will be applied to the targets.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [ScheduleOffset](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-ScheduleOffset"></a>
Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of `cron(0 0 ? * THU#2 *)`, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see [Reference: Cron and rate expressions for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html) in the * AWS Systems Manager User Guide*.   
To use offsets, you must specify the `ApplyOnlyAtCronInterval` parameter. This option tells the system not to run an association immediately after you create it. 
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 6.  
Required: No

 ** [SyncCompliance](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-SyncCompliance"></a>
The mode for generating association compliance. You can specify `AUTO` or `MANUAL`. In `AUTO` mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is `COMPLIANT`. If the association execution doesn't run successfully, the association is `NON-COMPLIANT`.  
In `MANUAL` mode, you must specify the `AssociationId` as a parameter for the [PutComplianceItems](API_PutComplianceItems.md) API operation. In this case, compliance data isn't managed by State Manager. It is managed by your direct call to the [PutComplianceItems](API_PutComplianceItems.md) API operation.  
By default, all associations use `AUTO` mode.  
Type: String  
Valid Values: `AUTO | MANUAL`   
Required: No

 ** [Tags](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-Tags"></a>
Adds or overwrites one or more tags for a State Manager association. *Tags* are metadata that you can assign to your AWS resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

 ** [TargetLocations](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-TargetLocations"></a>
A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.  
 `IncludeChildOrganizationUnits`, `ExcludeAccounts`, `TargetsMaxErrors`, `TargetsMaxConcurrency`, `Targets`, `TargetLocationAlarmConfiguration` parameters are not supported by State Manager.
Type: Array of [TargetLocation](API_TargetLocation.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: No

 ** [TargetMaps](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-TargetMaps"></a>
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.  
Type: Array of string to array of strings maps  
Array Members: Minimum number of 0 items. Maximum number of 300 items.  
Map Entries: Maximum number of 20 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 50.  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

 ** [Targets](#API_CreateAssociation_RequestSyntax) **   <a name="systemsmanager-CreateAssociation-request-Targets"></a>
The targets for the association. You can target managed nodes by using tags, AWS resource groups, all managed nodes in an AWS account, or individual managed node IDs. You can target all managed nodes in an AWS account by specifying the `InstanceIds` key with a value of `*`. For more information about choosing targets for an association, see [Understanding targets and rate controls in State Manager associations](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html) in the * AWS Systems Manager User Guide*.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

## Response Syntax
<a name="API_CreateAssociation_ResponseSyntax"></a>

```
{
   "AssociationDescription": { 
      "AlarmConfiguration": { 
         "Alarms": [ 
            { 
               "Name": "string"
            }
         ],
         "IgnorePollAlarmFailure": boolean
      },
      "ApplyOnlyAtCronInterval": boolean,
      "AssociationId": "string",
      "AssociationName": "string",
      "AssociationVersion": "string",
      "AutomationTargetParameterName": "string",
      "CalendarNames": [ "string" ],
      "ComplianceSeverity": "string",
      "Date": number,
      "DocumentVersion": "string",
      "Duration": number,
      "InstanceId": "string",
      "LastExecutionDate": number,
      "LastSuccessfulExecutionDate": number,
      "LastUpdateAssociationDate": number,
      "MaxConcurrency": "string",
      "MaxErrors": "string",
      "Name": "string",
      "OutputLocation": { 
         "S3Location": { 
            "OutputS3BucketName": "string",
            "OutputS3KeyPrefix": "string",
            "OutputS3Region": "string"
         }
      },
      "Overview": { 
         "AssociationStatusAggregatedCount": { 
            "string" : number 
         },
         "DetailedStatus": "string",
         "Status": "string"
      },
      "Parameters": { 
         "string" : [ "string" ]
      },
      "ScheduleExpression": "string",
      "ScheduleOffset": number,
      "Status": { 
         "AdditionalInfo": "string",
         "Date": number,
         "Message": "string",
         "Name": "string"
      },
      "SyncCompliance": "string",
      "TargetLocations": [ 
         { 
            "Accounts": [ "string" ],
            "ExcludeAccounts": [ "string" ],
            "ExecutionRoleName": "string",
            "IncludeChildOrganizationUnits": boolean,
            "Regions": [ "string" ],
            "TargetLocationAlarmConfiguration": { 
               "Alarms": [ 
                  { 
                     "Name": "string"
                  }
               ],
               "IgnorePollAlarmFailure": boolean
            },
            "TargetLocationMaxConcurrency": "string",
            "TargetLocationMaxErrors": "string",
            "Targets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ],
            "TargetsMaxConcurrency": "string",
            "TargetsMaxErrors": "string"
         }
      ],
      "TargetMaps": [ 
         { 
            "string" : [ "string" ]
         }
      ],
      "Targets": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ],
      "TriggeredAlarms": [ 
         { 
            "Name": "string",
            "State": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_CreateAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociationDescription](#API_CreateAssociation_ResponseSyntax) **   <a name="systemsmanager-CreateAssociation-response-AssociationDescription"></a>
Information about the association.  
Type: [AssociationDescription](API_AssociationDescription.md) object

## Errors
<a name="API_CreateAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociationAlreadyExists **   
The specified association already exists.  
HTTP Status Code: 400

 ** AssociationLimitExceeded **   
You can have at most 2,000 active associations.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentVersion **   
The document version isn't valid or doesn't exist.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidOutputLocation **   
The output location isn't valid or doesn't exist.  
HTTP Status Code: 400

 ** InvalidParameters **   
You must specify values for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.  
HTTP Status Code: 400

 ** InvalidSchedule **   
The schedule is invalid. Verify your cron or rate expression and try again.  
HTTP Status Code: 400

 ** InvalidTag **   
The specified tag key or value isn't valid.  
HTTP Status Code: 400

 ** InvalidTarget **   
The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.  
HTTP Status Code: 400

 ** InvalidTargetMaps **   
TargetMap parameter isn't valid.  
HTTP Status Code: 400

 ** UnsupportedPlatformType **   
The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.  
HTTP Status Code: 400

## Examples
<a name="API_CreateAssociation_Examples"></a>

### Example
<a name="API_CreateAssociation_Example_1"></a>

This example illustrates one usage of CreateAssociation.

#### Sample Request
<a name="API_CreateAssociation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.CreateAssociation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T140427Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 67

{
    "Name": "AWS-UpdateSSMAgent",
    "InstanceId": "i-02573cafcfEXAMPLE"
}
```

#### Sample Response
<a name="API_CreateAssociation_Example_1_Response"></a>

```
{
    "AssociationDescription": {
        "ApplyOnlyAtCronInterval": false,
        "AssociationId": "f7d193fe-7722-4f2b-ac53-d8736EXAMPLE",
        "AssociationVersion": "1",
        "Date": 1585058668.255,
        "DocumentVersion": "$DEFAULT",
        "InstanceId": "i-02573cafcfEXAMPLE",
        "LastUpdateAssociationDate": 1585058668.255,
        "Name": "AWS-UpdateSSMAgent",
        "Overview": {
            "DetailedStatus": "Creating",
            "Status": "Pending"
        },
        "Status": {
            "Date": 1585058668.255,
            "Message": "Associated with AWS-UpdateSSMAgent",
            "Name": "Associated"
        },
        "Targets": [
            {
                "Key": "InstanceIds",
                "Values": [
                    "i-02573cafcfEXAMPLE"
                ]
            }
        ]
    }
}
```

## See Also
<a name="API_CreateAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CreateAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CreateAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CreateAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CreateAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CreateAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CreateAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CreateAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CreateAssociation) 

# CreateAssociationBatch
<a name="API_CreateAssociationBatch"></a>

Associates the specified AWS Systems Manager document (SSM document) with the specified managed nodes or targets.

When you associate a document with one or more managed nodes using IDs or tags, AWS Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.

If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.

## Request Syntax
<a name="API_CreateAssociationBatch_RequestSyntax"></a>

```
{
   "Entries": [ 
      { 
         "AlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "ApplyOnlyAtCronInterval": boolean,
         "AssociationName": "string",
         "AutomationTargetParameterName": "string",
         "CalendarNames": [ "string" ],
         "ComplianceSeverity": "string",
         "DocumentVersion": "string",
         "Duration": number,
         "InstanceId": "string",
         "MaxConcurrency": "string",
         "MaxErrors": "string",
         "Name": "string",
         "OutputLocation": { 
            "S3Location": { 
               "OutputS3BucketName": "string",
               "OutputS3KeyPrefix": "string",
               "OutputS3Region": "string"
            }
         },
         "Parameters": { 
            "string" : [ "string" ]
         },
         "ScheduleExpression": "string",
         "ScheduleOffset": number,
         "SyncCompliance": "string",
         "TargetLocations": [ 
            { 
               "Accounts": [ "string" ],
               "ExcludeAccounts": [ "string" ],
               "ExecutionRoleName": "string",
               "IncludeChildOrganizationUnits": boolean,
               "Regions": [ "string" ],
               "TargetLocationAlarmConfiguration": { 
                  "Alarms": [ 
                     { 
                        "Name": "string"
                     }
                  ],
                  "IgnorePollAlarmFailure": boolean
               },
               "TargetLocationMaxConcurrency": "string",
               "TargetLocationMaxErrors": "string",
               "Targets": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ],
               "TargetsMaxConcurrency": "string",
               "TargetsMaxErrors": "string"
            }
         ],
         "TargetMaps": [ 
            { 
               "string" : [ "string" ]
            }
         ],
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ]
      }
   ]
}
```

## Request Parameters
<a name="API_CreateAssociationBatch_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Entries](#API_CreateAssociationBatch_RequestSyntax) **   <a name="systemsmanager-CreateAssociationBatch-request-Entries"></a>
One or more associations.  
Type: Array of [CreateAssociationBatchRequestEntry](API_CreateAssociationBatchRequestEntry.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_CreateAssociationBatch_ResponseSyntax"></a>

```
{
   "Failed": [ 
      { 
         "Entry": { 
            "AlarmConfiguration": { 
               "Alarms": [ 
                  { 
                     "Name": "string"
                  }
               ],
               "IgnorePollAlarmFailure": boolean
            },
            "ApplyOnlyAtCronInterval": boolean,
            "AssociationName": "string",
            "AutomationTargetParameterName": "string",
            "CalendarNames": [ "string" ],
            "ComplianceSeverity": "string",
            "DocumentVersion": "string",
            "Duration": number,
            "InstanceId": "string",
            "MaxConcurrency": "string",
            "MaxErrors": "string",
            "Name": "string",
            "OutputLocation": { 
               "S3Location": { 
                  "OutputS3BucketName": "string",
                  "OutputS3KeyPrefix": "string",
                  "OutputS3Region": "string"
               }
            },
            "Parameters": { 
               "string" : [ "string" ]
            },
            "ScheduleExpression": "string",
            "ScheduleOffset": number,
            "SyncCompliance": "string",
            "TargetLocations": [ 
               { 
                  "Accounts": [ "string" ],
                  "ExcludeAccounts": [ "string" ],
                  "ExecutionRoleName": "string",
                  "IncludeChildOrganizationUnits": boolean,
                  "Regions": [ "string" ],
                  "TargetLocationAlarmConfiguration": { 
                     "Alarms": [ 
                        { 
                           "Name": "string"
                        }
                     ],
                     "IgnorePollAlarmFailure": boolean
                  },
                  "TargetLocationMaxConcurrency": "string",
                  "TargetLocationMaxErrors": "string",
                  "Targets": [ 
                     { 
                        "Key": "string",
                        "Values": [ "string" ]
                     }
                  ],
                  "TargetsMaxConcurrency": "string",
                  "TargetsMaxErrors": "string"
               }
            ],
            "TargetMaps": [ 
               { 
                  "string" : [ "string" ]
               }
            ],
            "Targets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ]
         },
         "Fault": "string",
         "Message": "string"
      }
   ],
   "Successful": [ 
      { 
         "AlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "ApplyOnlyAtCronInterval": boolean,
         "AssociationId": "string",
         "AssociationName": "string",
         "AssociationVersion": "string",
         "AutomationTargetParameterName": "string",
         "CalendarNames": [ "string" ],
         "ComplianceSeverity": "string",
         "Date": number,
         "DocumentVersion": "string",
         "Duration": number,
         "InstanceId": "string",
         "LastExecutionDate": number,
         "LastSuccessfulExecutionDate": number,
         "LastUpdateAssociationDate": number,
         "MaxConcurrency": "string",
         "MaxErrors": "string",
         "Name": "string",
         "OutputLocation": { 
            "S3Location": { 
               "OutputS3BucketName": "string",
               "OutputS3KeyPrefix": "string",
               "OutputS3Region": "string"
            }
         },
         "Overview": { 
            "AssociationStatusAggregatedCount": { 
               "string" : number 
            },
            "DetailedStatus": "string",
            "Status": "string"
         },
         "Parameters": { 
            "string" : [ "string" ]
         },
         "ScheduleExpression": "string",
         "ScheduleOffset": number,
         "Status": { 
            "AdditionalInfo": "string",
            "Date": number,
            "Message": "string",
            "Name": "string"
         },
         "SyncCompliance": "string",
         "TargetLocations": [ 
            { 
               "Accounts": [ "string" ],
               "ExcludeAccounts": [ "string" ],
               "ExecutionRoleName": "string",
               "IncludeChildOrganizationUnits": boolean,
               "Regions": [ "string" ],
               "TargetLocationAlarmConfiguration": { 
                  "Alarms": [ 
                     { 
                        "Name": "string"
                     }
                  ],
                  "IgnorePollAlarmFailure": boolean
               },
               "TargetLocationMaxConcurrency": "string",
               "TargetLocationMaxErrors": "string",
               "Targets": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ],
               "TargetsMaxConcurrency": "string",
               "TargetsMaxErrors": "string"
            }
         ],
         "TargetMaps": [ 
            { 
               "string" : [ "string" ]
            }
         ],
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "TriggeredAlarms": [ 
            { 
               "Name": "string",
               "State": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_CreateAssociationBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Failed](#API_CreateAssociationBatch_ResponseSyntax) **   <a name="systemsmanager-CreateAssociationBatch-response-Failed"></a>
Information about the associations that failed.  
Type: Array of [FailedCreateAssociation](API_FailedCreateAssociation.md) objects

 ** [Successful](#API_CreateAssociationBatch_ResponseSyntax) **   <a name="systemsmanager-CreateAssociationBatch-response-Successful"></a>
Information about the associations that succeeded.  
Type: Array of [AssociationDescription](API_AssociationDescription.md) objects

## Errors
<a name="API_CreateAssociationBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociationLimitExceeded **   
You can have at most 2,000 active associations.  
HTTP Status Code: 400

 ** DuplicateInstanceId **   
You can't specify a managed node ID in more than one association.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentVersion **   
The document version isn't valid or doesn't exist.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidOutputLocation **   
The output location isn't valid or doesn't exist.  
HTTP Status Code: 400

 ** InvalidParameters **   
You must specify values for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.  
HTTP Status Code: 400

 ** InvalidSchedule **   
The schedule is invalid. Verify your cron or rate expression and try again.  
HTTP Status Code: 400

 ** InvalidTarget **   
The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.  
HTTP Status Code: 400

 ** InvalidTargetMaps **   
TargetMap parameter isn't valid.  
HTTP Status Code: 400

 ** UnsupportedPlatformType **   
The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.  
HTTP Status Code: 400

## Examples
<a name="API_CreateAssociationBatch_Examples"></a>

### Example
<a name="API_CreateAssociationBatch_Example_1"></a>

This example illustrates one usage of CreateAssociationBatch.

#### Sample Request
<a name="API_CreateAssociationBatch_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.CreateAssociationBatch
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T142446Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 151

{
    "Entries": [
        {
            "InstanceId": "i-0471e04240EXAMPLE",
            "Name": "AWS-UpdateSSMAgent"
        },
        {
            "InstanceId": "i-07782c72faEXAMPLE",
            "Name": "AWS-UpdateSSMAgent"
        }
    ]
}
```

#### Sample Response
<a name="API_CreateAssociationBatch_Example_1_Response"></a>

```
{
    "Failed": [],
    "Successful": [
        {
            "ApplyOnlyAtCronInterval": false,
            "AssociationId": "33858bec-0c55-4547-a054-eb5fcEXAMPLE",
            "AssociationVersion": "1",
            "Date": 1585059887.692,
            "DocumentVersion": "$DEFAULT",
            "InstanceId": "i-0471e04240EXAMPLE",
            "LastUpdateAssociationDate": 1585059887.692,
            "Name": "AWS-UpdateSSMAgent",
            "Overview": {
                "DetailedStatus": "Creating",
                "Status": "Pending"
            },
            "Status": {
                "Date": 1585059887.692,
                "Message": "Associated with AWS-UpdateSSMAgent",
                "Name": "Associated"
            },
            "Targets": [
                {
                    "Key": "InstanceIds",
                    "Values": [
                        "i-0471e04240EXAMPLE"
                    ]
                }
            ]
        },
        {
            "ApplyOnlyAtCronInterval": false,
            "AssociationId": "e0e0a062-3dcb-4b3e-bb2b-d01b4EXAMPLE",
            "AssociationVersion": "1",
            "Date": 1585059887.726,
            "DocumentVersion": "$DEFAULT",
            "InstanceId": "i-07782c72faEXAMPLE",
            "LastUpdateAssociationDate": 1585059887.726,
            "Name": "AWS-UpdateSSMAgent",
            "Overview": {
                "DetailedStatus": "Creating",
                "Status": "Pending"
            },
            "Status": {
                "Date": 1585059887.726,
                "Message": "Associated with AWS-UpdateSSMAgent",
                "Name": "Associated"
            },
            "Targets": [
                {
                    "Key": "InstanceIds",
                    "Values": [
                        "i-07782c72faEXAMPLE"
                    ]
                }
            ]
        }
    ]
}
```

## See Also
<a name="API_CreateAssociationBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CreateAssociationBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CreateAssociationBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CreateAssociationBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CreateAssociationBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateAssociationBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CreateAssociationBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CreateAssociationBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CreateAssociationBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateAssociationBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CreateAssociationBatch) 

# CreateDocument
<a name="API_CreateDocument"></a>

Creates a AWS Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see [AWS Systems Manager Documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/documents.html) in the * AWS Systems Manager User Guide*.

## Request Syntax
<a name="API_CreateDocument_RequestSyntax"></a>

```
{
   "Attachments": [ 
      { 
         "Key": "string",
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "Content": "string",
   "DisplayName": "string",
   "DocumentFormat": "string",
   "DocumentType": "string",
   "Name": "string",
   "Requires": [ 
      { 
         "Name": "string",
         "RequireType": "string",
         "Version": "string",
         "VersionName": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TargetType": "string",
   "VersionName": "string"
}
```

## Request Parameters
<a name="API_CreateDocument_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Attachments](#API_CreateDocument_RequestSyntax) **   <a name="systemsmanager-CreateDocument-request-Attachments"></a>
A list of key-value pairs that describe attachments to a version of a document.  
Type: Array of [AttachmentsSource](API_AttachmentsSource.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

 ** [Content](#API_CreateDocument_RequestSyntax) **   <a name="systemsmanager-CreateDocument-request-Content"></a>
The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.  
For examples, see the following topics in the * AWS Systems Manager User Guide*.  
+  [Create an SSM document (console)](https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-console) 
+  [Create an SSM document (command line)](https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-document-cli) 
+  [Create an SSM document (API)](https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-document-api) 
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [DisplayName](#API_CreateDocument_RequestSyntax) **   <a name="systemsmanager-CreateDocument-request-DisplayName"></a>
An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the [UpdateDocument](API_UpdateDocument.md) operation.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^[\w\.\-\:\/ ]*$`   
Required: No

 ** [DocumentFormat](#API_CreateDocument_RequestSyntax) **   <a name="systemsmanager-CreateDocument-request-DocumentFormat"></a>
Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.  
Type: String  
Valid Values: `YAML | JSON | TEXT`   
Required: No

 ** [DocumentType](#API_CreateDocument_RequestSyntax) **   <a name="systemsmanager-CreateDocument-request-DocumentType"></a>
The type of document to create.  
The `DeploymentStrategy` document type is an internal-use-only document type reserved for AWS AppConfig.
Type: String  
Valid Values: `Command | Policy | Automation | Session | Package | ApplicationConfiguration | ApplicationConfigurationSchema | DeploymentStrategy | ChangeCalendar | Automation.ChangeTemplate | ProblemAnalysis | ProblemAnalysisTemplate | CloudFormation | ConformancePackTemplate | QuickSetup | ManualApprovalPolicy | AutoApprovalPolicy`   
Required: No

 ** [Name](#API_CreateDocument_RequestSyntax) **   <a name="systemsmanager-CreateDocument-request-Name"></a>
A name for the SSM document.  
You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:  
+  `aws` 
+  `amazon` 
+  `amzn` 
+  `AWSEC2` 
+  `AWSConfigRemediation` 
+  `AWSSupport` 
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

 ** [Requires](#API_CreateDocument_RequestSyntax) **   <a name="systemsmanager-CreateDocument-request-Requires"></a>
A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig. When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document for validation purposes. For more information, see [What is AWS AppConfig?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the * AWS AppConfig User Guide*.  
Type: Array of [DocumentRequires](API_DocumentRequires.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** [Tags](#API_CreateDocument_RequestSyntax) **   <a name="systemsmanager-CreateDocument-request-Tags"></a>
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:  
+  `Key=OS,Value=Windows` 
+  `Key=Environment,Value=Production` 
To add tags to an existing SSM document, use the [AddTagsToResource](API_AddTagsToResource.md) operation.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

 ** [TargetType](#API_CreateDocument_RequestSyntax) **   <a name="systemsmanager-CreateDocument-request-TargetType"></a>
Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: `/AWS::EC2::Instance`. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the * AWS CloudFormation User Guide*.   
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `^\/[\w\.\-\:\/]*$`   
Required: No

 ** [VersionName](#API_CreateDocument_RequestSyntax) **   <a name="systemsmanager-CreateDocument-request-VersionName"></a>
An optional field specifying the version of the artifact you are creating with the document. For example, `Release12.1`. This value is unique across all versions of a document, and can't be changed.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{1,128}$`   
Required: No

## Response Syntax
<a name="API_CreateDocument_ResponseSyntax"></a>

```
{
   "DocumentDescription": { 
      "ApprovedVersion": "string",
      "AttachmentsInformation": [ 
         { 
            "Name": "string"
         }
      ],
      "Author": "string",
      "Category": [ "string" ],
      "CategoryEnum": [ "string" ],
      "CreatedDate": number,
      "DefaultVersion": "string",
      "Description": "string",
      "DisplayName": "string",
      "DocumentFormat": "string",
      "DocumentType": "string",
      "DocumentVersion": "string",
      "Hash": "string",
      "HashType": "string",
      "LatestVersion": "string",
      "Name": "string",
      "Owner": "string",
      "Parameters": [ 
         { 
            "DefaultValue": "string",
            "Description": "string",
            "Name": "string",
            "Type": "string"
         }
      ],
      "PendingReviewVersion": "string",
      "PlatformTypes": [ "string" ],
      "Requires": [ 
         { 
            "Name": "string",
            "RequireType": "string",
            "Version": "string",
            "VersionName": "string"
         }
      ],
      "ReviewInformation": [ 
         { 
            "ReviewedTime": number,
            "Reviewer": "string",
            "Status": "string"
         }
      ],
      "ReviewStatus": "string",
      "SchemaVersion": "string",
      "Sha1": "string",
      "Status": "string",
      "StatusInformation": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TargetType": "string",
      "VersionName": "string"
   }
}
```

## Response Elements
<a name="API_CreateDocument_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DocumentDescription](#API_CreateDocument_ResponseSyntax) **   <a name="systemsmanager-CreateDocument-response-DocumentDescription"></a>
Information about the SSM document.  
Type: [DocumentDescription](API_DocumentDescription.md) object

## Errors
<a name="API_CreateDocument_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DocumentAlreadyExists **   
The specified document already exists.  
HTTP Status Code: 400

 ** DocumentLimitExceeded **   
You can have at most 500 active SSM documents.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocumentContent **   
The content for the document isn't valid.    
 ** Message **   
A description of the validation error.
HTTP Status Code: 400

 ** InvalidDocumentSchemaVersion **   
The version of the document schema isn't supported.  
HTTP Status Code: 400

 ** MaxDocumentSizeExceeded **   
The size limit of a document is 64 KB.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDocument_Examples"></a>

### Example
<a name="API_CreateDocument_Example_1"></a>

This example illustrates one usage of CreateDocument.

#### Sample Request
<a name="API_CreateDocument_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.CreateDocument
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T145550Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 963

{
    "Content": "---\ndescription: \"Example\"\nschemaVersion: '0.3'\nassumeRole: \"{{ AutomationAssumeRole }}\"--truncated--",
    "Name": "Example",
    "DocumentType": "Automation",
    "DocumentFormat": "YAML"
}
```

#### Sample Response
<a name="API_CreateDocument_Example_1_Response"></a>

```
{
    "DocumentDescription": {
        "CreatedDate": 1585061751.738,
        "DefaultVersion": "1",
        "Description": "Custom Automation Example",
        "DocumentFormat": "YAML",
        "DocumentType": "Automation",
        "DocumentVersion": "1",
        "Hash": "0d3d879b3ca072e03c12638d0255ebd004d2c65bd318f8354fcde820dEXAMPLE",
        "HashType": "Sha256",
        "LatestVersion": "1",
        "Name": "Example",
        "Owner": "111122223333",
        "Parameters": [
            {
                "DefaultValue": "",
                "Description": "(Optional) 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.",
                "Name": "AutomationAssumeRole",
                "Type": "String"
            },
            {
                "DefaultValue": "",
                "Description": "(Required) The Instance Id to create an image of.",
                "Name": "InstanceId",
                "Type": "String"
            }
        ],
        "PlatformTypes": [
            "Windows",
            "Linux"
        ],
        "SchemaVersion": "0.3",
        "Status": "Creating",
        "Tags": []
    }
}
```

## See Also
<a name="API_CreateDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CreateDocument) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CreateDocument) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CreateDocument) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CreateDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateDocument) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CreateDocument) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CreateDocument) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CreateDocument) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CreateDocument) 

# CreateMaintenanceWindow
<a name="API_CreateMaintenanceWindow"></a>

Creates a new maintenance window.

**Note**  
The value you specify for `Duration` determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for `Cutoff`. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for `Cutoff` is one hour, no maintenance window tasks can start after 5 PM.

## Request Syntax
<a name="API_CreateMaintenanceWindow_RequestSyntax"></a>

```
{
   "AllowUnassociatedTargets": boolean,
   "ClientToken": "string",
   "Cutoff": number,
   "Description": "string",
   "Duration": number,
   "EndDate": "string",
   "Name": "string",
   "Schedule": "string",
   "ScheduleOffset": number,
   "ScheduleTimezone": "string",
   "StartDate": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateMaintenanceWindow_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AllowUnassociatedTargets](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-AllowUnassociatedTargets"></a>
Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.  
If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.  
Type: Boolean  
Required: Yes

 ** [ClientToken](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-ClientToken"></a>
User-provided idempotency token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [Cutoff](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-Cutoff"></a>
The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: Yes

 ** [Description](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-Description"></a>
An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [Duration](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-Duration"></a>
The duration of the maintenance window in hours.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 24.  
Required: Yes

 ** [EndDate](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-EndDate"></a>
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. `EndDate` allows you to set a date and time in the future when the maintenance window will no longer run.  
Type: String  
Required: No

 ** [Name](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-Name"></a>
The name of the maintenance window.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

 ** [Schedule](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-Schedule"></a>
The schedule of the maintenance window in the form of a cron or rate expression.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [ScheduleOffset](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-ScheduleOffset"></a>
The number of days to wait after the date and time specified by a cron expression before running the maintenance window.  
For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.  
 `cron(30 23 ? * TUE#3 *)`   
If the schedule offset is `2`, the maintenance window won't run until two days later.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 6.  
Required: No

 ** [ScheduleTimezone](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-ScheduleTimezone"></a>
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los\$1Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database](https://www.iana.org/time-zones) on the IANA website.  
Type: String  
Required: No

 ** [StartDate](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-StartDate"></a>
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. `StartDate` allows you to delay activation of the maintenance window until the specified future date.  
When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date. 
Type: String  
Required: No

 ** [Tags](#API_CreateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-request-Tags"></a>
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:  
+  `Key=TaskType,Value=AgentUpdate` 
+  `Key=OS,Value=Windows` 
+  `Key=Environment,Value=Production` 
To add tags to an existing maintenance window, use the [AddTagsToResource](API_AddTagsToResource.md) operation.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

## Response Syntax
<a name="API_CreateMaintenanceWindow_ResponseSyntax"></a>

```
{
   "WindowId": "string"
}
```

## Response Elements
<a name="API_CreateMaintenanceWindow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [WindowId](#API_CreateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-CreateMaintenanceWindow-response-WindowId"></a>
The ID of the created maintenance window.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$` 

## Errors
<a name="API_CreateMaintenanceWindow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** IdempotentParameterMismatch **   
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.   
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceLimitExceededException **   
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.  
For information about resource quotas in Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

## Examples
<a name="API_CreateMaintenanceWindow_Examples"></a>

### Example
<a name="API_CreateMaintenanceWindow_Example_1"></a>

This example illustrates one usage of CreateMaintenanceWindow.

#### Sample Request
<a name="API_CreateMaintenanceWindow_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 186
X-Amz-Target: AmazonSSM.CreateMaintenanceWindow
X-Amz-Date: 20240312T201809Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Name": "My-Development-Maintenance-Window",
    "Cutoff": 2,
    "Schedule": "cron(0 12 ? * WED *)",
    "AllowUnassociatedTargets": true,
    "Duration": 6,
    "Tags": [
        {
            "Key": "Environment",
            "Value": "Development"
        }
    ],
    "ClientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_CreateMaintenanceWindow_Example_1_Response"></a>

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

## See Also
<a name="API_CreateMaintenanceWindow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CreateMaintenanceWindow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CreateMaintenanceWindow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CreateMaintenanceWindow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CreateMaintenanceWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateMaintenanceWindow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CreateMaintenanceWindow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CreateMaintenanceWindow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CreateMaintenanceWindow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateMaintenanceWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CreateMaintenanceWindow) 

# CreateOpsItem
<a name="API_CreateOpsItem"></a>

Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see [Set up OpsCenter](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) in the * AWS Systems Manager User Guide*.

Operations engineers and IT professionals use AWS Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see [AWS Systems Manager OpsCenter](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the * AWS Systems Manager User Guide*. 

## Request Syntax
<a name="API_CreateOpsItem_RequestSyntax"></a>

```
{
   "AccountId": "string",
   "ActualEndTime": number,
   "ActualStartTime": number,
   "Category": "string",
   "Description": "string",
   "Notifications": [ 
      { 
         "Arn": "string"
      }
   ],
   "OperationalData": { 
      "string" : { 
         "Type": "string",
         "Value": "string"
      }
   },
   "OpsItemType": "string",
   "PlannedEndTime": number,
   "PlannedStartTime": number,
   "Priority": number,
   "RelatedOpsItems": [ 
      { 
         "OpsItemId": "string"
      }
   ],
   "Severity": "string",
   "Source": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Title": "string"
}
```

## Request Parameters
<a name="API_CreateOpsItem_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AccountId](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-AccountId"></a>
The target AWS account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see [Set up OpsCenter](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) in the * AWS Systems Manager User Guide*.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** [ActualEndTime](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-ActualEndTime"></a>
The time a runbook workflow ended. Currently reported only for the OpsItem type `/aws/changerequest`.  
Type: Timestamp  
Required: No

 ** [ActualStartTime](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-ActualStartTime"></a>
The time a runbook workflow started. Currently reported only for the OpsItem type `/aws/changerequest`.  
Type: Timestamp  
Required: No

 ** [Category](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-Category"></a>
Specify a category to assign to an OpsItem.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^(?!\s*$).+`   
Required: No

 ** [Description](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-Description"></a>
User-defined text that contains information about the OpsItem, in Markdown format.   
Provide enough information so that users viewing this OpsItem for the first time understand the issue. 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\s\S]*\S[\s\S]*`   
Required: Yes

 ** [Notifications](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-Notifications"></a>
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.  
Type: Array of [OpsItemNotification](API_OpsItemNotification.md) objects  
Required: No

 ** [OperationalData](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-OperationalData"></a>
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.  
Operational data keys *can't* begin with the following: `amazon`, `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the [DescribeOpsItems](API_DescribeOpsItems.md) API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the [GetOpsItem](API_GetOpsItem.md) API operation).  
Use the `/aws/resources` key in OperationalData to specify a related resource in the request. Use the `/aws/automations` key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see [Create OpsItems manually](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html) in the * AWS Systems Manager User Guide*.  
Type: String to [OpsItemDataValue](API_OpsItemDataValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!\s*$).+`   
Required: No

 ** [OpsItemType](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-OpsItemType"></a>
The type of OpsItem to create. Systems Manager supports the following types of OpsItems:  
+  `/aws/issue` 

  This type of OpsItem is used for default OpsItems created by OpsCenter. 
+  `/aws/insight` 

  This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems. 
+  `/aws/changerequest` 

  This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests. 
**Important**  
 AWS Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Change Manager availability change](https://docs.aws.amazon.com/systems-manager/latest/userguide/change-manager-availability-change.html).
Type: String  
Required: No

 ** [PlannedEndTime](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-PlannedEndTime"></a>
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type `/aws/changerequest`.  
Type: Timestamp  
Required: No

 ** [PlannedStartTime](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-PlannedStartTime"></a>
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type `/aws/changerequest`.  
Type: Timestamp  
Required: No

 ** [Priority](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-Priority"></a>
The importance of this OpsItem in relation to other OpsItems in the system.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 5.  
Required: No

 ** [RelatedOpsItems](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-RelatedOpsItems"></a>
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.  
Type: Array of [RelatedOpsItem](API_RelatedOpsItem.md) objects  
Required: No

 ** [Severity](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-Severity"></a>
Specify a severity to assign to an OpsItem.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^(?!\s*$).+`   
Required: No

 ** [Source](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-Source"></a>
The origin of the OpsItem, such as Amazon EC2 or Systems Manager.  
The source name can't contain the following strings: `aws`, `amazon`, and `amzn`. 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!\s*$).+`   
Required: Yes

 ** [Tags](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-Tags"></a>
Optional metadata that you assign to a resource.  
Tags use a key-value pair. For example:  
 `Key=Department,Value=Finance`   
To add tags to a new OpsItem, a user must have IAM permissions for both the `ssm:CreateOpsItems` operation and the `ssm:AddTagsToResource` operation. To add tags to an existing OpsItem, use the [AddTagsToResource](API_AddTagsToResource.md) operation.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

 ** [Title](#API_CreateOpsItem_RequestSyntax) **   <a name="systemsmanager-CreateOpsItem-request-Title"></a>
A short heading that describes the nature of the OpsItem and the impacted resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^(?!\s*$).+`   
Required: Yes

## Response Syntax
<a name="API_CreateOpsItem_ResponseSyntax"></a>

```
{
   "OpsItemArn": "string",
   "OpsItemId": "string"
}
```

## Response Elements
<a name="API_CreateOpsItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [OpsItemArn](#API_CreateOpsItem_ResponseSyntax) **   <a name="systemsmanager-CreateOpsItem-response-OpsItemArn"></a>
The OpsItem Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[0-9]{12}:opsitem.*` 

 ** [OpsItemId](#API_CreateOpsItem_ResponseSyntax) **   <a name="systemsmanager-CreateOpsItem-response-OpsItemId"></a>
The ID of the OpsItem.  
Type: String

## Errors
<a name="API_CreateOpsItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsItemAccessDeniedException **   
You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the AWS Organizations management account.  
HTTP Status Code: 400

 ** OpsItemAlreadyExistsException **   
The OpsItem already exists.  
HTTP Status Code: 400

 ** OpsItemInvalidParameterException **   
A specified parameter argument isn't valid. Verify the available arguments and try again.  
HTTP Status Code: 400

 ** OpsItemLimitExceededException **   
The request caused OpsItems to exceed one or more quotas.  
HTTP Status Code: 400

## Examples
<a name="API_CreateOpsItem_Examples"></a>

### Example
<a name="API_CreateOpsItem_Example_1"></a>

This example illustrates one usage of CreateOpsItem.

#### Sample Request
<a name="API_CreateOpsItem_Example_1_Request"></a>

```
POST / HTTP/1.1
 Host: ssm.us-east-2.amazonaws.com
 Accept-Encoding: identity
 X-Amz-Target: AmazonSSM.CreateOpsItem
 Content-Type: application/x-amz-json-1.1
 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
 X-Amz-Date: 20240401T161257Z
 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
 Content-Length: 80
 
 {
     "Description": "Example Ops Item",
     "Source": "SSM",
     "Title": "DocumentDeleted"
 }
```

#### Sample Response
<a name="API_CreateOpsItem_Example_1_Response"></a>

```
{{
     "OpsItemId": "oi-1f050EXAMPLE"
 }
```

## See Also
<a name="API_CreateOpsItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CreateOpsItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CreateOpsItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CreateOpsItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CreateOpsItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateOpsItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CreateOpsItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CreateOpsItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CreateOpsItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateOpsItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CreateOpsItem) 

# CreateOpsMetadata
<a name="API_CreateOpsMetadata"></a>

If you create a new application in Application Manager, AWS Systems Manager calls this API operation to specify information about the new application, including the application type.

## Request Syntax
<a name="API_CreateOpsMetadata_RequestSyntax"></a>

```
{
   "Metadata": { 
      "string" : { 
         "Value": "string"
      }
   },
   "ResourceId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateOpsMetadata_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Metadata](#API_CreateOpsMetadata_RequestSyntax) **   <a name="systemsmanager-CreateOpsMetadata-request-Metadata"></a>
Metadata for a new Application Manager application.   
Type: String to [MetadataValue](API_MetadataValue.md) object map  
Map Entries: Maximum number of 5 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `^(?!\s*$).+`   
Required: No

 ** [ResourceId](#API_CreateOpsMetadata_RequestSyntax) **   <a name="systemsmanager-CreateOpsMetadata-request-ResourceId"></a>
A resource ID for a new Application Manager application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^(?!\s*$).+`   
Required: Yes

 ** [Tags](#API_CreateOpsMetadata_RequestSyntax) **   <a name="systemsmanager-CreateOpsMetadata-request-Tags"></a>
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:  
+  `Key=Environment,Value=Production` 
+  `Key=Region,Value=us-east-2` 
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

## Response Syntax
<a name="API_CreateOpsMetadata_ResponseSyntax"></a>

```
{
   "OpsMetadataArn": "string"
}
```

## Response Elements
<a name="API_CreateOpsMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [OpsMetadataArn](#API_CreateOpsMetadata_ResponseSyntax) **   <a name="systemsmanager-CreateOpsMetadata-response-OpsMetadataArn"></a>
The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:opsmetadata\/([a-zA-Z0-9-_\.\/]*)` 

## Errors
<a name="API_CreateOpsMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsMetadataAlreadyExistsException **   
An OpsMetadata object already exists for the selected resource.  
HTTP Status Code: 400

 ** OpsMetadataInvalidArgumentException **   
One of the arguments passed is invalid.   
HTTP Status Code: 400

 ** OpsMetadataLimitExceededException **   
Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.  
HTTP Status Code: 400

 ** OpsMetadataTooManyUpdatesException **   
The system is processing too many concurrent updates. Wait a few moments and try again.  
HTTP Status Code: 400

## See Also
<a name="API_CreateOpsMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CreateOpsMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CreateOpsMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CreateOpsMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CreateOpsMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateOpsMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CreateOpsMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CreateOpsMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CreateOpsMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateOpsMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CreateOpsMetadata) 

# CreatePatchBaseline
<a name="API_CreatePatchBaseline"></a>

Creates a patch baseline.

**Note**  
For information about valid key-value pairs in `PatchFilters` for each supported operating system type, see [PatchFilter](API_PatchFilter.md).

## Request Syntax
<a name="API_CreatePatchBaseline_RequestSyntax"></a>

```
{
   "ApprovalRules": { 
      "PatchRules": [ 
         { 
            "ApproveAfterDays": number,
            "ApproveUntilDate": "string",
            "ComplianceLevel": "string",
            "EnableNonSecurity": boolean,
            "PatchFilterGroup": { 
               "PatchFilters": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         }
      ]
   },
   "ApprovedPatches": [ "string" ],
   "ApprovedPatchesComplianceLevel": "string",
   "ApprovedPatchesEnableNonSecurity": boolean,
   "AvailableSecurityUpdatesComplianceStatus": "string",
   "ClientToken": "string",
   "Description": "string",
   "GlobalFilters": { 
      "PatchFilters": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "Name": "string",
   "OperatingSystem": "string",
   "RejectedPatches": [ "string" ],
   "RejectedPatchesAction": "string",
   "Sources": [ 
      { 
         "Configuration": "string",
         "Name": "string",
         "Products": [ "string" ]
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreatePatchBaseline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApprovalRules](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-ApprovalRules"></a>
A set of rules used to include patches in the baseline.  
Type: [PatchRuleGroup](API_PatchRuleGroup.md) object  
Required: No

 ** [ApprovedPatches](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-ApprovedPatches"></a>
A list of explicitly approved patches for the baseline.  
For information about accepted formats for lists of approved patches and rejected patches, see [Package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the * AWS Systems Manager User Guide*.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [ApprovedPatchesComplianceLevel](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-ApprovedPatchesComplianceLevel"></a>
Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is `UNSPECIFIED`.  
Type: String  
Valid Values: `CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED`   
Required: No

 ** [ApprovedPatchesEnableNonSecurity](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-ApprovedPatchesEnableNonSecurity"></a>
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is `false`. Applies to Linux managed nodes only.  
Type: Boolean  
Required: No

 ** [AvailableSecurityUpdatesComplianceStatus](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-AvailableSecurityUpdatesComplianceStatus"></a>
Indicates the status you want to assign to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.  
Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.  
Supported for Windows Server managed nodes only.  
Type: String  
Valid Values: `COMPLIANT | NON_COMPLIANT`   
Required: No

 ** [ClientToken](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-ClientToken"></a>
User-provided idempotency token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [Description](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-Description"></a>
A description of the patch baseline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** [GlobalFilters](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-GlobalFilters"></a>
A set of global filters used to include patches in the baseline.  
The `GlobalFilters` parameter can be configured only by using the AWS CLI or an AWS SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.
Type: [PatchFilterGroup](API_PatchFilterGroup.md) object  
Required: No

 ** [Name](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-Name"></a>
The name of the patch baseline.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

 ** [OperatingSystem](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-OperatingSystem"></a>
Defines the operating system the patch baseline applies to. The default value is `WINDOWS`.  
Type: String  
Valid Values: `WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023`   
Required: No

 ** [RejectedPatches](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-RejectedPatches"></a>
A list of explicitly rejected patches for the baseline.  
For information about accepted formats for lists of approved patches and rejected patches, see [Package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the * AWS Systems Manager User Guide*.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [RejectedPatchesAction](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-RejectedPatchesAction"></a>
The action for Patch Manager to take on patches included in the `RejectedPackages` list.    
ALLOW\$1AS\$1DEPENDENCY  
 **Linux and macOS**: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as `INSTALLED_OTHER`. This is the default action if no option is specified.  
 **Windows Server**: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as `INSTALLED_OTHER`. Any package not already installed on the node is skipped. This is the default action if no option is specified.  
BLOCK  
 **All OSs**: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances.   
State value assignment for patch compliance:  
+ If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as `INSTALLED_REJECTED`.
+ If an update attempts to install a dependency package that is now rejected by the baseline, when previous versions of the package were not rejected, the package being updated is reported as `MISSING` for `SCAN` operations and as `FAILED` for `INSTALL` operations.
Type: String  
Valid Values: `ALLOW_AS_DEPENDENCY | BLOCK`   
Required: No

 ** [Sources](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-Sources"></a>
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.  
Type: Array of [PatchSource](API_PatchSource.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

 ** [Tags](#API_CreatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-CreatePatchBaseline-request-Tags"></a>
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key-value pairs:  
+  `Key=PatchSeverity,Value=Critical` 
+  `Key=OS,Value=Windows` 
To add tags to an existing patch baseline, use the [AddTagsToResource](API_AddTagsToResource.md) operation.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

## Response Syntax
<a name="API_CreatePatchBaseline_ResponseSyntax"></a>

```
{
   "BaselineId": "string"
}
```

## Response Elements
<a name="API_CreatePatchBaseline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BaselineId](#API_CreatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-CreatePatchBaseline-response-BaselineId"></a>
The ID of the created patch baseline.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$` 

## Errors
<a name="API_CreatePatchBaseline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** IdempotentParameterMismatch **   
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.   
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceLimitExceededException **   
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.  
For information about resource quotas in Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

## Examples
<a name="API_CreatePatchBaseline_Examples"></a>

### Example
<a name="API_CreatePatchBaseline_Example_1"></a>

This example illustrates one usage of CreatePatchBaseline.

#### Sample Request
<a name="API_CreatePatchBaseline_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 461
X-Amz-Target: AmazonSSM.CreatePatchBaseline
X-Amz-Date: 20240309T022356Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Description": "Baseline containing all updates approved for production systems",
    "ApprovalRules": {
        "PatchRules": [
            {
                "PatchFilterGroup": {
                    "PatchFilters": [
                        {
                            "Values": [
                                "Critical",
                                "Important",
                                "Moderate"
                            ],
                            "Key": "MSRC_SEVERITY"
                        },
                        {
                            "Values": [
                                "SecurityUpdates",
                                "Updates",
                                "UpdateRollups",
                                "CriticalUpdates"
                            ],
                            "Key": "CLASSIFICATION"
                        }
                    ]
                },
                "ApproveAfterDays": 7,
                "ApproveUntilDate": "",
                "EnableNonSecurity": true,
                "ComplianceLevel": "MEDIUM"
            }
        ]
    },
    "Name": "my-Windows-Server-patch-baseline",
    "OperatingSystem": "WINDOWS",
    "ClientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_CreatePatchBaseline_Example_1_Response"></a>

```
{
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

## See Also
<a name="API_CreatePatchBaseline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CreatePatchBaseline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CreatePatchBaseline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CreatePatchBaseline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CreatePatchBaseline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreatePatchBaseline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CreatePatchBaseline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CreatePatchBaseline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CreatePatchBaseline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreatePatchBaseline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CreatePatchBaseline) 

# CreateResourceDataSync
<a name="API_CreateResourceDataSync"></a>

A resource data sync helps you view data from multiple sources in a single location. AWS Systems Manager offers two types of resource data sync: `SyncToDestination` and `SyncFromSource`.

You can configure Systems Manager Inventory to use the `SyncToDestination` type to synchronize Inventory data from multiple AWS Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see [Creating a resource data sync for Inventory](https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-create-resource-data-sync.html) in the * AWS Systems Manager User Guide*.

You can configure Systems Manager Explorer to use the `SyncFromSource` type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple AWS accounts and AWS Regions or `EntireOrganization` by using AWS Organizations. For more information, see [Setting up Systems Manager Explorer to display data from multiple accounts and Regions](https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) in the * AWS Systems Manager User Guide*.

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the [ListResourceDataSync](API_ListResourceDataSync.md).

**Note**  
By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. 

## Request Syntax
<a name="API_CreateResourceDataSync_RequestSyntax"></a>

```
{
   "S3Destination": { 
      "AWSKMSKeyARN": "string",
      "BucketName": "string",
      "DestinationDataSharing": { 
         "DestinationDataSharingType": "string"
      },
      "Prefix": "string",
      "Region": "string",
      "SyncFormat": "string"
   },
   "SyncName": "string",
   "SyncSource": { 
      "AwsOrganizationsSource": { 
         "OrganizationalUnits": [ 
            { 
               "OrganizationalUnitId": "string"
            }
         ],
         "OrganizationSourceType": "string"
      },
      "EnableAllOpsDataSources": boolean,
      "IncludeFutureRegions": boolean,
      "SourceRegions": [ "string" ],
      "SourceType": "string"
   },
   "SyncType": "string"
}
```

## Request Parameters
<a name="API_CreateResourceDataSync_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [S3Destination](#API_CreateResourceDataSync_RequestSyntax) **   <a name="systemsmanager-CreateResourceDataSync-request-S3Destination"></a>
Amazon S3 configuration details for the sync. This parameter is required if the `SyncType` value is SyncToDestination.  
Type: [ResourceDataSyncS3Destination](API_ResourceDataSyncS3Destination.md) object  
Required: No

 ** [SyncName](#API_CreateResourceDataSync_RequestSyntax) **   <a name="systemsmanager-CreateResourceDataSync-request-SyncName"></a>
A name for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** [SyncSource](#API_CreateResourceDataSync_RequestSyntax) **   <a name="systemsmanager-CreateResourceDataSync-request-SyncSource"></a>
Specify information about the data sources to synchronize. This parameter is required if the `SyncType` value is SyncFromSource.  
Type: [ResourceDataSyncSource](API_ResourceDataSyncSource.md) object  
Required: No

 ** [SyncType](#API_CreateResourceDataSync_RequestSyntax) **   <a name="systemsmanager-CreateResourceDataSync-request-SyncType"></a>
Specify `SyncToDestination` to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify `SyncToDestination`, you must provide a value for `S3Destination`. Specify `SyncFromSource` to synchronize data from a single account and multiple Regions, or multiple AWS accounts and AWS Regions, as listed in AWS Organizations for Explorer. If you specify `SyncFromSource`, you must provide a value for `SyncSource`. The default value is `SyncToDestination`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Elements
<a name="API_CreateResourceDataSync_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CreateResourceDataSync_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceDataSyncAlreadyExistsException **   
A sync configuration with the same name already exists.  
HTTP Status Code: 400

 ** ResourceDataSyncCountExceededException **   
You have exceeded the allowed maximum sync configurations.  
HTTP Status Code: 400

 ** ResourceDataSyncInvalidConfigurationException **   
The specified sync configuration is invalid.  
HTTP Status Code: 400

## Examples
<a name="API_CreateResourceDataSync_Examples"></a>

### Example
<a name="API_CreateResourceDataSync_Example_1"></a>

This example illustrates one usage of CreateResourceDataSync.

#### Sample Request
<a name="API_CreateResourceDataSync_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.CreateResourceDataSync
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240327T173437Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240327/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 186

{
    "SyncName": "Example",
    "S3Destination": {
        "BucketName": "amzn-s3-demo-bucket",
        "Prefix": "amzn-s3-demo-bucket-prefix",
        "SyncFormat": "JsonSerDe",
        "Region": "us-east-2"
    },
    "SyncType": "SyncToDestination"
}
```

#### Sample Response
<a name="API_CreateResourceDataSync_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_CreateResourceDataSync_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/CreateResourceDataSync) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/CreateResourceDataSync) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/CreateResourceDataSync) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/CreateResourceDataSync) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateResourceDataSync) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/CreateResourceDataSync) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/CreateResourceDataSync) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/CreateResourceDataSync) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateResourceDataSync) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/CreateResourceDataSync) 

# DeleteActivation
<a name="API_DeleteActivation"></a>

Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.

## Request Syntax
<a name="API_DeleteActivation_RequestSyntax"></a>

```
{
   "ActivationId": "string"
}
```

## Request Parameters
<a name="API_DeleteActivation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ActivationId](#API_DeleteActivation_RequestSyntax) **   <a name="systemsmanager-DeleteActivation-request-ActivationId"></a>
The ID of the activation that you want to delete.  
Type: String  
Pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Response Elements
<a name="API_DeleteActivation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteActivation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidActivation **   
The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't match.  
HTTP Status Code: 400

 ** InvalidActivationId **   
The activation ID isn't valid. Verify that you entered the correct ActivationId or ActivationCode and try again.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteActivation_Examples"></a>

### Example
<a name="API_DeleteActivation_Example_1"></a>

This example illustrates one usage of DeleteActivation.

#### Sample Request
<a name="API_DeleteActivation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeleteActivation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T151218Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 56

{
    "ActivationId": "e488f2f6-e686-4afb-8a04-ef6dfEXAMPLE"
}
```

#### Sample Response
<a name="API_DeleteActivation_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteActivation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteActivation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteActivation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteActivation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteActivation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteActivation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteActivation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteActivation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteActivation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteActivation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteActivation) 

# DeleteAssociation
<a name="API_DeleteAssociation"></a>

Disassociates the specified AWS Systems Manager document (SSM document) from the specified managed node. If you created the association by using the `Targets` parameter, then you must delete the association by using the association ID.

When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.

## Request Syntax
<a name="API_DeleteAssociation_RequestSyntax"></a>

```
{
   "AssociationId": "string",
   "InstanceId": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeleteAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AssociationId](#API_DeleteAssociation_RequestSyntax) **   <a name="systemsmanager-DeleteAssociation-request-AssociationId"></a>
The association ID that you want to delete.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`   
Required: No

 ** [InstanceId](#API_DeleteAssociation_RequestSyntax) **   <a name="systemsmanager-DeleteAssociation-request-InstanceId"></a>
The managed node ID.  
 `InstanceId` has been deprecated. To specify a managed node ID for an association, use the `Targets` parameter. Requests that include the parameter `InstanceID` with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter `InstanceId`, you can't use the parameters `AssociationName`, `DocumentVersion`, `MaxErrors`, `MaxConcurrency`, `OutputLocation`, or `ScheduleExpression`. To use these parameters, you must use the `Targets` parameter.
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: No

 ** [Name](#API_DeleteAssociation_RequestSyntax) **   <a name="systemsmanager-DeleteAssociation-request-Name"></a>
The name of the SSM document.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: No

## Response Elements
<a name="API_DeleteAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociationDoesNotExist **   
The specified association doesn't exist.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteAssociation_Examples"></a>

### Example
<a name="API_DeleteAssociation_Example_1"></a>

This example illustrates one usage of DeleteAssociation.

#### Sample Request
<a name="API_DeleteAssociation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeleteAssociation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T150348Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 57

{
    "AssociationId": "33858bec-0c55-4547-a054-eb5fcEXAMPLE"
}
```

#### Sample Response
<a name="API_DeleteAssociation_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteAssociation) 

# DeleteDocument
<a name="API_DeleteDocument"></a>

Deletes the AWS Systems Manager document (SSM document) and all managed node associations to the document.

Before you delete the document, we recommend that you use [DeleteAssociation](API_DeleteAssociation.md) to disassociate all managed nodes that are associated with the document.

## Request Syntax
<a name="API_DeleteDocument_RequestSyntax"></a>

```
{
   "DocumentVersion": "string",
   "Force": boolean,
   "Name": "string",
   "VersionName": "string"
}
```

## Request Parameters
<a name="API_DeleteDocument_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DocumentVersion](#API_DeleteDocument_RequestSyntax) **   <a name="systemsmanager-DeleteDocument-request-DocumentVersion"></a>
The version of the document that you want to delete. If not provided, all versions of the document are deleted.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [Force](#API_DeleteDocument_RequestSyntax) **   <a name="systemsmanager-DeleteDocument-request-Force"></a>
Some SSM document types require that you specify a `Force` flag before you can delete the document. For example, you must specify a `Force` flag to delete a document of type `ApplicationConfigurationSchema`. You can restrict access to the `Force` flag in an AWS Identity and Access Management (IAM) policy.  
Type: Boolean  
Required: No

 ** [Name](#API_DeleteDocument_RequestSyntax) **   <a name="systemsmanager-DeleteDocument-request-Name"></a>
The name of the document.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

 ** [VersionName](#API_DeleteDocument_RequestSyntax) **   <a name="systemsmanager-DeleteDocument-request-VersionName"></a>
The version name of the document that you want to delete. If not provided, all versions of the document are deleted.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{1,128}$`   
Required: No

## Response Elements
<a name="API_DeleteDocument_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteDocument_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociatedInstances **   
You must disassociate a document from all managed nodes before you can delete it.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentOperation **   
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDocument_Examples"></a>

### Example
<a name="API_DeleteDocument_Example_1"></a>

This example illustrates one usage of DeleteDocument.

#### Sample Request
<a name="API_DeleteDocument_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeleteDocument
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T151532Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 19

{
    "Name": "Example"
}
```

#### Sample Response
<a name="API_DeleteDocument_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteDocument) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteDocument) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteDocument) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteDocument) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteDocument) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteDocument) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteDocument) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteDocument) 

# DeleteInventory
<a name="API_DeleteInventory"></a>

Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.

## Request Syntax
<a name="API_DeleteInventory_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DryRun": boolean,
   "SchemaDeleteOption": "string",
   "TypeName": "string"
}
```

## Request Parameters
<a name="API_DeleteInventory_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_DeleteInventory_RequestSyntax) **   <a name="systemsmanager-DeleteInventory-request-ClientToken"></a>
User-provided idempotency token.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** [DryRun](#API_DeleteInventory_RequestSyntax) **   <a name="systemsmanager-DeleteInventory-request-DryRun"></a>
Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the `DryRun` option.  
Type: Boolean  
Required: No

 ** [SchemaDeleteOption](#API_DeleteInventory_RequestSyntax) **   <a name="systemsmanager-DeleteInventory-request-SchemaDeleteOption"></a>
Use the `SchemaDeleteOption` to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:  
DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the `PutInventory` operation for a version greater than the disabled version.  
DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.  
Type: String  
Valid Values: `DisableSchema | DeleteSchema`   
Required: No

 ** [TypeName](#API_DeleteInventory_RequestSyntax) **   <a name="systemsmanager-DeleteInventory-request-TypeName"></a>
The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^(AWS|Custom):.*$`   
Required: Yes

## Response Syntax
<a name="API_DeleteInventory_ResponseSyntax"></a>

```
{
   "DeletionId": "string",
   "DeletionSummary": { 
      "RemainingCount": number,
      "SummaryItems": [ 
         { 
            "Count": number,
            "RemainingCount": number,
            "Version": "string"
         }
      ],
      "TotalCount": number
   },
   "TypeName": "string"
}
```

## Response Elements
<a name="API_DeleteInventory_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DeletionId](#API_DeleteInventory_ResponseSyntax) **   <a name="systemsmanager-DeleteInventory-response-DeletionId"></a>
Every `DeleteInventory` operation is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other operations.   
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [DeletionSummary](#API_DeleteInventory_ResponseSyntax) **   <a name="systemsmanager-DeleteInventory-response-DeletionSummary"></a>
A summary of the delete operation. For more information about this summary, see [Deleting custom inventory](https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-custom.html#delete-custom-inventory-summary) in the * AWS Systems Manager User Guide*.  
Type: [InventoryDeletionSummary](API_InventoryDeletionSummary.md) object

 ** [TypeName](#API_DeleteInventory_ResponseSyntax) **   <a name="systemsmanager-DeleteInventory-response-TypeName"></a>
The name of the inventory data type specified in the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^(AWS|Custom):.*$` 

## Errors
<a name="API_DeleteInventory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDeleteInventoryParametersException **   
One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.  
HTTP Status Code: 400

 ** InvalidInventoryRequestException **   
The request isn't valid.  
HTTP Status Code: 400

 ** InvalidOptionException **   
The delete inventory option specified isn't valid. Verify the option and try again.  
HTTP Status Code: 400

 ** InvalidTypeNameException **   
The parameter type name isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteInventory_Examples"></a>

### Example
<a name="API_DeleteInventory_Example_1"></a>

This example illustrates one usage of DeleteInventory.

#### Sample Request
<a name="API_DeleteInventory_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-west-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeleteInventory
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.25 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ssm.delete-inventory
X-Amz-Date: 20240809T230226Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240809/us-west-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature39c3b3042cd2aEXAMPLE
Content-Length: 124

{
  "TypeName": "Custom:RackInfo",
  "SchemaDeleteOption": "DeleteSchema",
  "ClientToken": "a7d4972c-ab3e-4b9a-b5c0-d5aExample"
}
```

#### Sample Response
<a name="API_DeleteInventory_Example_1_Response"></a>

```
{
  "DeletionId": "5bc2ba3b-ee6a-40fa-8d09-5e5Example",
  "DeletionSummary": {
    "RemainingCount": 1,
    "SummaryItems": [
      {
        "Count": 1,
        "RemainingCount": 1,
        "Version": "1.0"
      }
    ],
    "TotalCount": 1
  },
  "TypeName": "Custom:RackInfo"
}
```

## See Also
<a name="API_DeleteInventory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteInventory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteInventory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteInventory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteInventory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteInventory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteInventory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteInventory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteInventory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteInventory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteInventory) 

# DeleteMaintenanceWindow
<a name="API_DeleteMaintenanceWindow"></a>

Deletes a maintenance window.

## Request Syntax
<a name="API_DeleteMaintenanceWindow_RequestSyntax"></a>

```
{
   "WindowId": "string"
}
```

## Request Parameters
<a name="API_DeleteMaintenanceWindow_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [WindowId](#API_DeleteMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-DeleteMaintenanceWindow-request-WindowId"></a>
The ID of the maintenance window to delete.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

## Response Syntax
<a name="API_DeleteMaintenanceWindow_ResponseSyntax"></a>

```
{
   "WindowId": "string"
}
```

## Response Elements
<a name="API_DeleteMaintenanceWindow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [WindowId](#API_DeleteMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-DeleteMaintenanceWindow-response-WindowId"></a>
The ID of the deleted maintenance window.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$` 

## Errors
<a name="API_DeleteMaintenanceWindow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DeleteMaintenanceWindow_Examples"></a>

### Example
<a name="API_DeleteMaintenanceWindow_Example_1"></a>

This example illustrates one usage of DeleteMaintenanceWindow.

#### Sample Request
<a name="API_DeleteMaintenanceWindow_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 36
X-Amz-Target: AmazonSSM.DeleteMaintenanceWindow
X-Amz-Date: 20240312T210257Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

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

#### Sample Response
<a name="API_DeleteMaintenanceWindow_Example_1_Response"></a>

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

## See Also
<a name="API_DeleteMaintenanceWindow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteMaintenanceWindow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteMaintenanceWindow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteMaintenanceWindow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteMaintenanceWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteMaintenanceWindow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteMaintenanceWindow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteMaintenanceWindow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteMaintenanceWindow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteMaintenanceWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteMaintenanceWindow) 

# DeleteOpsItem
<a name="API_DeleteOpsItem"></a>

Delete an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to delete an OpsItem. 

**Important**  
Note the following important information about this operation.  
Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem.
This operation uses an *eventual consistency model*, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, [GetOpsItem](API_GetOpsItem.md), the deleted OpsItem might still appear in the response. 
This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.
This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see [Setting up OpsCenter to centrally manage OpsItems across accounts](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setting-up-cross-account.html) in the *Systems Manager User Guide*.

## Request Syntax
<a name="API_DeleteOpsItem_RequestSyntax"></a>

```
{
   "OpsItemId": "string"
}
```

## Request Parameters
<a name="API_DeleteOpsItem_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [OpsItemId](#API_DeleteOpsItem_RequestSyntax) **   <a name="systemsmanager-DeleteOpsItem-request-OpsItemId"></a>
The ID of the OpsItem that you want to delete.  
Type: String  
Pattern: `^(oi)-[0-9a-f]{12}$`   
Required: Yes

## Response Elements
<a name="API_DeleteOpsItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteOpsItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsItemInvalidParameterException **   
A specified parameter argument isn't valid. Verify the available arguments and try again.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteOpsItem_Examples"></a>

### Example
<a name="API_DeleteOpsItem_Example_1"></a>

This example illustrates one usage of DeleteOpsItem.

#### Sample Request
<a name="API_DeleteOpsItem_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeleteOpsItem
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T151532Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 19

{
    "OpsItemId": "oi-abcdef12345"
}
```

#### Sample Response
<a name="API_DeleteOpsItem_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteOpsItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteOpsItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteOpsItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteOpsItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteOpsItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteOpsItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteOpsItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteOpsItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteOpsItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteOpsItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteOpsItem) 

# DeleteOpsMetadata
<a name="API_DeleteOpsMetadata"></a>

Delete OpsMetadata related to an application.

## Request Syntax
<a name="API_DeleteOpsMetadata_RequestSyntax"></a>

```
{
   "OpsMetadataArn": "string"
}
```

## Request Parameters
<a name="API_DeleteOpsMetadata_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [OpsMetadataArn](#API_DeleteOpsMetadata_RequestSyntax) **   <a name="systemsmanager-DeleteOpsMetadata-request-OpsMetadataArn"></a>
The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:opsmetadata\/([a-zA-Z0-9-_\.\/]*)`   
Required: Yes

## Response Elements
<a name="API_DeleteOpsMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteOpsMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsMetadataInvalidArgumentException **   
One of the arguments passed is invalid.   
HTTP Status Code: 400

 ** OpsMetadataNotFoundException **   
The OpsMetadata object doesn't exist.   
HTTP Status Code: 400

## See Also
<a name="API_DeleteOpsMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteOpsMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteOpsMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteOpsMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteOpsMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteOpsMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteOpsMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteOpsMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteOpsMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteOpsMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteOpsMetadata) 

# DeleteParameter
<a name="API_DeleteParameter"></a>

Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

## Request Syntax
<a name="API_DeleteParameter_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeleteParameter_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DeleteParameter_RequestSyntax) **   <a name="systemsmanager-DeleteParameter-request-Name"></a>
The name of the parameter to delete.  
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Response Elements
<a name="API_DeleteParameter_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteParameter_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ParameterNotFound **   
The parameter couldn't be found. Verify the name and try again.  
For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is *not* recorded in AWS CloudTrail event logs.
HTTP Status Code: 400

## Examples
<a name="API_DeleteParameter_Examples"></a>

### Example
<a name="API_DeleteParameter_Example_1"></a>

This example illustrates one usage of DeleteParameter.

#### Sample Request
<a name="API_DeleteParameter_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 28
X-Amz-Target: AmazonSSM.DeleteParameter
X-Amz-Date: 20240316T010702Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Name": "EC2DevServerType"
}
```

#### Sample Response
<a name="API_DeleteParameter_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteParameter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteParameter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteParameter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteParameter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteParameter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteParameter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteParameter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteParameter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteParameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteParameter) 

# DeleteParameters
<a name="API_DeleteParameters"></a>

Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

## Request Syntax
<a name="API_DeleteParameters_RequestSyntax"></a>

```
{
   "Names": [ "string" ]
}
```

## Request Parameters
<a name="API_DeleteParameters_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Names](#API_DeleteParameters_RequestSyntax) **   <a name="systemsmanager-DeleteParameters-request-Names"></a>
The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.  
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Response Syntax
<a name="API_DeleteParameters_ResponseSyntax"></a>

```
{
   "DeletedParameters": [ "string" ],
   "InvalidParameters": [ "string" ]
}
```

## Response Elements
<a name="API_DeleteParameters_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DeletedParameters](#API_DeleteParameters_ResponseSyntax) **   <a name="systemsmanager-DeleteParameters-response-DeletedParameters"></a>
The names of the deleted parameters.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [InvalidParameters](#API_DeleteParameters_ResponseSyntax) **   <a name="systemsmanager-DeleteParameters-response-InvalidParameters"></a>
The names of parameters that weren't deleted because the parameters aren't valid.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_DeleteParameters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DeleteParameters_Examples"></a>

### Example
<a name="API_DeleteParameters_Example_1"></a>

This example illustrates one usage of DeleteParameters.

#### Sample Request
<a name="API_DeleteParameters_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 53
X-Amz-Target: AmazonSSM.DeleteParameters
X-Amz-Date: 20240316T010844Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Names": [
        "EC2TestServerType",
        "EC2ProdServerType"
    ]
}
```

#### Sample Response
<a name="API_DeleteParameters_Example_1_Response"></a>

```
{
    "DeletedParameters": [
        "EC2ProdServerType",
        "EC2TestServerType"
    ],
    "InvalidParameters": []
}
```

## See Also
<a name="API_DeleteParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteParameters) 

# DeletePatchBaseline
<a name="API_DeletePatchBaseline"></a>

Deletes a patch baseline.

## Request Syntax
<a name="API_DeletePatchBaseline_RequestSyntax"></a>

```
{
   "BaselineId": "string"
}
```

## Request Parameters
<a name="API_DeletePatchBaseline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BaselineId](#API_DeletePatchBaseline_RequestSyntax) **   <a name="systemsmanager-DeletePatchBaseline-request-BaselineId"></a>
The ID of the patch baseline to delete.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$`   
Required: Yes

## Response Syntax
<a name="API_DeletePatchBaseline_ResponseSyntax"></a>

```
{
   "BaselineId": "string"
}
```

## Response Elements
<a name="API_DeletePatchBaseline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BaselineId](#API_DeletePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-DeletePatchBaseline-response-BaselineId"></a>
The ID of the deleted patch baseline.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$` 

## Errors
<a name="API_DeletePatchBaseline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceInUseException **   
Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.  
HTTP Status Code: 400

## Examples
<a name="API_DeletePatchBaseline_Examples"></a>

### Example
<a name="API_DeletePatchBaseline_Example_1"></a>

This example illustrates one usage of DeletePatchBaseline.

#### Sample Request
<a name="API_DeletePatchBaseline_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 38
X-Amz-Target: AmazonSSM.DeletePatchBaseline
X-Amz-Date: 20240309T062407Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

#### Sample Response
<a name="API_DeletePatchBaseline_Example_1_Response"></a>

```
{
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

## See Also
<a name="API_DeletePatchBaseline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeletePatchBaseline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeletePatchBaseline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeletePatchBaseline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeletePatchBaseline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeletePatchBaseline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeletePatchBaseline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeletePatchBaseline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeletePatchBaseline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeletePatchBaseline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeletePatchBaseline) 

# DeleteResourceDataSync
<a name="API_DeleteResourceDataSync"></a>

Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.

## Request Syntax
<a name="API_DeleteResourceDataSync_RequestSyntax"></a>

```
{
   "SyncName": "string",
   "SyncType": "string"
}
```

## Request Parameters
<a name="API_DeleteResourceDataSync_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [SyncName](#API_DeleteResourceDataSync_RequestSyntax) **   <a name="systemsmanager-DeleteResourceDataSync-request-SyncName"></a>
The name of the configuration to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** [SyncType](#API_DeleteResourceDataSync_RequestSyntax) **   <a name="systemsmanager-DeleteResourceDataSync-request-SyncType"></a>
Specify the type of resource data sync to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Elements
<a name="API_DeleteResourceDataSync_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteResourceDataSync_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceDataSyncInvalidConfigurationException **   
The specified sync configuration is invalid.  
HTTP Status Code: 400

 ** ResourceDataSyncNotFoundException **   
The specified sync name wasn't found.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteResourceDataSync_Examples"></a>

### Example
<a name="API_DeleteResourceDataSync_Example_1"></a>

This example illustrates one usage of DeleteResourceDataSync.

#### Sample Request
<a name="API_DeleteResourceDataSync_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeleteResourceDataSync
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240330T144518Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 28

{
    "SyncName": "exampleSync"
}
```

#### Sample Response
<a name="API_DeleteResourceDataSync_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteResourceDataSync_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteResourceDataSync) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteResourceDataSync) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteResourceDataSync) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteResourceDataSync) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteResourceDataSync) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteResourceDataSync) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteResourceDataSync) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteResourceDataSync) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteResourceDataSync) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteResourceDataSync) 

# DeleteResourcePolicy
<a name="API_DeleteResourcePolicy"></a>

Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an AWS account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
+  `OpsItemGroup` - The resource policy for `OpsItemGroup` enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems).
+  `Parameter` - The resource policy is used to share a parameter with other accounts using AWS Resource Access Manager (AWS RAM). For more information about cross-account sharing of parameters, see [Working with shared parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html) in the * AWS Systems Manager User Guide*.

## Request Syntax
<a name="API_DeleteResourcePolicy_RequestSyntax"></a>

```
{
   "PolicyHash": "string",
   "PolicyId": "string",
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_DeleteResourcePolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [PolicyHash](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="systemsmanager-DeleteResourcePolicy-request-PolicyHash"></a>
ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.  
Type: String  
Required: Yes

 ** [PolicyId](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="systemsmanager-DeleteResourcePolicy-request-PolicyId"></a>
The policy ID.  
Type: String  
Required: Yes

 ** [ResourceArn](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="systemsmanager-DeleteResourcePolicy-request-ResourceArn"></a>
Amazon Resource Name (ARN) of the resource to which the policies are attached.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

## Response Elements
<a name="API_DeleteResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** MalformedResourcePolicyDocumentException **   
The specified policy document is malformed or invalid, or excessive `PutResourcePolicy` or `DeleteResourcePolicy` calls have been made.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified parameter to be shared could not be found.  
HTTP Status Code: 400

 ** ResourcePolicyConflictException **   
The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.  
HTTP Status Code: 400

 ** ResourcePolicyInvalidParameterException **   
One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.  
HTTP Status Code: 400

 ** ResourcePolicyNotFoundException **   
No policies with the specified policy ID and hash could be found.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeleteResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeleteResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeleteResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeleteResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeleteResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeleteResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeleteResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeleteResourcePolicy) 

# DeregisterManagedInstance
<a name="API_DeregisterManagedInstance"></a>

Removes the server or virtual machine from the list of registered servers.

If you want to reregister an on-premises server, edge device, or VM, you must use a different Activation Code and Activation ID than used to register the machine previously. The Activation Code and Activation ID must not have already been used on the maximum number of activations specified when they were created. For more information, see [Deregistering managed nodes in a hybrid and multicloud environment](https://docs.aws.amazon.com/systems-manager/latest/userguide/fleet-manager-deregister-hybrid-nodes.html) in the * AWS Systems Manager User Guide*.

## Request Syntax
<a name="API_DeregisterManagedInstance_RequestSyntax"></a>

```
{
   "InstanceId": "string"
}
```

## Request Parameters
<a name="API_DeregisterManagedInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceId](#API_DeregisterManagedInstance_RequestSyntax) **   <a name="systemsmanager-DeregisterManagedInstance-request-InstanceId"></a>
The ID assigned to the managed node when you registered it using the activation process.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 124.  
Pattern: `(^mi-[0-9a-f]{17}$)|(^eks_c:[0-9A-Za-z][A-Za-z0-9\-_]{0,99}_\w{17}$)`   
Required: Yes

## Response Elements
<a name="API_DeregisterManagedInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeregisterManagedInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

## Examples
<a name="API_DeregisterManagedInstance_Examples"></a>

### Example
<a name="API_DeregisterManagedInstance_Example_1"></a>

This example illustrates one usage of DeregisterManagedInstance.

#### Sample Request
<a name="API_DeregisterManagedInstance_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeregisterManagedInstance
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240220T234004Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240220/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 37

{
    "InstanceId": "mi-017431b35cEXAMPLE"
}
```

#### Sample Response
<a name="API_DeregisterManagedInstance_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeregisterManagedInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeregisterManagedInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeregisterManagedInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeregisterManagedInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeregisterManagedInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeregisterManagedInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeregisterManagedInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeregisterManagedInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeregisterManagedInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeregisterManagedInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeregisterManagedInstance) 

# DeregisterPatchBaselineForPatchGroup
<a name="API_DeregisterPatchBaselineForPatchGroup"></a>

Removes a patch group from a patch baseline.

## Request Syntax
<a name="API_DeregisterPatchBaselineForPatchGroup_RequestSyntax"></a>

```
{
   "BaselineId": "string",
   "PatchGroup": "string"
}
```

## Request Parameters
<a name="API_DeregisterPatchBaselineForPatchGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BaselineId](#API_DeregisterPatchBaselineForPatchGroup_RequestSyntax) **   <a name="systemsmanager-DeregisterPatchBaselineForPatchGroup-request-BaselineId"></a>
The ID of the patch baseline to deregister the patch group from.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$`   
Required: Yes

 ** [PatchGroup](#API_DeregisterPatchBaselineForPatchGroup_RequestSyntax) **   <a name="systemsmanager-DeregisterPatchBaselineForPatchGroup-request-PatchGroup"></a>
The name of the patch group that should be deregistered from the patch baseline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## Response Syntax
<a name="API_DeregisterPatchBaselineForPatchGroup_ResponseSyntax"></a>

```
{
   "BaselineId": "string",
   "PatchGroup": "string"
}
```

## Response Elements
<a name="API_DeregisterPatchBaselineForPatchGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BaselineId](#API_DeregisterPatchBaselineForPatchGroup_ResponseSyntax) **   <a name="systemsmanager-DeregisterPatchBaselineForPatchGroup-response-BaselineId"></a>
The ID of the patch baseline the patch group was deregistered from.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$` 

 ** [PatchGroup](#API_DeregisterPatchBaselineForPatchGroup_ResponseSyntax) **   <a name="systemsmanager-DeregisterPatchBaselineForPatchGroup-response-PatchGroup"></a>
The name of the patch group deregistered from the patch baseline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 

## Errors
<a name="API_DeregisterPatchBaselineForPatchGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidResourceId **   
The resource ID isn't valid. Verify that you entered the correct ID and try again.  
HTTP Status Code: 400

## Examples
<a name="API_DeregisterPatchBaselineForPatchGroup_Examples"></a>

### Example
<a name="API_DeregisterPatchBaselineForPatchGroup_Example_1"></a>

This example illustrates one usage of DeregisterPatchBaselineForPatchGroup.

#### Sample Request
<a name="API_DeregisterPatchBaselineForPatchGroup_Example_1_Request"></a>

```
POST / HTTP/1.1
  Host: ssm.us-east-2.amazonaws.com
  Accept-Encoding: identity
  Content-Length: 74
  X-Amz-Target: AmazonSSM.DeregisterPatchBaselineForPatchGroup
  X-Amz-Date: 20240309T062043Z
  User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
  Content-Type: application/x-amz-json-1.1
  Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
  SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
  
{
    "PatchGroup": "mypatchgroup",
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

#### Sample Response
<a name="API_DeregisterPatchBaselineForPatchGroup_Example_1_Response"></a>

```
{
    "PatchGroup": "mypatchgroup",
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

## See Also
<a name="API_DeregisterPatchBaselineForPatchGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup) 

# DeregisterTargetFromMaintenanceWindow
<a name="API_DeregisterTargetFromMaintenanceWindow"></a>

Removes a target from a maintenance window.

## Request Syntax
<a name="API_DeregisterTargetFromMaintenanceWindow_RequestSyntax"></a>

```
{
   "Safe": boolean,
   "WindowId": "string",
   "WindowTargetId": "string"
}
```

## Request Parameters
<a name="API_DeregisterTargetFromMaintenanceWindow_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Safe](#API_DeregisterTargetFromMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-DeregisterTargetFromMaintenanceWindow-request-Safe"></a>
The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn't deregister the target from the maintenance window.  
Type: Boolean  
Required: No

 ** [WindowId](#API_DeregisterTargetFromMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-DeregisterTargetFromMaintenanceWindow-request-WindowId"></a>
The ID of the maintenance window the target should be removed from.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

 ** [WindowTargetId](#API_DeregisterTargetFromMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-DeregisterTargetFromMaintenanceWindow-request-WindowTargetId"></a>
The ID of the target definition to remove.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_DeregisterTargetFromMaintenanceWindow_ResponseSyntax"></a>

```
{
   "WindowId": "string",
   "WindowTargetId": "string"
}
```

## Response Elements
<a name="API_DeregisterTargetFromMaintenanceWindow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [WindowId](#API_DeregisterTargetFromMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-DeregisterTargetFromMaintenanceWindow-response-WindowId"></a>
The ID of the maintenance window the target was removed from.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$` 

 ** [WindowTargetId](#API_DeregisterTargetFromMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-DeregisterTargetFromMaintenanceWindow-response-WindowTargetId"></a>
The ID of the removed target definition.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_DeregisterTargetFromMaintenanceWindow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** TargetInUseException **   
You specified the `Safe` option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.  
HTTP Status Code: 400

## Examples
<a name="API_DeregisterTargetFromMaintenanceWindow_Examples"></a>

### Example
<a name="API_DeregisterTargetFromMaintenanceWindow_Example_1"></a>

This example illustrates one usage of DeregisterTargetFromMaintenanceWindow.

#### Sample Request
<a name="API_DeregisterTargetFromMaintenanceWindow_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeregisterTargetFromMaintenanceWindow
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T182719Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 94

{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE"
}
```

#### Sample Response
<a name="API_DeregisterTargetFromMaintenanceWindow_Example_1_Response"></a>

```
{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE"
}
```

## See Also
<a name="API_DeregisterTargetFromMaintenanceWindow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow) 

# DeregisterTaskFromMaintenanceWindow
<a name="API_DeregisterTaskFromMaintenanceWindow"></a>

Removes a task from a maintenance window.

## Request Syntax
<a name="API_DeregisterTaskFromMaintenanceWindow_RequestSyntax"></a>

```
{
   "WindowId": "string",
   "WindowTaskId": "string"
}
```

## Request Parameters
<a name="API_DeregisterTaskFromMaintenanceWindow_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [WindowId](#API_DeregisterTaskFromMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-DeregisterTaskFromMaintenanceWindow-request-WindowId"></a>
The ID of the maintenance window the task should be removed from.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

 ** [WindowTaskId](#API_DeregisterTaskFromMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-DeregisterTaskFromMaintenanceWindow-request-WindowTaskId"></a>
The ID of the task to remove from the maintenance window.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_DeregisterTaskFromMaintenanceWindow_ResponseSyntax"></a>

```
{
   "WindowId": "string",
   "WindowTaskId": "string"
}
```

## Response Elements
<a name="API_DeregisterTaskFromMaintenanceWindow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [WindowId](#API_DeregisterTaskFromMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-DeregisterTaskFromMaintenanceWindow-response-WindowId"></a>
The ID of the maintenance window the task was removed from.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$` 

 ** [WindowTaskId](#API_DeregisterTaskFromMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-DeregisterTaskFromMaintenanceWindow-response-WindowTaskId"></a>
The ID of the task removed from the maintenance window.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_DeregisterTaskFromMaintenanceWindow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DeregisterTaskFromMaintenanceWindow_Examples"></a>

### Example
<a name="API_DeregisterTaskFromMaintenanceWindow_Example_1"></a>

This example illustrates one usage of DeregisterTaskFromMaintenanceWindow.

#### Sample Request
<a name="API_DeregisterTaskFromMaintenanceWindow_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeregisterTaskFromMaintenanceWindow
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T180133Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 92

{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE"
}
```

#### Sample Response
<a name="API_DeregisterTaskFromMaintenanceWindow_Example_1_Response"></a>

```
{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE"
}
```

## See Also
<a name="API_DeregisterTaskFromMaintenanceWindow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow) 

# DescribeActivations
<a name="API_DescribeActivations"></a>

Describes details about the activation, such as the date and time the activation was created, its expiration date, the AWS Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.

## Request Syntax
<a name="API_DescribeActivations_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "FilterKey": "string",
         "FilterValues": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeActivations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeActivations_RequestSyntax) **   <a name="systemsmanager-DescribeActivations-request-Filters"></a>
A filter to view information about your activations.  
Type: Array of [DescribeActivationsFilter](API_DescribeActivationsFilter.md) objects  
Required: No

 ** [MaxResults](#API_DescribeActivations_RequestSyntax) **   <a name="systemsmanager-DescribeActivations-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeActivations_RequestSyntax) **   <a name="systemsmanager-DescribeActivations-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeActivations_ResponseSyntax"></a>

```
{
   "ActivationList": [ 
      { 
         "ActivationId": "string",
         "CreatedDate": number,
         "DefaultInstanceName": "string",
         "Description": "string",
         "ExpirationDate": number,
         "Expired": boolean,
         "IamRole": "string",
         "RegistrationLimit": number,
         "RegistrationsCount": number,
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeActivations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ActivationList](#API_DescribeActivations_ResponseSyntax) **   <a name="systemsmanager-DescribeActivations-response-ActivationList"></a>
A list of activations for your AWS account.  
Type: Array of [Activation](API_Activation.md) objects

 ** [NextToken](#API_DescribeActivations_ResponseSyntax) **   <a name="systemsmanager-DescribeActivations-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.   
Type: String

## Errors
<a name="API_DescribeActivations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeActivations_Examples"></a>

### Example
<a name="API_DescribeActivations_Example_1"></a>

This example illustrates one usage of DescribeActivations.

#### Sample Request
<a name="API_DescribeActivations_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeActivations
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T152059Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2
```

#### Sample Response
<a name="API_DescribeActivations_Example_1_Response"></a>

```
{
    "ActivationList": [
        {
            "ActivationId": "e9136c70-ba7b-4d7d-8e31-174a7EXAMPLE",
            "CreatedDate": 1581954699.792,
            "Description": "Example",
            "ExpirationDate": 1584316800,
            "Expired": true,
            "IamRole": "service-role/RoleForManagedInstances",
            "RegistrationLimit": 5,
            "RegistrationsCount": 1
        }
    ]
}
```

## See Also
<a name="API_DescribeActivations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeActivations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeActivations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeActivations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeActivations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeActivations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeActivations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeActivations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeActivations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeActivations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeActivations) 

# DescribeAssociation
<a name="API_DescribeAssociation"></a>

Describes the association for the specified target or managed node. If you created the association by using the `Targets` parameter, then you must retrieve the association by using the association ID.

## Request Syntax
<a name="API_DescribeAssociation_RequestSyntax"></a>

```
{
   "AssociationId": "string",
   "AssociationVersion": "string",
   "InstanceId": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_DescribeAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AssociationId](#API_DescribeAssociation_RequestSyntax) **   <a name="systemsmanager-DescribeAssociation-request-AssociationId"></a>
The association ID for which you want information.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`   
Required: No

 ** [AssociationVersion](#API_DescribeAssociation_RequestSyntax) **   <a name="systemsmanager-DescribeAssociation-request-AssociationVersion"></a>
Specify the association version to retrieve. To view the latest version, either specify `$LATEST` for this parameter, or omit this parameter. To view a list of all associations for a managed node, use [ListAssociations](API_ListAssociations.md). To get a list of versions for a specific association, use [ListAssociationVersions](API_ListAssociationVersions.md).   
Type: String  
Pattern: `([$]LATEST)|([1-9][0-9]*)`   
Required: No

 ** [InstanceId](#API_DescribeAssociation_RequestSyntax) **   <a name="systemsmanager-DescribeAssociation-request-InstanceId"></a>
The managed node ID.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: No

 ** [Name](#API_DescribeAssociation_RequestSyntax) **   <a name="systemsmanager-DescribeAssociation-request-Name"></a>
The name of the SSM document.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: No

## Response Syntax
<a name="API_DescribeAssociation_ResponseSyntax"></a>

```
{
   "AssociationDescription": { 
      "AlarmConfiguration": { 
         "Alarms": [ 
            { 
               "Name": "string"
            }
         ],
         "IgnorePollAlarmFailure": boolean
      },
      "ApplyOnlyAtCronInterval": boolean,
      "AssociationId": "string",
      "AssociationName": "string",
      "AssociationVersion": "string",
      "AutomationTargetParameterName": "string",
      "CalendarNames": [ "string" ],
      "ComplianceSeverity": "string",
      "Date": number,
      "DocumentVersion": "string",
      "Duration": number,
      "InstanceId": "string",
      "LastExecutionDate": number,
      "LastSuccessfulExecutionDate": number,
      "LastUpdateAssociationDate": number,
      "MaxConcurrency": "string",
      "MaxErrors": "string",
      "Name": "string",
      "OutputLocation": { 
         "S3Location": { 
            "OutputS3BucketName": "string",
            "OutputS3KeyPrefix": "string",
            "OutputS3Region": "string"
         }
      },
      "Overview": { 
         "AssociationStatusAggregatedCount": { 
            "string" : number 
         },
         "DetailedStatus": "string",
         "Status": "string"
      },
      "Parameters": { 
         "string" : [ "string" ]
      },
      "ScheduleExpression": "string",
      "ScheduleOffset": number,
      "Status": { 
         "AdditionalInfo": "string",
         "Date": number,
         "Message": "string",
         "Name": "string"
      },
      "SyncCompliance": "string",
      "TargetLocations": [ 
         { 
            "Accounts": [ "string" ],
            "ExcludeAccounts": [ "string" ],
            "ExecutionRoleName": "string",
            "IncludeChildOrganizationUnits": boolean,
            "Regions": [ "string" ],
            "TargetLocationAlarmConfiguration": { 
               "Alarms": [ 
                  { 
                     "Name": "string"
                  }
               ],
               "IgnorePollAlarmFailure": boolean
            },
            "TargetLocationMaxConcurrency": "string",
            "TargetLocationMaxErrors": "string",
            "Targets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ],
            "TargetsMaxConcurrency": "string",
            "TargetsMaxErrors": "string"
         }
      ],
      "TargetMaps": [ 
         { 
            "string" : [ "string" ]
         }
      ],
      "Targets": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ],
      "TriggeredAlarms": [ 
         { 
            "Name": "string",
            "State": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_DescribeAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociationDescription](#API_DescribeAssociation_ResponseSyntax) **   <a name="systemsmanager-DescribeAssociation-response-AssociationDescription"></a>
Information about the association.  
Type: [AssociationDescription](API_AssociationDescription.md) object

## Errors
<a name="API_DescribeAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociationDoesNotExist **   
The specified association doesn't exist.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidAssociationVersion **   
The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the `$LATEST` parameter to view the latest version of the association.  
HTTP Status Code: 400

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

## Examples
<a name="API_DescribeAssociation_Examples"></a>

### Example
<a name="API_DescribeAssociation_Example_1"></a>

This example illustrates one usage of DescribeAssociation.

#### Sample Request
<a name="API_DescribeAssociation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeAssociation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T153423Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 57

{
    "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeAssociation_Example_1_Response"></a>

```
{
    "AssociationDescription": {
        "ApplyOnlyAtCronInterval": false,
        "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
        "AssociationVersion": "1",
        "ComplianceSeverity": "UNSPECIFIED",
        "Date": 1561053271.583,
        "DocumentVersion": "$DEFAULT",
        "LastExecutionDate": 1582037438.692,
        "LastSuccessfulExecutionDate": 1582037438.692,
        "LastUpdateAssociationDate": 1561053271.583,
        "Name": "AWS-UpdateSSMAgent",
        "Overview": {
            "AssociationStatusAggregatedCount": {
                "Success": 3
            },
            "DetailedStatus": "Success",
            "Status": "Success"
        },
        "Parameters": {
            "allowDowngrade": [
                "false"
            ],
            "version": [
                ""
            ]
        },
        "Targets": [
            {
                "Key": "tag:ssm",
                "Values": [
                    "true"
                ]
            }
        ]
    }
}
```

## See Also
<a name="API_DescribeAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeAssociation) 

# DescribeAssociationExecutions
<a name="API_DescribeAssociationExecutions"></a>

Views all executions for a specific association ID. 

## Request Syntax
<a name="API_DescribeAssociationExecutions_RequestSyntax"></a>

```
{
   "AssociationId": "string",
   "Filters": [ 
      { 
         "Key": "string",
         "Type": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeAssociationExecutions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AssociationId](#API_DescribeAssociationExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAssociationExecutions-request-AssociationId"></a>
The association ID for which you want to view execution history details.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`   
Required: Yes

 ** [Filters](#API_DescribeAssociationExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAssociationExecutions-request-Filters"></a>
Filters for the request. You can specify the following filters and values.  
ExecutionId (EQUAL)  
Status (EQUAL)  
CreatedTime (EQUAL, GREATER\$1THAN, LESS\$1THAN)  
Type: Array of [AssociationExecutionFilter](API_AssociationExecutionFilter.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** [MaxResults](#API_DescribeAssociationExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAssociationExecutions-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeAssociationExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAssociationExecutions-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeAssociationExecutions_ResponseSyntax"></a>

```
{
   "AssociationExecutions": [ 
      { 
         "AlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "AssociationId": "string",
         "AssociationVersion": "string",
         "CreatedTime": number,
         "DetailedStatus": "string",
         "ExecutionId": "string",
         "LastExecutionDate": number,
         "ResourceCountByStatus": "string",
         "Status": "string",
         "TriggeredAlarms": [ 
            { 
               "Name": "string",
               "State": "string"
            }
         ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeAssociationExecutions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociationExecutions](#API_DescribeAssociationExecutions_ResponseSyntax) **   <a name="systemsmanager-DescribeAssociationExecutions-response-AssociationExecutions"></a>
A list of the executions for the specified association ID.  
Type: Array of [AssociationExecution](API_AssociationExecution.md) objects

 ** [NextToken](#API_DescribeAssociationExecutions_ResponseSyntax) **   <a name="systemsmanager-DescribeAssociationExecutions-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

## Errors
<a name="API_DescribeAssociationExecutions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociationDoesNotExist **   
The specified association doesn't exist.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeAssociationExecutions_Examples"></a>

### Example
<a name="API_DescribeAssociationExecutions_Example_1"></a>

This example illustrates one usage of DescribeAssociationExecutions.

#### Sample Request
<a name="API_DescribeAssociationExecutions_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeAssociationExecutions
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T154610Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 57

{
    "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeAssociationExecutions_Example_1_Response"></a>

```
{
    "AssociationExecutions": [
        {
            "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
            "AssociationVersion": "1",
            "CreatedTime": 1561053271.718,
            "DetailedStatus": "Success",
            "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE",
            "ResourceCountByStatus": "{Success=3}",
            "Status": "Success"
        }
    ]
}
```

## See Also
<a name="API_DescribeAssociationExecutions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeAssociationExecutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeAssociationExecutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeAssociationExecutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeAssociationExecutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeAssociationExecutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeAssociationExecutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeAssociationExecutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeAssociationExecutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeAssociationExecutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeAssociationExecutions) 

# DescribeAssociationExecutionTargets
<a name="API_DescribeAssociationExecutionTargets"></a>

Views information about a specific execution of a specific association.

## Request Syntax
<a name="API_DescribeAssociationExecutionTargets_RequestSyntax"></a>

```
{
   "AssociationId": "string",
   "ExecutionId": "string",
   "Filters": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeAssociationExecutionTargets_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AssociationId](#API_DescribeAssociationExecutionTargets_RequestSyntax) **   <a name="systemsmanager-DescribeAssociationExecutionTargets-request-AssociationId"></a>
The association ID that includes the execution for which you want to view details.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`   
Required: Yes

 ** [ExecutionId](#API_DescribeAssociationExecutionTargets_RequestSyntax) **   <a name="systemsmanager-DescribeAssociationExecutionTargets-request-ExecutionId"></a>
The execution ID for which you want to view details.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`   
Required: Yes

 ** [Filters](#API_DescribeAssociationExecutionTargets_RequestSyntax) **   <a name="systemsmanager-DescribeAssociationExecutionTargets-request-Filters"></a>
Filters for the request. You can specify the following filters and values.  
Status (EQUAL)  
ResourceId (EQUAL)  
ResourceType (EQUAL)  
Type: Array of [AssociationExecutionTargetsFilter](API_AssociationExecutionTargetsFilter.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** [MaxResults](#API_DescribeAssociationExecutionTargets_RequestSyntax) **   <a name="systemsmanager-DescribeAssociationExecutionTargets-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeAssociationExecutionTargets_RequestSyntax) **   <a name="systemsmanager-DescribeAssociationExecutionTargets-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeAssociationExecutionTargets_ResponseSyntax"></a>

```
{
   "AssociationExecutionTargets": [ 
      { 
         "AssociationId": "string",
         "AssociationVersion": "string",
         "DetailedStatus": "string",
         "ExecutionId": "string",
         "LastExecutionDate": number,
         "OutputSource": { 
            "OutputSourceId": "string",
            "OutputSourceType": "string"
         },
         "ResourceId": "string",
         "ResourceType": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeAssociationExecutionTargets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociationExecutionTargets](#API_DescribeAssociationExecutionTargets_ResponseSyntax) **   <a name="systemsmanager-DescribeAssociationExecutionTargets-response-AssociationExecutionTargets"></a>
Information about the execution.  
Type: Array of [AssociationExecutionTarget](API_AssociationExecutionTarget.md) objects

 ** [NextToken](#API_DescribeAssociationExecutionTargets_ResponseSyntax) **   <a name="systemsmanager-DescribeAssociationExecutionTargets-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

## Errors
<a name="API_DescribeAssociationExecutionTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociationDoesNotExist **   
The specified association doesn't exist.  
HTTP Status Code: 400

 ** AssociationExecutionDoesNotExist **   
The specified execution ID doesn't exist. Verify the ID number and try again.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeAssociationExecutionTargets_Examples"></a>

### Example
<a name="API_DescribeAssociationExecutionTargets_Example_1"></a>

This example illustrates one usage of DescribeAssociationExecutionTargets.

#### Sample Request
<a name="API_DescribeAssociationExecutionTargets_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeAssociationExecutionTargets
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T165104Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 112

{
    "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
    "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeAssociationExecutionTargets_Example_1_Response"></a>

```
{
    "AssociationExecutionTargets": [
        {
            "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
            "AssociationVersion": "1",
            "DetailedStatus": "Success",
            "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE",
            "LastExecutionDate": 1582037438.692,
            "OutputSource": {
                "OutputSourceId": "1cdbb1e6-2e69-40b1-ac1d-121dcEXAMPLE",
                "OutputSourceType": "RunCommand"
            },
            "ResourceId": "i-02573cafcfEXAMPLE",
            "ResourceType": "ManagedInstance",
            "Status": "Success"
        },
        {
            "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
            "AssociationVersion": "1",
            "DetailedStatus": "Success",
            "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE",
            "LastExecutionDate": 1581948052.198,
            "OutputSource": {
                "OutputSourceId": "b170ae99-4959-479b-ab4d-f6ae0EXAMPLE",
                "OutputSourceType": "RunCommand"
            },
            "ResourceId": "i-0471e04240EXAMPLE",
            "ResourceType": "ManagedInstance",
            "Status": "Success"
        },
        {
            "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
            "AssociationVersion": "1",
            "DetailedStatus": "Success",
            "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE",
            "LastExecutionDate": 1561053316.711,
            "OutputSource": {
                "OutputSourceId": "89cd739c-d1a5-4dc9-af4f-8b624EXAMPLE",
                "OutputSourceType": "RunCommand"
            },
            "ResourceId": "i-07782c72faEXAMPLE",
            "ResourceType": "ManagedInstance",
            "Status": "Success"
        }
    ]
}
```

## See Also
<a name="API_DescribeAssociationExecutionTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeAssociationExecutionTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeAssociationExecutionTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeAssociationExecutionTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeAssociationExecutionTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeAssociationExecutionTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeAssociationExecutionTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeAssociationExecutionTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeAssociationExecutionTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeAssociationExecutionTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeAssociationExecutionTargets) 

# DescribeAutomationExecutions
<a name="API_DescribeAutomationExecutions"></a>

Provides details about all active and terminated Automation executions.

## Request Syntax
<a name="API_DescribeAutomationExecutions_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeAutomationExecutions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeAutomationExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAutomationExecutions-request-Filters"></a>
Filters used to limit the scope of executions that are requested.  
Type: Array of [AutomationExecutionFilter](API_AutomationExecutionFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [MaxResults](#API_DescribeAutomationExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAutomationExecutions-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeAutomationExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAutomationExecutions-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeAutomationExecutions_ResponseSyntax"></a>

```
{
   "AutomationExecutionMetadataList": [ 
      { 
         "AlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "AssociationId": "string",
         "AutomationExecutionId": "string",
         "AutomationExecutionStatus": "string",
         "AutomationSubtype": "string",
         "AutomationType": "string",
         "ChangeRequestName": "string",
         "CurrentAction": "string",
         "CurrentStepName": "string",
         "DocumentName": "string",
         "DocumentVersion": "string",
         "ExecutedBy": "string",
         "ExecutionEndTime": number,
         "ExecutionStartTime": number,
         "FailureMessage": "string",
         "LogFile": "string",
         "MaxConcurrency": "string",
         "MaxErrors": "string",
         "Mode": "string",
         "OpsItemId": "string",
         "Outputs": { 
            "string" : [ "string" ]
         },
         "ParentAutomationExecutionId": "string",
         "ResolvedTargets": { 
            "ParameterValues": [ "string" ],
            "Truncated": boolean
         },
         "Runbooks": [ 
            { 
               "DocumentName": "string",
               "DocumentVersion": "string",
               "MaxConcurrency": "string",
               "MaxErrors": "string",
               "Parameters": { 
                  "string" : [ "string" ]
               },
               "TargetLocations": [ 
                  { 
                     "Accounts": [ "string" ],
                     "ExcludeAccounts": [ "string" ],
                     "ExecutionRoleName": "string",
                     "IncludeChildOrganizationUnits": boolean,
                     "Regions": [ "string" ],
                     "TargetLocationAlarmConfiguration": { 
                        "Alarms": [ 
                           { 
                              "Name": "string"
                           }
                        ],
                        "IgnorePollAlarmFailure": boolean
                     },
                     "TargetLocationMaxConcurrency": "string",
                     "TargetLocationMaxErrors": "string",
                     "Targets": [ 
                        { 
                           "Key": "string",
                           "Values": [ "string" ]
                        }
                     ],
                     "TargetsMaxConcurrency": "string",
                     "TargetsMaxErrors": "string"
                  }
               ],
               "TargetMaps": [ 
                  { 
                     "string" : [ "string" ]
                  }
               ],
               "TargetParameterName": "string",
               "Targets": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         ],
         "ScheduledTime": number,
         "Target": "string",
         "TargetLocationsURL": "string",
         "TargetMaps": [ 
            { 
               "string" : [ "string" ]
            }
         ],
         "TargetParameterName": "string",
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "TriggeredAlarms": [ 
            { 
               "Name": "string",
               "State": "string"
            }
         ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeAutomationExecutions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AutomationExecutionMetadataList](#API_DescribeAutomationExecutions_ResponseSyntax) **   <a name="systemsmanager-DescribeAutomationExecutions-response-AutomationExecutionMetadataList"></a>
The list of details about each automation execution which has occurred which matches the filter specification, if any.  
Type: Array of [AutomationExecutionMetadata](API_AutomationExecutionMetadata.md) objects

 ** [NextToken](#API_DescribeAutomationExecutions_ResponseSyntax) **   <a name="systemsmanager-DescribeAutomationExecutions-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_DescribeAutomationExecutions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilterKey **   
The specified key isn't valid.  
HTTP Status Code: 400

 ** InvalidFilterValue **   
The filter value isn't valid. Verify the value and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeAutomationExecutions_Examples"></a>

### Example
<a name="API_DescribeAutomationExecutions_Example_1"></a>

This example illustrates one usage of DescribeAutomationExecutions.

#### Sample Request
<a name="API_DescribeAutomationExecutions_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeAutomationExecutions
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T173011Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2
```

#### Sample Response
<a name="API_DescribeAutomationExecutions_Example_1_Response"></a>

```
{
    "AutomationExecutionMetadataList": [
        {
            "AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE",
            "AutomationExecutionStatus": "Success",
            "AutomationType": "Local",
            "DocumentName": "Example",
            "DocumentVersion": "1",
            "ExecutedBy": "arn:aws:sts::111122223333:assumed-role/Example",
            "ExecutionEndTime": 1585062669.053,
            "ExecutionStartTime": 1585061570.827,
            "LogFile": "",
            "Mode": "Auto",
            "Outputs": {},
            "ResolvedTargets": {
                "ParameterValues": [],
                "Truncated": false
            },
            "Targets": []
        }
    ]
}
```

## See Also
<a name="API_DescribeAutomationExecutions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeAutomationExecutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeAutomationExecutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeAutomationExecutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeAutomationExecutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeAutomationExecutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeAutomationExecutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeAutomationExecutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeAutomationExecutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeAutomationExecutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeAutomationExecutions) 

# DescribeAutomationStepExecutions
<a name="API_DescribeAutomationStepExecutions"></a>

Information about all active and terminated step executions in an Automation workflow.

## Request Syntax
<a name="API_DescribeAutomationStepExecutions_RequestSyntax"></a>

```
{
   "AutomationExecutionId": "string",
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "ReverseOrder": boolean
}
```

## Request Parameters
<a name="API_DescribeAutomationStepExecutions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AutomationExecutionId](#API_DescribeAutomationStepExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAutomationStepExecutions-request-AutomationExecutionId"></a>
The Automation execution ID for which you want step execution descriptions.  
Type: String  
Length Constraints: Fixed length of 36.  
Required: Yes

 ** [Filters](#API_DescribeAutomationStepExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAutomationStepExecutions-request-Filters"></a>
One or more filters to limit the number of step executions returned by the request.  
Type: Array of [StepExecutionFilter](API_StepExecutionFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 6 items.  
Required: No

 ** [MaxResults](#API_DescribeAutomationStepExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAutomationStepExecutions-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeAutomationStepExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAutomationStepExecutions-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [ReverseOrder](#API_DescribeAutomationStepExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeAutomationStepExecutions-request-ReverseOrder"></a>
Indicates whether to list step executions in reverse order by start time. The default value is 'false'.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_DescribeAutomationStepExecutions_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "StepExecutions": [ 
      { 
         "Action": "string",
         "ExecutionEndTime": number,
         "ExecutionStartTime": number,
         "FailureDetails": { 
            "Details": { 
               "string" : [ "string" ]
            },
            "FailureStage": "string",
            "FailureType": "string"
         },
         "FailureMessage": "string",
         "Inputs": { 
            "string" : "string" 
         },
         "IsCritical": boolean,
         "IsEnd": boolean,
         "MaxAttempts": number,
         "NextStep": "string",
         "OnFailure": "string",
         "Outputs": { 
            "string" : [ "string" ]
         },
         "OverriddenParameters": { 
            "string" : [ "string" ]
         },
         "ParentStepDetails": { 
            "Action": "string",
            "Iteration": number,
            "IteratorValue": "string",
            "StepExecutionId": "string",
            "StepName": "string"
         },
         "Response": "string",
         "ResponseCode": "string",
         "StepExecutionId": "string",
         "StepName": "string",
         "StepStatus": "string",
         "TargetLocation": { 
            "Accounts": [ "string" ],
            "ExcludeAccounts": [ "string" ],
            "ExecutionRoleName": "string",
            "IncludeChildOrganizationUnits": boolean,
            "Regions": [ "string" ],
            "TargetLocationAlarmConfiguration": { 
               "Alarms": [ 
                  { 
                     "Name": "string"
                  }
               ],
               "IgnorePollAlarmFailure": boolean
            },
            "TargetLocationMaxConcurrency": "string",
            "TargetLocationMaxErrors": "string",
            "Targets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ],
            "TargetsMaxConcurrency": "string",
            "TargetsMaxErrors": "string"
         },
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "TimeoutSeconds": number,
         "TriggeredAlarms": [ 
            { 
               "Name": "string",
               "State": "string"
            }
         ],
         "ValidNextSteps": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_DescribeAutomationStepExecutions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeAutomationStepExecutions_ResponseSyntax) **   <a name="systemsmanager-DescribeAutomationStepExecutions-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [StepExecutions](#API_DescribeAutomationStepExecutions_ResponseSyntax) **   <a name="systemsmanager-DescribeAutomationStepExecutions-response-StepExecutions"></a>
A list of details about the current state of all steps that make up an execution.  
Type: Array of [StepExecution](API_StepExecution.md) objects

## Errors
<a name="API_DescribeAutomationStepExecutions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AutomationExecutionNotFoundException **   
There is no automation execution information for the requested automation execution ID.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilterKey **   
The specified key isn't valid.  
HTTP Status Code: 400

 ** InvalidFilterValue **   
The filter value isn't valid. Verify the value and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeAutomationStepExecutions_Examples"></a>

### Example
<a name="API_DescribeAutomationStepExecutions_Example_1"></a>

This example illustrates one usage of DescribeAutomationStepExecutions.

#### Sample Request
<a name="API_DescribeAutomationStepExecutions_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeAutomationStepExecutions
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T180909Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 65

{
    "AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeAutomationStepExecutions_Example_1_Response"></a>

```
{
    "StepExecutions": [
        {
            "Action": "aws:createImage",
            "ExecutionEndTime": 1585062668.968,
            "ExecutionStartTime": 1585061571.144,
            "Inputs": {
                "ImageDescription": "\"AMI for i-02573cafcfEXAMPLE created on 2020-03-24_14.52.51\"",
                "ImageName": "\"i-02573cafcfEXAMPLE-2020-03-24_14.52.51\"",
                "InstanceId": "\"i-02573cafcfEXAMPLE\"",
                "NoReboot": "false"
            },
            "OnFailure": "Abort",
            "Outputs": {
                "ImageId": [
                    "ami-0f4706cb37EXAMPLE"
                ],
                "ImageState": [
                    "available"
                ],
                "OutputPayload": [
                    "{\"ImageId\":\"ami-0f4706cb37EXAMPLE\",\"ImageState\":\"available\"}"
                ]
            },
            "OverriddenParameters": {},
            "StepExecutionId": "eff80946-356d-4128-97b2-6a0f5EXAMPLE",
            "StepName": "createImage",
            "StepStatus": "Success"
        }
    ]
}
```

## See Also
<a name="API_DescribeAutomationStepExecutions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeAutomationStepExecutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeAutomationStepExecutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeAutomationStepExecutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeAutomationStepExecutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeAutomationStepExecutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeAutomationStepExecutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeAutomationStepExecutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeAutomationStepExecutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeAutomationStepExecutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeAutomationStepExecutions) 

# DescribeAvailablePatches
<a name="API_DescribeAvailablePatches"></a>

Lists all patches eligible to be included in a patch baseline.

**Note**  
Currently, `DescribeAvailablePatches` supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems.

## Request Syntax
<a name="API_DescribeAvailablePatches_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeAvailablePatches_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeAvailablePatches_RequestSyntax) **   <a name="systemsmanager-DescribeAvailablePatches-request-Filters"></a>
Each element in the array is a structure containing a key-value pair.  
 **Windows Server**   
Supported keys for Windows Server managed node patches include the following:  
+  ** `PATCH_SET` ** 

  Sample values: `OS` \$1 `APPLICATION` 
+  ** `PRODUCT` ** 

  Sample values: `WindowsServer2012` \$1 `Office 2010` \$1 `MicrosoftDefenderAntivirus` 
+  ** `PRODUCT_FAMILY` ** 

  Sample values: `Windows` \$1 `Office` 
+  ** `MSRC_SEVERITY` ** 

  Sample values: `ServicePacks` \$1 `Important` \$1 `Moderate` 
+  ** `CLASSIFICATION` ** 

  Sample values: `ServicePacks` \$1 `SecurityUpdates` \$1 `DefinitionUpdates` 
+  ** `PATCH_ID` ** 

  Sample values: `KB123456` \$1 `KB4516046` 
 **Linux**   
When specifying filters for Linux patches, you must specify a key-pair for `PRODUCT`. For example, using the AWS Command Line Interface (AWS CLI), the following command fails:  
 `aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615`   
However, the following command succeeds:  
 `aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615` 
Supported keys for Linux managed node patches include the following:  
+  ** `PRODUCT` ** 

  Sample values: `AmazonLinux2018.03` \$1 `AmazonLinux2.0` 
+  ** `NAME` ** 

  Sample values: `kernel-headers` \$1 `samba-python` \$1 `php` 
+  ** `SEVERITY` ** 

  Sample values: `Critical` \$1 `Important` \$1 `Medium` \$1 `Low` 
+  ** `EPOCH` ** 

  Sample values: `0` \$1 `1` 
+  ** `VERSION` ** 

  Sample values: `78.6.1` \$1 `4.10.16` 
+  ** `RELEASE` ** 

  Sample values: `9.56.amzn1` \$1 `1.amzn2` 
+  ** `ARCH` ** 

  Sample values: `i686` \$1 `x86_64` 
+  ** `REPOSITORY` ** 

  Sample values: `Core` \$1 `Updates` 
+  ** `ADVISORY_ID` ** 

  Sample values: `ALAS-2018-1058` \$1 `ALAS2-2021-1594` 
+  ** `CVE_ID` ** 

  Sample values: `CVE-2018-3615` \$1 `CVE-2020-1472` 
+  ** `BUGZILLA_ID` ** 

  Sample values: `1463241` 
Type: Array of [PatchOrchestratorFilter](API_PatchOrchestratorFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_DescribeAvailablePatches_RequestSyntax) **   <a name="systemsmanager-DescribeAvailablePatches-request-MaxResults"></a>
The maximum number of patches to return (per page).  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeAvailablePatches_RequestSyntax) **   <a name="systemsmanager-DescribeAvailablePatches-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeAvailablePatches_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Patches": [ 
      { 
         "AdvisoryIds": [ "string" ],
         "Arch": "string",
         "BugzillaIds": [ "string" ],
         "Classification": "string",
         "ContentUrl": "string",
         "CVEIds": [ "string" ],
         "Description": "string",
         "Epoch": number,
         "Id": "string",
         "KbNumber": "string",
         "Language": "string",
         "MsrcNumber": "string",
         "MsrcSeverity": "string",
         "Name": "string",
         "Product": "string",
         "ProductFamily": "string",
         "Release": "string",
         "ReleaseDate": number,
         "Repository": "string",
         "Severity": "string",
         "Title": "string",
         "Vendor": "string",
         "Version": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeAvailablePatches_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeAvailablePatches_ResponseSyntax) **   <a name="systemsmanager-DescribeAvailablePatches-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [Patches](#API_DescribeAvailablePatches_ResponseSyntax) **   <a name="systemsmanager-DescribeAvailablePatches-response-Patches"></a>
An array of patches. Each entry in the array is a patch structure.  
Type: Array of [Patch](API_Patch.md) objects

## Errors
<a name="API_DescribeAvailablePatches_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeAvailablePatches_Examples"></a>

### Example
<a name="API_DescribeAvailablePatches_Example_1"></a>

This example illustrates one usage of DescribeAvailablePatches.

#### Sample Request
<a name="API_DescribeAvailablePatches_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 17
X-Amz-Target: AmazonSSM.DescribeAvailablePatches
X-Amz-Date: 20240308T193543Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Filters": [
        {
            "Key": "PRODUCT",
            "Values": [
                "WindowsServer2016"
            ]            
        },
        {            
            "Key": "CLASSIFICATION",
            "Values": [
                "SecurityUpdates"
            ]
        },
        {            
            "Key": "MSRC_SEVERITY",
            "Values": [
                "Critical"
            ]
        }
    ]
}
```

#### Sample Response
<a name="API_DescribeAvailablePatches_Example_1_Response"></a>

```
{
    "Patches": [
        {
            "Classification": "SecurityUpdates",
            "ContentUrl": "https://support.microsoft.com/en-us/kb/4074588",
            "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.",
            "Id": "11adea10-0701-430e-954f-9471595ae246",
            "KbNumber": "KB4074588",
            "Language": "All",
            "MsrcNumber": "",
            "MsrcSeverity": "Critical",
            "Product": "WindowsServer2016",
            "ProductFamily": "Windows",
            "ReleaseDate": 1518548400,
            "Title": "2018-02 Cumulative Update for Windows Server 2016 (1709) for x64-based 
            Systems (KB4074588)",
            "Vendor": "Microsoft"
        },
        {
            "Classification": "SecurityUpdates",
            "ContentUrl": "https://support.microsoft.com/en-us/kb/4074590",
            "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.",
            "Id": "f5f58231-ac5d-4640-ab1b-9dc8d857c265",
            "KbNumber": "KB4074590",
            "Language": "All",
            "MsrcNumber": "",
            "MsrcSeverity": "Critical",
            "Product": "WindowsServer2016",
            "ProductFamily": "Windows",
            "ReleaseDate": 1518544805,
            "Title": "2018-02 Cumulative Update for Windows Server 2016 for x64-based 
            Systems (KB4074590)",
            "Vendor": "Microsoft"
        },
        {
            "Classification": "SecurityUpdates",
            "ContentUrl": "https://support.microsoft.com/en-us/kb/4074595",
            "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.",
            "Id": "754b5889-2e01-40cc-8833-edf86b35541f",
            "KbNumber": "KB4074595",
            "Language": "All",
            "MsrcNumber": "",
            "MsrcSeverity": "Critical",
            "Product": "WindowsServer2016",
            "ProductFamily": "Windows",
            "ReleaseDate": 1517965209,
            "Title": "2018-02 Security Update for Adobe Flash Player for Windows Server 2016 
            for x64-based Systems (KB4074595)",
            "Vendor": "Microsoft"
        }
    ]
}
```

## See Also
<a name="API_DescribeAvailablePatches_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeAvailablePatches) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeAvailablePatches) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeAvailablePatches) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeAvailablePatches) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeAvailablePatches) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeAvailablePatches) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeAvailablePatches) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeAvailablePatches) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeAvailablePatches) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeAvailablePatches) 

# DescribeDocument
<a name="API_DescribeDocument"></a>

Describes the specified AWS Systems Manager document (SSM document).

## Request Syntax
<a name="API_DescribeDocument_RequestSyntax"></a>

```
{
   "DocumentVersion": "string",
   "Name": "string",
   "VersionName": "string"
}
```

## Request Parameters
<a name="API_DescribeDocument_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DocumentVersion](#API_DescribeDocument_RequestSyntax) **   <a name="systemsmanager-DescribeDocument-request-DocumentVersion"></a>
The document version for which you want information. Can be a specific version or the default version.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [Name](#API_DescribeDocument_RequestSyntax) **   <a name="systemsmanager-DescribeDocument-request-Name"></a>
The name of the SSM document.  
If you're calling a shared SSM document from a different AWS account, `Name` is the full Amazon Resource Name (ARN) of the document.
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: Yes

 ** [VersionName](#API_DescribeDocument_RequestSyntax) **   <a name="systemsmanager-DescribeDocument-request-VersionName"></a>
An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{1,128}$`   
Required: No

## Response Syntax
<a name="API_DescribeDocument_ResponseSyntax"></a>

```
{
   "Document": { 
      "ApprovedVersion": "string",
      "AttachmentsInformation": [ 
         { 
            "Name": "string"
         }
      ],
      "Author": "string",
      "Category": [ "string" ],
      "CategoryEnum": [ "string" ],
      "CreatedDate": number,
      "DefaultVersion": "string",
      "Description": "string",
      "DisplayName": "string",
      "DocumentFormat": "string",
      "DocumentType": "string",
      "DocumentVersion": "string",
      "Hash": "string",
      "HashType": "string",
      "LatestVersion": "string",
      "Name": "string",
      "Owner": "string",
      "Parameters": [ 
         { 
            "DefaultValue": "string",
            "Description": "string",
            "Name": "string",
            "Type": "string"
         }
      ],
      "PendingReviewVersion": "string",
      "PlatformTypes": [ "string" ],
      "Requires": [ 
         { 
            "Name": "string",
            "RequireType": "string",
            "Version": "string",
            "VersionName": "string"
         }
      ],
      "ReviewInformation": [ 
         { 
            "ReviewedTime": number,
            "Reviewer": "string",
            "Status": "string"
         }
      ],
      "ReviewStatus": "string",
      "SchemaVersion": "string",
      "Sha1": "string",
      "Status": "string",
      "StatusInformation": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TargetType": "string",
      "VersionName": "string"
   }
}
```

## Response Elements
<a name="API_DescribeDocument_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Document](#API_DescribeDocument_ResponseSyntax) **   <a name="systemsmanager-DescribeDocument-response-Document"></a>
Information about the SSM document.  
Type: [DocumentDescription](API_DocumentDescription.md) object

## Errors
<a name="API_DescribeDocument_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentVersion **   
The document version isn't valid or doesn't exist.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeDocument_Examples"></a>

### Example
<a name="API_DescribeDocument_Example_1"></a>

This example illustrates one usage of DescribeDocument.

#### Sample Request
<a name="API_DescribeDocument_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeDocument
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T182134Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 23

{
    "Name": "Example"
}
```

#### Sample Response
<a name="API_DescribeDocument_Example_1_Response"></a>

```
{
    "Document": {
        "CreatedDate": 1585061514.204,
        "DefaultVersion": "1",
        "Description": "Example",
        "DocumentFormat": "YAML",
        "DocumentType": "Automation",
        "DocumentVersion": "1",
        "DisplayName": "ExampleDoc",
        "Hash": "68b196e538f5a895f87a0cc15eb74614021f44b47329aa95ccc0f4f71EXAMPLE",
        "HashType": "Sha256",
        "LatestVersion": "1",
        "Name": "Example",
        "Owner": "111122223333",
        "Parameters": [
            {
                "DefaultValue": "",
                "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.",
                "Name": "AutomationAssumeRole",
                "Type": "String"
            },
            {
                "DefaultValue": "",
                "Description": "(Required) The Instance Id to create an image of.",
                "Name": "InstanceId",
                "Type": "String"
            }
        ],
        "PlatformTypes": [
            "Windows",
            "Linux"
        ],
        "SchemaVersion": "0.3",
        "Status": "Active",
        "Tags": []
    }
}
```

## See Also
<a name="API_DescribeDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeDocument) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeDocument) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeDocument) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeDocument) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeDocument) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeDocument) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeDocument) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeDocument) 

# DescribeDocumentPermission
<a name="API_DescribeDocumentPermission"></a>

Describes the permissions for a AWS Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (*All*). 

## Request Syntax
<a name="API_DescribeDocumentPermission_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "Name": "string",
   "NextToken": "string",
   "PermissionType": "string"
}
```

## Request Parameters
<a name="API_DescribeDocumentPermission_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_DescribeDocumentPermission_RequestSyntax) **   <a name="systemsmanager-DescribeDocumentPermission-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 200.  
Required: No

 ** [Name](#API_DescribeDocumentPermission_RequestSyntax) **   <a name="systemsmanager-DescribeDocumentPermission-request-Name"></a>
The name of the document for which you are the owner.   
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

 ** [NextToken](#API_DescribeDocumentPermission_RequestSyntax) **   <a name="systemsmanager-DescribeDocumentPermission-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [PermissionType](#API_DescribeDocumentPermission_RequestSyntax) **   <a name="systemsmanager-DescribeDocumentPermission-request-PermissionType"></a>
The permission type for the document. The permission type can be *Share*.  
Type: String  
Valid Values: `Share`   
Required: Yes

## Response Syntax
<a name="API_DescribeDocumentPermission_ResponseSyntax"></a>

```
{
   "AccountIds": [ "string" ],
   "AccountSharingInfoList": [ 
      { 
         "AccountId": "string",
         "SharedDocumentVersion": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeDocumentPermission_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountIds](#API_DescribeDocumentPermission_ResponseSyntax) **   <a name="systemsmanager-DescribeDocumentPermission-response-AccountIds"></a>
The account IDs that have permission to use this document. The ID can be either an AWS account number or `all`.  
Type: Array of strings  
Array Members: Maximum number of 20 items.  
Pattern: `(?i)all|[0-9]{12}` 

 ** [AccountSharingInfoList](#API_DescribeDocumentPermission_ResponseSyntax) **   <a name="systemsmanager-DescribeDocumentPermission-response-AccountSharingInfoList"></a>
A list of AWS accounts where the current document is shared and the version shared with each account.  
Type: Array of [AccountSharingInfo](API_AccountSharingInfo.md) objects

 ** [NextToken](#API_DescribeDocumentPermission_ResponseSyntax) **   <a name="systemsmanager-DescribeDocumentPermission-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

## Errors
<a name="API_DescribeDocumentPermission_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentOperation **   
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

 ** InvalidPermissionType **   
The permission type isn't supported. *Share* is the only supported permission type.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeDocumentPermission_Examples"></a>

### Example
<a name="API_DescribeDocumentPermission_Example_1"></a>

This example illustrates one usage of DescribeDocumentPermission.

#### Sample Request
<a name="API_DescribeDocumentPermission_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeDocumentPermission
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T182653Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 50

{
    "Name": "Example",
    "PermissionType": "Share"
}
```

#### Sample Response
<a name="API_DescribeDocumentPermission_Example_1_Response"></a>

```
{
    "AccountIds": [],
    "AccountSharingInfoList": []
}
```

## See Also
<a name="API_DescribeDocumentPermission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeDocumentPermission) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeDocumentPermission) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeDocumentPermission) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeDocumentPermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeDocumentPermission) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeDocumentPermission) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeDocumentPermission) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeDocumentPermission) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeDocumentPermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeDocumentPermission) 

# DescribeEffectiveInstanceAssociations
<a name="API_DescribeEffectiveInstanceAssociations"></a>

All associations for the managed nodes.

## Request Syntax
<a name="API_DescribeEffectiveInstanceAssociations_RequestSyntax"></a>

```
{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeEffectiveInstanceAssociations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceId](#API_DescribeEffectiveInstanceAssociations_RequestSyntax) **   <a name="systemsmanager-DescribeEffectiveInstanceAssociations-request-InstanceId"></a>
The managed node ID for which you want to view all associations.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: Yes

 ** [MaxResults](#API_DescribeEffectiveInstanceAssociations_RequestSyntax) **   <a name="systemsmanager-DescribeEffectiveInstanceAssociations-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 5.  
Required: No

 ** [NextToken](#API_DescribeEffectiveInstanceAssociations_RequestSyntax) **   <a name="systemsmanager-DescribeEffectiveInstanceAssociations-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeEffectiveInstanceAssociations_ResponseSyntax"></a>

```
{
   "Associations": [ 
      { 
         "AssociationId": "string",
         "AssociationVersion": "string",
         "Content": "string",
         "InstanceId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeEffectiveInstanceAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Associations](#API_DescribeEffectiveInstanceAssociations_ResponseSyntax) **   <a name="systemsmanager-DescribeEffectiveInstanceAssociations-response-Associations"></a>
The associations for the requested managed node.  
Type: Array of [InstanceAssociation](API_InstanceAssociation.md) objects

 ** [NextToken](#API_DescribeEffectiveInstanceAssociations_ResponseSyntax) **   <a name="systemsmanager-DescribeEffectiveInstanceAssociations-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_DescribeEffectiveInstanceAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeEffectiveInstanceAssociations_Examples"></a>

### Example
<a name="API_DescribeEffectiveInstanceAssociations_Example_1"></a>

This example illustrates one usage of DescribeEffectiveInstanceAssociations.

#### Sample Request
<a name="API_DescribeEffectiveInstanceAssociations_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeEffectiveInstanceAssociations
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240326T144721Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240326/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 37

{
    "InstanceId": "i-02573cafcfEXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeEffectiveInstanceAssociations_Example_1_Response"></a>

```
{
    "Associations": [
        {
            "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
            "InstanceId": "i-02573cafcfEXAMPLE",
            "Content": "{\n    \"schemaVersion\": \"1.2\",\n    \"description\": \"Update the Amazon SSM Agent to the latest version or specified version.\",\n--truncated--",
            "AssociationVersion": "1"
        }
    ]
}
```

## See Also
<a name="API_DescribeEffectiveInstanceAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeEffectiveInstanceAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeEffectiveInstanceAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeEffectiveInstanceAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeEffectiveInstanceAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeEffectiveInstanceAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeEffectiveInstanceAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeEffectiveInstanceAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeEffectiveInstanceAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeEffectiveInstanceAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeEffectiveInstanceAssociations) 

# DescribeEffectivePatchesForPatchBaseline
<a name="API_DescribeEffectivePatchesForPatchBaseline"></a>

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.

## Request Syntax
<a name="API_DescribeEffectivePatchesForPatchBaseline_RequestSyntax"></a>

```
{
   "BaselineId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeEffectivePatchesForPatchBaseline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BaselineId](#API_DescribeEffectivePatchesForPatchBaseline_RequestSyntax) **   <a name="systemsmanager-DescribeEffectivePatchesForPatchBaseline-request-BaselineId"></a>
The ID of the patch baseline to retrieve the effective patches for.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$`   
Required: Yes

 ** [MaxResults](#API_DescribeEffectivePatchesForPatchBaseline_RequestSyntax) **   <a name="systemsmanager-DescribeEffectivePatchesForPatchBaseline-request-MaxResults"></a>
The maximum number of patches to return (per page).  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeEffectivePatchesForPatchBaseline_RequestSyntax) **   <a name="systemsmanager-DescribeEffectivePatchesForPatchBaseline-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeEffectivePatchesForPatchBaseline_ResponseSyntax"></a>

```
{
   "EffectivePatches": [ 
      { 
         "Patch": { 
            "AdvisoryIds": [ "string" ],
            "Arch": "string",
            "BugzillaIds": [ "string" ],
            "Classification": "string",
            "ContentUrl": "string",
            "CVEIds": [ "string" ],
            "Description": "string",
            "Epoch": number,
            "Id": "string",
            "KbNumber": "string",
            "Language": "string",
            "MsrcNumber": "string",
            "MsrcSeverity": "string",
            "Name": "string",
            "Product": "string",
            "ProductFamily": "string",
            "Release": "string",
            "ReleaseDate": number,
            "Repository": "string",
            "Severity": "string",
            "Title": "string",
            "Vendor": "string",
            "Version": "string"
         },
         "PatchStatus": { 
            "ApprovalDate": number,
            "ComplianceLevel": "string",
            "DeploymentStatus": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeEffectivePatchesForPatchBaseline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EffectivePatches](#API_DescribeEffectivePatchesForPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-DescribeEffectivePatchesForPatchBaseline-response-EffectivePatches"></a>
An array of patches and patch status.  
Type: Array of [EffectivePatch](API_EffectivePatch.md) objects

 ** [NextToken](#API_DescribeEffectivePatchesForPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-DescribeEffectivePatchesForPatchBaseline-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_DescribeEffectivePatchesForPatchBaseline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidResourceId **   
The resource ID isn't valid. Verify that you entered the correct ID and try again.  
HTTP Status Code: 400

 ** UnsupportedOperatingSystem **   
The operating systems you specified isn't supported, or the operation isn't supported for the operating system.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeEffectivePatchesForPatchBaseline_Examples"></a>

### Example
<a name="API_DescribeEffectivePatchesForPatchBaseline_Example_1"></a>

This example illustrates one usage of DescribeEffectivePatchesForPatchBaseline.

#### Sample Request
<a name="API_DescribeEffectivePatchesForPatchBaseline_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 38
X-Amz-Target: AmazonSSM.DescribeEffectivePatchesForPatchBaseline
X-Amz-Date: 20240309T061447Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeEffectivePatchesForPatchBaseline_Example_1_Response"></a>

```
{
    "EffectivePatches": [
        {
            "Patch": {
                "Classification": "SecurityUpdates",
                "ContentUrl": "https://support.microsoft.com/en-us/kb/2032276",
                "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": "8692029b-a3a2-4a87-a73b-8ea881b4b4d6",
                "KbNumber": "KB2032276",
                "Language": "All",
                "MsrcNumber": "MS10-043",
                "MsrcSeverity": "Important",
                "Product": "WindowsServer2008R2",
                "ProductFamily": "Windows",
                "ReleaseDate": 1279040400,
                "Title": "Security Update for Windows Server 2008 R2 x64 Edition (KB2032276)",
                "Vendor": "Microsoft"
            },
            "PatchStatus": {
                "ApprovalDate": 1279299600,
                "ComplianceLevel": "UNSPECIFIED",
                "DeploymentStatus": "APPROVED"
            }
        },
        {
            "Patch": {
                "Classification": "SecurityUpdates",
                "ContentUrl": "https://support.microsoft.com/en-us/kb/2124261",
                "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": "12ef1bed-0dd2-4633-b3ac-60888aa8ba33",
                "KbNumber": "KB2124261",
                "Language": "All",
                "MsrcNumber": "MS10-065",
                "MsrcSeverity": "Important",
                "Product": "Windows7",
                "ProductFamily": "Windows",
                "ReleaseDate": 1284483600,
                "Title": "Security Update for Windows 7 (KB2124261)",
                "Vendor": "Microsoft"
            },
            "PatchStatus": {
                "ApprovalDate": 1284742800,
                "ComplianceLevel": "UNSPECIFIED",
                "DeploymentStatus": "APPROVED"
            }
        },
        {
            "Patch": {
                "Classification": "SecurityUpdates",
                "ContentUrl": "https://support.microsoft.com/en-us/kb/2124261",
                "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": "1b571637-30ed-48d6-b2f3-24d374fdebb8",
                "KbNumber": "KB2124261",
                "Language": "All",
                "MsrcNumber": "MS10-065",
                "MsrcSeverity": "Important",
                "Product": "WindowsServer2008R2",
                "ProductFamily": "Windows",
                "ReleaseDate": 1284483600,
                "Title": "Security Update for Windows Server 2008 R2 x64 Edition (KB2124261)",
                "Vendor": "Microsoft"
            },
            "PatchStatus": {
                "ApprovalDate": 1284742800,
                "ComplianceLevel": "UNSPECIFIED",
                "DeploymentStatus": "APPROVED"
            }
        }
        // There may be more content here
    ]
}
```

## See Also
<a name="API_DescribeEffectivePatchesForPatchBaseline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline) 

# DescribeInstanceAssociationsStatus
<a name="API_DescribeInstanceAssociationsStatus"></a>

The status of the associations for the managed nodes.

## Request Syntax
<a name="API_DescribeInstanceAssociationsStatus_RequestSyntax"></a>

```
{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeInstanceAssociationsStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceId](#API_DescribeInstanceAssociationsStatus_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceAssociationsStatus-request-InstanceId"></a>
The managed node IDs for which you want association status information.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: Yes

 ** [MaxResults](#API_DescribeInstanceAssociationsStatus_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceAssociationsStatus-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeInstanceAssociationsStatus_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceAssociationsStatus-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeInstanceAssociationsStatus_ResponseSyntax"></a>

```
{
   "InstanceAssociationStatusInfos": [ 
      { 
         "AssociationId": "string",
         "AssociationName": "string",
         "AssociationVersion": "string",
         "DetailedStatus": "string",
         "DocumentVersion": "string",
         "ErrorCode": "string",
         "ExecutionDate": number,
         "ExecutionSummary": "string",
         "InstanceId": "string",
         "Name": "string",
         "OutputUrl": { 
            "S3OutputUrl": { 
               "OutputUrl": "string"
            }
         },
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeInstanceAssociationsStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstanceAssociationStatusInfos](#API_DescribeInstanceAssociationsStatus_ResponseSyntax) **   <a name="systemsmanager-DescribeInstanceAssociationsStatus-response-InstanceAssociationStatusInfos"></a>
Status information about the association.  
Type: Array of [InstanceAssociationStatusInfo](API_InstanceAssociationStatusInfo.md) objects

 ** [NextToken](#API_DescribeInstanceAssociationsStatus_ResponseSyntax) **   <a name="systemsmanager-DescribeInstanceAssociationsStatus-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_DescribeInstanceAssociationsStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeInstanceAssociationsStatus_Examples"></a>

### Example
<a name="API_DescribeInstanceAssociationsStatus_Example_1"></a>

This example illustrates one usage of DescribeInstanceAssociationsStatus.

#### Sample Request
<a name="API_DescribeInstanceAssociationsStatus_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeInstanceAssociationsStatus
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T185152Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 37

{
    "InstanceId": "i-02573cafcfEXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeInstanceAssociationsStatus_Example_1_Response"></a>

```
{
    "InstanceAssociationStatusInfos": [
        {
            "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
            "AssociationVersion": "1",
            "DetailedStatus": "Success",
            "DocumentVersion": "1",
            "ExecutionDate": 1581948052.198,
            "InstanceId": "i-02573cafcfEXAMPLE",
            "Name": "AWS-UpdateSSMAgent",
            "Status": "Success"
        }
    ]
}
```

## See Also
<a name="API_DescribeInstanceAssociationsStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeInstanceAssociationsStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeInstanceAssociationsStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeInstanceAssociationsStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeInstanceAssociationsStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeInstanceAssociationsStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeInstanceAssociationsStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeInstanceAssociationsStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeInstanceAssociationsStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeInstanceAssociationsStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeInstanceAssociationsStatus) 

# DescribeInstanceInformation
<a name="API_DescribeInstanceInformation"></a>

Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.

If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.

**Note**  
The `IamRole` field returned for this API operation is the role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.

## Request Syntax
<a name="API_DescribeInstanceInformation_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "InstanceInformationFilterList": [ 
      { 
         "key": "string",
         "valueSet": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeInstanceInformation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeInstanceInformation_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceInformation-request-Filters"></a>
One or more filters. Use a filter to return a more specific list of managed nodes. You can filter based on tags applied to your managed nodes. Tag filters can't be combined with other filter types. Use this `Filters` data type instead of `InstanceInformationFilterList`, which is deprecated.  
Type: Array of [InstanceInformationStringFilter](API_InstanceInformationStringFilter.md) objects  
Array Members: Minimum number of 0 items.  
Required: No

 ** [InstanceInformationFilterList](#API_DescribeInstanceInformation_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceInformation-request-InstanceInformationFilterList"></a>
This is a legacy method. We recommend that you don't use this method. Instead, use the `Filters` data type. `Filters` enables you to return node information by filtering based on tags applied to managed nodes.  
Attempting to use `InstanceInformationFilterList` and `Filters` leads to an exception error. 
Type: Array of [InstanceInformationFilter](API_InstanceInformationFilter.md) objects  
Array Members: Minimum number of 0 items.  
Required: No

 ** [MaxResults](#API_DescribeInstanceInformation_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceInformation-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. The default value is 10 items.   
Type: Integer  
Valid Range: Minimum value of 5. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeInstanceInformation_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceInformation-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeInstanceInformation_ResponseSyntax"></a>

```
{
   "InstanceInformationList": [ 
      { 
         "ActivationId": "string",
         "AgentVersion": "string",
         "AssociationOverview": { 
            "DetailedStatus": "string",
            "InstanceAssociationStatusAggregatedCount": { 
               "string" : number 
            }
         },
         "AssociationStatus": "string",
         "ComputerName": "string",
         "IamRole": "string",
         "InstanceId": "string",
         "IPAddress": "string",
         "IsLatestVersion": boolean,
         "LastAssociationExecutionDate": number,
         "LastPingDateTime": number,
         "LastSuccessfulAssociationExecutionDate": number,
         "Name": "string",
         "PingStatus": "string",
         "PlatformName": "string",
         "PlatformType": "string",
         "PlatformVersion": "string",
         "RegistrationDate": number,
         "ResourceType": "string",
         "SourceId": "string",
         "SourceType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeInstanceInformation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstanceInformationList](#API_DescribeInstanceInformation_ResponseSyntax) **   <a name="systemsmanager-DescribeInstanceInformation-response-InstanceInformationList"></a>
The managed node information list.  
Type: Array of [InstanceInformation](API_InstanceInformation.md) objects

 ** [NextToken](#API_DescribeInstanceInformation_ResponseSyntax) **   <a name="systemsmanager-DescribeInstanceInformation-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.   
Type: String

## Errors
<a name="API_DescribeInstanceInformation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilterKey **   
The specified key isn't valid.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidInstanceInformationFilterValue **   
The specified filter value isn't valid.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeInstanceInformation_Examples"></a>

### Example
<a name="API_DescribeInstanceInformation_Example_1"></a>

This example illustrates one usage of DescribeInstanceInformation.

#### Sample Request
<a name="API_DescribeInstanceInformation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeInstanceInformation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240220T234247Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240220/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 72

{
    "Filters": [
        {
            "Key": "InstanceIds",
            "Values": [
                "i-02573cafcfEXAMPLE"
            ]
        }
    ]
}
```

#### Sample Response
<a name="API_DescribeInstanceInformation_Example_1_Response"></a>

```
{
    "InstanceInformationList": [
        {
            "AgentVersion": "2.3.871.0",
            "AssociationOverview": {
                "DetailedStatus": "Failed",
                "InstanceAssociationStatusAggregatedCount": {
                    "Failed": 1,
                    "Success": 1
                }
            },
            "AssociationStatus": "Failed",
            "ComputerName": "WIN-11RMS222RPK.WORKGROUP",
            "IPAddress": "203.0.113.0",
            "InstanceId": "i-02573cafcfEXAMPLE",
            "IsLatestVersion": false,
            "LastAssociationExecutionDate": 1582242019,
            "LastPingDateTime": 1582242018.094,
            "PingStatus": "Online",
            "PlatformName": "Microsoft Windows Server 2008 R2 Datacenter",
            "PlatformType": "Windows",
            "PlatformVersion": "6.1.7601",
            "ResourceType": "EC2Instance"
        }
    ]
}
```

## See Also
<a name="API_DescribeInstanceInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeInstanceInformation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeInstanceInformation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeInstanceInformation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeInstanceInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeInstanceInformation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeInstanceInformation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeInstanceInformation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeInstanceInformation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeInstanceInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeInstanceInformation) 

# DescribeInstancePatches
<a name="API_DescribeInstancePatches"></a>

Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.

## Request Syntax
<a name="API_DescribeInstancePatches_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeInstancePatches_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeInstancePatches_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatches-request-Filters"></a>
Each element in the array is a structure containing a key-value pair.  
Supported keys for `DescribeInstancePatches`include the following:  
+  ** `Classification` ** 

  Sample values: `Security` \$1 `SecurityUpdates` 
+  ** `KBId` ** 

  Sample values: `KB4480056` \$1 `java-1.7.0-openjdk.x86_64` 
+  ** `Severity` ** 

  Sample values: `Important` \$1 `Medium` \$1 `Low` 
+  ** `State` ** 

  Sample values: `Installed` \$1 `InstalledOther` \$1 `InstalledPendingReboot` 

  For lists of all `State` values, see [Patch compliance state values](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-compliance-states.html) in the * AWS Systems Manager User Guide*.
Type: Array of [PatchOrchestratorFilter](API_PatchOrchestratorFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [InstanceId](#API_DescribeInstancePatches_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatches-request-InstanceId"></a>
The ID of the managed node whose patch state information should be retrieved.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: Yes

 ** [MaxResults](#API_DescribeInstancePatches_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatches-request-MaxResults"></a>
The maximum number of patches to return (per page).  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeInstancePatches_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatches-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeInstancePatches_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Patches": [ 
      { 
         "Classification": "string",
         "CVEIds": "string",
         "InstalledTime": number,
         "KBId": "string",
         "Severity": "string",
         "State": "string",
         "Title": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeInstancePatches_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeInstancePatches_ResponseSyntax) **   <a name="systemsmanager-DescribeInstancePatches-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [Patches](#API_DescribeInstancePatches_ResponseSyntax) **   <a name="systemsmanager-DescribeInstancePatches-response-Patches"></a>
Each entry in the array is a structure containing:  
+ Title (string)
+ KBId (string)
+ Classification (string)
+ Severity (string)
+ State (string, such as "INSTALLED" or "FAILED")
+ InstalledTime (DateTime)
+ InstalledBy (string)
Type: Array of [PatchComplianceData](API_PatchComplianceData.md) objects

## Errors
<a name="API_DescribeInstancePatches_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeInstancePatches_Examples"></a>

### Example
<a name="API_DescribeInstancePatches_Example_1"></a>

This example illustrates one usage of DescribeInstancePatches.

#### Sample Request
<a name="API_DescribeInstancePatches_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 37
X-Amz-Target: AmazonSSM.DescribeInstancePatches
X-Amz-Date: 20240308T205131Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "InstanceId": "i-02573cafcfEXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeInstancePatches_Example_1_Response"></a>

```
{
    "Patches": [
        {
            "Title": "NetworkManager.x86_64:1:1.30.0-7.el8",
            "KBId": "NetworkManager.x86_64",
            "Classification": "Security",
            "Severity": "Moderate",
            "State": "Installed",
            "InstalledTime": "2024-05-19T10:03:07-07:00"
        },
        {
            "Title": "bash.x86_64:0:4.4.19-14.el8",
            "KBId": "bash.x86_64",
            "Classification": "Security",
            "Severity": "Low",
            "State": "Installed",
            "InstalledTime": "2024-05-19T10:03:25-07:00"
        },
        {
            "Title": "kernel-modules.x86_64:0:4.18.0-305.10.2.el8_4",
            "KBId": "kernel-modules.x86_64",
            "Classification": "Security",
            "Severity": "Important",
            "State": "Installed",
            "InstalledTime": "2024-08-04T10:45:42-07:00"
        }
        // There may be more content here
    ]
}
```

## See Also
<a name="API_DescribeInstancePatches_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeInstancePatches) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeInstancePatches) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeInstancePatches) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeInstancePatches) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeInstancePatches) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeInstancePatches) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeInstancePatches) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeInstancePatches) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeInstancePatches) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeInstancePatches) 

# DescribeInstancePatchStates
<a name="API_DescribeInstancePatchStates"></a>

Retrieves the high-level patch state of one or more managed nodes.

## Request Syntax
<a name="API_DescribeInstancePatchStates_RequestSyntax"></a>

```
{
   "InstanceIds": [ "string" ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeInstancePatchStates_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceIds](#API_DescribeInstancePatchStates_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatchStates-request-InstanceIds"></a>
The ID of the managed node for which patch state information should be retrieved.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: Yes

 ** [MaxResults](#API_DescribeInstancePatchStates_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatchStates-request-MaxResults"></a>
The maximum number of managed nodes to return (per page).  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeInstancePatchStates_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatchStates-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeInstancePatchStates_ResponseSyntax"></a>

```
{
   "InstancePatchStates": [ 
      { 
         "AvailableSecurityUpdateCount": number,
         "BaselineId": "string",
         "CriticalNonCompliantCount": number,
         "FailedCount": number,
         "InstalledCount": number,
         "InstalledOtherCount": number,
         "InstalledPendingRebootCount": number,
         "InstalledRejectedCount": number,
         "InstallOverrideList": "string",
         "InstanceId": "string",
         "LastNoRebootInstallOperationTime": number,
         "MissingCount": number,
         "NotApplicableCount": number,
         "Operation": "string",
         "OperationEndTime": number,
         "OperationStartTime": number,
         "OtherNonCompliantCount": number,
         "OwnerInformation": "string",
         "PatchGroup": "string",
         "RebootOption": "string",
         "SecurityNonCompliantCount": number,
         "SnapshotId": "string",
         "UnreportedNotApplicableCount": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeInstancePatchStates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstancePatchStates](#API_DescribeInstancePatchStates_ResponseSyntax) **   <a name="systemsmanager-DescribeInstancePatchStates-response-InstancePatchStates"></a>
The high-level patch state for the requested managed nodes.  
Type: Array of [InstancePatchState](API_InstancePatchState.md) objects

 ** [NextToken](#API_DescribeInstancePatchStates_ResponseSyntax) **   <a name="systemsmanager-DescribeInstancePatchStates-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_DescribeInstancePatchStates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeInstancePatchStates_Examples"></a>

### Example
<a name="API_DescribeInstancePatchStates_Example_1"></a>

This example illustrates one usage of DescribeInstancePatchStates.

#### Sample Request
<a name="API_DescribeInstancePatchStates_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 40
X-Amz-Target: AmazonSSM.DescribeInstancePatchStates
X-Amz-Date: 20240308T202310Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "InstanceIds": [
        "i-02573cafcfEXAMPLE"
    ]
}
```

#### Sample Response
<a name="API_DescribeInstancePatchStates_Example_1_Response"></a>

```
{
    "InstancePatchStates": [
        {
            "InstanceId": "i-02573cafcfEXAMPLE",
            "PatchGroup": "mypatchgroup",
            "BaselineId": "pb-0c10e65780EXAMPLE",            
            "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE",
            "CriticalNonCompliantCount": 2,
            "SecurityNonCompliantCount": 2,
            "OtherNonCompliantCount": 1,
            "InstalledCount": 123,
            "InstalledOtherCount": 334,
            "InstalledPendingRebootCount": 0,
            "InstalledRejectedCount": 0,
            "MissingCount": 1,
            "FailedCount": 2,
            "UnreportedNotApplicableCount": 11,
            "NotApplicableCount": 2063,
            "OperationStartTime": "2024-05-03T11:00:56-07:00",
            "OperationEndTime": "2024-05-03T11:01:09-07:00",
            "Operation": "Scan",
            "LastNoRebootInstallOperationTime": "2024-04-14T12:17:41-07:00",
            "RebootOption": "RebootIfNeeded"
        }
    ]
}
```

## See Also
<a name="API_DescribeInstancePatchStates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeInstancePatchStates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeInstancePatchStates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeInstancePatchStates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeInstancePatchStates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeInstancePatchStates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeInstancePatchStates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeInstancePatchStates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeInstancePatchStates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeInstancePatchStates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeInstancePatchStates) 

# DescribeInstancePatchStatesForPatchGroup
<a name="API_DescribeInstancePatchStatesForPatchGroup"></a>

Retrieves the high-level patch state for the managed nodes in the specified patch group.

## Request Syntax
<a name="API_DescribeInstancePatchStatesForPatchGroup_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Type": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "PatchGroup": "string"
}
```

## Request Parameters
<a name="API_DescribeInstancePatchStatesForPatchGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeInstancePatchStatesForPatchGroup_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatchStatesForPatchGroup-request-Filters"></a>
Each entry in the array is a structure containing:  
+ Key (string between 1 and 200 characters)
+ Values (array containing a single string)
+ Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
Type: Array of [InstancePatchStateFilter](API_InstancePatchStateFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 4 items.  
Required: No

 ** [MaxResults](#API_DescribeInstancePatchStatesForPatchGroup_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatchStatesForPatchGroup-request-MaxResults"></a>
The maximum number of patches to return (per page).  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeInstancePatchStatesForPatchGroup_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatchStatesForPatchGroup-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [PatchGroup](#API_DescribeInstancePatchStatesForPatchGroup_RequestSyntax) **   <a name="systemsmanager-DescribeInstancePatchStatesForPatchGroup-request-PatchGroup"></a>
The name of the patch group for which the patch state information should be retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## Response Syntax
<a name="API_DescribeInstancePatchStatesForPatchGroup_ResponseSyntax"></a>

```
{
   "InstancePatchStates": [ 
      { 
         "AvailableSecurityUpdateCount": number,
         "BaselineId": "string",
         "CriticalNonCompliantCount": number,
         "FailedCount": number,
         "InstalledCount": number,
         "InstalledOtherCount": number,
         "InstalledPendingRebootCount": number,
         "InstalledRejectedCount": number,
         "InstallOverrideList": "string",
         "InstanceId": "string",
         "LastNoRebootInstallOperationTime": number,
         "MissingCount": number,
         "NotApplicableCount": number,
         "Operation": "string",
         "OperationEndTime": number,
         "OperationStartTime": number,
         "OtherNonCompliantCount": number,
         "OwnerInformation": "string",
         "PatchGroup": "string",
         "RebootOption": "string",
         "SecurityNonCompliantCount": number,
         "SnapshotId": "string",
         "UnreportedNotApplicableCount": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeInstancePatchStatesForPatchGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstancePatchStates](#API_DescribeInstancePatchStatesForPatchGroup_ResponseSyntax) **   <a name="systemsmanager-DescribeInstancePatchStatesForPatchGroup-response-InstancePatchStates"></a>
The high-level patch state for the requested managed nodes.   
Type: Array of [InstancePatchState](API_InstancePatchState.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.

 ** [NextToken](#API_DescribeInstancePatchStatesForPatchGroup_ResponseSyntax) **   <a name="systemsmanager-DescribeInstancePatchStatesForPatchGroup-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_DescribeInstancePatchStatesForPatchGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeInstancePatchStatesForPatchGroup_Examples"></a>

### Example
<a name="API_DescribeInstancePatchStatesForPatchGroup_Example_1"></a>

This example illustrates one usage of DescribeInstancePatchStatesForPatchGroup.

#### Sample Request
<a name="API_DescribeInstancePatchStatesForPatchGroup_Example_1_Request"></a>

```
POST / HTTP/1.1
  Host: ssm.us-east-2.amazonaws.com
  Accept-Encoding: identity
  Content-Length: 33
  X-Amz-Target: AmazonSSM.DescribeInstancePatchStatesForPatchGroup
  X-Amz-Date: 20240308T204541Z
  User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
  Content-Type: application/x-amz-json-1.1
  Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/aws4_request, 
  SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
  
  {
    "PatchGroup": "mypatchgroup"
}
```

#### Sample Response
<a name="API_DescribeInstancePatchStatesForPatchGroup_Example_1_Response"></a>

```
{
    "InstancePatchStates": [
        {            
            "InstanceId": "i-02573cafcfEXAMPLE",            
            "PatchGroup": "mypatchgroup",
            "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": "2024-08-04T11:03:50.590000-07:00",
            "OperationEndTime": "2024-08-04T11:04:21.555000-07:00",
            "Operation": "Scan",
            "RebootOption": "NoReboot",
            "CriticalNonCompliantCount": 0,
            "SecurityNonCompliantCount": 1,
            "OtherNonCompliantCount": 0
        },
        {
            
            "InstanceId": "i-0471e04240EXAMPLE",  
            "PatchGroup": "mypatchgroup",  
            "BaselineId": "pb-09ca3fb51fEXAMPLE",
            "SnapshotId": "05d8ffb0-1bbe-4812-ba2d-d9b7bEXAMPLE",
            "OwnerInformation": "",
            "InstalledCount": 45,
            "InstalledOtherCount": 3,
            "InstalledPendingRebootCount": 1,
            "InstalledRejectedCount": 0,
            "MissingCount": 2,
            "FailedCount": 1,
            "UnreportedNotApplicableCount": 3154,
            "NotApplicableCount": 321,
            "OperationStartTime": "2024-08-04T11:04:30.290000-07:00",
            "OperationEndTime": "2024-08-04T11:04:49.255000-07:00",
            "Operation": "Scan",
            "RebootOption": "NoReboot",
            "CriticalNonCompliantCount": 0,
            "SecurityNonCompliantCount": 2,
            "OtherNonCompliantCount": 1
        }
        // There may be more content here
    ]
}
```

## See Also
<a name="API_DescribeInstancePatchStatesForPatchGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup) 

# DescribeInstanceProperties
<a name="API_DescribeInstanceProperties"></a>

An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.

## Request Syntax
<a name="API_DescribeInstanceProperties_RequestSyntax"></a>

```
{
   "FiltersWithOperator": [ 
      { 
         "Key": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ],
   "InstancePropertyFilterList": [ 
      { 
         "key": "string",
         "valueSet": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeInstanceProperties_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FiltersWithOperator](#API_DescribeInstanceProperties_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceProperties-request-FiltersWithOperator"></a>
The request filters to use with the operator.  
Type: Array of [InstancePropertyStringFilter](API_InstancePropertyStringFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 40 items.  
Required: No

 ** [InstancePropertyFilterList](#API_DescribeInstanceProperties_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceProperties-request-InstancePropertyFilterList"></a>
An array of instance property filters.  
Type: Array of [InstancePropertyFilter](API_InstancePropertyFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 40 items.  
Required: No

 ** [MaxResults](#API_DescribeInstanceProperties_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceProperties-request-MaxResults"></a>
The maximum number of items to return for the call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 5. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_DescribeInstanceProperties_RequestSyntax) **   <a name="systemsmanager-DescribeInstanceProperties-request-NextToken"></a>
The token provided by a previous request to use to return the next set of properties.  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeInstanceProperties_ResponseSyntax"></a>

```
{
   "InstanceProperties": [ 
      { 
         "ActivationId": "string",
         "AgentVersion": "string",
         "Architecture": "string",
         "AssociationOverview": { 
            "DetailedStatus": "string",
            "InstanceAssociationStatusAggregatedCount": { 
               "string" : number 
            }
         },
         "AssociationStatus": "string",
         "ComputerName": "string",
         "IamRole": "string",
         "InstanceId": "string",
         "InstanceRole": "string",
         "InstanceState": "string",
         "InstanceType": "string",
         "IPAddress": "string",
         "KeyName": "string",
         "LastAssociationExecutionDate": number,
         "LastPingDateTime": number,
         "LastSuccessfulAssociationExecutionDate": number,
         "LaunchTime": number,
         "Name": "string",
         "PingStatus": "string",
         "PlatformName": "string",
         "PlatformType": "string",
         "PlatformVersion": "string",
         "RegistrationDate": number,
         "ResourceType": "string",
         "SourceId": "string",
         "SourceType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeInstanceProperties_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstanceProperties](#API_DescribeInstanceProperties_ResponseSyntax) **   <a name="systemsmanager-DescribeInstanceProperties-response-InstanceProperties"></a>
Properties for the managed instances.  
Type: Array of [InstanceProperty](API_InstanceProperty.md) objects

 ** [NextToken](#API_DescribeInstanceProperties_ResponseSyntax) **   <a name="systemsmanager-DescribeInstanceProperties-response-NextToken"></a>
The token for the next set of properties to return. Use this token to get the next set of results.  
Type: String

## Errors
<a name="API_DescribeInstanceProperties_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidActivationId **   
The activation ID isn't valid. Verify that you entered the correct ActivationId or ActivationCode and try again.  
HTTP Status Code: 400

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidFilterKey **   
The specified key isn't valid.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidInstancePropertyFilterValue **   
The specified filter value isn't valid.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeInstanceProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeInstanceProperties) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeInstanceProperties) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeInstanceProperties) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeInstanceProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeInstanceProperties) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeInstanceProperties) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeInstanceProperties) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeInstanceProperties) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeInstanceProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeInstanceProperties) 

# DescribeInventoryDeletions
<a name="API_DescribeInventoryDeletions"></a>

Describes a specific delete inventory operation.

## Request Syntax
<a name="API_DescribeInventoryDeletions_RequestSyntax"></a>

```
{
   "DeletionId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeInventoryDeletions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DeletionId](#API_DescribeInventoryDeletions_RequestSyntax) **   <a name="systemsmanager-DescribeInventoryDeletions-request-DeletionId"></a>
Specify the delete inventory ID for which you want information. This ID was returned by the `DeleteInventory` operation.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** [MaxResults](#API_DescribeInventoryDeletions_RequestSyntax) **   <a name="systemsmanager-DescribeInventoryDeletions-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeInventoryDeletions_RequestSyntax) **   <a name="systemsmanager-DescribeInventoryDeletions-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeInventoryDeletions_ResponseSyntax"></a>

```
{
   "InventoryDeletions": [ 
      { 
         "DeletionId": "string",
         "DeletionStartTime": number,
         "DeletionSummary": { 
            "RemainingCount": number,
            "SummaryItems": [ 
               { 
                  "Count": number,
                  "RemainingCount": number,
                  "Version": "string"
               }
            ],
            "TotalCount": number
         },
         "LastStatus": "string",
         "LastStatusMessage": "string",
         "LastStatusUpdateTime": number,
         "TypeName": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeInventoryDeletions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InventoryDeletions](#API_DescribeInventoryDeletions_ResponseSyntax) **   <a name="systemsmanager-DescribeInventoryDeletions-response-InventoryDeletions"></a>
A list of status items for deleted inventory.  
Type: Array of [InventoryDeletionStatusItem](API_InventoryDeletionStatusItem.md) objects

 ** [NextToken](#API_DescribeInventoryDeletions_ResponseSyntax) **   <a name="systemsmanager-DescribeInventoryDeletions-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

## Errors
<a name="API_DescribeInventoryDeletions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDeletionIdException **   
The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeInventoryDeletions_Examples"></a>

### Example
<a name="API_DescribeInventoryDeletions_Example_1"></a>

This example illustrates one usage of DescribeInventoryDeletions.

#### Sample Request
<a name="API_DescribeInventoryDeletions_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-west-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeInventoryDeletions
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.25 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ssm.describe-inventory-deletions
X-Amz-Date: 20240810T211220Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240810/us-west-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2

{}
```

#### Sample Response
<a name="API_DescribeInventoryDeletions_Example_1_Response"></a>

```
{
  "InventoryDeletions": [
    {
      "DeletionId": "5bc2ba3b-ee6a-40fa-8d09-5eExample",
      "DeletionStartTime": 1628550146,
      "DeletionSummary": {
        "RemainingCount": 0,
        "SummaryItems": [
          {
            "Count": 1,
            "RemainingCount": 0,
            "Version": "1.0"
          }
        ],
        "TotalCount": 1
      },
      "LastStatus": "Complete",
      "LastStatusMessage": "Deletion is successful",
      "LastStatusUpdateTime": 1628550238,
      "TypeName": "Custom:RackInfo"
    }
  ]
}
```

## See Also
<a name="API_DescribeInventoryDeletions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeInventoryDeletions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeInventoryDeletions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeInventoryDeletions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeInventoryDeletions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeInventoryDeletions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeInventoryDeletions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeInventoryDeletions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeInventoryDeletions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeInventoryDeletions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeInventoryDeletions) 

# DescribeMaintenanceWindowExecutions
<a name="API_DescribeMaintenanceWindowExecutions"></a>

Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.

## Request Syntax
<a name="API_DescribeMaintenanceWindowExecutions_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "WindowId": "string"
}
```

## Request Parameters
<a name="API_DescribeMaintenanceWindowExecutions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeMaintenanceWindowExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutions-request-Filters"></a>
Each entry in the array is a structure containing:  
+ Key. A string between 1 and 128 characters. Supported keys include `ExecutedBefore` and `ExecutedAfter`.
+ Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as `2024-11-04T05:00:00Z`.
Type: Array of [MaintenanceWindowFilter](API_MaintenanceWindowFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_DescribeMaintenanceWindowExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutions-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeMaintenanceWindowExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutions-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [WindowId](#API_DescribeMaintenanceWindowExecutions_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutions-request-WindowId"></a>
The ID of the maintenance window whose executions should be retrieved.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeMaintenanceWindowExecutions_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "WindowExecutions": [ 
      { 
         "EndTime": number,
         "StartTime": number,
         "Status": "string",
         "StatusDetails": "string",
         "WindowExecutionId": "string",
         "WindowId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeMaintenanceWindowExecutions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeMaintenanceWindowExecutions_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutions-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [WindowExecutions](#API_DescribeMaintenanceWindowExecutions_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutions-response-WindowExecutions"></a>
Information about the maintenance window executions.  
Type: Array of [MaintenanceWindowExecution](API_MaintenanceWindowExecution.md) objects

## Errors
<a name="API_DescribeMaintenanceWindowExecutions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeMaintenanceWindowExecutions_Examples"></a>

### Example
<a name="API_DescribeMaintenanceWindowExecutions_Example_1"></a>

This example illustrates one usage of DescribeMaintenanceWindowExecutions.

#### Sample Request
<a name="API_DescribeMaintenanceWindowExecutions_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 36
X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowExecutions
X-Amz-Date: 20240312T204551Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

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

#### Sample Response
<a name="API_DescribeMaintenanceWindowExecutions_Example_1_Response"></a>

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

## See Also
<a name="API_DescribeMaintenanceWindowExecutions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeMaintenanceWindowExecutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeMaintenanceWindowExecutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeMaintenanceWindowExecutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeMaintenanceWindowExecutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeMaintenanceWindowExecutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeMaintenanceWindowExecutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeMaintenanceWindowExecutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeMaintenanceWindowExecutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeMaintenanceWindowExecutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeMaintenanceWindowExecutions) 

# DescribeMaintenanceWindowExecutionTaskInvocations
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations"></a>

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

## Request Syntax
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "TaskId": "string",
   "WindowExecutionId": "string"
}
```

## Request Parameters
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeMaintenanceWindowExecutionTaskInvocations_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTaskInvocations-request-Filters"></a>
Optional filters used to scope down the returned task invocations. The supported filter key is `STATUS` with the corresponding values `PENDING`, `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`, `CANCELLING`, and `CANCELLED`.  
Type: Array of [MaintenanceWindowFilter](API_MaintenanceWindowFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_DescribeMaintenanceWindowExecutionTaskInvocations_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTaskInvocations-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeMaintenanceWindowExecutionTaskInvocations_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTaskInvocations-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [TaskId](#API_DescribeMaintenanceWindowExecutionTaskInvocations_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTaskInvocations-request-TaskId"></a>
The ID of the specific task in the maintenance window task that should be retrieved.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

 ** [WindowExecutionId](#API_DescribeMaintenanceWindowExecutionTaskInvocations_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTaskInvocations-request-WindowExecutionId"></a>
The ID of the maintenance window execution the task is part of.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "WindowExecutionTaskInvocationIdentities": [ 
      { 
         "EndTime": number,
         "ExecutionId": "string",
         "InvocationId": "string",
         "OwnerInformation": "string",
         "Parameters": "string",
         "StartTime": number,
         "Status": "string",
         "StatusDetails": "string",
         "TaskExecutionId": "string",
         "TaskType": "string",
         "WindowExecutionId": "string",
         "WindowTargetId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeMaintenanceWindowExecutionTaskInvocations_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTaskInvocations-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [WindowExecutionTaskInvocationIdentities](#API_DescribeMaintenanceWindowExecutionTaskInvocations_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTaskInvocations-response-WindowExecutionTaskInvocationIdentities"></a>
Information about the task invocation results per invocation.  
Type: Array of [MaintenanceWindowExecutionTaskInvocationIdentity](API_MaintenanceWindowExecutionTaskInvocationIdentity.md) objects

## Errors
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations_Examples"></a>

### Example
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations_Example_1"></a>

This example illustrates one usage of DescribeMaintenanceWindowExecutionTaskInvocations.

#### Sample Request
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowExecutionTaskInvocations
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240224T233800Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240224/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 111

{
    "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef4EXAMPLE",
    "TaskId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations_Example_1_Response"></a>

```
{
    "WindowExecutionTaskInvocationIdentities": [
        {            
            "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef4EXAMPLE",
            "TaskExecutionId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE",
            "InvocationId": "0e466033-290b-4d74-9ae0-f33e3EXAMPLE",
            "ExecutionId": "1203cf98-5a79-4ec3-97e9-12e0bEXAMPLE",
            "TaskType": "RUN_COMMAND",
            "Parameters": "{\"comment\":\"\",\"documentName\":\"AWS-ApplyPatchBaseline\",\"instanceIds\":[\"i-00ec29b21eEXAMPLE\",\"i-09911ddd90EXAMPLE\"],\"maxConcurrency\":\"1\",\"maxErrors\":\"1\",\"parameters\":{\"SnapshotId\":[\"\"],\"Operation\":[\"Install\"]},\"timeoutSeconds\":600}",
            "Status": "SUCCESS",
            "StatusDetails": "Success",
            "StartTime": "2024-08-04T11:35:35.170000-07:00",
            "EndTime": "2024-08-04T11:42:11.330000-07:00"
        }
    ]
}
```

## See Also
<a name="API_DescribeMaintenanceWindowExecutionTaskInvocations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations) 

# DescribeMaintenanceWindowExecutionTasks
<a name="API_DescribeMaintenanceWindowExecutionTasks"></a>

For a given maintenance window execution, lists the tasks that were run.

## Request Syntax
<a name="API_DescribeMaintenanceWindowExecutionTasks_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "WindowExecutionId": "string"
}
```

## Request Parameters
<a name="API_DescribeMaintenanceWindowExecutionTasks_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeMaintenanceWindowExecutionTasks_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTasks-request-Filters"></a>
Optional filters used to scope down the returned tasks. The supported filter key is `STATUS` with the corresponding values `PENDING`, `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`, `CANCELLING`, and `CANCELLED`.  
Type: Array of [MaintenanceWindowFilter](API_MaintenanceWindowFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_DescribeMaintenanceWindowExecutionTasks_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTasks-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeMaintenanceWindowExecutionTasks_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTasks-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [WindowExecutionId](#API_DescribeMaintenanceWindowExecutionTasks_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTasks-request-WindowExecutionId"></a>
The ID of the maintenance window execution whose task executions should be retrieved.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeMaintenanceWindowExecutionTasks_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "WindowExecutionTaskIdentities": [ 
      { 
         "AlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "EndTime": number,
         "StartTime": number,
         "Status": "string",
         "StatusDetails": "string",
         "TaskArn": "string",
         "TaskExecutionId": "string",
         "TaskType": "string",
         "TriggeredAlarms": [ 
            { 
               "Name": "string",
               "State": "string"
            }
         ],
         "WindowExecutionId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeMaintenanceWindowExecutionTasks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeMaintenanceWindowExecutionTasks_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTasks-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [WindowExecutionTaskIdentities](#API_DescribeMaintenanceWindowExecutionTasks_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowExecutionTasks-response-WindowExecutionTaskIdentities"></a>
Information about the task executions.  
Type: Array of [MaintenanceWindowExecutionTaskIdentity](API_MaintenanceWindowExecutionTaskIdentity.md) objects

## Errors
<a name="API_DescribeMaintenanceWindowExecutionTasks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeMaintenanceWindowExecutionTasks_Examples"></a>

### Example
<a name="API_DescribeMaintenanceWindowExecutionTasks_Example_1"></a>

This example illustrates one usage of DescribeMaintenanceWindowExecutionTasks.

#### Sample Request
<a name="API_DescribeMaintenanceWindowExecutionTasks_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowExecutionTasks
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240224T234903Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240224/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 61

{
    "WindowExecutionId": "a06e9f91-3b9c-4c3e-8bd4-246ccEXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeMaintenanceWindowExecutionTasks_Example_1_Response"></a>

```
{
    "WindowExecutionTaskIdentities": [
        {
            "WindowExecutionId": "a06e9f91-3b9c-4c3e-8bd4-246ccEXAMPLE",
            "TaskExecutionId": "f407ba63-998f-4b89-8467-279fcEXAMPLE",
            "Status": "SUCCESS",
            "StartTime": "2024-08-04T11:35:35.145000-07:00",
            "EndTime": "2024-08-04T11:38:09.062000-07:00",
            "TaskArn": "AWS-RunPatchBaseline",
            "TaskType": "RUN_COMMAND"
        }
    ]
}
```

## See Also
<a name="API_DescribeMaintenanceWindowExecutionTasks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks) 

# DescribeMaintenanceWindows
<a name="API_DescribeMaintenanceWindows"></a>

Retrieves the maintenance windows in an AWS account.

## Request Syntax
<a name="API_DescribeMaintenanceWindows_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeMaintenanceWindows_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeMaintenanceWindows_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindows-request-Filters"></a>
Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are `Name` and `Enabled`. For example, `Name=MyMaintenanceWindow` and `Enabled=True`.  
Type: Array of [MaintenanceWindowFilter](API_MaintenanceWindowFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_DescribeMaintenanceWindows_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindows-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeMaintenanceWindows_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindows-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeMaintenanceWindows_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "WindowIdentities": [ 
      { 
         "Cutoff": number,
         "Description": "string",
         "Duration": number,
         "Enabled": boolean,
         "EndDate": "string",
         "Name": "string",
         "NextExecutionTime": "string",
         "Schedule": "string",
         "ScheduleOffset": number,
         "ScheduleTimezone": "string",
         "StartDate": "string",
         "WindowId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeMaintenanceWindows_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeMaintenanceWindows_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindows-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [WindowIdentities](#API_DescribeMaintenanceWindows_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindows-response-WindowIdentities"></a>
Information about the maintenance windows.  
Type: Array of [MaintenanceWindowIdentity](API_MaintenanceWindowIdentity.md) objects

## Errors
<a name="API_DescribeMaintenanceWindows_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeMaintenanceWindows_Examples"></a>

### Example
<a name="API_DescribeMaintenanceWindows_Example_1"></a>

This example illustrates one usage of DescribeMaintenanceWindows.

#### Sample Request
<a name="API_DescribeMaintenanceWindows_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: AmazonSSM.DescribeMaintenanceWindows
X-Amz-Date: 20240312T202609Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Filters": [
        {
            "Values": [
                "true"
            ],
            "Key": "Enabled"
        }
    ]
}
```

#### Sample Response
<a name="API_DescribeMaintenanceWindows_Example_1_Response"></a>

```
{
    "WindowIdentities": [
        {
            "WindowId": "mw-0c5ed765acEXAMPLE",
            "Name": "Windows-Testing-Maintenance-Window",
            "Description": "Standard maintenance windows for Test Servers",
            "Enabled": true,
            "Duration": 6,
            "Cutoff": 2,
            "Schedule": "rate(2 weeks)",
            "NextExecutionTime": "2024-02-24T23:52:15.099Z"
        },
        {
            "WindowId": "mw-0c50858d01EXAMPLE",
            "Name": "Windows-Staging-Maintenance-Window",
            "Description": "Standard maintenance windows for Staging Servers",
            "Enabled": true,
            "Duration": 10,
            "Cutoff": 4,
            "Schedule": "cron(0 0 6 ? * MON *)",
            "NextExecutionTime": "2024-03-02T06:00:00.099Z"
        },
        {
            "WindowId": "mw-07f80c1841EXAMPLE",
            "Cutoff": 4,
            "Name": "Windows-Production-Maintenance-Window",
            "Description": "Standard maintenance windows for Production Servers",
            "Enabled": true,
            "Duration": 10,
            "Schedule": "cron(0 0 6 ? * WED *)",
            "NextExecutionTime": "2024-03-05T06:00:00.099Z"
        }
    ]
}
```

## See Also
<a name="API_DescribeMaintenanceWindows_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeMaintenanceWindows) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeMaintenanceWindows) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeMaintenanceWindows) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeMaintenanceWindows) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeMaintenanceWindows) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeMaintenanceWindows) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeMaintenanceWindows) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeMaintenanceWindows) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeMaintenanceWindows) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeMaintenanceWindows) 

# DescribeMaintenanceWindowSchedule
<a name="API_DescribeMaintenanceWindowSchedule"></a>

Retrieves information about upcoming executions of a maintenance window.

## Request Syntax
<a name="API_DescribeMaintenanceWindowSchedule_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "ResourceType": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "WindowId": "string"
}
```

## Request Parameters
<a name="API_DescribeMaintenanceWindowSchedule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeMaintenanceWindowSchedule_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowSchedule-request-Filters"></a>
Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.  
Type: Array of [PatchOrchestratorFilter](API_PatchOrchestratorFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_DescribeMaintenanceWindowSchedule_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowSchedule-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_DescribeMaintenanceWindowSchedule_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowSchedule-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [ResourceType](#API_DescribeMaintenanceWindowSchedule_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowSchedule-request-ResourceType"></a>
The type of resource you want to retrieve information about. For example, `INSTANCE`.  
Type: String  
Valid Values: `INSTANCE | RESOURCE_GROUP`   
Required: No

 ** [Targets](#API_DescribeMaintenanceWindowSchedule_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowSchedule-request-Targets"></a>
The managed node ID or key-value pair to retrieve information about.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [WindowId](#API_DescribeMaintenanceWindowSchedule_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowSchedule-request-WindowId"></a>
The ID of the maintenance window to retrieve information about.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: No

## Response Syntax
<a name="API_DescribeMaintenanceWindowSchedule_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "ScheduledWindowExecutions": [ 
      { 
         "ExecutionTime": "string",
         "Name": "string",
         "WindowId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeMaintenanceWindowSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeMaintenanceWindowSchedule_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowSchedule-response-NextToken"></a>
The token for the next set of items to return. (You use this token in the next call.)  
Type: String

 ** [ScheduledWindowExecutions](#API_DescribeMaintenanceWindowSchedule_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowSchedule-response-ScheduledWindowExecutions"></a>
Information about maintenance window executions scheduled for the specified time range.  
Type: Array of [ScheduledWindowExecution](API_ScheduledWindowExecution.md) objects

## Errors
<a name="API_DescribeMaintenanceWindowSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeMaintenanceWindowSchedule_Examples"></a>

### Example
<a name="API_DescribeMaintenanceWindowSchedule_Example_1"></a>

This example illustrates one usage of DescribeMaintenanceWindowSchedule.

#### Sample Request
<a name="API_DescribeMaintenanceWindowSchedule_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowSchedule
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240224T235938Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240224/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 36

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

#### Sample Response
<a name="API_DescribeMaintenanceWindowSchedule_Example_1_Response"></a>

```
{
    "NextToken": "EXAMPLE/39c3b3042cd2aEXAMPLEAKIAIOSFODNN7EXAMPLE==",
    "ScheduledWindowExecutions": [
        {
            "ExecutionTime": "2024-02-25T00:00:15.099Z",
            "Name": "MyMaintenanceWindow",
            "WindowId": "mw-0c50858d01EXAMPLE"
        },
        {
            "ExecutionTime": "2024-02-26T00:00:15.099Z",
            "Name": "MyMaintenanceWindow",
            "WindowId": "mw-0c50858d01EXAMPLE"
        },
        {
            "ExecutionTime": "2024-02-27T00:00:15.099Z",
            "Name": "MyMaintenanceWindow",
            "WindowId": "mw-0c50858d01EXAMPLE"
        }
    ]
}
```

## See Also
<a name="API_DescribeMaintenanceWindowSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeMaintenanceWindowSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeMaintenanceWindowSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeMaintenanceWindowSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeMaintenanceWindowSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeMaintenanceWindowSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeMaintenanceWindowSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeMaintenanceWindowSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeMaintenanceWindowSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeMaintenanceWindowSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeMaintenanceWindowSchedule) 

# DescribeMaintenanceWindowsForTarget
<a name="API_DescribeMaintenanceWindowsForTarget"></a>

Retrieves information about the maintenance window targets or tasks that a managed node is associated with.

## Request Syntax
<a name="API_DescribeMaintenanceWindowsForTarget_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "ResourceType": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ]
}
```

## Request Parameters
<a name="API_DescribeMaintenanceWindowsForTarget_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_DescribeMaintenanceWindowsForTarget_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowsForTarget-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_DescribeMaintenanceWindowsForTarget_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowsForTarget-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [ResourceType](#API_DescribeMaintenanceWindowsForTarget_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowsForTarget-request-ResourceType"></a>
The type of resource you want to retrieve information about. For example, `INSTANCE`.  
Type: String  
Valid Values: `INSTANCE | RESOURCE_GROUP`   
Required: Yes

 ** [Targets](#API_DescribeMaintenanceWindowsForTarget_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowsForTarget-request-Targets"></a>
The managed node ID or key-value pair to retrieve information about.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: Yes

## Response Syntax
<a name="API_DescribeMaintenanceWindowsForTarget_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "WindowIdentities": [ 
      { 
         "Name": "string",
         "WindowId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeMaintenanceWindowsForTarget_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeMaintenanceWindowsForTarget_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowsForTarget-response-NextToken"></a>
The token for the next set of items to return. (You use this token in the next call.)  
Type: String

 ** [WindowIdentities](#API_DescribeMaintenanceWindowsForTarget_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowsForTarget-response-WindowIdentities"></a>
Information about the maintenance window targets and tasks a managed node is associated with.  
Type: Array of [MaintenanceWindowIdentityForTarget](API_MaintenanceWindowIdentityForTarget.md) objects

## Errors
<a name="API_DescribeMaintenanceWindowsForTarget_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeMaintenanceWindowsForTarget_Examples"></a>

### Example
<a name="API_DescribeMaintenanceWindowsForTarget_Example_1"></a>

This example illustrates one usage of DescribeMaintenanceWindowsForTarget.

#### Sample Request
<a name="API_DescribeMaintenanceWindowsForTarget_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowsForTarget
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T003520Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 100

{
    "Targets": [
        {
            "Key": "InstanceIds",
            "Values": [
                "i-07782c72faEXAMPLE"
            ]
        }
    ],
    "ResourceType": "INSTANCE"
}
```

#### Sample Response
<a name="API_DescribeMaintenanceWindowsForTarget_Example_1_Response"></a>

```
{
    "WindowIdentities": [
        {
            "Name": "MyFirstMaintenanceWindow",
            "WindowId": "mw-0c50858d01EXAMPLE"
        },
        {
            "Name": "MySecondMaintenanceWindow",
            "WindowId": "mw-05aaf9f490EXAMPLE"
        },
        {
            "Name": "MyThirdMaintenanceWindow",
            "WindowId": "mw-0ecb1226ddEXAMPLE"
        }
    ]
}
```

## See Also
<a name="API_DescribeMaintenanceWindowsForTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget) 

# DescribeMaintenanceWindowTargets
<a name="API_DescribeMaintenanceWindowTargets"></a>

Lists the targets registered with the maintenance window.

## Request Syntax
<a name="API_DescribeMaintenanceWindowTargets_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "WindowId": "string"
}
```

## Request Parameters
<a name="API_DescribeMaintenanceWindowTargets_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeMaintenanceWindowTargets_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTargets-request-Filters"></a>
Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are `Type`, `WindowTargetId`, and `OwnerInformation`.  
Type: Array of [MaintenanceWindowFilter](API_MaintenanceWindowFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_DescribeMaintenanceWindowTargets_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTargets-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeMaintenanceWindowTargets_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTargets-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [WindowId](#API_DescribeMaintenanceWindowTargets_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTargets-request-WindowId"></a>
The ID of the maintenance window whose targets should be retrieved.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeMaintenanceWindowTargets_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Targets": [ 
      { 
         "Description": "string",
         "Name": "string",
         "OwnerInformation": "string",
         "ResourceType": "string",
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "WindowId": "string",
         "WindowTargetId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeMaintenanceWindowTargets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeMaintenanceWindowTargets_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTargets-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [Targets](#API_DescribeMaintenanceWindowTargets_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTargets-response-Targets"></a>
Information about the targets in the maintenance window.  
Type: Array of [MaintenanceWindowTarget](API_MaintenanceWindowTarget.md) objects

## Errors
<a name="API_DescribeMaintenanceWindowTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeMaintenanceWindowTargets_Examples"></a>

### Example
<a name="API_DescribeMaintenanceWindowTargets_Example_1"></a>

This example illustrates one usage of DescribeMaintenanceWindowTargets.

#### Sample Request
<a name="API_DescribeMaintenanceWindowTargets_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowTargets
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T003928Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 36

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

#### Sample Response
<a name="API_DescribeMaintenanceWindowTargets_Example_1_Response"></a>

```
{
    "Targets": [
        {            
            "WindowId": "mw-0c50858d01EXAMPLE",
            "Name": "MyTargets",
            "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE",
            "ResourceType": "INSTANCE",
            "Targets": [
                {
                    "Key": "InstanceIds",
                    "Values": [
                        "i-02573cafcfEXAMPLE",
                        "i-0471e04240EXAMPLE"
                    ]
                }
            ]
        },
        {            
            "WindowId": "mw-0c50858d01EXAMPLE",
            "WindowTargetId": "7f4813bb-df25-4e59-b34f-c9e83EXAMPLE",
            "ResourceType": "INSTANCE",
            "Targets": [
                {
                    "Key": "InstanceIds",
                    "Values": [
                        "i-07782c72faEXAMPLE"
                    ]
                }
            ]
        }
    ]
}
```

## See Also
<a name="API_DescribeMaintenanceWindowTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeMaintenanceWindowTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeMaintenanceWindowTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeMaintenanceWindowTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeMaintenanceWindowTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeMaintenanceWindowTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeMaintenanceWindowTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeMaintenanceWindowTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeMaintenanceWindowTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeMaintenanceWindowTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeMaintenanceWindowTargets) 

# DescribeMaintenanceWindowTasks
<a name="API_DescribeMaintenanceWindowTasks"></a>

Lists the tasks in a maintenance window.

**Note**  
For maintenance window tasks without a specified target, you can't supply values for `--max-errors` and `--max-concurrency`. Instead, the system inserts a placeholder value of `1`, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

## Request Syntax
<a name="API_DescribeMaintenanceWindowTasks_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "WindowId": "string"
}
```

## Request Parameters
<a name="API_DescribeMaintenanceWindowTasks_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeMaintenanceWindowTasks_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTasks-request-Filters"></a>
Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are `WindowTaskId`, `TaskArn`, `Priority`, and `TaskType`.  
Type: Array of [MaintenanceWindowFilter](API_MaintenanceWindowFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_DescribeMaintenanceWindowTasks_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTasks-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeMaintenanceWindowTasks_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTasks-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [WindowId](#API_DescribeMaintenanceWindowTasks_RequestSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTasks-request-WindowId"></a>
The ID of the maintenance window whose tasks should be retrieved.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeMaintenanceWindowTasks_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Tasks": [ 
      { 
         "AlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "CutoffBehavior": "string",
         "Description": "string",
         "LoggingInfo": { 
            "S3BucketName": "string",
            "S3KeyPrefix": "string",
            "S3Region": "string"
         },
         "MaxConcurrency": "string",
         "MaxErrors": "string",
         "Name": "string",
         "Priority": number,
         "ServiceRoleArn": "string",
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "TaskArn": "string",
         "TaskParameters": { 
            "string" : { 
               "Values": [ "string" ]
            }
         },
         "Type": "string",
         "WindowId": "string",
         "WindowTaskId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeMaintenanceWindowTasks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeMaintenanceWindowTasks_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTasks-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [Tasks](#API_DescribeMaintenanceWindowTasks_ResponseSyntax) **   <a name="systemsmanager-DescribeMaintenanceWindowTasks-response-Tasks"></a>
Information about the tasks in the maintenance window.  
Type: Array of [MaintenanceWindowTask](API_MaintenanceWindowTask.md) objects

## Errors
<a name="API_DescribeMaintenanceWindowTasks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeMaintenanceWindowTasks_Examples"></a>

### Example
<a name="API_DescribeMaintenanceWindowTasks_Example_1"></a>

This example illustrates one usage of DescribeMaintenanceWindowTasks.

#### Sample Request
<a name="API_DescribeMaintenanceWindowTasks_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowTasks
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T004311Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 36

{
    "WindowId": "mw-0ecb1226dd7bEXAMPLE"
}
```

#### Sample Response
<a name="API_DescribeMaintenanceWindowTasks_Example_1_Response"></a>

```
{
    "Tasks": [
        {
            "WindowId": "mw-0ecb1226ddEXAMPLE",
            "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::111122223333:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
            "Targets": [
                {
                    "Key": "WindowTargetIds",
                    "Values": [
                        "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE"
                    ]
                }
            ]
        },
        {
            "WindowId": "mw-0ecb1226ddEXAMPLE",
            "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::111122223333:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
            "Targets": [
                {
                    "Key": "WindowTargetIds",
                    "Values": [
                        "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE"
                    ]
                }
            ]
        }
    ]
}
```

## See Also
<a name="API_DescribeMaintenanceWindowTasks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeMaintenanceWindowTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeMaintenanceWindowTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeMaintenanceWindowTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeMaintenanceWindowTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeMaintenanceWindowTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeMaintenanceWindowTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeMaintenanceWindowTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeMaintenanceWindowTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeMaintenanceWindowTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeMaintenanceWindowTasks) 

# DescribeOpsItems
<a name="API_DescribeOpsItems"></a>

Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see [Set up OpsCenter](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) in the * AWS Systems Manager User Guide*.

Operations engineers and IT professionals use AWS Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see [AWS Systems Manager OpsCenter](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the * AWS Systems Manager User Guide*. 

## Request Syntax
<a name="API_DescribeOpsItems_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "OpsItemFilters": [ 
      { 
         "Key": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ]
}
```

## Request Parameters
<a name="API_DescribeOpsItems_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_DescribeOpsItems_RequestSyntax) **   <a name="systemsmanager-DescribeOpsItems-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeOpsItems_RequestSyntax) **   <a name="systemsmanager-DescribeOpsItems-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Type: String  
Required: No

 ** [OpsItemFilters](#API_DescribeOpsItems_RequestSyntax) **   <a name="systemsmanager-DescribeOpsItems-request-OpsItemFilters"></a>
One or more filters to limit the response.  
+ Key: CreatedTime

  Operations: GreaterThan, LessThan
+ Key: LastModifiedBy

  Operations: Contains, Equals
+ Key: LastModifiedTime

  Operations: GreaterThan, LessThan
+ Key: Priority

  Operations: Equals
+ Key: Source

  Operations: Contains, Equals
+ Key: Status

  Operations: Equals
+ Key: Title\$1

  Operations: Equals,Contains
+ Key: OperationalData\$1\$1

  Operations: Equals
+ Key: OperationalDataKey

  Operations: Equals
+ Key: OperationalDataValue

  Operations: Equals, Contains
+ Key: OpsItemId

  Operations: Equals
+ Key: ResourceId

  Operations: Contains
+ Key: AutomationId

  Operations: Equals
+ Key: AccountId

  Operations: Equals
\$1The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.  
\$1\$1If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: \$1"key":"key\$1name","value":"a\$1value"\$1  
Type: Array of [OpsItemFilter](API_OpsItemFilter.md) objects  
Required: No

## Response Syntax
<a name="API_DescribeOpsItems_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "OpsItemSummaries": [ 
      { 
         "ActualEndTime": number,
         "ActualStartTime": number,
         "Category": "string",
         "CreatedBy": "string",
         "CreatedTime": number,
         "LastModifiedBy": "string",
         "LastModifiedTime": number,
         "OperationalData": { 
            "string" : { 
               "Type": "string",
               "Value": "string"
            }
         },
         "OpsItemId": "string",
         "OpsItemType": "string",
         "PlannedEndTime": number,
         "PlannedStartTime": number,
         "Priority": number,
         "Severity": "string",
         "Source": "string",
         "Status": "string",
         "Title": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeOpsItems_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeOpsItems_ResponseSyntax) **   <a name="systemsmanager-DescribeOpsItems-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

 ** [OpsItemSummaries](#API_DescribeOpsItems_ResponseSyntax) **   <a name="systemsmanager-DescribeOpsItems-response-OpsItemSummaries"></a>
A list of OpsItems.  
Type: Array of [OpsItemSummary](API_OpsItemSummary.md) objects

## Errors
<a name="API_DescribeOpsItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeOpsItems_Examples"></a>

### Example
<a name="API_DescribeOpsItems_Example_1"></a>

This example illustrates one usage of DescribeOpsItems.

#### Sample Request
<a name="API_DescribeOpsItems_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeOpsItems
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240401T163154Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 80

{
    "OpsItemFilters": [
        {
            "Key": "Status",
            "Values": [
                "Open"
            ],
            "Operator": "Equal"
        }
    ]
}
```

#### Sample Response
<a name="API_DescribeOpsItems_Example_1_Response"></a>

```
{
    "OpsItemSummaries": [
        {
            "CreatedBy": "arn:aws:iam::111122223333:user/example",
            "CreatedTime": 1585757579.218,
            "LastModifiedBy": "arn:aws:iam::111122223333:user/example",
            "LastModifiedTime": 1585757579.218,
            "OpsItemId": "oi-1f050EXAMPLE",
            "Source": "SSM",
            "Status": "Open",
            "Title": "DocumentDeleted"
        },
        {
            "Category": "Availability",
            "CreatedBy": "arn:aws:sts::111122223333:assumed-role/OpsCenterRole/af3935bb93783f02aeea51784EXAMPLE",
            "CreatedTime": 1582701517.193,
            "LastModifiedBy": "arn:aws:sts::111122223333:assumed-role/OpsCenterRole/af3935bb93783f02aeea51784EXAMPLE",
            "LastModifiedTime": 1582701517.193,
            "OperationalData": {
                "/aws/dedup": {
                    "Type": "SearchableString",
                    "Value": "{\"dedupString\":\"SSMOpsItems-SSM-maintenance-window-execution-failed\"}"
                },
                "/aws/resources": {
                    "Type": "SearchableString",
                    "Value": "[{\"arn\":\"arn:aws:ssm:us-east-2:111122223333:maintenancewindow/mw-0e357ebdc6EXAMPLE\"}]"
                }
            },
            "OpsItemId": "oi-f99f2EXAMPLE",
            "Severity": "3",
            "Source": "SSM",
            "Status": "Open",
            "Title": "SSM Maintenance Window execution failed"
        }
    ]
}
```

## See Also
<a name="API_DescribeOpsItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeOpsItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeOpsItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeOpsItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeOpsItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeOpsItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeOpsItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeOpsItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeOpsItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeOpsItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeOpsItems) 

# DescribeParameters
<a name="API_DescribeParameters"></a>

Lists the parameters in your AWS account or the parameters shared with you when you enable the [Shared](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribeParameters.html#systemsmanager-DescribeParameters-request-Shared) option.

Request results are returned on a best-effort basis. If you specify `MaxResults` in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of `MaxResults`. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a `NextToken`. You can specify the `NextToken` in a subsequent call to get the next set of results.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a `ValidationException` error.

**Important**  
If you change the AWS KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, `DescribeParameters` retrieves whatever the original key alias was referencing.

## Request Syntax
<a name="API_DescribeParameters_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "ParameterFilters": [ 
      { 
         "Key": "string",
         "Option": "string",
         "Values": [ "string" ]
      }
   ],
   "Shared": boolean
}
```

## Request Parameters
<a name="API_DescribeParameters_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeParameters_RequestSyntax) **   <a name="systemsmanager-DescribeParameters-request-Filters"></a>
This data type is deprecated. Instead, use `ParameterFilters`.  
Type: Array of [ParametersFilter](API_ParametersFilter.md) objects  
Required: No

 ** [MaxResults](#API_DescribeParameters_RequestSyntax) **   <a name="systemsmanager-DescribeParameters-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeParameters_RequestSyntax) **   <a name="systemsmanager-DescribeParameters-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [ParameterFilters](#API_DescribeParameters_RequestSyntax) **   <a name="systemsmanager-DescribeParameters-request-ParameterFilters"></a>
Filters to limit the request results.  
Type: Array of [ParameterStringFilter](API_ParameterStringFilter.md) objects  
Required: No

 ** [Shared](#API_DescribeParameters_RequestSyntax) **   <a name="systemsmanager-DescribeParameters-request-Shared"></a>
Lists parameters that are shared with you.  
By default when using this option, the command returns parameters that have been shared using a standard AWS Resource Access Manager Resource Share. In order for a parameter that was shared using the [PutResourcePolicy](API_PutResourcePolicy.md) command to be returned, the associated ` AWS RAM Resource Share Created From Policy` must have been promoted to a standard Resource Share using the AWS RAM [PromoteResourceShareCreatedFromPolicy](https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) API operation.  
For more information about sharing parameters, see [Working with shared parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html) in the * AWS Systems Manager User Guide*.
Type: Boolean  
Required: No

## Response Syntax
<a name="API_DescribeParameters_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Parameters": [ 
      { 
         "AllowedPattern": "string",
         "ARN": "string",
         "DataType": "string",
         "Description": "string",
         "KeyId": "string",
         "LastModifiedDate": number,
         "LastModifiedUser": "string",
         "Name": "string",
         "Policies": [ 
            { 
               "PolicyStatus": "string",
               "PolicyText": "string",
               "PolicyType": "string"
            }
         ],
         "Tier": "string",
         "Type": "string",
         "Version": number
      }
   ]
}
```

## Response Elements
<a name="API_DescribeParameters_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeParameters_ResponseSyntax) **   <a name="systemsmanager-DescribeParameters-response-NextToken"></a>
The token to use when requesting the next set of items.  
Type: String

 ** [Parameters](#API_DescribeParameters_ResponseSyntax) **   <a name="systemsmanager-DescribeParameters-response-Parameters"></a>
Parameters returned by the request.  
Type: Array of [ParameterMetadata](API_ParameterMetadata.md) objects

## Errors
<a name="API_DescribeParameters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilterKey **   
The specified key isn't valid.  
HTTP Status Code: 400

 ** InvalidFilterOption **   
The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.    
 ** message **   
The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
HTTP Status Code: 400

 ** InvalidFilterValue **   
The filter value isn't valid. Verify the value and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeParameters_Examples"></a>

### Example
<a name="API_DescribeParameters_Example_1"></a>

This example illustrates one usage of DescribeParameters.

#### Sample Request
<a name="API_DescribeParameters_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 95
X-Amz-Target: AmazonSSM.DescribeParameters
X-Amz-Date: 20240316T010204Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "ParameterFilters": [
        {
            "Values": [
                "String"
            ],
            "Key": "Type"
        },
        {
            "Values": [
                "/Branch312"
            ],
            "Key": "Name"
        }
    ]
}
```

#### Sample Response
<a name="API_DescribeParameters_Example_1_Response"></a>

```
{
    "Parameters": [
        {
            "LastModifiedDate": 1521160696.821,
            "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson",
            "Name": "/Branch312/Dev/Engineer1",
            "Policies": [],
            "Type": "String",
            "Version": 1,
            "Tier": "Standard"
        },
        {
            "LastModifiedDate": 1521160709.358,
            "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson",
            "Name": "/Branch312/Dev/Engineer2",
            "Policies": [],
            "Type": "String",
            "Version": 1,
            "Tier": "Standard"
        },
        {
            "LastModifiedDate": 1521160717.945,
            "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson",
            "Name": "/Branch312/Dev/Engineer3",
            "Policies": [],
            "Type": "String",
            "Version": 1,
            "Tier": "Standard"
        },
        {
            "LastModifiedDate": 1521160747.499,
            "LastModifiedUser": "arn:aws:iam::111122223333:user/Mary.Major",
            "Name": "/Branch312/Dev/Intern",
            "Policies": [
                {
                    "PolicyStatus": "Pending",
                    "PolicyText": "{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2024-03-31T17:00:00Z\"}}",
                    "PolicyType": "Expiration"
                },
                {
                    "PolicyStatus": "Pending",
                    "PolicyText": "{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"14\",\"Unit\":\"Days\"}}",
                    "PolicyType": "ExpirationNotification"
                }
            ],
            "Type": "String",
            "Version": 1,
            "Tier": "Standard"
        },
        {
            "LastModifiedDate": 1521160588.291,
            "LastModifiedUser": "arn:aws:iam::111122223333:user/John.Stiles",
            "Name": "/Branch312/Dev/TeamLead",
            "Policies": [],
            "Type": "String",
            "Version": 1,
            "Tier": "Standard"
        }
    ]
}
```

## See Also
<a name="API_DescribeParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeParameters) 

# DescribePatchBaselines
<a name="API_DescribePatchBaselines"></a>

Lists the patch baselines in your AWS account.

## Request Syntax
<a name="API_DescribePatchBaselines_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribePatchBaselines_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribePatchBaselines_RequestSyntax) **   <a name="systemsmanager-DescribePatchBaselines-request-Filters"></a>
Each element in the array is a structure containing a key-value pair.  
Supported keys for `DescribePatchBaselines` include the following:  
+  ** `NAME_PREFIX` ** 

  Sample values: `AWS-` \$1 `My-` 
+  ** `OWNER` ** 

  Sample values: `AWS` \$1 `Self` 
+  ** `OPERATING_SYSTEM` ** 

  Sample values: `AMAZON_LINUX` \$1 `SUSE` \$1 `WINDOWS` 
Type: Array of [PatchOrchestratorFilter](API_PatchOrchestratorFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_DescribePatchBaselines_RequestSyntax) **   <a name="systemsmanager-DescribePatchBaselines-request-MaxResults"></a>
The maximum number of patch baselines to return (per page).  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribePatchBaselines_RequestSyntax) **   <a name="systemsmanager-DescribePatchBaselines-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribePatchBaselines_ResponseSyntax"></a>

```
{
   "BaselineIdentities": [ 
      { 
         "BaselineDescription": "string",
         "BaselineId": "string",
         "BaselineName": "string",
         "DefaultBaseline": boolean,
         "OperatingSystem": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribePatchBaselines_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BaselineIdentities](#API_DescribePatchBaselines_ResponseSyntax) **   <a name="systemsmanager-DescribePatchBaselines-response-BaselineIdentities"></a>
An array of `PatchBaselineIdentity` elements.  
Type: Array of [PatchBaselineIdentity](API_PatchBaselineIdentity.md) objects

 ** [NextToken](#API_DescribePatchBaselines_ResponseSyntax) **   <a name="systemsmanager-DescribePatchBaselines-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_DescribePatchBaselines_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribePatchBaselines_Examples"></a>

### Example
<a name="API_DescribePatchBaselines_Example_1"></a>

This example illustrates one usage of DescribePatchBaselines.

#### Sample Request
<a name="API_DescribePatchBaselines_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: AmazonSSM.DescribePatchBaselines
X-Amz-Date: 20240309T024139Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{}
```

#### Sample Response
<a name="API_DescribePatchBaselines_Example_1_Response"></a>

```
{
    "BaselineIdentities": [
        {
            "BaselineDescription": "Default Patch Baseline for Suse Provided by AWS.",
            "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-07d8884178EXAMPLE",
            "BaselineName": "AWS-SuseDefaultPatchBaseline",
            "DefaultBaseline": true,
            "OperatingSystem": "SUSE"
        },
        {
            "BaselineDescription": "Default Patch Baseline Provided by AWS.",
            "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-09ca3fb51fEXAMPLE",
            "BaselineName": "AWS-DefaultPatchBaseline",
            "DefaultBaseline": true,
            "OperatingSystem": "WINDOWS"
        },
        {
            "BaselineDescription": "Default Patch Baseline for Amazon Linux Provided by AWS.",
            "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-0c10e65780EXAMPLE",
            "BaselineName": "AWS-AmazonLinuxDefaultPatchBaseline",
            "DefaultBaseline": true,
            "OperatingSystem": "AMAZON_LINUX"
        },
        {
            "BaselineDescription": "Default Patch Baseline for Ubuntu Provided by AWS.",
            "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-0c7e89f711EXAMPLE",
            "BaselineName": "AWS-UbuntuDefaultPatchBaseline",
            "DefaultBaseline": true,
            "OperatingSystem": "UBUNTU"
        },
        {
            "BaselineDescription": "Default Patch Baseline for Redhat Enterprise Linux Provided by AWS.",
            "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-0cbb3a633dEXAMPLE",
            "BaselineName": "AWS-RedHatDefaultPatchBaseline",
            "DefaultBaseline": true,
            "OperatingSystem": "REDHAT_ENTERPRISE_LINUX"
        }
        // There may be more content here
    ]
}
```

## See Also
<a name="API_DescribePatchBaselines_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribePatchBaselines) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribePatchBaselines) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribePatchBaselines) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribePatchBaselines) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribePatchBaselines) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribePatchBaselines) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribePatchBaselines) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribePatchBaselines) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribePatchBaselines) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribePatchBaselines) 

# DescribePatchGroups
<a name="API_DescribePatchGroups"></a>

Lists all patch groups that have been registered with patch baselines.

## Request Syntax
<a name="API_DescribePatchGroups_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribePatchGroups_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribePatchGroups_RequestSyntax) **   <a name="systemsmanager-DescribePatchGroups-request-Filters"></a>
Each element in the array is a structure containing a key-value pair.  
Supported keys for `DescribePatchGroups` include the following:  
+  ** `NAME_PREFIX` ** 

  Sample values: `AWS-` \$1 `My-`.
+  ** `OPERATING_SYSTEM` ** 

  Sample values: `AMAZON_LINUX` \$1 `SUSE` \$1 `WINDOWS` 
Type: Array of [PatchOrchestratorFilter](API_PatchOrchestratorFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_DescribePatchGroups_RequestSyntax) **   <a name="systemsmanager-DescribePatchGroups-request-MaxResults"></a>
The maximum number of patch groups to return (per page).  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribePatchGroups_RequestSyntax) **   <a name="systemsmanager-DescribePatchGroups-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribePatchGroups_ResponseSyntax"></a>

```
{
   "Mappings": [ 
      { 
         "BaselineIdentity": { 
            "BaselineDescription": "string",
            "BaselineId": "string",
            "BaselineName": "string",
            "DefaultBaseline": boolean,
            "OperatingSystem": "string"
         },
         "PatchGroup": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribePatchGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Mappings](#API_DescribePatchGroups_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroups-response-Mappings"></a>
Each entry in the array contains:  
+  `PatchGroup`: string (between 1 and 256 characters. Regex: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$)` 
+  `PatchBaselineIdentity`: A `PatchBaselineIdentity` element.
Type: Array of [PatchGroupPatchBaselineMapping](API_PatchGroupPatchBaselineMapping.md) objects

 ** [NextToken](#API_DescribePatchGroups_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroups-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_DescribePatchGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribePatchGroups_Examples"></a>

### Example
<a name="API_DescribePatchGroups_Example_1"></a>

This example illustrates one usage of DescribePatchGroups.

#### Sample Request
<a name="API_DescribePatchGroups_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: AmazonSSM.DescribePatchGroups
X-Amz-Date: 20240308T211212Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{}
```

#### Sample Response
<a name="API_DescribePatchGroups_Example_1_Response"></a>

```
{
    "Mappings": [
        {
            "PatchGroup": "Database Servers",
            "BaselineIdentity": {
                "BaselineName": "Windows-Server-2012R2",
                "DefaultBaseline": false,
                "BaselineDescription": "Windows Server 2012 R2, Important and Critical security updates",
                "BaselineId": "pb-0c4e592064EXAMPLE",
                "OperatingSystem": "WINDOWS"
            }
        },
        {
            "PatchGroup": "Production",
            "BaselineIdentity": {
                "BaselineName": "Windows-Server-2012R2",
                "DefaultBaseline": false,
                "BaselineDescription": "Windows Server 2012 R2, Important and Critical security updates",
                "BaselineId": "pb-0c4e592064EXAMPLE",
                "OperatingSystem": "WINDOWS"
            }
        },
        {
            "PatchGroup": "Production",
            "BaselineIdentity": {
                "BaselineName": "Amazon-Linux-Production",
                "DefaultBaseline": false,
                "BaselineDescription": "Patch baseline used for production instances",
                "BaselineId": "pb-022cbaf99cEXAMPLE",
                "OperatingSystem": "AMAZON_LINUX"
            }
        },
        {
            "PatchGroup": "Production",
            "BaselineIdentity": {
                "BaselineName": "RHEL-ZeroDay-Critical",
                "DefaultBaseline": false,
                "BaselineId": "pb-0ea5bc85f4EXAMPLE",
                "OperatingSystem": "REDHAT_ENTERPRISE_LINUX"
            }
        },
        {
            "PatchGroup": "Production-Demo",
            "BaselineIdentity": {
                "BaselineName": "Only-Security-Patches",
                "DefaultBaseline": false,
                "BaselineDescription": "Security updates for all versions of Windows",
                "BaselineId": "pb-08521bdf9eEXAMPLE",
                "OperatingSystem": "WINDOWS"
            }
        }
    ]
}
```

## See Also
<a name="API_DescribePatchGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribePatchGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribePatchGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribePatchGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribePatchGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribePatchGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribePatchGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribePatchGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribePatchGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribePatchGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribePatchGroups) 

# DescribePatchGroupState
<a name="API_DescribePatchGroupState"></a>

Returns high-level aggregated patch compliance state information for a patch group.

## Request Syntax
<a name="API_DescribePatchGroupState_RequestSyntax"></a>

```
{
   "PatchGroup": "string"
}
```

## Request Parameters
<a name="API_DescribePatchGroupState_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [PatchGroup](#API_DescribePatchGroupState_RequestSyntax) **   <a name="systemsmanager-DescribePatchGroupState-request-PatchGroup"></a>
The name of the patch group whose patch snapshot should be retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## Response Syntax
<a name="API_DescribePatchGroupState_ResponseSyntax"></a>

```
{
   "Instances": number,
   "InstancesWithAvailableSecurityUpdates": number,
   "InstancesWithCriticalNonCompliantPatches": number,
   "InstancesWithFailedPatches": number,
   "InstancesWithInstalledOtherPatches": number,
   "InstancesWithInstalledPatches": number,
   "InstancesWithInstalledPendingRebootPatches": number,
   "InstancesWithInstalledRejectedPatches": number,
   "InstancesWithMissingPatches": number,
   "InstancesWithNotApplicablePatches": number,
   "InstancesWithOtherNonCompliantPatches": number,
   "InstancesWithSecurityNonCompliantPatches": number,
   "InstancesWithUnreportedNotApplicablePatches": number
}
```

## Response Elements
<a name="API_DescribePatchGroupState_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Instances](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-Instances"></a>
The number of managed nodes in the patch group.  
Type: Integer

 ** [InstancesWithAvailableSecurityUpdates](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithAvailableSecurityUpdates"></a>
The number of managed nodes for which security-related patches are available but not approved because because they didn't meet the patch baseline requirements. For example, an updated version of a patch might have been released before the specified auto-approval period was over.  
Applies to Windows Server managed nodes only.  
Type: Integer

 ** [InstancesWithCriticalNonCompliantPatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithCriticalNonCompliantPatches"></a>
The number of managed nodes where patches that are specified as `Critical` for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is `NON_COMPLIANT`.  
Type: Integer

 ** [InstancesWithFailedPatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithFailedPatches"></a>
The number of managed nodes with patches from the patch baseline that failed to install.  
Type: Integer

 ** [InstancesWithInstalledOtherPatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithInstalledOtherPatches"></a>
The number of managed nodes with patches installed that aren't defined in the patch baseline.  
Type: Integer

 ** [InstancesWithInstalledPatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithInstalledPatches"></a>
The number of managed nodes with installed patches.  
Type: Integer

 ** [InstancesWithInstalledPendingRebootPatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithInstalledPendingRebootPatches"></a>
The number of managed nodes with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these managed nodes is `NON_COMPLIANT`.  
Type: Integer

 ** [InstancesWithInstalledRejectedPatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithInstalledRejectedPatches"></a>
The number of managed nodes with patches installed that are specified in a `RejectedPatches` list. Patches with a status of `INSTALLED_REJECTED` were typically installed before they were added to a `RejectedPatches` list.  
If `ALLOW_AS_DEPENDENCY` is the specified option for `RejectedPatchesAction`, the value of `InstancesWithInstalledRejectedPatches` will always be `0` (zero).
Type: Integer

 ** [InstancesWithMissingPatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithMissingPatches"></a>
The number of managed nodes with missing patches from the patch baseline.  
Type: Integer

 ** [InstancesWithNotApplicablePatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithNotApplicablePatches"></a>
The number of managed nodes with patches that aren't applicable.  
Type: Integer

 ** [InstancesWithOtherNonCompliantPatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithOtherNonCompliantPatches"></a>
The number of managed nodes with patches installed that are specified as other than `Critical` or `Security` but aren't compliant with the patch baseline. The status of these managed nodes is `NON_COMPLIANT`.  
Type: Integer

 ** [InstancesWithSecurityNonCompliantPatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithSecurityNonCompliantPatches"></a>
The number of managed nodes where patches that are specified as `Security` in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is `NON_COMPLIANT`.  
Type: Integer

 ** [InstancesWithUnreportedNotApplicablePatches](#API_DescribePatchGroupState_ResponseSyntax) **   <a name="systemsmanager-DescribePatchGroupState-response-InstancesWithUnreportedNotApplicablePatches"></a>
The number of managed nodes with `NotApplicable` patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a tool in AWS Systems Manager.  
Type: Integer

## Errors
<a name="API_DescribePatchGroupState_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribePatchGroupState_Examples"></a>

### Example
<a name="API_DescribePatchGroupState_Example_1"></a>

This example illustrates one usage of DescribePatchGroupState.

#### Sample Request
<a name="API_DescribePatchGroupState_Example_1_Request"></a>

```
POST / HTTP/1.1
  Host: ssm.us-east-2.amazonaws.com
  Accept-Encoding: identity
  Content-Length: 33
  X-Amz-Target: AmazonSSM.DescribePatchGroupState
  X-Amz-Date: 20240308T205757Z
  User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
  Content-Type: application/x-amz-json-1.1
  Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/aws4_request, 
  SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
  
  {
    "PatchGroup": "mypatchgroup"
}
```

#### Sample Response
<a name="API_DescribePatchGroupState_Example_1_Response"></a>

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

## See Also
<a name="API_DescribePatchGroupState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribePatchGroupState) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribePatchGroupState) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribePatchGroupState) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribePatchGroupState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribePatchGroupState) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribePatchGroupState) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribePatchGroupState) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribePatchGroupState) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribePatchGroupState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribePatchGroupState) 

# DescribePatchProperties
<a name="API_DescribePatchProperties"></a>

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as [CreatePatchBaseline](API_CreatePatchBaseline.md), [UpdatePatchBaseline](API_UpdatePatchBaseline.md), [DescribeAvailablePatches](API_DescribeAvailablePatches.md), and [DescribePatchBaselines](API_DescribePatchBaselines.md).

The following section lists the properties that can be used in filters for each major operating system type:

AMAZON\$1LINUX  
Valid properties: `PRODUCT` \$1 `CLASSIFICATION` \$1 `SEVERITY` 

AMAZON\$1LINUX\$12  
Valid properties: `PRODUCT` \$1 `CLASSIFICATION` \$1 `SEVERITY` 

AMAZON\$1LINUX\$12023  
Valid properties: `PRODUCT` \$1 `CLASSIFICATION` \$1 `SEVERITY` 

CENTOS  
Valid properties: `PRODUCT` \$1 `CLASSIFICATION` \$1 `SEVERITY` 

DEBIAN  
Valid properties: `PRODUCT` \$1 `PRIORITY` 

MACOS  
Valid properties: `PRODUCT` \$1 `CLASSIFICATION` 

ORACLE\$1LINUX  
Valid properties: `PRODUCT` \$1 `CLASSIFICATION` \$1 `SEVERITY` 

REDHAT\$1ENTERPRISE\$1LINUX  
Valid properties: `PRODUCT` \$1 `CLASSIFICATION` \$1 `SEVERITY` 

SUSE  
Valid properties: `PRODUCT` \$1 `CLASSIFICATION` \$1 `SEVERITY` 

UBUNTU  
Valid properties: `PRODUCT` \$1 `PRIORITY` 

WINDOWS  
Valid properties: `PRODUCT` \$1 `PRODUCT_FAMILY` \$1 `CLASSIFICATION` \$1 `MSRC_SEVERITY` 

## Request Syntax
<a name="API_DescribePatchProperties_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "OperatingSystem": "string",
   "PatchSet": "string",
   "Property": "string"
}
```

## Request Parameters
<a name="API_DescribePatchProperties_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_DescribePatchProperties_RequestSyntax) **   <a name="systemsmanager-DescribePatchProperties-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribePatchProperties_RequestSyntax) **   <a name="systemsmanager-DescribePatchProperties-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [OperatingSystem](#API_DescribePatchProperties_RequestSyntax) **   <a name="systemsmanager-DescribePatchProperties-request-OperatingSystem"></a>
The operating system type for which to list patches.  
Type: String  
Valid Values: `WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023`   
Required: Yes

 ** [PatchSet](#API_DescribePatchProperties_RequestSyntax) **   <a name="systemsmanager-DescribePatchProperties-request-PatchSet"></a>
Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.  
Type: String  
Valid Values: `OS | APPLICATION`   
Required: No

 ** [Property](#API_DescribePatchProperties_RequestSyntax) **   <a name="systemsmanager-DescribePatchProperties-request-Property"></a>
The patch property for which you want to view patch details.   
Type: String  
Valid Values: `PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY | PRIORITY | SEVERITY`   
Required: Yes

## Response Syntax
<a name="API_DescribePatchProperties_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Properties": [ 
      { 
         "string" : "string" 
      }
   ]
}
```

## Response Elements
<a name="API_DescribePatchProperties_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribePatchProperties_ResponseSyntax) **   <a name="systemsmanager-DescribePatchProperties-response-NextToken"></a>
The token for the next set of items to return. (You use this token in the next call.)  
Type: String

 ** [Properties](#API_DescribePatchProperties_ResponseSyntax) **   <a name="systemsmanager-DescribePatchProperties-response-Properties"></a>
A list of the properties for patches matching the filter request parameters.  
Type: Array of string to string maps  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Value Length Constraints: Minimum length of 0. Maximum length of 4096.

## Errors
<a name="API_DescribePatchProperties_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_DescribePatchProperties_Examples"></a>

### Example
<a name="API_DescribePatchProperties_Example_1"></a>

This example illustrates one usage of DescribePatchProperties.

#### Sample Request
<a name="API_DescribePatchProperties_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 95
X-Amz-Target: AmazonSSM.DescribePatchProperties
X-Amz-Date: 20240312T010204Z
User-Agent: aws-cli/1.16.96 Python/2.7.15 Windows/10 botocore/1.12.86
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "OperatingSystem": "Windows",
    "Property": "PRODUCT",
    "PatchSet": "OS"
}
```

#### Sample Response
<a name="API_DescribePatchProperties_Example_1_Response"></a>

```
{
    "Properties": [        
        {
            "Name": "WindowsServer2012",
            "ProductFamily": "Windows"
        },
        {
            "Name": "WindowsServer2012R2",
            "ProductFamily": "Windows"
        },
        {
            "Name": "WindowsServer2016",
            "ProductFamily": "Windows"
        },
        {
            "Name": "WindowsServer2019",
            "ProductFamily": "Windows"
        }
    ]
}
```

## See Also
<a name="API_DescribePatchProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribePatchProperties) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribePatchProperties) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribePatchProperties) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribePatchProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribePatchProperties) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribePatchProperties) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribePatchProperties) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribePatchProperties) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribePatchProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribePatchProperties) 

# DescribeSessions
<a name="API_DescribeSessions"></a>

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

## Request Syntax
<a name="API_DescribeSessions_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "State": "string"
}
```

## Request Parameters
<a name="API_DescribeSessions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_DescribeSessions_RequestSyntax) **   <a name="systemsmanager-DescribeSessions-request-Filters"></a>
One or more filters to limit the type of sessions returned by the request.  
Type: Array of [SessionFilter](API_SessionFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 6 items.  
Required: No

 ** [MaxResults](#API_DescribeSessions_RequestSyntax) **   <a name="systemsmanager-DescribeSessions-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 200.  
Required: No

 ** [NextToken](#API_DescribeSessions_RequestSyntax) **   <a name="systemsmanager-DescribeSessions-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [State](#API_DescribeSessions_RequestSyntax) **   <a name="systemsmanager-DescribeSessions-request-State"></a>
The session status to retrieve a list of sessions for. For example, "Active".  
Type: String  
Valid Values: `Active | History`   
Required: Yes

## Response Syntax
<a name="API_DescribeSessions_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Sessions": [ 
      { 
         "AccessType": "string",
         "Details": "string",
         "DocumentName": "string",
         "EndDate": number,
         "MaxSessionDuration": "string",
         "OutputUrl": { 
            "CloudWatchOutputUrl": "string",
            "S3OutputUrl": "string"
         },
         "Owner": "string",
         "Reason": "string",
         "SessionId": "string",
         "StartDate": number,
         "Status": "string",
         "Target": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeSessions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_DescribeSessions_ResponseSyntax) **   <a name="systemsmanager-DescribeSessions-response-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String

 ** [Sessions](#API_DescribeSessions_ResponseSyntax) **   <a name="systemsmanager-DescribeSessions-response-Sessions"></a>
A list of sessions meeting the request parameters.  
Type: Array of [Session](API_Session.md) objects

## Errors
<a name="API_DescribeSessions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilterKey **   
The specified key isn't valid.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeSessions_Examples"></a>

### Example
<a name="API_DescribeSessions_Example_1"></a>

This example illustrates one usage of DescribeSessions.

#### Sample Request
<a name="API_DescribeSessions_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeSessions
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T175636Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 20

{
    "State": "History"
}
```

#### Sample Response
<a name="API_DescribeSessions_Example_1_Response"></a>

```
{
    "Sessions": [
        {
            "EndDate": 1582069847.807,
            "OutputUrl": {
                "S3OutputUrl": "https://us-east-2.console.aws.amazon.com/s3/object/amzn-s3-demo-bucket/session-data/Mary-Major-0ab177d470EXAMPLE.log"
            },
            "Owner": "arn:aws:iam::111122223333:user/Mary-Major",
            "SessionId": "Mary-Major-0ab177d470EXAMPLE",
            "StartDate": 1582068633.188,
            "Status": "Terminated",
            "Target": "i-07782c72faEXAMPLE"
        }
        // There may be more content here
    ]
}
```

## See Also
<a name="API_DescribeSessions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DescribeSessions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DescribeSessions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DescribeSessions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DescribeSessions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeSessions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DescribeSessions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DescribeSessions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DescribeSessions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeSessions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DescribeSessions) 

# DisassociateOpsItemRelatedItem
<a name="API_DisassociateOpsItemRelatedItem"></a>

Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in AWS Systems Manager.

## Request Syntax
<a name="API_DisassociateOpsItemRelatedItem_RequestSyntax"></a>

```
{
   "AssociationId": "string",
   "OpsItemId": "string"
}
```

## Request Parameters
<a name="API_DisassociateOpsItemRelatedItem_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AssociationId](#API_DisassociateOpsItemRelatedItem_RequestSyntax) **   <a name="systemsmanager-DisassociateOpsItemRelatedItem-request-AssociationId"></a>
The ID of the association for which you want to delete an association between the OpsItem and a related item.  
Type: String  
Required: Yes

 ** [OpsItemId](#API_DisassociateOpsItemRelatedItem_RequestSyntax) **   <a name="systemsmanager-DisassociateOpsItemRelatedItem-request-OpsItemId"></a>
The ID of the OpsItem for which you want to delete an association between the OpsItem and a related item.  
Type: String  
Pattern: `^(oi)-[0-9a-f]{12}$`   
Required: Yes

## Response Elements
<a name="API_DisassociateOpsItemRelatedItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateOpsItemRelatedItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsItemConflictException **   
The specified OpsItem is in the process of being deleted.  
HTTP Status Code: 400

 ** OpsItemInvalidParameterException **   
A specified parameter argument isn't valid. Verify the available arguments and try again.  
HTTP Status Code: 400

 ** OpsItemNotFoundException **   
The specified OpsItem ID doesn't exist. Verify the ID and try again.  
HTTP Status Code: 400

 ** OpsItemRelatedItemAssociationNotFoundException **   
The association wasn't found using the parameters you specified in the call. Verify the information and try again.  
HTTP Status Code: 400

## Examples
<a name="API_DisassociateOpsItemRelatedItem_Examples"></a>

### Example
<a name="API_DisassociateOpsItemRelatedItem_Example_1"></a>

This example illustrates one usage of DisassociateOpsItemRelatedItem.

#### Sample Request
<a name="API_DisassociateOpsItemRelatedItem_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DisassociateOpsItemRelatedItem
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm.disassociate-ops-item-related-item
X-Amz-Date: 20240910T182919Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240910/us-east-1/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 89

{
	"OpsItemId": "oi-f99f2EXAMPLE", 
	"AssociationId": "e2036148-cccb-490e-ac2a-390e5EXAMPLE"
}
```

#### Sample Response
<a name="API_DisassociateOpsItemRelatedItem_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DisassociateOpsItemRelatedItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/DisassociateOpsItemRelatedItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/DisassociateOpsItemRelatedItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DisassociateOpsItemRelatedItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/DisassociateOpsItemRelatedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DisassociateOpsItemRelatedItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/DisassociateOpsItemRelatedItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/DisassociateOpsItemRelatedItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/DisassociateOpsItemRelatedItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DisassociateOpsItemRelatedItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DisassociateOpsItemRelatedItem) 

# GetAccessToken
<a name="API_GetAccessToken"></a>

Returns a credentials set to be used with just-in-time node access.

## Request Syntax
<a name="API_GetAccessToken_RequestSyntax"></a>

```
{
   "AccessRequestId": "string"
}
```

## Request Parameters
<a name="API_GetAccessToken_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AccessRequestId](#API_GetAccessToken_RequestSyntax) **   <a name="systemsmanager-GetAccessToken-request-AccessRequestId"></a>
The ID of a just-in-time node access request.  
Type: String  
Pattern: `^(oi)-[0-9a-f]{12}$`   
Required: Yes

## Response Syntax
<a name="API_GetAccessToken_ResponseSyntax"></a>

```
{
   "AccessRequestStatus": "string",
   "Credentials": { 
      "AccessKeyId": "string",
      "ExpirationTime": number,
      "SecretAccessKey": "string",
      "SessionToken": "string"
   }
}
```

## Response Elements
<a name="API_GetAccessToken_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccessRequestStatus](#API_GetAccessToken_ResponseSyntax) **   <a name="systemsmanager-GetAccessToken-response-AccessRequestStatus"></a>
The status of the access request.  
Type: String  
Valid Values: `Approved | Rejected | Revoked | Expired | Pending` 

 ** [Credentials](#API_GetAccessToken_ResponseSyntax) **   <a name="systemsmanager-GetAccessToken-response-Credentials"></a>
The temporary security credentials which can be used to start just-in-time node access sessions.  
Type: [Credentials](API_Credentials.md) object

## Errors
<a name="API_GetAccessToken_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requester doesn't have permissions to perform the requested operation.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified parameter to be shared could not be found.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request or operation couldn't be performed because the service is throttling requests.    
 ** QuotaCode **   
The quota code recognized by the AWS Service Quotas service.  
 ** ServiceCode **   
The code for the AWS service that owns the quota.
HTTP Status Code: 400

 ** ValidationException **   
The request isn't valid. Verify that you entered valid contents for the command and try again.    
 ** ReasonCode **   
The reason code for the invalid request.
HTTP Status Code: 400

## See Also
<a name="API_GetAccessToken_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetAccessToken) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetAccessToken) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetAccessToken) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetAccessToken) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetAccessToken) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetAccessToken) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetAccessToken) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetAccessToken) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetAccessToken) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetAccessToken) 

# GetAutomationExecution
<a name="API_GetAutomationExecution"></a>

Get detailed information about a particular Automation execution.

## Request Syntax
<a name="API_GetAutomationExecution_RequestSyntax"></a>

```
{
   "AutomationExecutionId": "string"
}
```

## Request Parameters
<a name="API_GetAutomationExecution_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AutomationExecutionId](#API_GetAutomationExecution_RequestSyntax) **   <a name="systemsmanager-GetAutomationExecution-request-AutomationExecutionId"></a>
The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated.  
Type: String  
Length Constraints: Fixed length of 36.  
Required: Yes

## Response Syntax
<a name="API_GetAutomationExecution_ResponseSyntax"></a>

```
{
   "AutomationExecution": { 
      "AlarmConfiguration": { 
         "Alarms": [ 
            { 
               "Name": "string"
            }
         ],
         "IgnorePollAlarmFailure": boolean
      },
      "AssociationId": "string",
      "AutomationExecutionId": "string",
      "AutomationExecutionStatus": "string",
      "AutomationSubtype": "string",
      "ChangeRequestName": "string",
      "CurrentAction": "string",
      "CurrentStepName": "string",
      "DocumentName": "string",
      "DocumentVersion": "string",
      "ExecutedBy": "string",
      "ExecutionEndTime": number,
      "ExecutionStartTime": number,
      "FailureMessage": "string",
      "MaxConcurrency": "string",
      "MaxErrors": "string",
      "Mode": "string",
      "OpsItemId": "string",
      "Outputs": { 
         "string" : [ "string" ]
      },
      "Parameters": { 
         "string" : [ "string" ]
      },
      "ParentAutomationExecutionId": "string",
      "ProgressCounters": { 
         "CancelledSteps": number,
         "FailedSteps": number,
         "SuccessSteps": number,
         "TimedOutSteps": number,
         "TotalSteps": number
      },
      "ResolvedTargets": { 
         "ParameterValues": [ "string" ],
         "Truncated": boolean
      },
      "Runbooks": [ 
         { 
            "DocumentName": "string",
            "DocumentVersion": "string",
            "MaxConcurrency": "string",
            "MaxErrors": "string",
            "Parameters": { 
               "string" : [ "string" ]
            },
            "TargetLocations": [ 
               { 
                  "Accounts": [ "string" ],
                  "ExcludeAccounts": [ "string" ],
                  "ExecutionRoleName": "string",
                  "IncludeChildOrganizationUnits": boolean,
                  "Regions": [ "string" ],
                  "TargetLocationAlarmConfiguration": { 
                     "Alarms": [ 
                        { 
                           "Name": "string"
                        }
                     ],
                     "IgnorePollAlarmFailure": boolean
                  },
                  "TargetLocationMaxConcurrency": "string",
                  "TargetLocationMaxErrors": "string",
                  "Targets": [ 
                     { 
                        "Key": "string",
                        "Values": [ "string" ]
                     }
                  ],
                  "TargetsMaxConcurrency": "string",
                  "TargetsMaxErrors": "string"
               }
            ],
            "TargetMaps": [ 
               { 
                  "string" : [ "string" ]
               }
            ],
            "TargetParameterName": "string",
            "Targets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ]
         }
      ],
      "ScheduledTime": number,
      "StepExecutions": [ 
         { 
            "Action": "string",
            "ExecutionEndTime": number,
            "ExecutionStartTime": number,
            "FailureDetails": { 
               "Details": { 
                  "string" : [ "string" ]
               },
               "FailureStage": "string",
               "FailureType": "string"
            },
            "FailureMessage": "string",
            "Inputs": { 
               "string" : "string" 
            },
            "IsCritical": boolean,
            "IsEnd": boolean,
            "MaxAttempts": number,
            "NextStep": "string",
            "OnFailure": "string",
            "Outputs": { 
               "string" : [ "string" ]
            },
            "OverriddenParameters": { 
               "string" : [ "string" ]
            },
            "ParentStepDetails": { 
               "Action": "string",
               "Iteration": number,
               "IteratorValue": "string",
               "StepExecutionId": "string",
               "StepName": "string"
            },
            "Response": "string",
            "ResponseCode": "string",
            "StepExecutionId": "string",
            "StepName": "string",
            "StepStatus": "string",
            "TargetLocation": { 
               "Accounts": [ "string" ],
               "ExcludeAccounts": [ "string" ],
               "ExecutionRoleName": "string",
               "IncludeChildOrganizationUnits": boolean,
               "Regions": [ "string" ],
               "TargetLocationAlarmConfiguration": { 
                  "Alarms": [ 
                     { 
                        "Name": "string"
                     }
                  ],
                  "IgnorePollAlarmFailure": boolean
               },
               "TargetLocationMaxConcurrency": "string",
               "TargetLocationMaxErrors": "string",
               "Targets": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ],
               "TargetsMaxConcurrency": "string",
               "TargetsMaxErrors": "string"
            },
            "Targets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ],
            "TimeoutSeconds": number,
            "TriggeredAlarms": [ 
               { 
                  "Name": "string",
                  "State": "string"
               }
            ],
            "ValidNextSteps": [ "string" ]
         }
      ],
      "StepExecutionsTruncated": boolean,
      "Target": "string",
      "TargetLocations": [ 
         { 
            "Accounts": [ "string" ],
            "ExcludeAccounts": [ "string" ],
            "ExecutionRoleName": "string",
            "IncludeChildOrganizationUnits": boolean,
            "Regions": [ "string" ],
            "TargetLocationAlarmConfiguration": { 
               "Alarms": [ 
                  { 
                     "Name": "string"
                  }
               ],
               "IgnorePollAlarmFailure": boolean
            },
            "TargetLocationMaxConcurrency": "string",
            "TargetLocationMaxErrors": "string",
            "Targets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ],
            "TargetsMaxConcurrency": "string",
            "TargetsMaxErrors": "string"
         }
      ],
      "TargetLocationsURL": "string",
      "TargetMaps": [ 
         { 
            "string" : [ "string" ]
         }
      ],
      "TargetParameterName": "string",
      "Targets": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ],
      "TriggeredAlarms": [ 
         { 
            "Name": "string",
            "State": "string"
         }
      ],
      "Variables": { 
         "string" : [ "string" ]
      }
   }
}
```

## Response Elements
<a name="API_GetAutomationExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AutomationExecution](#API_GetAutomationExecution_ResponseSyntax) **   <a name="systemsmanager-GetAutomationExecution-response-AutomationExecution"></a>
Detailed information about the current state of an automation execution.  
Type: [AutomationExecution](API_AutomationExecution.md) object

## Errors
<a name="API_GetAutomationExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AutomationExecutionNotFoundException **   
There is no automation execution information for the requested automation execution ID.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_GetAutomationExecution_Examples"></a>

### Example
<a name="API_GetAutomationExecution_Example_1"></a>

This example illustrates one usage of GetAutomationExecution.

#### Sample Request
<a name="API_GetAutomationExecution_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetAutomationExecution
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T185532Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 65

{
    "AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE"
}
```

#### Sample Response
<a name="API_GetAutomationExecution_Example_1_Response"></a>

```
{
    "AutomationExecution": {
        "AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE",
        "AutomationExecutionStatus": "Success",
        "DocumentName": "CreateImage",
        "DocumentVersion": "1",
        "ExecutedBy": "arn:aws:sts::111122223333:assumed-role/Example",
        "ExecutionEndTime": 1585062669.053,
        "ExecutionStartTime": 1585061570.827,
        "Mode": "Auto",
        "Outputs": {},
        "Parameters": {
            "InstanceId": [
                "i-02573cafcfEXAMPLE"
            ]
        },
        "ResolvedTargets": {
            "ParameterValues": [],
            "Truncated": false
        },
        "StepExecutions": [
            {
                "Action": "aws:createImage",
                "ExecutionEndTime": 1585062668.968,
                "ExecutionStartTime": 1585061571.144,
                "Inputs": {
                    "ImageDescription": "\"AMI for i-02573cafcfEXAMPLE created on 2020-03-24_14.52.51\"",
                    "ImageName": "\"i-02573cafcfEXAMPLE-2020-03-24_14.52.51\"",
                    "InstanceId": "\"i-02573cafcfEXAMPLE\"",
                    "NoReboot": "false"
                },
                "OnFailure": "Abort",
                "Outputs": {
                    "ImageId": [
                        "ami-0f4706cb37EXAMPLE"
                    ],
                    "ImageState": [
                        "available"
                    ],
                    "OutputPayload": [
                        "{\"ImageId\":\"ami-0f4706cb37EXAMPLE\",\"ImageState\":\"available\"}"
                    ]
                },
                "OverriddenParameters": {},
                "StepExecutionId": "eff80946-356d-4128-97b2-6a0f5EXAMPLE",
                "StepName": "createImage",
                "StepStatus": "Success"
            }
        ],
        "StepExecutionsTruncated": false,
        "Targets": []
    }
}
```

## See Also
<a name="API_GetAutomationExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetAutomationExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetAutomationExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetAutomationExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetAutomationExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetAutomationExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetAutomationExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetAutomationExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetAutomationExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetAutomationExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetAutomationExecution) 

# GetCalendarState
<a name="API_GetCalendarState"></a>

Gets the state of a AWS Systems Manager change calendar at the current time or a specified time. If you specify a time, `GetCalendarState` returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, `GetCalendarState` uses the current time. Change Calendar entries have two possible states: `OPEN` or `CLOSED`.

If you specify more than one calendar in a request, the command returns the status of `OPEN` only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is `CLOSED`.

For more information about Change Calendar, a tool in AWS Systems Manager, see [AWS Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html) in the * AWS Systems Manager User Guide*.

## Request Syntax
<a name="API_GetCalendarState_RequestSyntax"></a>

```
{
   "AtTime": "string",
   "CalendarNames": [ "string" ]
}
```

## Request Parameters
<a name="API_GetCalendarState_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AtTime](#API_GetCalendarState_RequestSyntax) **   <a name="systemsmanager-GetCalendarState-request-AtTime"></a>
(Optional) The specific time for which you want to get calendar state information, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If you don't specify a value or `AtTime`, the current time is used.  
Type: String  
Required: No

 ** [CalendarNames](#API_GetCalendarState_RequestSyntax) **   <a name="systemsmanager-GetCalendarState-request-CalendarNames"></a>
The names of Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.  
Type: Array of strings  
Required: Yes

## Response Syntax
<a name="API_GetCalendarState_ResponseSyntax"></a>

```
{
   "AtTime": "string",
   "NextTransitionTime": "string",
   "State": "string"
}
```

## Response Elements
<a name="API_GetCalendarState_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AtTime](#API_GetCalendarState_ResponseSyntax) **   <a name="systemsmanager-GetCalendarState-response-AtTime"></a>
The time, as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string, that you specified in your command. If you don't specify a time, `GetCalendarState` uses the current time.  
Type: String

 ** [NextTransitionTime](#API_GetCalendarState_ResponseSyntax) **   <a name="systemsmanager-GetCalendarState-response-NextTransitionTime"></a>
The time, as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string, that the calendar state will change. If the current calendar state is `OPEN`, `NextTransitionTime` indicates when the calendar state changes to `CLOSED`, and vice-versa.  
Type: String

 ** [State](#API_GetCalendarState_ResponseSyntax) **   <a name="systemsmanager-GetCalendarState-response-State"></a>
The state of the calendar. An `OPEN` calendar indicates that actions are allowed to proceed, and a `CLOSED` calendar indicates that actions aren't allowed to proceed.  
Type: String  
Valid Values: `OPEN | CLOSED` 

## Errors
<a name="API_GetCalendarState_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentType **   
The SSM document type isn't valid. Valid document types are described in the `DocumentType` property.  
HTTP Status Code: 400

 ** UnsupportedCalendarException **   
The calendar entry contained in the specified SSM document isn't supported.  
HTTP Status Code: 400

## Examples
<a name="API_GetCalendarState_Examples"></a>

### Example
<a name="API_GetCalendarState_Example_1"></a>

This example illustrates one usage of GetCalendarState.

#### Sample Request
<a name="API_GetCalendarState_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetCalendarState
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240224T191829Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 67

{
    "CalendarNames": [
        "MyCalendar"
    ],
    "AtTime": "2024-02-25T19:05:47Z"
}
```

#### Sample Response
<a name="API_GetCalendarState_Example_1_Response"></a>

```
{
    "AtTime": "2024-02-25T19:05:47Z",
    "State": "OPEN"
}
```

## See Also
<a name="API_GetCalendarState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetCalendarState) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetCalendarState) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetCalendarState) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetCalendarState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetCalendarState) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetCalendarState) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetCalendarState) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetCalendarState) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetCalendarState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetCalendarState) 

# GetCommandInvocation
<a name="API_GetCommandInvocation"></a>

Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.

 `GetCommandInvocation` only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use [ListCommandInvocations](API_ListCommandInvocations.md). To get the command execution status across managed nodes, use [ListCommands](API_ListCommands.md).

## Request Syntax
<a name="API_GetCommandInvocation_RequestSyntax"></a>

```
{
   "CommandId": "string",
   "InstanceId": "string",
   "PluginName": "string"
}
```

## Request Parameters
<a name="API_GetCommandInvocation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CommandId](#API_GetCommandInvocation_RequestSyntax) **   <a name="systemsmanager-GetCommandInvocation-request-CommandId"></a>
(Required) The parent command ID of the invocation plugin.  
Type: String  
Length Constraints: Fixed length of 36.  
Required: Yes

 ** [InstanceId](#API_GetCommandInvocation_RequestSyntax) **   <a name="systemsmanager-GetCommandInvocation-request-InstanceId"></a>
(Required) The ID of the managed node targeted by the command. A *managed node* can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for AWS Systems Manager.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: Yes

 ** [PluginName](#API_GetCommandInvocation_RequestSyntax) **   <a name="systemsmanager-GetCommandInvocation-request-PluginName"></a>
The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like `aws:RunShellScript`.  
To find the `PluginName`, check the document content and find the name of the step you want details for. Alternatively, use [ListCommandInvocations](API_ListCommandInvocations.md) with the `CommandId` and `Details` parameters. The `PluginName` is the `Name` attribute of the `CommandPlugin` object in the `CommandPlugins` list.  
Type: String  
Length Constraints: Minimum length of 4.  
Required: No

## Response Syntax
<a name="API_GetCommandInvocation_ResponseSyntax"></a>

```
{
   "CloudWatchOutputConfig": { 
      "CloudWatchLogGroupName": "string",
      "CloudWatchOutputEnabled": boolean
   },
   "CommandId": "string",
   "Comment": "string",
   "DocumentName": "string",
   "DocumentVersion": "string",
   "ExecutionElapsedTime": "string",
   "ExecutionEndDateTime": "string",
   "ExecutionStartDateTime": "string",
   "InstanceId": "string",
   "PluginName": "string",
   "ResponseCode": number,
   "StandardErrorContent": "string",
   "StandardErrorUrl": "string",
   "StandardOutputContent": "string",
   "StandardOutputUrl": "string",
   "Status": "string",
   "StatusDetails": "string"
}
```

## Response Elements
<a name="API_GetCommandInvocation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CloudWatchOutputConfig](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-CloudWatchOutputConfig"></a>
Amazon CloudWatch Logs information where Systems Manager sent the command output.  
Type: [CloudWatchOutputConfig](API_CloudWatchOutputConfig.md) object

 ** [CommandId](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-CommandId"></a>
The parent command ID of the invocation plugin.  
Type: String  
Length Constraints: Fixed length of 36.

 ** [Comment](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-Comment"></a>
The comment text for the command.  
Type: String  
Length Constraints: Maximum length of 100.

 ** [DocumentName](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-DocumentName"></a>
The name of the document that was run. For example, `AWS-RunShellScript`.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$` 

 ** [DocumentVersion](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-DocumentVersion"></a>
The Systems Manager document (SSM document) version used in the request.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` 

 ** [ExecutionElapsedTime](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-ExecutionElapsedTime"></a>
Duration since `ExecutionStartDateTime`.  
Type: String  
Pattern: `^([\-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d(?!:))?)?(\17[0-5]\d([\.,]\d)?)?([zZ]|([\-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$` 

 ** [ExecutionEndDateTime](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-ExecutionEndDateTime"></a>
The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the `InvokedAfter` filter.  
 `aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z`   
If the plugin hasn't started to run, the string is empty.  
Type: String  
Pattern: `^([\-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d(?!:))?)?(\17[0-5]\d([\.,]\d)?)?([zZ]|([\-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$` 

 ** [ExecutionStartDateTime](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-ExecutionStartDateTime"></a>
The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the `InvokedBefore` filter.  
 `aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z`   
If the plugin hasn't started to run, the string is empty.  
Type: String  
Pattern: `^([\-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d(?!:))?)?(\17[0-5]\d([\.,]\d)?)?([zZ]|([\-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$` 

 ** [InstanceId](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-InstanceId"></a>
The ID of the managed node targeted by the command. A *managed node* can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for AWS Systems Manager.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)` 

 ** [PluginName](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-PluginName"></a>
The name of the plugin, or *step name*, for which details are reported. For example, `aws:RunShellScript` is a plugin.  
Type: String  
Length Constraints: Minimum length of 4.

 ** [ResponseCode](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-ResponseCode"></a>
The error level response code for the plugin script. If the response code is `-1`, then the command hasn't started running on the managed node, or it wasn't received by the node.  
Type: Integer

 ** [StandardErrorContent](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-StandardErrorContent"></a>
The first 8,000 characters written by the plugin to `stderr`. If the command hasn't finished running, then this string is empty.  
Type: String  
Length Constraints: Maximum length of 8000.

 ** [StandardErrorUrl](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-StandardErrorUrl"></a>
The URL for the complete text written by the plugin to `stderr`. If the command hasn't finished running, then this string is empty.  
Type: String

 ** [StandardOutputContent](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-StandardOutputContent"></a>
The first 24,000 characters written by the plugin to `stdout`. If the command hasn't finished running, if `ExecutionStatus` is neither Succeeded nor Failed, then this string is empty.  
Type: String  
Length Constraints: Maximum length of 24000.

 ** [StandardOutputUrl](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-StandardOutputUrl"></a>
The URL for the complete text written by the plugin to `stdout` in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.  
Type: String

 ** [Status](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-Status"></a>
The status of this invocation plugin. This status can be different than `StatusDetails`.  
Type: String  
Valid Values: `Pending | InProgress | Delayed | Success | Cancelled | TimedOut | Failed | Cancelling` 

 ** [StatusDetails](#API_GetCommandInvocation_ResponseSyntax) **   <a name="systemsmanager-GetCommandInvocation-response-StatusDetails"></a>
A detailed status of the command execution for an invocation. `StatusDetails` includes more information than `Status` because it includes states resulting from error and concurrency control parameters. `StatusDetails` can show different results than `Status`. For more information about these statuses, see [Understanding command statuses](https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) in the * AWS Systems Manager User Guide*. `StatusDetails` can be one of the following values:  
+ Pending: The command hasn't been sent to the managed node.
+ In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
+ Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.
+ Success: The command or plugin ran successfully. This is a terminal state.
+ Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's `MaxErrors` limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
+ Execution Timed Out: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the `MaxErrors` limit of the parent command. This is a terminal state.
+ Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the `MaxErrors` limit of the parent command. This is a terminal state.
+ Cancelled: The command was terminated before it was completed. This is a terminal state.
+ Undeliverable: The command can't be delivered to the managed node. The node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's `MaxErrors` limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
+ Terminated: The parent command exceeded its `MaxErrors` limit and subsequent command invocations were canceled by the system. This is a terminal state.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.

## Errors
<a name="API_GetCommandInvocation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidCommandId **   
The specified command ID isn't valid. Verify the ID and try again.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidPluginName **   
The plugin name isn't valid.  
HTTP Status Code: 400

 ** InvocationDoesNotExist **   
The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and the managed node ID and try again.   
HTTP Status Code: 400

## Examples
<a name="API_GetCommandInvocation_Examples"></a>

### Example
<a name="API_GetCommandInvocation_Example_1"></a>

This example illustrates one usage of GetCommandInvocation.

#### Sample Request
<a name="API_GetCommandInvocation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetCommandInvocation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240220T235111Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240220/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 90

{
    "CommandId": "32d70fe0-ddbc-4a4e-943f-ffcbcEXAMPLE",
    "InstanceId": "i-02573cafcfEXAMPLE"
}
```

#### Sample Response
<a name="API_GetCommandInvocation_Example_1_Response"></a>

```
{
    "CloudWatchOutputConfig": {
        "CloudWatchLogGroupName": "",
        "CloudWatchOutputEnabled": false
    },
    "CommandId": "32d70fe0-ddbc-4a4e-943f-ffcbcEXAMPLE",
    "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE",
    "DocumentName": "AWS-UpdateSSMAgent",
    "DocumentVersion": "",
    "ExecutionElapsedTime": "PT44.002S",
    "ExecutionEndDateTime": "2024-02-20T23:35:26.758Z",
    "ExecutionStartDateTime": "2024-02-20T23:34:42.758Z",
    "InstanceId": "i-02573cafcfEXAMPLE",
    "PluginName": "aws:updateSsmAgent",
    "ResponseCode": 0,
    "StandardErrorContent": "",
    "StandardErrorUrl": "",
    "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
        \nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent-updater/2.3.871.0/amazon-ssm-agent-updater-windows-amd64.zip
        \nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent/2.3.842.0/amazon-ssm-agent-windows-amd64.zip
        \nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent/2.3.871.0/amazon-ssm-agent-windows-amd64.zip
        \nInitiating amazon-ssm-agent update to 2.3.871.0
        \namazon-ssm-agent updated successfully to 2.3.871.0",
    "StandardOutputUrl": "",
    "Status": "Success",
    "StatusDetails": "Success"
}
```

## See Also
<a name="API_GetCommandInvocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetCommandInvocation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetCommandInvocation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetCommandInvocation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetCommandInvocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetCommandInvocation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetCommandInvocation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetCommandInvocation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetCommandInvocation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetCommandInvocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetCommandInvocation) 

# GetConnectionStatus
<a name="API_GetConnectionStatus"></a>

Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.

## Request Syntax
<a name="API_GetConnectionStatus_RequestSyntax"></a>

```
{
   "Target": "string"
}
```

## Request Parameters
<a name="API_GetConnectionStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Target](#API_GetConnectionStatus_RequestSyntax) **   <a name="systemsmanager-GetConnectionStatus-request-Target"></a>
The managed node ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 400.  
Required: Yes

## Response Syntax
<a name="API_GetConnectionStatus_ResponseSyntax"></a>

```
{
   "Status": "string",
   "Target": "string"
}
```

## Response Elements
<a name="API_GetConnectionStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Status](#API_GetConnectionStatus_ResponseSyntax) **   <a name="systemsmanager-GetConnectionStatus-response-Status"></a>
The status of the connection to the managed node.  
Type: String  
Valid Values: `connected | notconnected` 

 ** [Target](#API_GetConnectionStatus_ResponseSyntax) **   <a name="systemsmanager-GetConnectionStatus-response-Target"></a>
The ID of the managed node to check connection status.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 400.

## Errors
<a name="API_GetConnectionStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_GetConnectionStatus_Examples"></a>

### Example
<a name="API_GetConnectionStatus_Example_1"></a>

This example illustrates one usage of GetConnectionStatus.

#### Sample Request
<a name="API_GetConnectionStatus_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetConnectionStatus
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T180655Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 33

{
    "Target": "i-02573cafcfEXAMPLE"
}
```

#### Sample Response
<a name="API_GetConnectionStatus_Example_1_Response"></a>

```
{
    "Status": "connected",
    "Target": "i-02573cafcfEXAMPLE"
}
```

## See Also
<a name="API_GetConnectionStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetConnectionStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetConnectionStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetConnectionStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetConnectionStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetConnectionStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetConnectionStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetConnectionStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetConnectionStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetConnectionStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetConnectionStatus) 

# GetDefaultPatchBaseline
<a name="API_GetDefaultPatchBaseline"></a>

Retrieves the default patch baseline. AWS Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

If you don't specify an operating system value, the default patch baseline for Windows is returned.

## Request Syntax
<a name="API_GetDefaultPatchBaseline_RequestSyntax"></a>

```
{
   "OperatingSystem": "string"
}
```

## Request Parameters
<a name="API_GetDefaultPatchBaseline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [OperatingSystem](#API_GetDefaultPatchBaseline_RequestSyntax) **   <a name="systemsmanager-GetDefaultPatchBaseline-request-OperatingSystem"></a>
Returns the default patch baseline for the specified operating system.  
Type: String  
Valid Values: `WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023`   
Required: No

## Response Syntax
<a name="API_GetDefaultPatchBaseline_ResponseSyntax"></a>

```
{
   "BaselineId": "string",
   "OperatingSystem": "string"
}
```

## Response Elements
<a name="API_GetDefaultPatchBaseline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BaselineId](#API_GetDefaultPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetDefaultPatchBaseline-response-BaselineId"></a>
The ID of the default patch baseline.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$` 

 ** [OperatingSystem](#API_GetDefaultPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetDefaultPatchBaseline-response-OperatingSystem"></a>
The operating system for the returned patch baseline.   
Type: String  
Valid Values: `WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023` 

## Errors
<a name="API_GetDefaultPatchBaseline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_GetDefaultPatchBaseline_Examples"></a>

### Example
<a name="API_GetDefaultPatchBaseline_Example_1"></a>

This example illustrates one usage of GetDefaultPatchBaseline.

#### Sample Request
<a name="API_GetDefaultPatchBaseline_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 35
X-Amz-Target: AmazonSSM.GetDefaultPatchBaseline
X-Amz-Date: 20240309T025228Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "OperatingSystem": "AMAZON_LINUX"
}
```

#### Sample Response
<a name="API_GetDefaultPatchBaseline_Example_1_Response"></a>

```
{
    "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-0c10e65780EXAMPLE",
    "OperatingSystem": "AMAZON_LINUX"
}
```

## See Also
<a name="API_GetDefaultPatchBaseline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetDefaultPatchBaseline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetDefaultPatchBaseline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetDefaultPatchBaseline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetDefaultPatchBaseline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetDefaultPatchBaseline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetDefaultPatchBaseline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetDefaultPatchBaseline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetDefaultPatchBaseline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetDefaultPatchBaseline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetDefaultPatchBaseline) 

# GetDeployablePatchSnapshotForInstance
<a name="API_GetDeployablePatchSnapshotForInstance"></a>

Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the `AWS-RunPatchBaseline` Systems Manager document (SSM document).

**Note**  
If you run the command locally, such as with the AWS Command Line Interface (AWS CLI), the system attempts to use your local AWS credentials and the operation fails. To avoid this, you can run the command in the AWS Systems Manager console. Use Run Command, a tool in AWS Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the `AWS-RunShellScript` document or the `AWS-RunPowerShellScript` document.

## Request Syntax
<a name="API_GetDeployablePatchSnapshotForInstance_RequestSyntax"></a>

```
{
   "BaselineOverride": { 
      "ApprovalRules": { 
         "PatchRules": [ 
            { 
               "ApproveAfterDays": number,
               "ApproveUntilDate": "string",
               "ComplianceLevel": "string",
               "EnableNonSecurity": boolean,
               "PatchFilterGroup": { 
                  "PatchFilters": [ 
                     { 
                        "Key": "string",
                        "Values": [ "string" ]
                     }
                  ]
               }
            }
         ]
      },
      "ApprovedPatches": [ "string" ],
      "ApprovedPatchesComplianceLevel": "string",
      "ApprovedPatchesEnableNonSecurity": boolean,
      "AvailableSecurityUpdatesComplianceStatus": "string",
      "GlobalFilters": { 
         "PatchFilters": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ]
      },
      "OperatingSystem": "string",
      "RejectedPatches": [ "string" ],
      "RejectedPatchesAction": "string",
      "Sources": [ 
         { 
            "Configuration": "string",
            "Name": "string",
            "Products": [ "string" ]
         }
      ]
   },
   "InstanceId": "string",
   "SnapshotId": "string",
   "UseS3DualStackEndpoint": boolean
}
```

## Request Parameters
<a name="API_GetDeployablePatchSnapshotForInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BaselineOverride](#API_GetDeployablePatchSnapshotForInstance_RequestSyntax) **   <a name="systemsmanager-GetDeployablePatchSnapshotForInstance-request-BaselineOverride"></a>
Defines the basic information about a patch baseline override.  
Type: [BaselineOverride](API_BaselineOverride.md) object  
Required: No

 ** [InstanceId](#API_GetDeployablePatchSnapshotForInstance_RequestSyntax) **   <a name="systemsmanager-GetDeployablePatchSnapshotForInstance-request-InstanceId"></a>
The ID of the managed node for which the appropriate patch snapshot should be retrieved.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: Yes

 ** [SnapshotId](#API_GetDeployablePatchSnapshotForInstance_RequestSyntax) **   <a name="systemsmanager-GetDeployablePatchSnapshotForInstance-request-SnapshotId"></a>
The snapshot ID provided by the user when running `AWS-RunPatchBaseline`.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`   
Required: Yes

 ** [UseS3DualStackEndpoint](#API_GetDeployablePatchSnapshotForInstance_RequestSyntax) **   <a name="systemsmanager-GetDeployablePatchSnapshotForInstance-request-UseS3DualStackEndpoint"></a>
Specifies whether to use S3 dualstack endpoints for the patch snapshot download URL. Set to `true` to receive a presigned URL that supports both IPv4 and IPv6 connectivity. Set to `false` to use standard IPv4-only endpoints. Default is `false`. This parameter is required for managed nodes in IPv6-only environments.   
Type: Boolean  
Required: No

## Response Syntax
<a name="API_GetDeployablePatchSnapshotForInstance_ResponseSyntax"></a>

```
{
   "InstanceId": "string",
   "Product": "string",
   "SnapshotDownloadUrl": "string",
   "SnapshotId": "string"
}
```

## Response Elements
<a name="API_GetDeployablePatchSnapshotForInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstanceId](#API_GetDeployablePatchSnapshotForInstance_ResponseSyntax) **   <a name="systemsmanager-GetDeployablePatchSnapshotForInstance-response-InstanceId"></a>
The managed node ID.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)` 

 ** [Product](#API_GetDeployablePatchSnapshotForInstance_ResponseSyntax) **   <a name="systemsmanager-GetDeployablePatchSnapshotForInstance-response-Product"></a>
Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the managed node for the specified patch snapshot.  
Type: String

 ** [SnapshotDownloadUrl](#API_GetDeployablePatchSnapshotForInstance_ResponseSyntax) **   <a name="systemsmanager-GetDeployablePatchSnapshotForInstance-response-SnapshotDownloadUrl"></a>
A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.  
Type: String

 ** [SnapshotId](#API_GetDeployablePatchSnapshotForInstance_ResponseSyntax) **   <a name="systemsmanager-GetDeployablePatchSnapshotForInstance-response-SnapshotId"></a>
The user-defined snapshot ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_GetDeployablePatchSnapshotForInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** UnsupportedFeatureRequiredException **   
Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see [Turning on the advanced-instances tier](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html) in the * AWS Systems Manager User Guide*.  
HTTP Status Code: 400

 ** UnsupportedOperatingSystem **   
The operating systems you specified isn't supported, or the operation isn't supported for the operating system.  
HTTP Status Code: 400

## Examples
<a name="API_GetDeployablePatchSnapshotForInstance_Examples"></a>

### Example
<a name="API_GetDeployablePatchSnapshotForInstance_Example_1"></a>

This example illustrates one usage of GetDeployablePatchSnapshotForInstance.

#### Sample Request
<a name="API_GetDeployablePatchSnapshotForInstance_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 91
X-Amz-Target: AmazonSSM.GetDeployablePatchSnapshotForInstance
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.12 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ssm.get-deployable-patch-snapshot-for-instance
X-Amz-Date: 20240618T204500Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240618/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "InstanceId": "i-02573cafcfEXAMPLE",
    "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE"
}
```

#### Sample Response
<a name="API_GetDeployablePatchSnapshotForInstance_Example_1_Response"></a>

```
{
    "InstanceId": "i-02573cafcfEXAMPLE",
    "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE",
    "Product": "AmazonLinux2018.03",
    "SnapshotDownloadUrl": "https://amzn-s3-demo-bucket.s3.us-east-2.amazonaws.com/b7d801675252464bEXAMPLE--truncated--"
}
```

## See Also
<a name="API_GetDeployablePatchSnapshotForInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance) 

# GetDocument
<a name="API_GetDocument"></a>

Gets the contents of the specified AWS Systems Manager document (SSM document).

## Request Syntax
<a name="API_GetDocument_RequestSyntax"></a>

```
{
   "DocumentFormat": "string",
   "DocumentVersion": "string",
   "Name": "string",
   "VersionName": "string"
}
```

## Request Parameters
<a name="API_GetDocument_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DocumentFormat](#API_GetDocument_RequestSyntax) **   <a name="systemsmanager-GetDocument-request-DocumentFormat"></a>
Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.  
Type: String  
Valid Values: `YAML | JSON | TEXT`   
Required: No

 ** [DocumentVersion](#API_GetDocument_RequestSyntax) **   <a name="systemsmanager-GetDocument-request-DocumentVersion"></a>
The document version for which you want information.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [Name](#API_GetDocument_RequestSyntax) **   <a name="systemsmanager-GetDocument-request-Name"></a>
The name of the SSM document.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: Yes

 ** [VersionName](#API_GetDocument_RequestSyntax) **   <a name="systemsmanager-GetDocument-request-VersionName"></a>
An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document and can't be changed.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{1,128}$`   
Required: No

## Response Syntax
<a name="API_GetDocument_ResponseSyntax"></a>

```
{
   "AttachmentsContent": [ 
      { 
         "Hash": "string",
         "HashType": "string",
         "Name": "string",
         "Size": number,
         "Url": "string"
      }
   ],
   "Content": "string",
   "CreatedDate": number,
   "DisplayName": "string",
   "DocumentFormat": "string",
   "DocumentType": "string",
   "DocumentVersion": "string",
   "Name": "string",
   "Requires": [ 
      { 
         "Name": "string",
         "RequireType": "string",
         "Version": "string",
         "VersionName": "string"
      }
   ],
   "ReviewStatus": "string",
   "Status": "string",
   "StatusInformation": "string",
   "VersionName": "string"
}
```

## Response Elements
<a name="API_GetDocument_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AttachmentsContent](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-AttachmentsContent"></a>
A description of the document attachments, including names, locations, sizes, and so on.  
Type: Array of [AttachmentContent](API_AttachmentContent.md) objects

 ** [Content](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-Content"></a>
The contents of the SSM document.  
Type: String  
Length Constraints: Minimum length of 1.

 ** [CreatedDate](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-CreatedDate"></a>
The date the SSM document was created.  
Type: Timestamp

 ** [DisplayName](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-DisplayName"></a>
The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see [UpdateDocument](API_UpdateDocument.md).  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^[\w\.\-\:\/ ]*$` 

 ** [DocumentFormat](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-DocumentFormat"></a>
The document format, either JSON or YAML.  
Type: String  
Valid Values: `YAML | JSON | TEXT` 

 ** [DocumentType](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-DocumentType"></a>
The document type.  
Type: String  
Valid Values: `Command | Policy | Automation | Session | Package | ApplicationConfiguration | ApplicationConfigurationSchema | DeploymentStrategy | ChangeCalendar | Automation.ChangeTemplate | ProblemAnalysis | ProblemAnalysisTemplate | CloudFormation | ConformancePackTemplate | QuickSetup | ManualApprovalPolicy | AutoApprovalPolicy` 

 ** [DocumentVersion](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-DocumentVersion"></a>
The document version.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` 

 ** [Name](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-Name"></a>
The name of the SSM document.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$` 

 ** [Requires](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-Requires"></a>
A list of SSM documents required by a document. For example, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document.  
Type: Array of [DocumentRequires](API_DocumentRequires.md) objects  
Array Members: Minimum number of 1 item.

 ** [ReviewStatus](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-ReviewStatus"></a>
The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.  
Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.  
Only one version of an SSM document can be in review, or PENDING, at a time.  
Type: String  
Valid Values: `APPROVED | NOT_REVIEWED | PENDING | REJECTED` 

 ** [Status](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-Status"></a>
The status of the SSM document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.  
Type: String  
Valid Values: `Creating | Active | Updating | Deleting | Failed` 

 ** [StatusInformation](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-StatusInformation"></a>
A message returned by AWS Systems Manager that explains the `Status` value. For example, a `Failed` status might be explained by the `StatusInformation` message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."  
Type: String

 ** [VersionName](#API_GetDocument_ResponseSyntax) **   <a name="systemsmanager-GetDocument-response-VersionName"></a>
The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{1,128}$` 

## Errors
<a name="API_GetDocument_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentVersion **   
The document version isn't valid or doesn't exist.  
HTTP Status Code: 400

## Examples
<a name="API_GetDocument_Examples"></a>

### Example
<a name="API_GetDocument_Example_1"></a>

This example illustrates one usage of GetDocument.

#### Sample Request
<a name="API_GetDocument_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetDocument
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T190721Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 30

{
    "Name": "AWS-UpdateSSMAgent"
}
```

#### Sample Response
<a name="API_GetDocument_Example_1_Response"></a>

```
{
   "Content":"{\n    \"schemaVersion\": \"1.2\",\n  \"description\": \"Update the Amazon SSM Agent to the latest version or specified version.\",--truncated--n",
   "DocumentFormat":"JSON",
   "DocumentType":"Command",
   "DocumentVersion":"1",
   "Name":"AWS-UpdateSSMAgent",
   "Status":"Active"
}
```

## See Also
<a name="API_GetDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetDocument) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetDocument) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetDocument) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetDocument) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetDocument) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetDocument) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetDocument) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetDocument) 

# GetExecutionPreview
<a name="API_GetExecutionPreview"></a>

Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.

## Request Syntax
<a name="API_GetExecutionPreview_RequestSyntax"></a>

```
{
   "ExecutionPreviewId": "string"
}
```

## Request Parameters
<a name="API_GetExecutionPreview_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ExecutionPreviewId](#API_GetExecutionPreview_RequestSyntax) **   <a name="systemsmanager-GetExecutionPreview-request-ExecutionPreviewId"></a>
The ID of the existing execution preview.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}`   
Required: Yes

## Response Syntax
<a name="API_GetExecutionPreview_ResponseSyntax"></a>

```
{
   "EndedAt": number,
   "ExecutionPreview": { ... },
   "ExecutionPreviewId": "string",
   "Status": "string",
   "StatusMessage": "string"
}
```

## Response Elements
<a name="API_GetExecutionPreview_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EndedAt](#API_GetExecutionPreview_ResponseSyntax) **   <a name="systemsmanager-GetExecutionPreview-response-EndedAt"></a>
A UTC timestamp indicating when the execution preview operation ended.  
Type: Timestamp

 ** [ExecutionPreview](#API_GetExecutionPreview_ResponseSyntax) **   <a name="systemsmanager-GetExecutionPreview-response-ExecutionPreview"></a>
Information about the changes that would be made if an execution were run.  
Type: [ExecutionPreview](API_ExecutionPreview.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [ExecutionPreviewId](#API_GetExecutionPreview_ResponseSyntax) **   <a name="systemsmanager-GetExecutionPreview-response-ExecutionPreviewId"></a>
The generated ID for the existing execution preview.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}` 

 ** [Status](#API_GetExecutionPreview_ResponseSyntax) **   <a name="systemsmanager-GetExecutionPreview-response-Status"></a>
The current status of the execution preview operation.  
Type: String  
Valid Values: `Pending | InProgress | Success | Failed` 

 ** [StatusMessage](#API_GetExecutionPreview_ResponseSyntax) **   <a name="systemsmanager-GetExecutionPreview-response-StatusMessage"></a>
Supplemental information about the current status of the execution preview.  
Type: String

## Errors
<a name="API_GetExecutionPreview_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified parameter to be shared could not be found.  
HTTP Status Code: 400

## Examples
<a name="API_GetExecutionPreview_Examples"></a>

### Example
<a name="API_GetExecutionPreview_Example_1"></a>

This example illustrates one usage of GetExecutionPreview.

#### Sample Request
<a name="API_GetExecutionPreview_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetExecutionPreview
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20241125T162110Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 86
    
{
    "ExecutionPreviewId": "2f27d6e5-9676-4708-b8bd-aef0aEXAMPLE"
}
```

### Example
<a name="API_GetExecutionPreview_Example_2"></a>

This example illustrates one usage of GetExecutionPreview.

#### Sample Response
<a name="API_GetExecutionPreview_Example_2_Response"></a>

```
{
    "ExecutionPreviewId": "2f27d6e5-9676-4708-b8bd-aef0EXAMPLE",
    "EndedAt": "2024-11-25T01:50:39.424000+00:00",
    "Status": "Success",
    "ExecutionPreview": {
        "Automation": {
            "StepPreviews": {
                "Undetermined": 1
            },
            "Regions": [
                "us-east-2"
            ],
            "TotalAccounts": 7
        }
    }
}
```

## See Also
<a name="API_GetExecutionPreview_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetExecutionPreview) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetExecutionPreview) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetExecutionPreview) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetExecutionPreview) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetExecutionPreview) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetExecutionPreview) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetExecutionPreview) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetExecutionPreview) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetExecutionPreview) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetExecutionPreview) 

# GetInventory
<a name="API_GetInventory"></a>

Query inventory information. This includes managed node status, such as `Stopped` or `Terminated`.

## Request Syntax
<a name="API_GetInventory_RequestSyntax"></a>

```
{
   "Aggregators": [ 
      { 
         "Aggregators": [ 
            "InventoryAggregator"
         ],
         "Expression": "string",
         "Groups": [ 
            { 
               "Filters": [ 
                  { 
                     "Key": "string",
                     "Type": "string",
                     "Values": [ "string" ]
                  }
               ],
               "Name": "string"
            }
         ]
      }
   ],
   "Filters": [ 
      { 
         "Key": "string",
         "Type": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "ResultAttributes": [ 
      { 
         "TypeName": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_GetInventory_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Aggregators](#API_GetInventory_RequestSyntax) **   <a name="systemsmanager-GetInventory-request-Aggregators"></a>
Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the `AWS:InstanceInformation.PlatformType` type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried fleet.  
Type: Array of [InventoryAggregator](API_InventoryAggregator.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [Filters](#API_GetInventory_RequestSyntax) **   <a name="systemsmanager-GetInventory-request-Filters"></a>
One or more filters. Use a filter to return a more specific list of results.  
Type: Array of [InventoryFilter](API_InventoryFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_GetInventory_RequestSyntax) **   <a name="systemsmanager-GetInventory-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_GetInventory_RequestSyntax) **   <a name="systemsmanager-GetInventory-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [ResultAttributes](#API_GetInventory_RequestSyntax) **   <a name="systemsmanager-GetInventory-request-ResultAttributes"></a>
The list of inventory item types to return.  
Type: Array of [ResultAttribute](API_ResultAttribute.md) objects  
Array Members: Fixed number of 1 item.  
Required: No

## Response Syntax
<a name="API_GetInventory_ResponseSyntax"></a>

```
{
   "Entities": [ 
      { 
         "Data": { 
            "string" : { 
               "CaptureTime": "string",
               "Content": [ 
                  { 
                     "string" : "string" 
                  }
               ],
               "ContentHash": "string",
               "SchemaVersion": "string",
               "TypeName": "string"
            }
         },
         "Id": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetInventory_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Entities](#API_GetInventory_ResponseSyntax) **   <a name="systemsmanager-GetInventory-response-Entities"></a>
Collection of inventory entities such as a collection of managed node inventory.   
Type: Array of [InventoryResultEntity](API_InventoryResultEntity.md) objects

 ** [NextToken](#API_GetInventory_ResponseSyntax) **   <a name="systemsmanager-GetInventory-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_GetInventory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidAggregatorException **   
The specified aggregator isn't valid for the group type. Verify that the aggregator you provided is supported.  
HTTP Status Code: 400

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidInventoryGroupException **   
The specified inventory group isn't valid.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

 ** InvalidResultAttributeException **   
The specified inventory item result attribute isn't valid.  
HTTP Status Code: 400

 ** InvalidTypeNameException **   
The parameter type name isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_GetInventory_Examples"></a>

### Example
<a name="API_GetInventory_Example_1"></a>

This example illustrates one usage of GetInventory.

#### Sample Request
<a name="API_GetInventory_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetInventory
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240330T145054Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2
```

#### Sample Response
<a name="API_GetInventory_Example_1_Response"></a>

```
{
    "Entities": [
        {
            "Data": {
                "Id": "i-04bf6ad63bEXAMPLE",
                "AWS:InstanceInformation": {
                    "TypeName": "AWS:InstanceInformation",
                    "SchemaVersion": "1.0",
                    "CaptureTime": "2024-03-30T14:00:57Z",
                    "Content": [
                        {
                            "AgentType": "amazon-ssm-agent",
                            "AgentVersion": "2.3.930.0",
                            "ComputerName": "EC2AMAZ-EXAMPLE.WORKGROUP",
                            "InstanceId": "i-04bf6ad63bEXAMPLE",
                            "InstanceStatus": "Stopped",
                            "IpAddress": "172.16.0.4",
                            "PlatformName": "Microsoft Windows Server 2016 Datacenter",
                            "PlatformType": "Windows",
                            "PlatformVersion": "10.0.14393",
                            "ResourceType": "EC2Instance"
                        }
                    ]
                }
            }
        }
    ]
}
```

## See Also
<a name="API_GetInventory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetInventory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetInventory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetInventory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetInventory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetInventory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetInventory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetInventory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetInventory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetInventory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetInventory) 

# GetInventorySchema
<a name="API_GetInventorySchema"></a>

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

## Request Syntax
<a name="API_GetInventorySchema_RequestSyntax"></a>

```
{
   "Aggregator": boolean,
   "MaxResults": number,
   "NextToken": "string",
   "SubType": boolean,
   "TypeName": "string"
}
```

## Request Parameters
<a name="API_GetInventorySchema_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Aggregator](#API_GetInventorySchema_RequestSyntax) **   <a name="systemsmanager-GetInventorySchema-request-Aggregator"></a>
Returns inventory schemas that support aggregation. For example, this call returns the `AWS:InstanceInformation` type, because it supports aggregation based on the `PlatformName`, `PlatformType`, and `PlatformVersion` attributes.  
Type: Boolean  
Required: No

 ** [MaxResults](#API_GetInventorySchema_RequestSyntax) **   <a name="systemsmanager-GetInventorySchema-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 50. Maximum value of 200.  
Required: No

 ** [NextToken](#API_GetInventorySchema_RequestSyntax) **   <a name="systemsmanager-GetInventorySchema-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [SubType](#API_GetInventorySchema_RequestSyntax) **   <a name="systemsmanager-GetInventorySchema-request-SubType"></a>
Returns the sub-type schema for a specified inventory type.  
Type: Boolean  
Required: No

 ** [TypeName](#API_GetInventorySchema_RequestSyntax) **   <a name="systemsmanager-GetInventorySchema-request-TypeName"></a>
The type of inventory item to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Required: No

## Response Syntax
<a name="API_GetInventorySchema_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Schemas": [ 
      { 
         "Attributes": [ 
            { 
               "DataType": "string",
               "Name": "string"
            }
         ],
         "DisplayName": "string",
         "TypeName": "string",
         "Version": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetInventorySchema_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_GetInventorySchema_ResponseSyntax) **   <a name="systemsmanager-GetInventorySchema-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [Schemas](#API_GetInventorySchema_ResponseSyntax) **   <a name="systemsmanager-GetInventorySchema-response-Schemas"></a>
Inventory schemas returned by the request.  
Type: Array of [InventoryItemSchema](API_InventoryItemSchema.md) objects

## Errors
<a name="API_GetInventorySchema_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

 ** InvalidTypeNameException **   
The parameter type name isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_GetInventorySchema_Examples"></a>

### Example
<a name="API_GetInventorySchema_Example_1"></a>

This example illustrates one usage of GetInventorySchema.

#### Sample Request
<a name="API_GetInventorySchema_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetInventorySchema
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240330T150040Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2
```

#### Sample Response
<a name="API_GetInventorySchema_Example_1_Response"></a>

```
{
   "Schemas":[
      {
         "Attributes":[
            {
               "DataType":"STRING",
               "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"
            }
         ],
         "TypeName":"AWS:AWSComponent",
         "Version":"1.0"
      },--truncated--
      {
         "Attributes":[
            {
               "DataType":"STRING",
               "Name":"Name"
            },
            {
               "DataType":"STRING",
               "Name":"DisplayName"
            },
            {
               "DataType":"STRING",
               "Name":"ServiceType"
            },
            {
               "DataType":"STRING",
               "Name":"Status"
            },
            {
               "DataType":"STRING",
               "Name":"DependentServices"
            },
            {
               "DataType":"STRING",
               "Name":"ServicesDependedOn"
            },
            {
               "DataType":"STRING",
               "Name":"StartType"
            }
         ],
         "TypeName":"AWS:Service",
         "Version":"1.0"
      }--truncated--
   ]
}
```

## See Also
<a name="API_GetInventorySchema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetInventorySchema) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetInventorySchema) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetInventorySchema) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetInventorySchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetInventorySchema) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetInventorySchema) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetInventorySchema) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetInventorySchema) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetInventorySchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetInventorySchema) 

# GetMaintenanceWindow
<a name="API_GetMaintenanceWindow"></a>

Retrieves a maintenance window.

## Request Syntax
<a name="API_GetMaintenanceWindow_RequestSyntax"></a>

```
{
   "WindowId": "string"
}
```

## Request Parameters
<a name="API_GetMaintenanceWindow_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [WindowId](#API_GetMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-request-WindowId"></a>
The ID of the maintenance window for which you want to retrieve information.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

## Response Syntax
<a name="API_GetMaintenanceWindow_ResponseSyntax"></a>

```
{
   "AllowUnassociatedTargets": boolean,
   "CreatedDate": number,
   "Cutoff": number,
   "Description": "string",
   "Duration": number,
   "Enabled": boolean,
   "EndDate": "string",
   "ModifiedDate": number,
   "Name": "string",
   "NextExecutionTime": "string",
   "Schedule": "string",
   "ScheduleOffset": number,
   "ScheduleTimezone": "string",
   "StartDate": "string",
   "WindowId": "string"
}
```

## Response Elements
<a name="API_GetMaintenanceWindow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AllowUnassociatedTargets](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-AllowUnassociatedTargets"></a>
Whether targets must be registered with the maintenance window before tasks can be defined for those targets.  
Type: Boolean

 ** [CreatedDate](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-CreatedDate"></a>
The date the maintenance window was created.  
Type: Timestamp

 ** [Cutoff](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-Cutoff"></a>
The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.

 ** [Description](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-Description"></a>
The description of the maintenance window.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [Duration](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-Duration"></a>
The duration of the maintenance window in hours.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 24.

 ** [Enabled](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-Enabled"></a>
Indicates whether the maintenance window is enabled.  
Type: Boolean

 ** [EndDate](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-EndDate"></a>
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.  
Type: String

 ** [ModifiedDate](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-ModifiedDate"></a>
The date the maintenance window was last modified.  
Type: Timestamp

 ** [Name](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-Name"></a>
The name of the maintenance window.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$` 

 ** [NextExecutionTime](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-NextExecutionTime"></a>
The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.  
Type: String

 ** [Schedule](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-Schedule"></a>
The schedule of the maintenance window in the form of a cron or rate expression.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [ScheduleOffset](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-ScheduleOffset"></a>
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 6.

 ** [ScheduleTimezone](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-ScheduleTimezone"></a>
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los\$1Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database](https://www.iana.org/time-zones) on the IANA website.  
Type: String

 ** [StartDate](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-StartDate"></a>
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.  
Type: String

 ** [WindowId](#API_GetMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindow-response-WindowId"></a>
The ID of the created maintenance window.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$` 

## Errors
<a name="API_GetMaintenanceWindow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_GetMaintenanceWindow_Examples"></a>

### Example
<a name="API_GetMaintenanceWindow_Example_1"></a>

This example illustrates one usage of GetMaintenanceWindow.

#### Sample Request
<a name="API_GetMaintenanceWindow_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 36
X-Amz-Target: AmazonSSM.GetMaintenanceWindow
X-Amz-Date: 20240312T203140Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

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

#### Sample Response
<a name="API_GetMaintenanceWindow_Example_1_Response"></a>

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

## See Also
<a name="API_GetMaintenanceWindow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetMaintenanceWindow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetMaintenanceWindow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetMaintenanceWindow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetMaintenanceWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetMaintenanceWindow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetMaintenanceWindow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetMaintenanceWindow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetMaintenanceWindow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetMaintenanceWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetMaintenanceWindow) 

# GetMaintenanceWindowExecution
<a name="API_GetMaintenanceWindowExecution"></a>

Retrieves details about a specific a maintenance window execution.

## Request Syntax
<a name="API_GetMaintenanceWindowExecution_RequestSyntax"></a>

```
{
   "WindowExecutionId": "string"
}
```

## Request Parameters
<a name="API_GetMaintenanceWindowExecution_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [WindowExecutionId](#API_GetMaintenanceWindowExecution_RequestSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecution-request-WindowExecutionId"></a>
The ID of the maintenance window execution that includes the task.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_GetMaintenanceWindowExecution_ResponseSyntax"></a>

```
{
   "EndTime": number,
   "StartTime": number,
   "Status": "string",
   "StatusDetails": "string",
   "TaskIds": [ "string" ],
   "WindowExecutionId": "string"
}
```

## Response Elements
<a name="API_GetMaintenanceWindowExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EndTime](#API_GetMaintenanceWindowExecution_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecution-response-EndTime"></a>
The time the maintenance window finished running.  
Type: Timestamp

 ** [StartTime](#API_GetMaintenanceWindowExecution_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecution-response-StartTime"></a>
The time the maintenance window started running.  
Type: Timestamp

 ** [Status](#API_GetMaintenanceWindowExecution_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecution-response-Status"></a>
The status of the maintenance window execution.  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | SUCCESS | FAILED | TIMED_OUT | CANCELLING | CANCELLED | SKIPPED_OVERLAPPING` 

 ** [StatusDetails](#API_GetMaintenanceWindowExecution_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecution-response-StatusDetails"></a>
The details explaining the status. Not available for all status values.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 250.

 ** [TaskIds](#API_GetMaintenanceWindowExecution_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecution-response-TaskIds"></a>
The ID of the task executions from the maintenance window execution.  
Type: Array of strings  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

 ** [WindowExecutionId](#API_GetMaintenanceWindowExecution_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecution-response-WindowExecutionId"></a>
The ID of the maintenance window execution.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_GetMaintenanceWindowExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_GetMaintenanceWindowExecution_Examples"></a>

### Example
<a name="API_GetMaintenanceWindowExecution_Example_1"></a>

This example illustrates one usage of GetMaintenanceWindowExecution.

#### Sample Request
<a name="API_GetMaintenanceWindowExecution_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 61
X-Amz-Target: AmazonSSM.GetMaintenanceWindowExecution
X-Amz-Date: 20240312T205830Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE"
}
```

#### Sample Response
<a name="API_GetMaintenanceWindowExecution_Example_1_Response"></a>

```
{
    "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE",
    "TaskIds": [
        "4b9f371e-a820-422d-b432-8dec9EXAMPLE"
    ],    
    "Status": "SUCCESS",
    "StartTime": "2024-08-04T11:45:34.994000-07:00",
    "EndTime": "2024-08-04T11:48:09.123000-07:00"
}
```

## See Also
<a name="API_GetMaintenanceWindowExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetMaintenanceWindowExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetMaintenanceWindowExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetMaintenanceWindowExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetMaintenanceWindowExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetMaintenanceWindowExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetMaintenanceWindowExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetMaintenanceWindowExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetMaintenanceWindowExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetMaintenanceWindowExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetMaintenanceWindowExecution) 

# GetMaintenanceWindowExecutionTask
<a name="API_GetMaintenanceWindowExecutionTask"></a>

Retrieves the details about a specific task run as part of a maintenance window execution.

## Request Syntax
<a name="API_GetMaintenanceWindowExecutionTask_RequestSyntax"></a>

```
{
   "TaskId": "string",
   "WindowExecutionId": "string"
}
```

## Request Parameters
<a name="API_GetMaintenanceWindowExecutionTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TaskId](#API_GetMaintenanceWindowExecutionTask_RequestSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-request-TaskId"></a>
The ID of the specific task execution in the maintenance window task that should be retrieved.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

 ** [WindowExecutionId](#API_GetMaintenanceWindowExecutionTask_RequestSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-request-WindowExecutionId"></a>
The ID of the maintenance window execution that includes the task.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_GetMaintenanceWindowExecutionTask_ResponseSyntax"></a>

```
{
   "AlarmConfiguration": { 
      "Alarms": [ 
         { 
            "Name": "string"
         }
      ],
      "IgnorePollAlarmFailure": boolean
   },
   "EndTime": number,
   "MaxConcurrency": "string",
   "MaxErrors": "string",
   "Priority": number,
   "ServiceRole": "string",
   "StartTime": number,
   "Status": "string",
   "StatusDetails": "string",
   "TaskArn": "string",
   "TaskExecutionId": "string",
   "TaskParameters": [ 
      { 
         "string" : { 
            "Values": [ "string" ]
         }
      }
   ],
   "TriggeredAlarms": [ 
      { 
         "Name": "string",
         "State": "string"
      }
   ],
   "Type": "string",
   "WindowExecutionId": "string"
}
```

## Response Elements
<a name="API_GetMaintenanceWindowExecutionTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AlarmConfiguration](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-AlarmConfiguration"></a>
The details for the CloudWatch alarm you applied to your maintenance window task.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object

 ** [EndTime](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-EndTime"></a>
The time the task execution completed.  
Type: Timestamp

 ** [MaxConcurrency](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-MaxConcurrency"></a>
The defined maximum number of task executions that could be run in parallel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$` 

 ** [MaxErrors](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-MaxErrors"></a>
The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$` 

 ** [Priority](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-Priority"></a>
The priority of the task.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [ServiceRole](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-ServiceRole"></a>
The role that was assumed when running the task.  
Type: String

 ** [StartTime](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-StartTime"></a>
The time the task execution started.  
Type: Timestamp

 ** [Status](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-Status"></a>
The status of the task.  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | SUCCESS | FAILED | TIMED_OUT | CANCELLING | CANCELLED | SKIPPED_OVERLAPPING` 

 ** [StatusDetails](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-StatusDetails"></a>
The details explaining the status. Not available for all status values.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 250.

 ** [TaskArn](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-TaskArn"></a>
The Amazon Resource Name (ARN) of the task that ran.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.

 ** [TaskExecutionId](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-TaskExecutionId"></a>
The ID of the specific task execution in the maintenance window task that was retrieved.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

 ** [TaskParameters](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-TaskParameters"></a>
The parameters passed to the task when it was run.  
 `TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md).
The map has the following format:  
+  `Key`: string, between 1 and 255 characters
+  `Value`: an array of strings, each between 1 and 255 characters
Type: Array of string to [MaintenanceWindowTaskParameterValueExpression](API_MaintenanceWindowTaskParameterValueExpression.md) object maps  
Key Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [TriggeredAlarms](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-TriggeredAlarms"></a>
The CloudWatch alarms that were invoked by the maintenance window task.  
Type: Array of [AlarmStateInformation](API_AlarmStateInformation.md) objects  
Array Members: Fixed number of 1 item.

 ** [Type](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-Type"></a>
The type of task that was run.  
Type: String  
Valid Values: `RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA` 

 ** [WindowExecutionId](#API_GetMaintenanceWindowExecutionTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTask-response-WindowExecutionId"></a>
The ID of the maintenance window execution that includes the task.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_GetMaintenanceWindowExecutionTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_GetMaintenanceWindowExecutionTask_Examples"></a>

### Example
<a name="API_GetMaintenanceWindowExecutionTask_Example_1"></a>

This example illustrates one usage of GetMaintenanceWindowExecutionTask.

#### Sample Request
<a name="API_GetMaintenanceWindowExecutionTask_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetMaintenanceWindowExecutionTask
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T001515Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 111

{
    "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef436EXAMPLE",
    "TaskId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE"
}
```

#### Sample Response
<a name="API_GetMaintenanceWindowExecutionTask_Example_1_Response"></a>

```
{
    "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef436EXAMPLE",
    "TaskExecutionId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE",
    "TaskArn": "AWS-RunPatchBaseline",
    "ServiceRole": "arn:aws:iam::111122223333: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": "2024-08-04T11:45:35.088000-07:00",
    "EndTime": "2024-08-04T11:48:09.079000-07:00"
}
```

## See Also
<a name="API_GetMaintenanceWindowExecutionTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetMaintenanceWindowExecutionTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetMaintenanceWindowExecutionTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetMaintenanceWindowExecutionTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetMaintenanceWindowExecutionTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetMaintenanceWindowExecutionTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetMaintenanceWindowExecutionTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetMaintenanceWindowExecutionTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetMaintenanceWindowExecutionTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetMaintenanceWindowExecutionTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetMaintenanceWindowExecutionTask) 

# GetMaintenanceWindowExecutionTaskInvocation
<a name="API_GetMaintenanceWindowExecutionTaskInvocation"></a>

Retrieves information about a specific task running on a specific target.

## Request Syntax
<a name="API_GetMaintenanceWindowExecutionTaskInvocation_RequestSyntax"></a>

```
{
   "InvocationId": "string",
   "TaskId": "string",
   "WindowExecutionId": "string"
}
```

## Request Parameters
<a name="API_GetMaintenanceWindowExecutionTaskInvocation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InvocationId](#API_GetMaintenanceWindowExecutionTaskInvocation_RequestSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-request-InvocationId"></a>
The invocation ID to retrieve.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

 ** [TaskId](#API_GetMaintenanceWindowExecutionTaskInvocation_RequestSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-request-TaskId"></a>
The ID of the specific task in the maintenance window task that should be retrieved.   
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

 ** [WindowExecutionId](#API_GetMaintenanceWindowExecutionTaskInvocation_RequestSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-request-WindowExecutionId"></a>
The ID of the maintenance window execution for which the task is a part.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax"></a>

```
{
   "EndTime": number,
   "ExecutionId": "string",
   "InvocationId": "string",
   "OwnerInformation": "string",
   "Parameters": "string",
   "StartTime": number,
   "Status": "string",
   "StatusDetails": "string",
   "TaskExecutionId": "string",
   "TaskType": "string",
   "WindowExecutionId": "string",
   "WindowTargetId": "string"
}
```

## Response Elements
<a name="API_GetMaintenanceWindowExecutionTaskInvocation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EndTime](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-EndTime"></a>
The time that the task finished running on the target.  
Type: Timestamp

 ** [ExecutionId](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-ExecutionId"></a>
The execution ID.  
Type: String

 ** [InvocationId](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-InvocationId"></a>
The invocation ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

 ** [OwnerInformation](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-OwnerInformation"></a>
User-provided value to be included in any Amazon CloudWatch Events or Amazon EventBridge events raised while running tasks for these targets in this maintenance window.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [Parameters](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-Parameters"></a>
The parameters used at the time that the task ran.  
Type: String

 ** [StartTime](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-StartTime"></a>
The time that the task started running on the target.  
Type: Timestamp

 ** [Status](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-Status"></a>
The task status for an invocation.  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | SUCCESS | FAILED | TIMED_OUT | CANCELLING | CANCELLED | SKIPPED_OVERLAPPING` 

 ** [StatusDetails](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-StatusDetails"></a>
The details explaining the status. Details are only available for certain status values.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 250.

 ** [TaskExecutionId](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-TaskExecutionId"></a>
The task execution ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

 ** [TaskType](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-TaskType"></a>
Retrieves the task type for a maintenance window.  
Type: String  
Valid Values: `RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA` 

 ** [WindowExecutionId](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-WindowExecutionId"></a>
The maintenance window execution ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

 ** [WindowTargetId](#API_GetMaintenanceWindowExecutionTaskInvocation_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowExecutionTaskInvocation-response-WindowTargetId"></a>
The maintenance window target ID.  
Type: String  
Length Constraints: Maximum length of 36.

## Errors
<a name="API_GetMaintenanceWindowExecutionTaskInvocation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_GetMaintenanceWindowExecutionTaskInvocation_Examples"></a>

### Example
<a name="API_GetMaintenanceWindowExecutionTaskInvocation_Example_1"></a>

This example illustrates one usage of GetMaintenanceWindowExecutionTaskInvocation.

#### Sample Request
<a name="API_GetMaintenanceWindowExecutionTaskInvocation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetMaintenanceWindowExecutionTaskInvocation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T001923Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 167

{
    "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef4EXAMPLE",
    "TaskId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE",
    "InvocationId": "0e466033-290b-4d74-9ae0-f33e3EXAMPLE"
}
```

#### Sample Response
<a name="API_GetMaintenanceWindowExecutionTaskInvocation_Example_1_Response"></a>

```
{
    "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef4EXAMPLE",
    "TaskExecutionId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE",
    "InvocationId": "0e466033-290b-4d74-9ae0-f33e3EXAMPLE",
    "ExecutionId": "1203cf98-5a79-4ec3-97e9-12e0bEXAMPLE",
    "TaskType": "RUN_COMMAND",
    "Parameters": "{\"comment\":\"\",\"documentName\":\"AWS-ApplyPatchBaseline\",\"instanceIds\":[\"i-02573cafcfEXAMPLE\",\"i-0471e04240EXAMPLE\"],\"maxConcurrency\":\"1\",\"maxErrors\":\"1\",\"parameters\":{\"SnapshotId\":[\"\"],\"Operation\":[\"Install\"]},\"timeoutSeconds\":600}",
    "Status": "SUCCESS",
    "StatusDetails": "Success",
    "StartTime": "2024-08-04T11:45:35.141000-07:00",
    "EndTime": "2024-08-04T11:48:08.960000-07:00"
}
```

## See Also
<a name="API_GetMaintenanceWindowExecutionTaskInvocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation) 

# GetMaintenanceWindowTask
<a name="API_GetMaintenanceWindowTask"></a>

Retrieves the details of a maintenance window task.

**Note**  
For maintenance window tasks without a specified target, you can't supply values for `--max-errors` and `--max-concurrency`. Instead, the system inserts a placeholder value of `1`, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

To retrieve a list of tasks in a maintenance window, instead use the [DescribeMaintenanceWindowTasks](API_DescribeMaintenanceWindowTasks.md) command.

## Request Syntax
<a name="API_GetMaintenanceWindowTask_RequestSyntax"></a>

```
{
   "WindowId": "string",
   "WindowTaskId": "string"
}
```

## Request Parameters
<a name="API_GetMaintenanceWindowTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [WindowId](#API_GetMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-request-WindowId"></a>
The maintenance window ID that includes the task to retrieve.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

 ** [WindowTaskId](#API_GetMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-request-WindowTaskId"></a>
The maintenance window task ID to retrieve.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_GetMaintenanceWindowTask_ResponseSyntax"></a>

```
{
   "AlarmConfiguration": { 
      "Alarms": [ 
         { 
            "Name": "string"
         }
      ],
      "IgnorePollAlarmFailure": boolean
   },
   "CutoffBehavior": "string",
   "Description": "string",
   "LoggingInfo": { 
      "S3BucketName": "string",
      "S3KeyPrefix": "string",
      "S3Region": "string"
   },
   "MaxConcurrency": "string",
   "MaxErrors": "string",
   "Name": "string",
   "Priority": number,
   "ServiceRoleArn": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "TaskArn": "string",
   "TaskInvocationParameters": { 
      "Automation": { 
         "DocumentVersion": "string",
         "Parameters": { 
            "string" : [ "string" ]
         }
      },
      "Lambda": { 
         "ClientContext": "string",
         "Payload": blob,
         "Qualifier": "string"
      },
      "RunCommand": { 
         "CloudWatchOutputConfig": { 
            "CloudWatchLogGroupName": "string",
            "CloudWatchOutputEnabled": boolean
         },
         "Comment": "string",
         "DocumentHash": "string",
         "DocumentHashType": "string",
         "DocumentVersion": "string",
         "NotificationConfig": { 
            "NotificationArn": "string",
            "NotificationEvents": [ "string" ],
            "NotificationType": "string"
         },
         "OutputS3BucketName": "string",
         "OutputS3KeyPrefix": "string",
         "Parameters": { 
            "string" : [ "string" ]
         },
         "ServiceRoleArn": "string",
         "TimeoutSeconds": number
      },
      "StepFunctions": { 
         "Input": "string",
         "Name": "string"
      }
   },
   "TaskParameters": { 
      "string" : { 
         "Values": [ "string" ]
      }
   },
   "TaskType": "string",
   "WindowId": "string",
   "WindowTaskId": "string"
}
```

## Response Elements
<a name="API_GetMaintenanceWindowTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AlarmConfiguration](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-AlarmConfiguration"></a>
The details for the CloudWatch alarm you applied to your maintenance window task.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object

 ** [CutoffBehavior](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-CutoffBehavior"></a>
The action to take on tasks when the maintenance window cutoff time is reached. `CONTINUE_TASK` means that tasks continue to run. For Automation, AWS Lambda, AWS Step Functions tasks, `CANCEL_TASK` means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, `CANCEL_TASK` means the system attempts to stop the task by sending a `CancelCommand` operation.  
Type: String  
Valid Values: `CONTINUE_TASK | CANCEL_TASK` 

 ** [Description](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-Description"></a>
The retrieved task description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [LoggingInfo](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-LoggingInfo"></a>
The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.  
 `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how AWS Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md).
Type: [LoggingInfo](API_LoggingInfo.md) object

 ** [MaxConcurrency](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-MaxConcurrency"></a>
The maximum number of targets allowed to run this task in parallel.  
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1`, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$` 

 ** [MaxErrors](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-MaxErrors"></a>
The maximum number of errors allowed before the task stops being scheduled.  
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1`, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$` 

 ** [Name](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-Name"></a>
The retrieved task name.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$` 

 ** [Priority](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-Priority"></a>
The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [ServiceRoleArn](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-ServiceRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run `RegisterTaskWithMaintenanceWindow`.  
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see [Setting up Maintenance Windows](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html) in the in the * AWS Systems Manager User Guide*.  
Type: String

 ** [Targets](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-Targets"></a>
The targets where the task should run.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

 ** [TaskArn](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-TaskArn"></a>
The resource that the task used during execution. For `RUN_COMMAND` and `AUTOMATION` task types, the value of `TaskArn` is the SSM document name/ARN. For `LAMBDA` tasks, the value is the function name/ARN. For `STEP_FUNCTIONS` tasks, the value is the state machine ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.

 ** [TaskInvocationParameters](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-TaskInvocationParameters"></a>
The parameters to pass to the task when it runs.  
Type: [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md) object

 ** [TaskParameters](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-TaskParameters"></a>
The parameters to pass to the task when it runs.  
 `TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md).
Type: String to [MaintenanceWindowTaskParameterValueExpression](API_MaintenanceWindowTaskParameterValueExpression.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [TaskType](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-TaskType"></a>
The type of task to run.  
Type: String  
Valid Values: `RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA` 

 ** [WindowId](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-WindowId"></a>
The retrieved maintenance window ID.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$` 

 ** [WindowTaskId](#API_GetMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-GetMaintenanceWindowTask-response-WindowTaskId"></a>
The retrieved maintenance window task ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_GetMaintenanceWindowTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_GetMaintenanceWindowTask_Examples"></a>

### Example
<a name="API_GetMaintenanceWindowTask_Example_1"></a>

This example illustrates one usage of GetMaintenanceWindowTask.

#### Sample Request
<a name="API_GetMaintenanceWindowTask_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetMaintenanceWindowTask
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T002532Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 92

{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE"
}
```

#### Sample Response
<a name="API_GetMaintenanceWindowTask_Example_1_Response"></a>

```
{    
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE",
    "Name": "MyRunCommandTask",
    "Targets": [
        {
            "Key": "WindowTargetIds",
            "Values": [
                "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE"
            ]
        }
    ],
    "TaskArn": "AWS-ApplyPatchBaseline",
    "ServiceRoleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
    "TaskType": "RUN_COMMAND",
    "TaskParameters": {},
    "Priority": 1,
    "TaskInvocationParameters": {
        "RunCommand": {
            "Comment": "",
            "Parameters": {
                "Operation": [
                    "Install"
                ],
                "SnapshotId": [
                    ""
                ]
            },
            "TimeoutSeconds": 600
        }
    },
    "MaxConcurrency": "1",
    "MaxErrors": "1"
}
```

## See Also
<a name="API_GetMaintenanceWindowTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetMaintenanceWindowTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetMaintenanceWindowTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetMaintenanceWindowTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetMaintenanceWindowTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetMaintenanceWindowTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetMaintenanceWindowTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetMaintenanceWindowTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetMaintenanceWindowTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetMaintenanceWindowTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetMaintenanceWindowTask) 

# GetOpsItem
<a name="API_GetOpsItem"></a>

Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see [Set up OpsCenter](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) in the * AWS Systems Manager User Guide*.

Operations engineers and IT professionals use AWS Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see [AWS Systems Manager OpsCenter](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the * AWS Systems Manager User Guide*. 

## Request Syntax
<a name="API_GetOpsItem_RequestSyntax"></a>

```
{
   "OpsItemArn": "string",
   "OpsItemId": "string"
}
```

## Request Parameters
<a name="API_GetOpsItem_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [OpsItemArn](#API_GetOpsItem_RequestSyntax) **   <a name="systemsmanager-GetOpsItem-request-OpsItemArn"></a>
The OpsItem Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[0-9]{12}:opsitem.*`   
Required: No

 ** [OpsItemId](#API_GetOpsItem_RequestSyntax) **   <a name="systemsmanager-GetOpsItem-request-OpsItemId"></a>
The ID of the OpsItem that you want to get.  
Type: String  
Pattern: `^(oi)-[0-9a-f]{12}$`   
Required: Yes

## Response Syntax
<a name="API_GetOpsItem_ResponseSyntax"></a>

```
{
   "OpsItem": { 
      "ActualEndTime": number,
      "ActualStartTime": number,
      "Category": "string",
      "CreatedBy": "string",
      "CreatedTime": number,
      "Description": "string",
      "LastModifiedBy": "string",
      "LastModifiedTime": number,
      "Notifications": [ 
         { 
            "Arn": "string"
         }
      ],
      "OperationalData": { 
         "string" : { 
            "Type": "string",
            "Value": "string"
         }
      },
      "OpsItemArn": "string",
      "OpsItemId": "string",
      "OpsItemType": "string",
      "PlannedEndTime": number,
      "PlannedStartTime": number,
      "Priority": number,
      "RelatedOpsItems": [ 
         { 
            "OpsItemId": "string"
         }
      ],
      "Severity": "string",
      "Source": "string",
      "Status": "string",
      "Title": "string",
      "Version": "string"
   }
}
```

## Response Elements
<a name="API_GetOpsItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [OpsItem](#API_GetOpsItem_ResponseSyntax) **   <a name="systemsmanager-GetOpsItem-response-OpsItem"></a>
The OpsItem.  
Type: [OpsItem](API_OpsItem.md) object

## Errors
<a name="API_GetOpsItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsItemAccessDeniedException **   
You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the AWS Organizations management account.  
HTTP Status Code: 400

 ** OpsItemNotFoundException **   
The specified OpsItem ID doesn't exist. Verify the ID and try again.  
HTTP Status Code: 400

## Examples
<a name="API_GetOpsItem_Examples"></a>

### Example
<a name="API_GetOpsItem_Example_1"></a>

This example illustrates one usage of GetOpsItem.

#### Sample Request
<a name="API_GetOpsItem_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetOpsItem
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240330T153712Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 32

{
    "OpsItemId": "oi-f99f2EXAMPLE"
}
```

#### Sample Response
<a name="API_GetOpsItem_Example_1_Response"></a>

```
{
    "OpsItem": {
        "Category": "Availability",
        "CreatedBy": "arn:aws:sts::111122223333:assumed-role/OpsCenterRole/af3935bb93783f02aeea51784EXAMPLE",
        "CreatedTime": 1582701517.193,
        "Description": "CloudWatch Event Rule SSMOpsItems-SSM-maintenance-window-execution-failed was triggered. Your SSM Maintenance Window execution has failed. See below for more details.",
        "LastModifiedBy": "arn:aws:sts::111122223333:assumed-role/OpsCenterRole/af3935bb93783f02aeea51784EXAMPLE",
        "LastModifiedTime": 1582701517.193,
        "Notifications": [],
        "OperationalData": {
            "/aws/dedup": {
                "Type": "SearchableString",
                "Value": "{\"dedupString\":\"SSMOpsItems-SSM-maintenance-window-execution-failed\"}"
            },
            "/aws/resources": {
                "Type": "SearchableString",
                "Value": "[{\"arn\":\"arn:aws:ssm:us-east-2:111122223333:maintenancewindow/mw-0e357ebdc6EXAMPLE\"}]"
            },
            "window-execution-id": {
                "Type": "String",
                "Value": "e79e904b-0e42-43b8-a83d-b2aedEXAMPLE"
            },
            "window-id": {
                "Type": "String",
                "Value": "mw-0e357ebdc6EXAMPLE"
            }
        },
        "OpsItemId": "oi-f99f2EXAMPLE",
        "RelatedOpsItems": [],
        "Severity": "3",
        "Source": "SSM",
        "Status": "Open",
        "Title": "SSM Maintenance Window execution failed"
    }
}
```

## See Also
<a name="API_GetOpsItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetOpsItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetOpsItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetOpsItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetOpsItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetOpsItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetOpsItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetOpsItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetOpsItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetOpsItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetOpsItem) 

# GetOpsMetadata
<a name="API_GetOpsMetadata"></a>

View operational metadata related to an application in Application Manager.

## Request Syntax
<a name="API_GetOpsMetadata_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "OpsMetadataArn": "string"
}
```

## Request Parameters
<a name="API_GetOpsMetadata_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_GetOpsMetadata_RequestSyntax) **   <a name="systemsmanager-GetOpsMetadata-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [NextToken](#API_GetOpsMetadata_RequestSyntax) **   <a name="systemsmanager-GetOpsMetadata-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Type: String  
Required: No

 ** [OpsMetadataArn](#API_GetOpsMetadata_RequestSyntax) **   <a name="systemsmanager-GetOpsMetadata-request-OpsMetadataArn"></a>
The Amazon Resource Name (ARN) of an OpsMetadata Object to view.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:opsmetadata\/([a-zA-Z0-9-_\.\/]*)`   
Required: Yes

## Response Syntax
<a name="API_GetOpsMetadata_ResponseSyntax"></a>

```
{
   "Metadata": { 
      "string" : { 
         "Value": "string"
      }
   },
   "NextToken": "string",
   "ResourceId": "string"
}
```

## Response Elements
<a name="API_GetOpsMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Metadata](#API_GetOpsMetadata_ResponseSyntax) **   <a name="systemsmanager-GetOpsMetadata-response-Metadata"></a>
OpsMetadata for an Application Manager application.  
Type: String to [MetadataValue](API_MetadataValue.md) object map  
Map Entries: Maximum number of 5 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `^(?!\s*$).+` 

 ** [NextToken](#API_GetOpsMetadata_ResponseSyntax) **   <a name="systemsmanager-GetOpsMetadata-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

 ** [ResourceId](#API_GetOpsMetadata_ResponseSyntax) **   <a name="systemsmanager-GetOpsMetadata-response-ResourceId"></a>
The resource ID of the Application Manager application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^(?!\s*$).+` 

## Errors
<a name="API_GetOpsMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsMetadataInvalidArgumentException **   
One of the arguments passed is invalid.   
HTTP Status Code: 400

 ** OpsMetadataNotFoundException **   
The OpsMetadata object doesn't exist.   
HTTP Status Code: 400

## See Also
<a name="API_GetOpsMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetOpsMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetOpsMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetOpsMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetOpsMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetOpsMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetOpsMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetOpsMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetOpsMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetOpsMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetOpsMetadata) 

# GetOpsSummary
<a name="API_GetOpsSummary"></a>

View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about AWS Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any AWS resource or service configured to report OpsData to AWS Systems Manager Explorer. 

## Request Syntax
<a name="API_GetOpsSummary_RequestSyntax"></a>

```
{
   "Aggregators": [ 
      { 
         "Aggregators": [ 
            "OpsAggregator"
         ],
         "AggregatorType": "string",
         "AttributeName": "string",
         "Filters": [ 
            { 
               "Key": "string",
               "Type": "string",
               "Values": [ "string" ]
            }
         ],
         "TypeName": "string",
         "Values": { 
            "string" : "string" 
         }
      }
   ],
   "Filters": [ 
      { 
         "Key": "string",
         "Type": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "ResultAttributes": [ 
      { 
         "TypeName": "string"
      }
   ],
   "SyncName": "string"
}
```

## Request Parameters
<a name="API_GetOpsSummary_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Aggregators](#API_GetOpsSummary_RequestSyntax) **   <a name="systemsmanager-GetOpsSummary-request-Aggregators"></a>
Optional aggregators that return counts of OpsData based on one or more expressions.  
Type: Array of [OpsAggregator](API_OpsAggregator.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 12 items.  
Required: No

 ** [Filters](#API_GetOpsSummary_RequestSyntax) **   <a name="systemsmanager-GetOpsSummary-request-Filters"></a>
Optional filters used to scope down the returned OpsData.   
Type: Array of [OpsFilter](API_OpsFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_GetOpsSummary_RequestSyntax) **   <a name="systemsmanager-GetOpsSummary-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_GetOpsSummary_RequestSyntax) **   <a name="systemsmanager-GetOpsSummary-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

 ** [ResultAttributes](#API_GetOpsSummary_RequestSyntax) **   <a name="systemsmanager-GetOpsSummary-request-ResultAttributes"></a>
The OpsData data type to return.  
Type: Array of [OpsResultAttribute](API_OpsResultAttribute.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** [SyncName](#API_GetOpsSummary_RequestSyntax) **   <a name="systemsmanager-GetOpsSummary-request-SyncName"></a>
Specify the name of a resource data sync to get.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Syntax
<a name="API_GetOpsSummary_ResponseSyntax"></a>

```
{
   "Entities": [ 
      { 
         "Data": { 
            "string" : { 
               "CaptureTime": "string",
               "Content": [ 
                  { 
                     "string" : "string" 
                  }
               ]
            }
         },
         "Id": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetOpsSummary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Entities](#API_GetOpsSummary_ResponseSyntax) **   <a name="systemsmanager-GetOpsSummary-response-Entities"></a>
The list of aggregated details and filtered OpsData.  
Type: Array of [OpsEntity](API_OpsEntity.md) objects

 ** [NextToken](#API_GetOpsSummary_ResponseSyntax) **   <a name="systemsmanager-GetOpsSummary-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

## Errors
<a name="API_GetOpsSummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidAggregatorException **   
The specified aggregator isn't valid for the group type. Verify that the aggregator you provided is supported.  
HTTP Status Code: 400

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

 ** InvalidTypeNameException **   
The parameter type name isn't valid.  
HTTP Status Code: 400

 ** ResourceDataSyncNotFoundException **   
The specified sync name wasn't found.  
HTTP Status Code: 400

## Examples
<a name="API_GetOpsSummary_Examples"></a>

### Example
<a name="API_GetOpsSummary_Example_1"></a>

This example illustrates one usage of GetOpsSummary.

#### Sample Request
<a name="API_GetOpsSummary_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetOpsSummary
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240330T152044Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2
```

#### Sample Response
<a name="API_GetOpsSummary_Example_1_Response"></a>

```
{
    "Entities": [
        {
            "Data": {
                "AWS:OpsItem": {
                    "CaptureTime": "2024-02-26T05:59:57.430Z",
                    "Content": [
                        {
                            "AccountId": "111122223333",
                            "Category": "Availability",
                            "CreatedBy": "arn:aws:sts::111122223333:assumed-role/OpsCenterRole/af3935bb93783f02aeea51784EXAMPLE",
                            "CreatedTime": "2024-02-26T07:18:37.193Z",
                            "Description": "CloudWatch Event Rule SSMOpsItems-SSM-maintenance-window-execution-failed was triggered. Your SSM Maintenance Window execution has failed. See below for more details.",
                            "LastModifiedBy": "arn:aws:sts::111122223333:assumed-role/OpsCenterRole/af3935bb93783f02aeea51784EXAMPLE",
                            "LastModifiedTime": "2024-02-26T07:18:37.193Z",
                            "Notifications": "",
                            "OperationalData": "{\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ssm:us-east-2:111122223333:maintenancewindow/mw-0e357ebdc6EXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-SSM-maintenance-window-execution-failed\\\"}\"}}",
                            "OpsItemId": "oi-f99f2EXAMPLE",
                            "RelatedItems": "",
                            "Severity": "3",
                            "Source": "SSM",
                            "Status": "Open",
                            "Title": "SSM Maintenance Window execution failed"
                        }
                    ]
                }
            },
            "Id": "oi-f99f2EXAMPLE"
        },---truncated---
    ]
}
```

## See Also
<a name="API_GetOpsSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetOpsSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetOpsSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetOpsSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetOpsSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetOpsSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetOpsSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetOpsSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetOpsSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetOpsSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetOpsSummary) 

# GetParameter
<a name="API_GetParameter"></a>

Get information about a single parameter by specifying the parameter name.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a `ValidationException` error.

**Note**  
To get information about more than one parameter at a time, use the [GetParameters](API_GetParameters.md) operation.

## Request Syntax
<a name="API_GetParameter_RequestSyntax"></a>

```
{
   "Name": "string",
   "WithDecryption": boolean
}
```

## Request Parameters
<a name="API_GetParameter_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_GetParameter_RequestSyntax) **   <a name="systemsmanager-GetParameter-request-Name"></a>
The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.  
To query by parameter label, use `"Name": "name:label"`. To query by parameter version, use `"Name": "name:version"`.  
For more information about shared parameters, see [Working with shared parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html) in the * AWS Systems Manager User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [WithDecryption](#API_GetParameter_RequestSyntax) **   <a name="systemsmanager-GetParameter-request-WithDecryption"></a>
Return decrypted values for secure string parameters. This flag is ignored for `String` and `StringList` parameter types.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_GetParameter_ResponseSyntax"></a>

```
{
   "Parameter": { 
      "ARN": "string",
      "DataType": "string",
      "LastModifiedDate": number,
      "Name": "string",
      "Selector": "string",
      "SourceResult": "string",
      "Type": "string",
      "Value": "string",
      "Version": number
   }
}
```

## Response Elements
<a name="API_GetParameter_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Parameter](#API_GetParameter_ResponseSyntax) **   <a name="systemsmanager-GetParameter-response-Parameter"></a>
Information about a parameter.  
Type: [Parameter](API_Parameter.md) object

## Errors
<a name="API_GetParameter_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidKeyId **   
The query key ID isn't valid.  
HTTP Status Code: 400

 ** ParameterNotFound **   
The parameter couldn't be found. Verify the name and try again.  
For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is *not* recorded in AWS CloudTrail event logs.
HTTP Status Code: 400

 ** ParameterVersionNotFound **   
The specified parameter version wasn't found. Verify the parameter name and version, and try again.  
HTTP Status Code: 400

## Examples
<a name="API_GetParameter_Examples"></a>

### Example
<a name="API_GetParameter_Example_1"></a>

This example illustrates one usage of GetParameter.

#### Sample Request
<a name="API_GetParameter_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 29
X-Amz-Target: AmazonSSM.GetParameter
X-Amz-Date: 20240316T005724Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Name": "MyGitHubPassword"
}
```

#### Sample Response
<a name="API_GetParameter_Example_1_Response"></a>

```
{
    "Parameter": {
        "ARN": "arn:aws:ssm:us-east-2:111122223333:parameter/MyGitHubPassword",
        "DataType": "text",
        "LastModifiedDate": 1582657288.8,
        "Name": "MyGitHubPassword",
        "Type": "SecureString",
        "Value": "AYA39c3b3042cd2aEXAMPLE/AKIAIOSFODNN7EXAMPLE/fh983hg9awEXAMPLE==",
        "Version": 3
    }
}
```

## See Also
<a name="API_GetParameter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetParameter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetParameter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetParameter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetParameter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetParameter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetParameter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetParameter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetParameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetParameter) 

# GetParameterHistory
<a name="API_GetParameterHistory"></a>

Retrieves the history of all changes to a parameter.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a `ValidationException` error.

**Important**  
If you change the AWS KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, `GetParameterHistory` retrieves whatever the original key alias was referencing.

## Request Syntax
<a name="API_GetParameterHistory_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "Name": "string",
   "NextToken": "string",
   "WithDecryption": boolean
}
```

## Request Parameters
<a name="API_GetParameterHistory_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_GetParameterHistory_RequestSyntax) **   <a name="systemsmanager-GetParameterHistory-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [Name](#API_GetParameterHistory_RequestSyntax) **   <a name="systemsmanager-GetParameterHistory-request-Name"></a>
The name or Amazon Resource Name (ARN) of the parameter for which you want to review history. For parameters shared with you from another account, you must use the full ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [NextToken](#API_GetParameterHistory_RequestSyntax) **   <a name="systemsmanager-GetParameterHistory-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [WithDecryption](#API_GetParameterHistory_RequestSyntax) **   <a name="systemsmanager-GetParameterHistory-request-WithDecryption"></a>
Return decrypted values for secure string parameters. This flag is ignored for `String` and `StringList` parameter types.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_GetParameterHistory_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Parameters": [ 
      { 
         "AllowedPattern": "string",
         "DataType": "string",
         "Description": "string",
         "KeyId": "string",
         "Labels": [ "string" ],
         "LastModifiedDate": number,
         "LastModifiedUser": "string",
         "Name": "string",
         "Policies": [ 
            { 
               "PolicyStatus": "string",
               "PolicyText": "string",
               "PolicyType": "string"
            }
         ],
         "Tier": "string",
         "Type": "string",
         "Value": "string",
         "Version": number
      }
   ]
}
```

## Response Elements
<a name="API_GetParameterHistory_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_GetParameterHistory_ResponseSyntax) **   <a name="systemsmanager-GetParameterHistory-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [Parameters](#API_GetParameterHistory_ResponseSyntax) **   <a name="systemsmanager-GetParameterHistory-response-Parameters"></a>
A list of parameters returned by the request.  
Type: Array of [ParameterHistory](API_ParameterHistory.md) objects

## Errors
<a name="API_GetParameterHistory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidKeyId **   
The query key ID isn't valid.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

 ** ParameterNotFound **   
The parameter couldn't be found. Verify the name and try again.  
For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is *not* recorded in AWS CloudTrail event logs.
HTTP Status Code: 400

## Examples
<a name="API_GetParameterHistory_Examples"></a>

### Example
<a name="API_GetParameterHistory_Example_1"></a>

This example illustrates one usage of GetParameterHistory.

#### Sample Request
<a name="API_GetParameterHistory_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 29
X-Amz-Target: AmazonSSM.GetParameterHistory
X-Amz-Date: 20240316T005206Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Name": "EC2TestServerType"
}
```

#### Sample Response
<a name="API_GetParameterHistory_Example_1_Response"></a>

```
{
    "Parameters": [
        {
            "Description": "Instance type for Test servers",
            "LastModifiedDate": 1521158745.607,
            "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson",
            "Name": "EC2TestServerType",
            "Policies": [],
            "Type": "String",
            "Value": "t2.nano",
            "Version": 1
        },
        {
            "Description": "Instance type for Test servers",
            "LastModifiedDate": 1521158834.467,
            "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson",
            "Name": "EC2TestServerType",
            "Policies": [],
            "Type": "String",
            "Value": "t2.micro",
            "Version": 2
        },
        {
            "Description": "Instance type for Test servers",
            "LastModifiedDate": 1521158912.828,
            "LastModifiedUser": "arn:aws:iam::111122223333:user/Jane.Roe",
            "Name": "EC2TestServerType",
            "Policies": [],
            "Type": "String",
            "Value": "t2.large",
            "Version": 3
        }
    ]
}
```

## See Also
<a name="API_GetParameterHistory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetParameterHistory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetParameterHistory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetParameterHistory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetParameterHistory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetParameterHistory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetParameterHistory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetParameterHistory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetParameterHistory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetParameterHistory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetParameterHistory) 

# GetParameters
<a name="API_GetParameters"></a>

Get information about one or more parameters by specifying multiple parameter names.

**Note**  
To get information about a single parameter, you can use the [GetParameter](API_GetParameter.md) operation instead.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a `ValidationException` error.

## Request Syntax
<a name="API_GetParameters_RequestSyntax"></a>

```
{
   "Names": [ "string" ],
   "WithDecryption": boolean
}
```

## Request Parameters
<a name="API_GetParameters_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Names](#API_GetParameters_RequestSyntax) **   <a name="systemsmanager-GetParameters-request-Names"></a>
The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs.  
To query by parameter label, use `"Name": "name:label"`. To query by parameter version, use `"Name": "name:version"`.  
The results for `GetParameters` requests are listed in alphabetical order in query responses.
For information about shared parameters, see [Working with shared parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html) in the * AWS Systems Manager User Guide*.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [WithDecryption](#API_GetParameters_RequestSyntax) **   <a name="systemsmanager-GetParameters-request-WithDecryption"></a>
Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for `String` and `StringList` parameter types.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_GetParameters_ResponseSyntax"></a>

```
{
   "InvalidParameters": [ "string" ],
   "Parameters": [ 
      { 
         "ARN": "string",
         "DataType": "string",
         "LastModifiedDate": number,
         "Name": "string",
         "Selector": "string",
         "SourceResult": "string",
         "Type": "string",
         "Value": "string",
         "Version": number
      }
   ]
}
```

## Response Elements
<a name="API_GetParameters_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InvalidParameters](#API_GetParameters_ResponseSyntax) **   <a name="systemsmanager-GetParameters-response-InvalidParameters"></a>
A list of parameters that aren't formatted correctly or don't run during an execution.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Parameters](#API_GetParameters_ResponseSyntax) **   <a name="systemsmanager-GetParameters-response-Parameters"></a>
A list of details for a parameter.  
Type: Array of [Parameter](API_Parameter.md) objects

## Errors
<a name="API_GetParameters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidKeyId **   
The query key ID isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_GetParameters_Examples"></a>

### Example
<a name="API_GetParameters_Example_1"></a>

This example illustrates one usage of GetParameters.

#### Sample Request
<a name="API_GetParameters_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 73
X-Amz-Target: AmazonSSM.GetParameters
X-Amz-Date: 20240316T001029Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Names": [
        "EC2DevServerTypo",
        "EC2DevServerType",
        "EC2TestServerType",
        "EC2ProdServerType"
    ]
}
```

#### Sample Response
<a name="API_GetParameters_Example_1_Response"></a>

```
{
    "InvalidParameters": [
        "EC2DevServerTypo"
    ],
    "Parameters": [
        {
            "Name": "EC2DevServerType",
            "Type": "String",
            "Value": "t2.micro",
            "Version": 2
        },
        {
            "Name": "EC2ProdServerType",
            "Type": "String",
            "Value": "m4.large",
            "Version": 1
        },
        {
            "Name": "EC2TestServerType",
            "Type": "String",
            "Value": "t2.large",
            "Version": 3
        }
    ]
}
```

## See Also
<a name="API_GetParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetParameters) 

# GetParametersByPath
<a name="API_GetParametersByPath"></a>

Retrieve information about one or more parameters under a specified level in a hierarchy. 

Request results are returned on a best-effort basis. If you specify `MaxResults` in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of `MaxResults`. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a `NextToken`. You can specify the `NextToken` in a subsequent call to get the next set of results.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a `ValidationException` error.

## Request Syntax
<a name="API_GetParametersByPath_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "ParameterFilters": [ 
      { 
         "Key": "string",
         "Option": "string",
         "Values": [ "string" ]
      }
   ],
   "Path": "string",
   "Recursive": boolean,
   "WithDecryption": boolean
}
```

## Request Parameters
<a name="API_GetParametersByPath_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_GetParametersByPath_RequestSyntax) **   <a name="systemsmanager-GetParametersByPath-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [NextToken](#API_GetParametersByPath_RequestSyntax) **   <a name="systemsmanager-GetParametersByPath-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

 ** [ParameterFilters](#API_GetParametersByPath_RequestSyntax) **   <a name="systemsmanager-GetParametersByPath-request-ParameterFilters"></a>
Filters to limit the request results.  
The following `Key` values are supported for `GetParametersByPath`: `Type`, `KeyId`, and `Label`.  
The following `Key` values aren't supported for `GetParametersByPath`: `tag`, `DataType`, `Name`, `Path`, and `Tier`.
Type: Array of [ParameterStringFilter](API_ParameterStringFilter.md) objects  
Required: No

 ** [Path](#API_GetParametersByPath_RequestSyntax) **   <a name="systemsmanager-GetParametersByPath-request-Path"></a>
The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: `/Finance/Prod/IAD/WinServ2016/license33 `   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [Recursive](#API_GetParametersByPath_RequestSyntax) **   <a name="systemsmanager-GetParametersByPath-request-Recursive"></a>
Retrieve all parameters within a hierarchy.  
If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path `/a`, then the user can also access `/a/b`. Even if a user has explicitly been denied access in IAM for parameter `/a/b`, they can still call the GetParametersByPath API operation recursively for `/a` and view `/a/b`.
Type: Boolean  
Required: No

 ** [WithDecryption](#API_GetParametersByPath_RequestSyntax) **   <a name="systemsmanager-GetParametersByPath-request-WithDecryption"></a>
Retrieve all parameters in a hierarchy with their value decrypted.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_GetParametersByPath_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Parameters": [ 
      { 
         "ARN": "string",
         "DataType": "string",
         "LastModifiedDate": number,
         "Name": "string",
         "Selector": "string",
         "SourceResult": "string",
         "Type": "string",
         "Value": "string",
         "Version": number
      }
   ]
}
```

## Response Elements
<a name="API_GetParametersByPath_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_GetParametersByPath_ResponseSyntax) **   <a name="systemsmanager-GetParametersByPath-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

 ** [Parameters](#API_GetParametersByPath_ResponseSyntax) **   <a name="systemsmanager-GetParametersByPath-response-Parameters"></a>
A list of parameters found in the specified hierarchy.  
Type: Array of [Parameter](API_Parameter.md) objects

## Errors
<a name="API_GetParametersByPath_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilterKey **   
The specified key isn't valid.  
HTTP Status Code: 400

 ** InvalidFilterOption **   
The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.    
 ** message **   
The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
HTTP Status Code: 400

 ** InvalidFilterValue **   
The filter value isn't valid. Verify the value and try again.  
HTTP Status Code: 400

 ** InvalidKeyId **   
The query key ID isn't valid.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_GetParametersByPath_Examples"></a>

### Example
<a name="API_GetParametersByPath_Example_1"></a>

This example illustrates one usage of GetParametersByPath.

#### Sample Request
<a name="API_GetParametersByPath_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 46
X-Amz-Target: AmazonSSM.GetParametersByPath
X-Amz-Date: 20240316T004724Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Path": "/Branch312/Dev/",
    "Recursive": true
}
```

#### Sample Response
<a name="API_GetParametersByPath_Example_1_Response"></a>

```
{
    "Parameters": [
        {
            "Name": "/Branch312/Dev/Engineer1",
            "Type": "String",
            "Value": "Saanvi Sarkar",
            "Version": 1
        },
        {
            "Name": "/Branch312/Dev/Engineer2",
            "Type": "String",
            "Value": "Zhang Wei",
            "Version": 1
        },
        {
            "Name": "/Branch312/Dev/Engineer3",
            "Type": "String",
            "Value": "Alejandro Rosalez",
            "Version": 1
        },
        {
            "Name": "/Branch312/Dev/Intern",
            "Type": "String",
            "Value": "Nikhil Jayashankar",
            "Version": 1
        },
        {
            "Name": "/Branch312/Dev/TeamLead",
            "Type": "String",
            "Value": "Jane Roe",
            "Version": 1
        }
    ]
}
```

## See Also
<a name="API_GetParametersByPath_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetParametersByPath) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetParametersByPath) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetParametersByPath) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetParametersByPath) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetParametersByPath) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetParametersByPath) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetParametersByPath) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetParametersByPath) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetParametersByPath) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetParametersByPath) 

# GetPatchBaseline
<a name="API_GetPatchBaseline"></a>

Retrieves information about a patch baseline.

## Request Syntax
<a name="API_GetPatchBaseline_RequestSyntax"></a>

```
{
   "BaselineId": "string"
}
```

## Request Parameters
<a name="API_GetPatchBaseline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BaselineId](#API_GetPatchBaseline_RequestSyntax) **   <a name="systemsmanager-GetPatchBaseline-request-BaselineId"></a>
The ID of the patch baseline to retrieve.  
To retrieve information about an AWS managed patch baseline, specify the full Amazon Resource Name (ARN) of the baseline. For example, for the baseline `AWS-AmazonLinuxDefaultPatchBaseline`, specify `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7` instead of `pb-0e392de35e7c563b7`.
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$`   
Required: Yes

## Response Syntax
<a name="API_GetPatchBaseline_ResponseSyntax"></a>

```
{
   "ApprovalRules": { 
      "PatchRules": [ 
         { 
            "ApproveAfterDays": number,
            "ApproveUntilDate": "string",
            "ComplianceLevel": "string",
            "EnableNonSecurity": boolean,
            "PatchFilterGroup": { 
               "PatchFilters": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         }
      ]
   },
   "ApprovedPatches": [ "string" ],
   "ApprovedPatchesComplianceLevel": "string",
   "ApprovedPatchesEnableNonSecurity": boolean,
   "AvailableSecurityUpdatesComplianceStatus": "string",
   "BaselineId": "string",
   "CreatedDate": number,
   "Description": "string",
   "GlobalFilters": { 
      "PatchFilters": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "ModifiedDate": number,
   "Name": "string",
   "OperatingSystem": "string",
   "PatchGroups": [ "string" ],
   "RejectedPatches": [ "string" ],
   "RejectedPatchesAction": "string",
   "Sources": [ 
      { 
         "Configuration": "string",
         "Name": "string",
         "Products": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_GetPatchBaseline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApprovalRules](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-ApprovalRules"></a>
A set of rules used to include patches in the baseline.  
Type: [PatchRuleGroup](API_PatchRuleGroup.md) object

 ** [ApprovedPatches](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-ApprovedPatches"></a>
A list of explicitly approved patches for the baseline.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [ApprovedPatchesComplianceLevel](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-ApprovedPatchesComplianceLevel"></a>
Returns the specified compliance severity level for approved patches in the patch baseline.  
Type: String  
Valid Values: `CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED` 

 ** [ApprovedPatchesEnableNonSecurity](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-ApprovedPatchesEnableNonSecurity"></a>
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is `false`. Applies to Linux managed nodes only.  
Type: Boolean

 ** [AvailableSecurityUpdatesComplianceStatus](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-AvailableSecurityUpdatesComplianceStatus"></a>
Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. This preference is specified when the `CreatePatchBaseline` or `UpdatePatchBaseline` commands are run.  
Applies to Windows Server managed nodes only.  
Type: String  
Valid Values: `COMPLIANT | NON_COMPLIANT` 

 ** [BaselineId](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-BaselineId"></a>
The ID of the retrieved patch baseline.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$` 

 ** [CreatedDate](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-CreatedDate"></a>
The date the patch baseline was created.  
Type: Timestamp

 ** [Description](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-Description"></a>
A description of the patch baseline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [GlobalFilters](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-GlobalFilters"></a>
A set of global filters used to exclude patches from the baseline.  
Type: [PatchFilterGroup](API_PatchFilterGroup.md) object

 ** [ModifiedDate](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-ModifiedDate"></a>
The date the patch baseline was last modified.  
Type: Timestamp

 ** [Name](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-Name"></a>
The name of the patch baseline.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$` 

 ** [OperatingSystem](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-OperatingSystem"></a>
Returns the operating system specified for the patch baseline.  
Type: String  
Valid Values: `WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023` 

 ** [PatchGroups](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-PatchGroups"></a>
Patch groups included in the patch baseline.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 

 ** [RejectedPatches](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-RejectedPatches"></a>
A list of explicitly rejected patches for the baseline.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [RejectedPatchesAction](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-RejectedPatchesAction"></a>
The action specified to take on patches included in the `RejectedPatches` list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.  
Type: String  
Valid Values: `ALLOW_AS_DEPENDENCY | BLOCK` 

 ** [Sources](#API_GetPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaseline-response-Sources"></a>
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.  
Type: Array of [PatchSource](API_PatchSource.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

## Errors
<a name="API_GetPatchBaseline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidResourceId **   
The resource ID isn't valid. Verify that you entered the correct ID and try again.  
HTTP Status Code: 400

## Examples
<a name="API_GetPatchBaseline_Examples"></a>

### Example
<a name="API_GetPatchBaseline_Example_1"></a>

This example illustrates one usage of GetPatchBaseline.

#### Sample Request
<a name="API_GetPatchBaseline_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 38
X-Amz-Target: AmazonSSM.GetPatchBaseline
X-Amz-Date: 20240309T020232Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

#### Sample Response
<a name="API_GetPatchBaseline_Example_1_Response"></a>

```
{
    "ApprovalRules": {
        "PatchRules": [
            {
                "ApproveAfterDays": 1,
                "ComplianceLevel": "UNSPECIFIED",
                "EnableNonSecurity": false,
                "PatchFilterGroup": {
                    "PatchFilters": [
                        {
                            "Key": "PRODUCT",
                            "Values": [
                                "WindowsServer2012R2"
                            ]
                        },
                        {
                            "Key": "CLASSIFICATION",
                            "Values": [
                                "SecurityUpdates"
                            ]
                        },
                        {
                            "Key": "MSRC_SEVERITY",
                            "Values": [
                                "Important",
                                "Critical",
                                "Moderate"
                            ]
                        }
                    ]
                }
            }
        ]
    },
    "ApprovedPatches": [],
    "ApprovedPatchesComplianceLevel": "HIGH",
    "ApprovedPatchesEnableNonSecurity": false,
    "BaselineId": "pb-0c10e65780EXAMPLE",
    "Description": "My Moderate, Important, and Critical security updates for Windows Server 2012 R2",
    "GlobalFilters": {
        "PatchFilters": []
    },
    "CreatedDate": 1520561435.87,
    "ModifiedDate": 1520561435.869,
    "Name": "my-Windows-Server-2012R2",
    "OperatingSystem": "WINDOWS",
    "PatchGroups": [
        "mypatchgroup"
    ],
    "RejectedPatches": [
        "KB3452678"
    ],
    "RejecteddPatchesAction": "ALLOW_AS_DEPENDENCY",
    "Sources": []
}
```

## See Also
<a name="API_GetPatchBaseline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetPatchBaseline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetPatchBaseline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetPatchBaseline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetPatchBaseline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetPatchBaseline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetPatchBaseline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetPatchBaseline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetPatchBaseline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetPatchBaseline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetPatchBaseline) 

# GetPatchBaselineForPatchGroup
<a name="API_GetPatchBaselineForPatchGroup"></a>

Retrieves the patch baseline that should be used for the specified patch group.

## Request Syntax
<a name="API_GetPatchBaselineForPatchGroup_RequestSyntax"></a>

```
{
   "OperatingSystem": "string",
   "PatchGroup": "string"
}
```

## Request Parameters
<a name="API_GetPatchBaselineForPatchGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [OperatingSystem](#API_GetPatchBaselineForPatchGroup_RequestSyntax) **   <a name="systemsmanager-GetPatchBaselineForPatchGroup-request-OperatingSystem"></a>
Returns the operating system rule specified for patch groups using the patch baseline.  
Type: String  
Valid Values: `WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023`   
Required: No

 ** [PatchGroup](#API_GetPatchBaselineForPatchGroup_RequestSyntax) **   <a name="systemsmanager-GetPatchBaselineForPatchGroup-request-PatchGroup"></a>
The name of the patch group whose patch baseline should be retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## Response Syntax
<a name="API_GetPatchBaselineForPatchGroup_ResponseSyntax"></a>

```
{
   "BaselineId": "string",
   "OperatingSystem": "string",
   "PatchGroup": "string"
}
```

## Response Elements
<a name="API_GetPatchBaselineForPatchGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BaselineId](#API_GetPatchBaselineForPatchGroup_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaselineForPatchGroup-response-BaselineId"></a>
The ID of the patch baseline that should be used for the patch group.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$` 

 ** [OperatingSystem](#API_GetPatchBaselineForPatchGroup_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaselineForPatchGroup-response-OperatingSystem"></a>
The operating system rule specified for patch groups using the patch baseline.  
Type: String  
Valid Values: `WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023` 

 ** [PatchGroup](#API_GetPatchBaselineForPatchGroup_ResponseSyntax) **   <a name="systemsmanager-GetPatchBaselineForPatchGroup-response-PatchGroup"></a>
The name of the patch group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 

## Errors
<a name="API_GetPatchBaselineForPatchGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_GetPatchBaselineForPatchGroup_Examples"></a>

### Example
<a name="API_GetPatchBaselineForPatchGroup_Example_1"></a>

This example illustrates one usage of GetPatchBaselineForPatchGroup.

#### Sample Request
<a name="API_GetPatchBaselineForPatchGroup_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 66
X-Amz-Target: AmazonSSM.GetPatchBaselineForPatchGroup
X-Amz-Date: 20240309T060906Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "PatchGroup": "mypatchgroup",
    "OperatingSystem": "WINDOWS"
}
```

#### Sample Response
<a name="API_GetPatchBaselineForPatchGroup_Example_1_Response"></a>

```
{
    "BaselineId": "pb-0c10e65780EXAMPLE",
    "OperatingSystem": "WINDOWS",
    "PatchGroup": "mypatchgroup"
}
```

## See Also
<a name="API_GetPatchBaselineForPatchGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetPatchBaselineForPatchGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetPatchBaselineForPatchGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetPatchBaselineForPatchGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetPatchBaselineForPatchGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetPatchBaselineForPatchGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetPatchBaselineForPatchGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetPatchBaselineForPatchGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetPatchBaselineForPatchGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetPatchBaselineForPatchGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetPatchBaselineForPatchGroup) 

# GetResourcePolicies
<a name="API_GetResourcePolicies"></a>

Returns an array of the `Policy` object.

## Request Syntax
<a name="API_GetResourcePolicies_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_GetResourcePolicies_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_GetResourcePolicies_RequestSyntax) **   <a name="systemsmanager-GetResourcePolicies-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_GetResourcePolicies_RequestSyntax) **   <a name="systemsmanager-GetResourcePolicies-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Type: String  
Required: No

 ** [ResourceArn](#API_GetResourcePolicies_RequestSyntax) **   <a name="systemsmanager-GetResourcePolicies-request-ResourceArn"></a>
Amazon Resource Name (ARN) of the resource to which the policies are attached.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

## Response Syntax
<a name="API_GetResourcePolicies_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Policies": [ 
      { 
         "Policy": "string",
         "PolicyHash": "string",
         "PolicyId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetResourcePolicies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_GetResourcePolicies_ResponseSyntax) **   <a name="systemsmanager-GetResourcePolicies-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

 ** [Policies](#API_GetResourcePolicies_ResponseSyntax) **   <a name="systemsmanager-GetResourcePolicies-response-Policies"></a>
An array of the `Policy` object.  
Type: Array of [GetResourcePoliciesResponseEntry](API_GetResourcePoliciesResponseEntry.md) objects

## Errors
<a name="API_GetResourcePolicies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified parameter to be shared could not be found.  
HTTP Status Code: 400

 ** ResourcePolicyInvalidParameterException **   
One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.  
HTTP Status Code: 400

## See Also
<a name="API_GetResourcePolicies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetResourcePolicies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetResourcePolicies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetResourcePolicies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetResourcePolicies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetResourcePolicies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetResourcePolicies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetResourcePolicies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetResourcePolicies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetResourcePolicies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetResourcePolicies) 

# GetServiceSetting
<a name="API_GetServiceSetting"></a>

 `ServiceSetting` is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of `false`. This means the user can't use this feature unless they change the setting to `true` and intentionally opt in for a paid feature.

Services map a `SettingId` object to a setting value. AWS services teams define the default value for a `SettingId`. You can't create a new `SettingId`, but you can overwrite the default value if you have the `ssm:UpdateServiceSetting` permission for the setting. Use the [UpdateServiceSetting](API_UpdateServiceSetting.md) API operation to change the default setting. Or use the [ResetServiceSetting](API_ResetServiceSetting.md) to change the value back to the original value defined by the AWS service team.

Query the current service setting for the AWS account. 

## Request Syntax
<a name="API_GetServiceSetting_RequestSyntax"></a>

```
{
   "SettingId": "string"
}
```

## Request Parameters
<a name="API_GetServiceSetting_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [SettingId](#API_GetServiceSetting_RequestSyntax) **   <a name="systemsmanager-GetServiceSetting-request-SettingId"></a>
The ID of the service setting to get. The setting ID can be one of the following.  
+  `/ssm/appmanager/appmanager-enabled` 
+  `/ssm/automation/customer-script-log-destination` 
+  `/ssm/automation/customer-script-log-group-name` 
+ /ssm/automation/enable-adaptive-concurrency
+  `/ssm/documents/console/public-sharing-permission` 
+  `/ssm/managed-instance/activation-tier` 
+  `/ssm/managed-instance/default-ec2-instance-management-role` 
+  `/ssm/opsinsights/opscenter` 
+  `/ssm/parameter-store/default-parameter-tier` 
+  `/ssm/parameter-store/high-throughput-enabled` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Response Syntax
<a name="API_GetServiceSetting_ResponseSyntax"></a>

```
{
   "ServiceSetting": { 
      "ARN": "string",
      "LastModifiedDate": number,
      "LastModifiedUser": "string",
      "SettingId": "string",
      "SettingValue": "string",
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_GetServiceSetting_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ServiceSetting](#API_GetServiceSetting_ResponseSyntax) **   <a name="systemsmanager-GetServiceSetting-response-ServiceSetting"></a>
The query result of the current service setting.  
Type: [ServiceSetting](API_ServiceSetting.md) object

## Errors
<a name="API_GetServiceSetting_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ServiceSettingNotFound **   
The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the AWS service team.  
HTTP Status Code: 400

## Examples
<a name="API_GetServiceSetting_Examples"></a>

### Example
<a name="API_GetServiceSetting_Example_1"></a>

This example illustrates one usage of GetServiceSetting.

#### Sample Request
<a name="API_GetServiceSetting_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetServiceSetting
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T203339Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 54

{
    "SettingId": "/ssm/managed-instance/activation-tier"
}
```

#### Sample Response
<a name="API_GetServiceSetting_Example_1_Response"></a>

```
{
    "ServiceSetting": {
        "ARN": "arn:aws:ssm:us-east-2:111122223333:servicesetting/ssm/managed-instance/activation-tier",
        "LastModifiedDate": 1579136114.275,
        "LastModifiedUser": "System",
        "SettingId": "/ssm/managed-instance/activation-tier",
        "SettingValue": "standard",
        "Status": "Default"
    }
}
```

## See Also
<a name="API_GetServiceSetting_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/GetServiceSetting) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/GetServiceSetting) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/GetServiceSetting) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/GetServiceSetting) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/GetServiceSetting) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/GetServiceSetting) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/GetServiceSetting) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/GetServiceSetting) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/GetServiceSetting) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/GetServiceSetting) 

# LabelParameterVersion
<a name="API_LabelParameterVersion"></a>

A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, AWS Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. 

Parameter labels have the following requirements and restrictions.
+ A version of a parameter can have a maximum of 10 labels.
+ You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
+ You can move a label from one version of a parameter to another.
+ You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
+ If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.
+ A label can have a maximum of 100 characters.
+ Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (\$1).
+ Labels can't begin with a number, "`aws`" or "`ssm`" (not case sensitive). If a label fails to meet these requirements, then the label isn't associated with a parameter and the system displays it in the list of InvalidLabels.
+ Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a `ValidationException` error.

## Request Syntax
<a name="API_LabelParameterVersion_RequestSyntax"></a>

```
{
   "Labels": [ "string" ],
   "Name": "string",
   "ParameterVersion": number
}
```

## Request Parameters
<a name="API_LabelParameterVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Labels](#API_LabelParameterVersion_RequestSyntax) **   <a name="systemsmanager-LabelParameterVersion-request-Labels"></a>
One or more labels to attach to the specified parameter version.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Name](#API_LabelParameterVersion_RequestSyntax) **   <a name="systemsmanager-LabelParameterVersion-request-Name"></a>
The parameter name on which you want to attach one or more labels.  
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [ParameterVersion](#API_LabelParameterVersion_RequestSyntax) **   <a name="systemsmanager-LabelParameterVersion-request-ParameterVersion"></a>
The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.  
Type: Long  
Required: No

## Response Syntax
<a name="API_LabelParameterVersion_ResponseSyntax"></a>

```
{
   "InvalidLabels": [ "string" ],
   "ParameterVersion": number
}
```

## Response Elements
<a name="API_LabelParameterVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InvalidLabels](#API_LabelParameterVersion_ResponseSyntax) **   <a name="systemsmanager-LabelParameterVersion-response-InvalidLabels"></a>
The label doesn't meet the requirements. For information about parameter label requirements, see [Working with parameter labels](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html) in the * AWS Systems Manager User Guide*.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [ParameterVersion](#API_LabelParameterVersion_ResponseSyntax) **   <a name="systemsmanager-LabelParameterVersion-response-ParameterVersion"></a>
The version of the parameter that has been labeled.  
Type: Long

## Errors
<a name="API_LabelParameterVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ParameterNotFound **   
The parameter couldn't be found. Verify the name and try again.  
For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is *not* recorded in AWS CloudTrail event logs.
HTTP Status Code: 400

 ** ParameterVersionLabelLimitExceeded **   
A parameter version can have a maximum of ten labels.  
HTTP Status Code: 400

 ** ParameterVersionNotFound **   
The specified parameter version wasn't found. Verify the parameter name and version, and try again.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_LabelParameterVersion_Examples"></a>

### Example
<a name="API_LabelParameterVersion_Example_1"></a>

This example illustrates one usage of LabelParameterVersion.

#### Sample Request
<a name="API_LabelParameterVersion_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.LabelParameterVersion
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T191052Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240229/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 76

{
    "Name": "MyGitHubPassword",
    "ParameterVersion": 3,
    "Labels": [
        "March-2020"
    ]
}
```

#### Sample Response
<a name="API_LabelParameterVersion_Example_1_Response"></a>

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

## See Also
<a name="API_LabelParameterVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/LabelParameterVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/LabelParameterVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/LabelParameterVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/LabelParameterVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/LabelParameterVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/LabelParameterVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/LabelParameterVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/LabelParameterVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/LabelParameterVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/LabelParameterVersion) 

# ListAssociations
<a name="API_ListAssociations"></a>

Returns all State Manager associations in the current AWS account and AWS Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a tool in AWS Systems Manager.

## Request Syntax
<a name="API_ListAssociations_RequestSyntax"></a>

```
{
   "AssociationFilterList": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListAssociations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AssociationFilterList](#API_ListAssociations_RequestSyntax) **   <a name="systemsmanager-ListAssociations-request-AssociationFilterList"></a>
One or more filters. Use a filter to return a more specific list of results.  
Filtering associations using the `InstanceID` attribute only returns legacy associations created using the `InstanceID` attribute. Associations targeting the managed node that are part of the Target Attributes `ResourceGroup` or `Tags` aren't returned.
Type: Array of [AssociationFilter](API_AssociationFilter.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** [MaxResults](#API_ListAssociations_RequestSyntax) **   <a name="systemsmanager-ListAssociations-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListAssociations_RequestSyntax) **   <a name="systemsmanager-ListAssociations-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_ListAssociations_ResponseSyntax"></a>

```
{
   "Associations": [ 
      { 
         "AssociationId": "string",
         "AssociationName": "string",
         "AssociationVersion": "string",
         "DocumentVersion": "string",
         "Duration": number,
         "InstanceId": "string",
         "LastExecutionDate": number,
         "Name": "string",
         "Overview": { 
            "AssociationStatusAggregatedCount": { 
               "string" : number 
            },
            "DetailedStatus": "string",
            "Status": "string"
         },
         "ScheduleExpression": "string",
         "ScheduleOffset": number,
         "TargetMaps": [ 
            { 
               "string" : [ "string" ]
            }
         ],
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Associations](#API_ListAssociations_ResponseSyntax) **   <a name="systemsmanager-ListAssociations-response-Associations"></a>
The associations.  
Type: Array of [Association](API_Association.md) objects

 ** [NextToken](#API_ListAssociations_ResponseSyntax) **   <a name="systemsmanager-ListAssociations-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_ListAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_ListAssociations_Examples"></a>

### Example
<a name="API_ListAssociations_Example_1"></a>

This example illustrates one usage of ListAssociations.

#### Sample Request
<a name="API_ListAssociations_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListAssociations
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T143814Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2
```

#### Sample Response
<a name="API_ListAssociations_Example_1_Response"></a>

```
{
    "Associations": [
        {
            "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
            "AssociationVersion": "1",
            "LastExecutionDate": 1582037438.692,
            "Name": "AWS-UpdateSSMAgent",
            "Overview": {
                "AssociationStatusAggregatedCount": {
                    "Success": 3
                },
                "DetailedStatus": "Success",
                "Status": "Success"
            },
            "Targets": [
                {
                    "Key": "tag:ssm",
                    "Values": [
                        "true"
                    ]
                }
            ]
        }
    ]
}
```

## See Also
<a name="API_ListAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListAssociations) 

# ListAssociationVersions
<a name="API_ListAssociationVersions"></a>

Retrieves all versions of an association for a specific association ID.

## Request Syntax
<a name="API_ListAssociationVersions_RequestSyntax"></a>

```
{
   "AssociationId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListAssociationVersions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AssociationId](#API_ListAssociationVersions_RequestSyntax) **   <a name="systemsmanager-ListAssociationVersions-request-AssociationId"></a>
The association ID for which you want to view all versions.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`   
Required: Yes

 ** [MaxResults](#API_ListAssociationVersions_RequestSyntax) **   <a name="systemsmanager-ListAssociationVersions-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListAssociationVersions_RequestSyntax) **   <a name="systemsmanager-ListAssociationVersions-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

## Response Syntax
<a name="API_ListAssociationVersions_ResponseSyntax"></a>

```
{
   "AssociationVersions": [ 
      { 
         "ApplyOnlyAtCronInterval": boolean,
         "AssociationId": "string",
         "AssociationName": "string",
         "AssociationVersion": "string",
         "CalendarNames": [ "string" ],
         "ComplianceSeverity": "string",
         "CreatedDate": number,
         "DocumentVersion": "string",
         "Duration": number,
         "MaxConcurrency": "string",
         "MaxErrors": "string",
         "Name": "string",
         "OutputLocation": { 
            "S3Location": { 
               "OutputS3BucketName": "string",
               "OutputS3KeyPrefix": "string",
               "OutputS3Region": "string"
            }
         },
         "Parameters": { 
            "string" : [ "string" ]
         },
         "ScheduleExpression": "string",
         "ScheduleOffset": number,
         "SyncCompliance": "string",
         "TargetLocations": [ 
            { 
               "Accounts": [ "string" ],
               "ExcludeAccounts": [ "string" ],
               "ExecutionRoleName": "string",
               "IncludeChildOrganizationUnits": boolean,
               "Regions": [ "string" ],
               "TargetLocationAlarmConfiguration": { 
                  "Alarms": [ 
                     { 
                        "Name": "string"
                     }
                  ],
                  "IgnorePollAlarmFailure": boolean
               },
               "TargetLocationMaxConcurrency": "string",
               "TargetLocationMaxErrors": "string",
               "Targets": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ],
               "TargetsMaxConcurrency": "string",
               "TargetsMaxErrors": "string"
            }
         ],
         "TargetMaps": [ 
            { 
               "string" : [ "string" ]
            }
         ],
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAssociationVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociationVersions](#API_ListAssociationVersions_ResponseSyntax) **   <a name="systemsmanager-ListAssociationVersions-response-AssociationVersions"></a>
Information about all versions of the association for the specified association ID.  
Type: Array of [AssociationVersionInfo](API_AssociationVersionInfo.md) objects  
Array Members: Minimum number of 1 item.

 ** [NextToken](#API_ListAssociationVersions_ResponseSyntax) **   <a name="systemsmanager-ListAssociationVersions-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

## Errors
<a name="API_ListAssociationVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociationDoesNotExist **   
The specified association doesn't exist.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_ListAssociationVersions_Examples"></a>

### Example
<a name="API_ListAssociationVersions_Example_1"></a>

This example illustrates one usage of ListAssociationVersions.

#### Sample Request
<a name="API_ListAssociationVersions_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListAssociationVersions
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T144807Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 57

{
    "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE"
}
```

#### Sample Response
<a name="API_ListAssociationVersions_Example_1_Response"></a>

```
{
    "AssociationVersions": [
        {
            "ApplyOnlyAtCronInterval": false,
            "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
            "AssociationVersion": "1",
            "CreatedDate": 1561053271.583,
            "Name": "AWS-UpdateSSMAgent",
            "Parameters": {
                "allowDowngrade": [
                    "false"
                ],
                "version": [
                    ""
                ]
            },
            "Targets": [
                {
                    "Key": "tag:ssm",
                    "Values": [
                        "true"
                    ]
                }
            ]
        }
    ]
}
```

## See Also
<a name="API_ListAssociationVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListAssociationVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListAssociationVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListAssociationVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListAssociationVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListAssociationVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListAssociationVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListAssociationVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListAssociationVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListAssociationVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListAssociationVersions) 

# ListCommandInvocations
<a name="API_ListCommandInvocations"></a>

An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs `SendCommand` against three managed nodes, then a command invocation is created for each requested managed node ID. `ListCommandInvocations` provide status about command execution.

## Request Syntax
<a name="API_ListCommandInvocations_RequestSyntax"></a>

```
{
   "CommandId": "string",
   "Details": boolean,
   "Filters": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListCommandInvocations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CommandId](#API_ListCommandInvocations_RequestSyntax) **   <a name="systemsmanager-ListCommandInvocations-request-CommandId"></a>
(Optional) The invocations for a specific command ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Required: No

 ** [Details](#API_ListCommandInvocations_RequestSyntax) **   <a name="systemsmanager-ListCommandInvocations-request-Details"></a>
(Optional) If set this returns the response of the command executions and any command output. The default value is `false`.   
Type: Boolean  
Required: No

 ** [Filters](#API_ListCommandInvocations_RequestSyntax) **   <a name="systemsmanager-ListCommandInvocations-request-Filters"></a>
(Optional) One or more filters. Use a filter to return a more specific list of results.  
Type: Array of [CommandFilter](API_CommandFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** [InstanceId](#API_ListCommandInvocations_RequestSyntax) **   <a name="systemsmanager-ListCommandInvocations-request-InstanceId"></a>
(Optional) The command execution details for a specific managed node ID.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: No

 ** [MaxResults](#API_ListCommandInvocations_RequestSyntax) **   <a name="systemsmanager-ListCommandInvocations-request-MaxResults"></a>
(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListCommandInvocations_RequestSyntax) **   <a name="systemsmanager-ListCommandInvocations-request-NextToken"></a>
(Optional) The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_ListCommandInvocations_ResponseSyntax"></a>

```
{
   "CommandInvocations": [ 
      { 
         "CloudWatchOutputConfig": { 
            "CloudWatchLogGroupName": "string",
            "CloudWatchOutputEnabled": boolean
         },
         "CommandId": "string",
         "CommandPlugins": [ 
            { 
               "Name": "string",
               "Output": "string",
               "OutputS3BucketName": "string",
               "OutputS3KeyPrefix": "string",
               "OutputS3Region": "string",
               "ResponseCode": number,
               "ResponseFinishDateTime": number,
               "ResponseStartDateTime": number,
               "StandardErrorUrl": "string",
               "StandardOutputUrl": "string",
               "Status": "string",
               "StatusDetails": "string"
            }
         ],
         "Comment": "string",
         "DocumentName": "string",
         "DocumentVersion": "string",
         "InstanceId": "string",
         "InstanceName": "string",
         "NotificationConfig": { 
            "NotificationArn": "string",
            "NotificationEvents": [ "string" ],
            "NotificationType": "string"
         },
         "RequestedDateTime": number,
         "ServiceRole": "string",
         "StandardErrorUrl": "string",
         "StandardOutputUrl": "string",
         "Status": "string",
         "StatusDetails": "string",
         "TraceOutput": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListCommandInvocations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CommandInvocations](#API_ListCommandInvocations_ResponseSyntax) **   <a name="systemsmanager-ListCommandInvocations-response-CommandInvocations"></a>
(Optional) A list of all invocations.   
Type: Array of [CommandInvocation](API_CommandInvocation.md) objects

 ** [NextToken](#API_ListCommandInvocations_ResponseSyntax) **   <a name="systemsmanager-ListCommandInvocations-response-NextToken"></a>
(Optional) The token for the next set of items to return. (You received this token from a previous call.)  
Type: String

## Errors
<a name="API_ListCommandInvocations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidCommandId **   
The specified command ID isn't valid. Verify the ID and try again.  
HTTP Status Code: 400

 ** InvalidFilterKey **   
The specified key isn't valid.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_ListCommandInvocations_Examples"></a>

### Example
<a name="API_ListCommandInvocations_Example_1"></a>

This example illustrates one usage of ListCommandInvocations.

#### Sample Request
<a name="API_ListCommandInvocations_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListCommandInvocations
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T000322Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 53

{
    "CommandId": "4171bb3b-fe26-48ea-94fe-d1727b4d58e5"
}
```

#### Sample Response
<a name="API_ListCommandInvocations_Example_1_Response"></a>

```
{
    "CommandInvocations": [
        {
            "CloudWatchOutputConfig": {
                "CloudWatchLogGroupName": "",
                "CloudWatchOutputEnabled": false
            },
            "CommandId": "4171bb3b-fe26-48ea-94fe-d1727EXAMPLE",
            "CommandPlugins": [],
            "Comment": "",
            "DocumentName": "AWS-FindWindowsUpdates",
            "DocumentVersion": "1",
            "InstanceId": "i-02573cafcfEXAMPLE",
            "InstanceName": "EXAMPLE-4J5FVEG.WORKGROUP",
            "NotificationConfig": {
                "NotificationArn": "arn:aws:sns:us-east-2:111122223333:my-us-east-2-notification-arn",
                "NotificationEvents": [
                    "All"
                ],
                "NotificationType": "Invocation"
            },
            "RequestedDateTime": 1579893879.775,
            "ServiceRole": "arn:aws:iam::111122223333:role/my-SNS-notifications-role",
            "StandardErrorUrl": "https://s3.us-east-2.amazonaws.com/amzn-s3-demo-bucket/my-output/1231bb3b-fe26-48ea-94fe-d1727EXAMPLE/i-02573cafcfEXAMPLE/awsrunPowerShellScript/0.awsrunPowerShellScript/stderr",
            "StandardOutputUrl": "https://s3.us-east-2.amazonaws.com/amzn-s3-demo-bucket/my-output/1231bb3b-fe26-48ea-94fe-d1727EXAMPLE/i-02573cafcfEXAMPLE/awsrunPowerShellScript/0.awsrunPowerShellScript/stdout",
            "Status": "Success",
            "StatusDetails": "Success"
        },
        {
            "CloudWatchOutputConfig": {
                "CloudWatchLogGroupName": "",
                "CloudWatchOutputEnabled": false
            },
            "CommandId": "4171bb3b-fe26-48ea-94fe-d1727EXAMPLE",
            "CommandPlugins": [],
            "Comment": "",
            "DocumentName": "AWS-FindWindowsUpdates",
            "DocumentVersion": "1",
            "InstanceId": "i-0471e04240EXAMPLE",
            "InstanceName": "EXAMPLE-A1PDOM8.WORKGROUP",
            "NotificationConfig": {
                "NotificationArn": "arn:aws:sns:us-east-2:111122223333:my-us-east-2-notification-arn",
                "NotificationEvents": [
                    "All"
                ],
                "NotificationType": "Invocation"
            },
            "RequestedDateTime": 1579893879.6,
            "ServiceRole": "arn:aws:iam::111122223333:role/my-SNS-notifications-role",
            "StandardErrorUrl": "https://s3.us-east-2.amazonaws.com/amzn-s3-demo-bucket/my-output/4171bb3b-fe26-48ea-94fe-d1727EXAMPLE/i-0471e04240EXAMPLE/awsrunPowerShellScript/0.awsrunPowerShellScript/stderr",
            "StandardOutputUrl": "https://s3.us-east-2.amazonaws.com/amzn-s3-demo-bucket/my-output/4171bb3b-fe26-48ea-94fe-d1727EXAMPLE/i-0471e04240EXAMPLE/awsrunPowerShellScript/0.awsrunPowerShellScript/stdout",
            "Status": "Success",
            "StatusDetails": "Success"
        }
    ]
}
```

## See Also
<a name="API_ListCommandInvocations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListCommandInvocations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListCommandInvocations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListCommandInvocations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListCommandInvocations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListCommandInvocations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListCommandInvocations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListCommandInvocations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListCommandInvocations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListCommandInvocations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListCommandInvocations) 

# ListCommands
<a name="API_ListCommands"></a>

Lists the commands requested by users of the AWS account.

## Request Syntax
<a name="API_ListCommands_RequestSyntax"></a>

```
{
   "CommandId": "string",
   "Filters": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListCommands_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CommandId](#API_ListCommands_RequestSyntax) **   <a name="systemsmanager-ListCommands-request-CommandId"></a>
(Optional) If provided, lists only the specified command.  
Type: String  
Length Constraints: Fixed length of 36.  
Required: No

 ** [Filters](#API_ListCommands_RequestSyntax) **   <a name="systemsmanager-ListCommands-request-Filters"></a>
(Optional) One or more filters. Use a filter to return a more specific list of results.   
Type: Array of [CommandFilter](API_CommandFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** [InstanceId](#API_ListCommands_RequestSyntax) **   <a name="systemsmanager-ListCommands-request-InstanceId"></a>
(Optional) Lists commands issued against this managed node ID.  
You can't specify a managed node ID in the same command that you specify `Status` = `Pending`. This is because the command hasn't reached the managed node yet.
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: No

 ** [MaxResults](#API_ListCommands_RequestSyntax) **   <a name="systemsmanager-ListCommands-request-MaxResults"></a>
(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListCommands_RequestSyntax) **   <a name="systemsmanager-ListCommands-request-NextToken"></a>
(Optional) The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_ListCommands_ResponseSyntax"></a>

```
{
   "Commands": [ 
      { 
         "AlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "CloudWatchOutputConfig": { 
            "CloudWatchLogGroupName": "string",
            "CloudWatchOutputEnabled": boolean
         },
         "CommandId": "string",
         "Comment": "string",
         "CompletedCount": number,
         "DeliveryTimedOutCount": number,
         "DocumentName": "string",
         "DocumentVersion": "string",
         "ErrorCount": number,
         "ExpiresAfter": number,
         "InstanceIds": [ "string" ],
         "MaxConcurrency": "string",
         "MaxErrors": "string",
         "NotificationConfig": { 
            "NotificationArn": "string",
            "NotificationEvents": [ "string" ],
            "NotificationType": "string"
         },
         "OutputS3BucketName": "string",
         "OutputS3KeyPrefix": "string",
         "OutputS3Region": "string",
         "Parameters": { 
            "string" : [ "string" ]
         },
         "RequestedDateTime": number,
         "ServiceRole": "string",
         "Status": "string",
         "StatusDetails": "string",
         "TargetCount": number,
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "TimeoutSeconds": number,
         "TriggeredAlarms": [ 
            { 
               "Name": "string",
               "State": "string"
            }
         ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListCommands_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Commands](#API_ListCommands_ResponseSyntax) **   <a name="systemsmanager-ListCommands-response-Commands"></a>
(Optional) The list of commands requested by the user.   
Type: Array of [Command](API_Command.md) objects

 ** [NextToken](#API_ListCommands_ResponseSyntax) **   <a name="systemsmanager-ListCommands-response-NextToken"></a>
(Optional) The token for the next set of items to return. (You received this token from a previous call.)  
Type: String

## Errors
<a name="API_ListCommands_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidCommandId **   
The specified command ID isn't valid. Verify the ID and try again.  
HTTP Status Code: 400

 ** InvalidFilterKey **   
The specified key isn't valid.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_ListCommands_Examples"></a>

### Example
<a name="API_ListCommands_Example_1"></a>

This example illustrates one usage of ListCommands.

#### Sample Request
<a name="API_ListCommands_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListCommands
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T002657Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 53

{
    "CommandId": "088e4813-f292-48b3-8180-d8be9EXAMPLE"
}
```

#### Sample Response
<a name="API_ListCommands_Example_1_Response"></a>

```
{
    "Commands": [
        {
            "CloudWatchOutputConfig": {
                "CloudWatchLogGroupName": "my-log-group",
                "CloudWatchOutputEnabled": true
            },
            "CommandId": "088e4813-f292-48b3-8180-d8be9EXAMPLE",
            "Comment": "",
            "CompletedCount": 0,
            "DeliveryTimedOutCount": 0,
            "DocumentName": "AWS-InstallMissingWindowsUpdates",
            "DocumentVersion": "1",
            "ErrorCount": 0,
            "ExpiresAfter": 1582248743.188,
            "InstanceIds": [],
            "Interactive": false,
            "MaxConcurrency": "2",
            "MaxErrors": "3",
            "NotificationConfig": {
                "NotificationArn": "arn:aws:sns:us-east-2:111122223333:my-us-east-2-notification-arn",
                "NotificationEvents": [
                    "All"
                ],
                "NotificationType": "Command"
            },
            "OutputS3BucketName": "amzn-s3-demo-bucket",
            "OutputS3KeyPrefix": "my-prefix",
            "Parameters": {
                "ExcludeKbArticleIds": [
                    ""
                ],
                "UpdateLevel": [
                    "All"
                ]
            },
            "RequestedDateTime": 1582244543.188,
            "ServiceRole": "arn:aws:iam::111122223333:role/my-SNS-notifications-role",
            "Status": "InProgress",
            "StatusDetails": "InProgress",
            "TargetCount": 5,
            "Targets": [
                {
                    "Key": "InstanceIds",
                    "Values": [
                        "i-09c350ed76EXAMPLE",
                        "i-07be1baa4aEXAMPLE",
                        "i-00ec29b21eEXAMPLE",
                        "i-09911ddd90EXAMPLE",
                        "i-017431b35cEXAMPLE"
                    ]
                }
            ]
        }
    ]
}
```

## See Also
<a name="API_ListCommands_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListCommands) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListCommands) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListCommands) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListCommands) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListCommands) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListCommands) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListCommands) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListCommands) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListCommands) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListCommands) 

# ListComplianceItems
<a name="API_ListComplianceItems"></a>

For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

## Request Syntax
<a name="API_ListComplianceItems_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Type": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "ResourceIds": [ "string" ],
   "ResourceTypes": [ "string" ]
}
```

## Request Parameters
<a name="API_ListComplianceItems_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_ListComplianceItems_RequestSyntax) **   <a name="systemsmanager-ListComplianceItems-request-Filters"></a>
One or more compliance filters. Use a filter to return a more specific list of results.  
Type: Array of [ComplianceStringFilter](API_ComplianceStringFilter.md) objects  
Required: No

 ** [MaxResults](#API_ListComplianceItems_RequestSyntax) **   <a name="systemsmanager-ListComplianceItems-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListComplianceItems_RequestSyntax) **   <a name="systemsmanager-ListComplianceItems-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

 ** [ResourceIds](#API_ListComplianceItems_RequestSyntax) **   <a name="systemsmanager-ListComplianceItems-request-ResourceIds"></a>
The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [ResourceTypes](#API_ListComplianceItems_RequestSyntax) **   <a name="systemsmanager-ListComplianceItems-request-ResourceTypes"></a>
The type of resource from which to get compliance information. Currently, the only supported resource type is `ManagedInstance`.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

## Response Syntax
<a name="API_ListComplianceItems_ResponseSyntax"></a>

```
{
   "ComplianceItems": [ 
      { 
         "ComplianceType": "string",
         "Details": { 
            "string" : "string" 
         },
         "ExecutionSummary": { 
            "ExecutionId": "string",
            "ExecutionTime": number,
            "ExecutionType": "string"
         },
         "Id": "string",
         "ResourceId": "string",
         "ResourceType": "string",
         "Severity": "string",
         "Status": "string",
         "Title": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListComplianceItems_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ComplianceItems](#API_ListComplianceItems_ResponseSyntax) **   <a name="systemsmanager-ListComplianceItems-response-ComplianceItems"></a>
A list of compliance information for the specified resource ID.   
Type: Array of [ComplianceItem](API_ComplianceItem.md) objects

 ** [NextToken](#API_ListComplianceItems_ResponseSyntax) **   <a name="systemsmanager-ListComplianceItems-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

## Errors
<a name="API_ListComplianceItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

 ** InvalidResourceId **   
The resource ID isn't valid. Verify that you entered the correct ID and try again.  
HTTP Status Code: 400

 ** InvalidResourceType **   
The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.  
HTTP Status Code: 400

## Examples
<a name="API_ListComplianceItems_Examples"></a>

### Example
<a name="API_ListComplianceItems_Example_1"></a>

This example illustrates one usage of ListComplianceItems.

#### Sample Request
<a name="API_ListComplianceItems_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListComplianceItems
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240401T173645Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 40

{
    "ResourceIds": [
        "i-0cb99161f6EXAMPLE"
    ]
}
```

#### Sample Response
<a name="API_ListComplianceItems_Example_1_Response"></a>

```
{
    "ComplianceItems": [
        {
            "ComplianceType": "Association",
            "ResourceType": "ManagedInstance",
            "ResourceId": "i-0cb99161f6EXAMPLE",
            "Id": "bdf308d4-b431-440d-a2ee-dcca7EXAMPLE",
            "Title": "",
            "Status": "COMPLIANT",
            "Severity": "UNSPECIFIED",
            "ExecutionSummary": {
                "ExecutionTime": 1585761335
            },
            "Details": {
                "DocumentName": "AWS-GatherSoftwareInventory",
                "DocumentVersion": "1"
            }
        },
        {
            "ComplianceType": "Association",
            "ResourceType": "ManagedInstance",
            "ResourceId": "i-0cb99161f6EXAMPLE",
            "Id": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
            "Title": "",
            "Status": "COMPLIANT",
            "Severity": "HIGH",
            "ExecutionSummary": {
                "ExecutionTime": 1585761335
            },
            "Details": {
                "DocumentName": "AWS-UpdateSSMAgent",
                "DocumentVersion": "1"
            }
        }
    ]
}
```

## See Also
<a name="API_ListComplianceItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListComplianceItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListComplianceItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListComplianceItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListComplianceItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListComplianceItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListComplianceItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListComplianceItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListComplianceItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListComplianceItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListComplianceItems) 

# ListComplianceSummaries
<a name="API_ListComplianceSummaries"></a>

Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

## Request Syntax
<a name="API_ListComplianceSummaries_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Type": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListComplianceSummaries_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_ListComplianceSummaries_RequestSyntax) **   <a name="systemsmanager-ListComplianceSummaries-request-Filters"></a>
One or more compliance or inventory filters. Use a filter to return a more specific list of results.  
Type: Array of [ComplianceStringFilter](API_ComplianceStringFilter.md) objects  
Required: No

 ** [MaxResults](#API_ListComplianceSummaries_RequestSyntax) **   <a name="systemsmanager-ListComplianceSummaries-request-MaxResults"></a>
The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListComplianceSummaries_RequestSyntax) **   <a name="systemsmanager-ListComplianceSummaries-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

## Response Syntax
<a name="API_ListComplianceSummaries_ResponseSyntax"></a>

```
{
   "ComplianceSummaryItems": [ 
      { 
         "ComplianceType": "string",
         "CompliantSummary": { 
            "CompliantCount": number,
            "SeveritySummary": { 
               "CriticalCount": number,
               "HighCount": number,
               "InformationalCount": number,
               "LowCount": number,
               "MediumCount": number,
               "UnspecifiedCount": number
            }
         },
         "NonCompliantSummary": { 
            "NonCompliantCount": number,
            "SeveritySummary": { 
               "CriticalCount": number,
               "HighCount": number,
               "InformationalCount": number,
               "LowCount": number,
               "MediumCount": number,
               "UnspecifiedCount": number
            }
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListComplianceSummaries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ComplianceSummaryItems](#API_ListComplianceSummaries_ResponseSyntax) **   <a name="systemsmanager-ListComplianceSummaries-response-ComplianceSummaryItems"></a>
A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.  
Type: Array of [ComplianceSummaryItem](API_ComplianceSummaryItem.md) objects

 ** [NextToken](#API_ListComplianceSummaries_ResponseSyntax) **   <a name="systemsmanager-ListComplianceSummaries-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

## Errors
<a name="API_ListComplianceSummaries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_ListComplianceSummaries_Examples"></a>

### Example
<a name="API_ListComplianceSummaries_Example_1"></a>

This example illustrates one usage of ListComplianceSummaries.

#### Sample Request
<a name="API_ListComplianceSummaries_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListComplianceSummaries
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240401T174348Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2
```

#### Sample Response
<a name="API_ListComplianceSummaries_Example_1_Response"></a>

```
{
    "ComplianceSummaryItems": [
        {
            "ComplianceType": "FleetTotal",
            "CompliantSummary": {
                "CompliantCount": 1,
                "SeveritySummary": {
                    "CriticalCount": 0,
                    "HighCount": 1,
                    "InformationalCount": 0,
                    "LowCount": 0,
                    "MediumCount": 0,
                    "UnspecifiedCount": 0
                }
            },
            "NonCompliantSummary": {
                "NonCompliantCount": 2,
                "SeveritySummary": {
                    "CriticalCount": 0,
                    "HighCount": 0,
                    "InformationalCount": 0,
                    "LowCount": 0,
                    "MediumCount": 0,
                    "UnspecifiedCount": 2
                }
            }
        },
        {
            "ComplianceType": "Association",
            "CompliantSummary": {
                "CompliantCount": 3,
                "SeveritySummary": {
                    "CriticalCount": 0,
                    "HighCount": 2,
                    "InformationalCount": 0,
                    "LowCount": 0,
                    "MediumCount": 0,
                    "UnspecifiedCount": 1
                }
            },
            "NonCompliantSummary": {
                "NonCompliantCount": 0,
                "SeveritySummary": {
                    "CriticalCount": 0,
                    "HighCount": 0,
                    "InformationalCount": 0,
                    "LowCount": 0,
                    "MediumCount": 0,
                    "UnspecifiedCount": 0
                }
            }
        },
        {
            "ComplianceType": "Patch",
            "CompliantSummary": {
                "CompliantCount": 1,
                "SeveritySummary": {
                    "CriticalCount": 0,
                    "HighCount": 0,
                    "InformationalCount": 0,
                    "LowCount": 0,
                    "MediumCount": 0,
                    "UnspecifiedCount": 1
                }
            },
            "NonCompliantSummary": {
                "NonCompliantCount": 2,
                "SeveritySummary": {
                    "CriticalCount": 0,
                    "HighCount": 0,
                    "InformationalCount": 0,
                    "LowCount": 0,
                    "MediumCount": 0,
                    "UnspecifiedCount": 2
                }
            }
        }
    ]
}
```

## See Also
<a name="API_ListComplianceSummaries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListComplianceSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListComplianceSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListComplianceSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListComplianceSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListComplianceSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListComplianceSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListComplianceSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListComplianceSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListComplianceSummaries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListComplianceSummaries) 

# ListDocumentMetadataHistory
<a name="API_ListDocumentMetadataHistory"></a>

**Important**  
 AWS Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Change Manager availability change](https://docs.aws.amazon.com/systems-manager/latest/userguide/change-manager-availability-change.html).

Information about approval reviews for a version of a change template in Change Manager.

## Request Syntax
<a name="API_ListDocumentMetadataHistory_RequestSyntax"></a>

```
{
   "DocumentVersion": "string",
   "MaxResults": number,
   "Metadata": "string",
   "Name": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListDocumentMetadataHistory_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DocumentVersion](#API_ListDocumentMetadataHistory_RequestSyntax) **   <a name="systemsmanager-ListDocumentMetadataHistory-request-DocumentVersion"></a>
The version of the change template.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [MaxResults](#API_ListDocumentMetadataHistory_RequestSyntax) **   <a name="systemsmanager-ListDocumentMetadataHistory-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [Metadata](#API_ListDocumentMetadataHistory_RequestSyntax) **   <a name="systemsmanager-ListDocumentMetadataHistory-request-Metadata"></a>
The type of data for which details are being requested. Currently, the only supported value is `DocumentReviews`.  
Type: String  
Valid Values: `DocumentReviews`   
Required: Yes

 ** [Name](#API_ListDocumentMetadataHistory_RequestSyntax) **   <a name="systemsmanager-ListDocumentMetadataHistory-request-Name"></a>
The name of the change template.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

 ** [NextToken](#API_ListDocumentMetadataHistory_RequestSyntax) **   <a name="systemsmanager-ListDocumentMetadataHistory-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_ListDocumentMetadataHistory_ResponseSyntax"></a>

```
{
   "Author": "string",
   "DocumentVersion": "string",
   "Metadata": { 
      "ReviewerResponse": [ 
         { 
            "Comment": [ 
               { 
                  "Content": "string",
                  "Type": "string"
               }
            ],
            "CreateTime": number,
            "Reviewer": "string",
            "ReviewStatus": "string",
            "UpdatedTime": number
         }
      ]
   },
   "Name": "string",
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDocumentMetadataHistory_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Author](#API_ListDocumentMetadataHistory_ResponseSyntax) **   <a name="systemsmanager-ListDocumentMetadataHistory-response-Author"></a>
The user ID of the person in the organization who requested the review of the change template.  
Type: String

 ** [DocumentVersion](#API_ListDocumentMetadataHistory_ResponseSyntax) **   <a name="systemsmanager-ListDocumentMetadataHistory-response-DocumentVersion"></a>
The version of the change template.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` 

 ** [Metadata](#API_ListDocumentMetadataHistory_ResponseSyntax) **   <a name="systemsmanager-ListDocumentMetadataHistory-response-Metadata"></a>
Information about the response to the change template approval request.  
Type: [DocumentMetadataResponseInfo](API_DocumentMetadataResponseInfo.md) object

 ** [Name](#API_ListDocumentMetadataHistory_ResponseSyntax) **   <a name="systemsmanager-ListDocumentMetadataHistory-response-Name"></a>
The name of the change template.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$` 

 ** [NextToken](#API_ListDocumentMetadataHistory_ResponseSyntax) **   <a name="systemsmanager-ListDocumentMetadataHistory-response-NextToken"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: String

## Errors
<a name="API_ListDocumentMetadataHistory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentVersion **   
The document version isn't valid or doesn't exist.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_ListDocumentMetadataHistory_Examples"></a>

### Example
<a name="API_ListDocumentMetadataHistory_Example_1"></a>

This example illustrates one usage of ListDocumentMetadataHistory.

#### Sample Request
<a name="API_ListDocumentMetadataHistory_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListDocumentMetadataHistory
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240730T154930Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240730/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 68

{
    "Name": "MyChangeManagerTemplate",
    "Metadata": "DocumentReviews"
}
```

#### Sample Response
<a name="API_ListDocumentMetadataHistory_Example_1_Response"></a>

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

## See Also
<a name="API_ListDocumentMetadataHistory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListDocumentMetadataHistory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListDocumentMetadataHistory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListDocumentMetadataHistory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListDocumentMetadataHistory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListDocumentMetadataHistory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListDocumentMetadataHistory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListDocumentMetadataHistory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListDocumentMetadataHistory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListDocumentMetadataHistory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListDocumentMetadataHistory) 

# ListDocuments
<a name="API_ListDocuments"></a>

Returns all Systems Manager (SSM) documents in the current AWS account and AWS Region. You can limit the results of this request by using a filter.

## Request Syntax
<a name="API_ListDocuments_RequestSyntax"></a>

```
{
   "DocumentFilterList": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListDocuments_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DocumentFilterList](#API_ListDocuments_RequestSyntax) **   <a name="systemsmanager-ListDocuments-request-DocumentFilterList"></a>
This data type is deprecated. Instead, use `Filters`.  
Type: Array of [DocumentFilter](API_DocumentFilter.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** [Filters](#API_ListDocuments_RequestSyntax) **   <a name="systemsmanager-ListDocuments-request-Filters"></a>
One or more `DocumentKeyValuesFilter` objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include `Owner`, `Name`, `PlatformTypes`, `DocumentType`, and `TargetType`. For example, to return documents you own use `Key=Owner,Values=Self`. To specify a custom key-value pair, use the format `Key=tag:tagName,Values=valueName`.  
This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: `Key=tag:tagName,Values=valueName1,valueName2` 
Type: Array of [DocumentKeyValuesFilter](API_DocumentKeyValuesFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 6 items.  
Required: No

 ** [MaxResults](#API_ListDocuments_RequestSyntax) **   <a name="systemsmanager-ListDocuments-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListDocuments_RequestSyntax) **   <a name="systemsmanager-ListDocuments-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_ListDocuments_ResponseSyntax"></a>

```
{
   "DocumentIdentifiers": [ 
      { 
         "Author": "string",
         "CreatedDate": number,
         "DisplayName": "string",
         "DocumentFormat": "string",
         "DocumentType": "string",
         "DocumentVersion": "string",
         "Name": "string",
         "Owner": "string",
         "PlatformTypes": [ "string" ],
         "Requires": [ 
            { 
               "Name": "string",
               "RequireType": "string",
               "Version": "string",
               "VersionName": "string"
            }
         ],
         "ReviewStatus": "string",
         "SchemaVersion": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "TargetType": "string",
         "VersionName": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDocuments_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DocumentIdentifiers](#API_ListDocuments_ResponseSyntax) **   <a name="systemsmanager-ListDocuments-response-DocumentIdentifiers"></a>
The names of the SSM documents.  
Type: Array of [DocumentIdentifier](API_DocumentIdentifier.md) objects

 ** [NextToken](#API_ListDocuments_ResponseSyntax) **   <a name="systemsmanager-ListDocuments-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_ListDocuments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilterKey **   
The specified key isn't valid.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_ListDocuments_Examples"></a>

### Example
<a name="API_ListDocuments_Example_1"></a>

This example illustrates one usage of ListDocuments.

#### Sample Request
<a name="API_ListDocuments_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListDocuments
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T150301Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 97

{
    "Filters": [
        {
            "Key": "Owner",
            "Values": [
                "Self"
            ]
        },
        {
            "Key": "tag:DocUse",
            "Values": [
                "Testing"
            ]
        }
    ]
}
```

#### Sample Response
<a name="API_ListDocuments_Example_1_Response"></a>

```
{
    "DocumentIdentifiers": [
        {
            "CreatedDate": 1486594364.541,
            "DocumentFormat": "YAML",
            "DocumentType": "Automation",
            "DocumentVersion": "1",
            "DisplayName": "ExampleDoc",
            "Name": "Example",
            "Owner": "111122223333",
            "PlatformTypes": [
                "Windows",
                "Linux"
            ],
            "SchemaVersion": "0.3",
            "Tags": [
                {
                    "Key": "DocUse",
                    "Value": "Testing"
                }
            ]
        }
    ]
}
```

## See Also
<a name="API_ListDocuments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListDocuments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListDocuments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListDocuments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListDocuments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListDocuments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListDocuments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListDocuments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListDocuments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListDocuments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListDocuments) 

# ListDocumentVersions
<a name="API_ListDocumentVersions"></a>

List all versions for a document.

## Request Syntax
<a name="API_ListDocumentVersions_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "Name": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListDocumentVersions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListDocumentVersions_RequestSyntax) **   <a name="systemsmanager-ListDocumentVersions-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [Name](#API_ListDocumentVersions_RequestSyntax) **   <a name="systemsmanager-ListDocumentVersions-request-Name"></a>
The name of the document. You can specify an Amazon Resource Name (ARN).  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: Yes

 ** [NextToken](#API_ListDocumentVersions_RequestSyntax) **   <a name="systemsmanager-ListDocumentVersions-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

## Response Syntax
<a name="API_ListDocumentVersions_ResponseSyntax"></a>

```
{
   "DocumentVersions": [ 
      { 
         "CreatedDate": number,
         "DisplayName": "string",
         "DocumentFormat": "string",
         "DocumentVersion": "string",
         "IsDefaultVersion": boolean,
         "Name": "string",
         "ReviewStatus": "string",
         "Status": "string",
         "StatusInformation": "string",
         "VersionName": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDocumentVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DocumentVersions](#API_ListDocumentVersions_ResponseSyntax) **   <a name="systemsmanager-ListDocumentVersions-response-DocumentVersions"></a>
The document versions.  
Type: Array of [DocumentVersionInfo](API_DocumentVersionInfo.md) objects  
Array Members: Minimum number of 1 item.

 ** [NextToken](#API_ListDocumentVersions_ResponseSyntax) **   <a name="systemsmanager-ListDocumentVersions-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

## Errors
<a name="API_ListDocumentVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_ListDocumentVersions_Examples"></a>

### Example
<a name="API_ListDocumentVersions_Example_1"></a>

This example illustrates one usage of ListDocumentVersions.

#### Sample Request
<a name="API_ListDocumentVersions_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListDocumentVersions
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T151751Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 30

{
    "Name": "AWS-UpdateSSMAgent"
}
```

#### Sample Response
<a name="API_ListDocumentVersions_Example_1_Response"></a>

```
{
    "DocumentVersions": [
        {
            "CreatedDate": 1486594364.541,
            "DisplayName": "ExampleDoc",
            "DocumentFormat": "JSON",
            "DocumentVersion": "1",
            "IsDefaultVersion": true,
            "Name": "AWS-UpdateSSMAgent",
            "Status": "Active"
        }
    ]
}
```

## See Also
<a name="API_ListDocumentVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListDocumentVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListDocumentVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListDocumentVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListDocumentVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListDocumentVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListDocumentVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListDocumentVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListDocumentVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListDocumentVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListDocumentVersions) 

# ListInventoryEntries
<a name="API_ListInventoryEntries"></a>

A list of inventory items returned by the request.

## Request Syntax
<a name="API_ListInventoryEntries_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Type": "string",
         "Values": [ "string" ]
      }
   ],
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "TypeName": "string"
}
```

## Request Parameters
<a name="API_ListInventoryEntries_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_ListInventoryEntries_RequestSyntax) **   <a name="systemsmanager-ListInventoryEntries-request-Filters"></a>
One or more filters. Use a filter to return a more specific list of results.  
Type: Array of [InventoryFilter](API_InventoryFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** [InstanceId](#API_ListInventoryEntries_RequestSyntax) **   <a name="systemsmanager-ListInventoryEntries-request-InstanceId"></a>
The managed node ID for which you want inventory information.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: Yes

 ** [MaxResults](#API_ListInventoryEntries_RequestSyntax) **   <a name="systemsmanager-ListInventoryEntries-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListInventoryEntries_RequestSyntax) **   <a name="systemsmanager-ListInventoryEntries-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [TypeName](#API_ListInventoryEntries_RequestSyntax) **   <a name="systemsmanager-ListInventoryEntries-request-TypeName"></a>
The type of inventory item for which you want information.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^(AWS|Custom):.*$`   
Required: Yes

## Response Syntax
<a name="API_ListInventoryEntries_ResponseSyntax"></a>

```
{
   "CaptureTime": "string",
   "Entries": [ 
      { 
         "string" : "string" 
      }
   ],
   "InstanceId": "string",
   "NextToken": "string",
   "SchemaVersion": "string",
   "TypeName": "string"
}
```

## Response Elements
<a name="API_ListInventoryEntries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CaptureTime](#API_ListInventoryEntries_ResponseSyntax) **   <a name="systemsmanager-ListInventoryEntries-response-CaptureTime"></a>
The time that inventory information was collected for the managed nodes.  
Type: String  
Pattern: `^(20)[0-9][0-9]-(0[1-9]|1[012])-([12][0-9]|3[01]|0[1-9])(T)(2[0-3]|[0-1][0-9])(:[0-5][0-9])(:[0-5][0-9])(Z)$` 

 ** [Entries](#API_ListInventoryEntries_ResponseSyntax) **   <a name="systemsmanager-ListInventoryEntries-response-Entries"></a>
A list of inventory items on the managed nodes.  
Type: Array of string to string maps  
Array Members: Minimum number of 0 items. Maximum number of 10000 items.  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Value Length Constraints: Minimum length of 0. Maximum length of 4096.

 ** [InstanceId](#API_ListInventoryEntries_ResponseSyntax) **   <a name="systemsmanager-ListInventoryEntries-response-InstanceId"></a>
The managed node ID targeted by the request to query inventory information.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)` 

 ** [NextToken](#API_ListInventoryEntries_ResponseSyntax) **   <a name="systemsmanager-ListInventoryEntries-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [SchemaVersion](#API_ListInventoryEntries_ResponseSyntax) **   <a name="systemsmanager-ListInventoryEntries-response-SchemaVersion"></a>
The inventory schema version used by the managed nodes.  
Type: String  
Pattern: `^([0-9]{1,6})(\.[0-9]{1,6})$` 

 ** [TypeName](#API_ListInventoryEntries_ResponseSyntax) **   <a name="systemsmanager-ListInventoryEntries-response-TypeName"></a>
The type of inventory item returned by the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^(AWS|Custom):.*$` 

## Errors
<a name="API_ListInventoryEntries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

 ** InvalidTypeNameException **   
The parameter type name isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_ListInventoryEntries_Examples"></a>

### Example
<a name="API_ListInventoryEntries_Example_1"></a>

This example illustrates one usage of ListInventoryEntries.

#### Sample Request
<a name="API_ListInventoryEntries_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListInventoryEntries
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240330T154930Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 68

{
    "InstanceId": "i-04bf6ad63bEXAMPLE",
    "TypeName": "AWS:Application"
}
```

#### Sample Response
<a name="API_ListInventoryEntries_Example_1_Response"></a>

```
{
    "CaptureTime": "2020-03-30T15:45:32Z",
    "Entries": [
        {
            "Architecture": "i386",
            "InstalledTime": "2020-01-15T00:00:00Z",
            "Name": "AWS Tools for Windows",
            "PackageId": "{2088D019-97CC-4349-BA45-9777568EAE94}",
            "Publisher": "Amazon Web Services Developer Relations",
            "Version": "3.15.925"
        },
        {
            "Architecture": "i386",
            "Name": "Amazon SSM Agent",
            "PackageId": "{2a4673c2-68c6-4a4c-9be6-c3b1be96fdff}",
            "Publisher": "Amazon Web Services",
            "Version": "2.3.930.0"
        },
        {
            "Architecture": "x86_64",
            "InstalledTime": "2018-10-14T00:00:00Z",
            "Name": "aws-cfn-bootstrap",
            "PackageId": "{34CD0CCF-195B-4BC5-B409-D44EB9A129C8}",
            "Publisher": "Amazon Web Services",
            "Version": "1.4.31"
        },
        {
            "Architecture": "x86_64",
            "InstalledTime": "2020-03-10T00:00:00Z",
            "Name": "PowerShell 7-x64",
            "PackageId": "{B324E508-9AAE-446A-BC4C-BB446E8C2A18}",
            "Publisher": "Microsoft Corporation",
            "Version": "7.0.0.0"
        },
        {
            "Architecture": "x86_64",
            "InstalledTime": "2019-09-06T00:00:00Z",
            "Name": "AWS PV Drivers",
            "PackageId": "{C1F68A8D-F235-4886-87B0-150107C07EDA}",
            "Publisher": "Amazon Web Services",
            "Version": "8.3.2"
        }
    ],
    "InstanceId": "i-04bf6ad63bEXAMPLE",
    "SchemaVersion": "1.1",
    "TypeName": "AWS:Application"
}
```

## See Also
<a name="API_ListInventoryEntries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListInventoryEntries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListInventoryEntries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListInventoryEntries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListInventoryEntries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListInventoryEntries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListInventoryEntries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListInventoryEntries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListInventoryEntries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListInventoryEntries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListInventoryEntries) 

# ListNodes
<a name="API_ListNodes"></a>

Takes in filters and returns a list of managed nodes matching the filter criteria.

## Request Syntax
<a name="API_ListNodes_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Type": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "SyncName": "string"
}
```

## Request Parameters
<a name="API_ListNodes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_ListNodes_RequestSyntax) **   <a name="systemsmanager-ListNodes-request-Filters"></a>
One or more filters. Use a filter to return a more specific list of managed nodes.  
Type: Array of [NodeFilter](API_NodeFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_ListNodes_RequestSyntax) **   <a name="systemsmanager-ListNodes-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListNodes_RequestSyntax) **   <a name="systemsmanager-ListNodes-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [SyncName](#API_ListNodes_RequestSyntax) **   <a name="systemsmanager-ListNodes-request-SyncName"></a>
The name of the AWS managed resource data sync to retrieve information about.  
For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is `AWS-QuickSetup-ManagedNode`.  
For single account/single-Region configurations, the parameter is not required.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Syntax
<a name="API_ListNodes_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Nodes": [ 
      { 
         "CaptureTime": number,
         "Id": "string",
         "NodeType": { ... },
         "Owner": { 
            "AccountId": "string",
            "OrganizationalUnitId": "string",
            "OrganizationalUnitPath": "string"
         },
         "Region": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListNodes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListNodes_ResponseSyntax) **   <a name="systemsmanager-ListNodes-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [Nodes](#API_ListNodes_ResponseSyntax) **   <a name="systemsmanager-ListNodes-response-Nodes"></a>
A list of managed nodes that match the specified filter criteria.  
Type: Array of [Node](API_Node.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

## Errors
<a name="API_ListNodes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

 ** ResourceDataSyncNotFoundException **   
The specified sync name wasn't found.  
HTTP Status Code: 400

 ** UnsupportedOperationException **   
This operation is not supported for the current account. You must first enable the Systems Manager integrated experience in your account.  
HTTP Status Code: 400

## Examples
<a name="API_ListNodes_Examples"></a>

### Example
<a name="API_ListNodes_Example_1"></a>

This example illustrates one usage of ListNodes.

#### Sample Request
<a name="API_ListNodes_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListNodes
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20241119/25T150301Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 97

{
  "SyncName": "AWS-QuickSetup-ManagedNode",
  "Filters": [
    {
      "Key": "Region",
      "Values": [
        "us-east-2"
      ],
      "Type": "Equal"
    }
  ],
  "MaxResults": 1
}
```

#### Sample Response
<a name="API_ListNodes_Example_1_Response"></a>

```
{
  "NextToken": "A9lT8CAxj9aDFRi+MNA---truncated---oFq08IEXAMPLE",
  "Nodes": [
    {
      "CaptureTime": 2024-11-19T22:01:18,
      "Id": "i-0471e04240EXAMPLE",
      "NodeType": {
        "Instance": {
          "AgentType": "amazon-ssm-agent",
          "AgentVersion": "3.3.859.0",
          "ComputerName": "ip-192.0.2.0.ec2.internal",
          "InstanceStatus": "Active",
          "IpAddress": "192.0.2.0",
          "ManagedStatus": "Managed",
          "PlatformName": "Amazon Linux",
          "PlatformType": "Linux",
          "PlatformVersion": "2023",
          "ResourceType": "EC2Instance"
        }
      },
      "Owner": {
        "AccountId": "444455556666",
        "OrganizationalUnitId": "ou-b8dn-sEXAMPLE",
        "OrganizationalUnitPath": "r-b8dn/ou-b8dn-sEXAMPLE"
      },
      "Region": "us-east-2"
    }
  ]
}
```

## See Also
<a name="API_ListNodes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListNodes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListNodes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListNodes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListNodes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListNodes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListNodes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListNodes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListNodes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListNodes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListNodes) 

# ListNodesSummary
<a name="API_ListNodesSummary"></a>

Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.

## Request Syntax
<a name="API_ListNodesSummary_RequestSyntax"></a>

```
{
   "Aggregators": [ 
      { 
         "Aggregators": [ 
            "NodeAggregator"
         ],
         "AggregatorType": "string",
         "AttributeName": "string",
         "TypeName": "string"
      }
   ],
   "Filters": [ 
      { 
         "Key": "string",
         "Type": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "SyncName": "string"
}
```

## Request Parameters
<a name="API_ListNodesSummary_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Aggregators](#API_ListNodesSummary_RequestSyntax) **   <a name="systemsmanager-ListNodesSummary-request-Aggregators"></a>
Specify one or more aggregators to return a count of managed nodes that match that expression. For example, a count of managed nodes by operating system.  
Type: Array of [NodeAggregator](API_NodeAggregator.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Required: Yes

 ** [Filters](#API_ListNodesSummary_RequestSyntax) **   <a name="systemsmanager-ListNodesSummary-request-Filters"></a>
One or more filters. Use a filter to generate a summary that matches your specified filter criteria.  
Type: Array of [NodeFilter](API_NodeFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** [MaxResults](#API_ListNodesSummary_RequestSyntax) **   <a name="systemsmanager-ListNodesSummary-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListNodesSummary_RequestSyntax) **   <a name="systemsmanager-ListNodesSummary-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.) The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: String  
Required: No

 ** [SyncName](#API_ListNodesSummary_RequestSyntax) **   <a name="systemsmanager-ListNodesSummary-request-SyncName"></a>
The name of the AWS managed resource data sync to retrieve information about.  
For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is `AWS-QuickSetup-ManagedNode`.  
For single account/single-Region configurations, the parameter is not required.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Syntax
<a name="API_ListNodesSummary_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Summary": [ 
      { 
         "string" : "string" 
      }
   ]
}
```

## Response Elements
<a name="API_ListNodesSummary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListNodesSummary_ResponseSyntax) **   <a name="systemsmanager-ListNodesSummary-response-NextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.  
Type: String

 ** [Summary](#API_ListNodesSummary_ResponseSyntax) **   <a name="systemsmanager-ListNodesSummary-response-Summary"></a>
A collection of objects reporting information about your managed nodes, such as the count of nodes by operating system.  
Type: Array of string to string maps  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Map Entries: Minimum number of 0 items. Maximum number of 3 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Value Length Constraints: Minimum length of 0. Maximum length of 4096.

## Errors
<a name="API_ListNodesSummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidAggregatorException **   
The specified aggregator isn't valid for the group type. Verify that the aggregator you provided is supported.  
HTTP Status Code: 400

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

 ** ResourceDataSyncNotFoundException **   
The specified sync name wasn't found.  
HTTP Status Code: 400

 ** UnsupportedOperationException **   
This operation is not supported for the current account. You must first enable the Systems Manager integrated experience in your account.  
HTTP Status Code: 400

## Examples
<a name="API_ListNodesSummary_Examples"></a>

### Example
<a name="API_ListNodesSummary_Example_1"></a>

This example illustrates one usage of ListNodesSummary.

#### Sample Request
<a name="API_ListNodesSummary_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListNodesSummary
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20241119/25T150301Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 197

{ 
 "SyncName": "AWS-QuickSetup-ManagedNode",
 "Aggregators": 
  [
    {"AggregatorType": "Count",
     "TypeName": "Instance",
     "AttributeName": "Region"}
  ],
  "Filters": 
  [
    {"Key": "InstanceStatus",
     "Values": 
      ["Active"],
     "Type": "Equal"}
  ],
  "MaxResults" : 2,
  "NextToken": "A9lT8CAxj9aDFRi+MNA---truncated---oFq08IEXAMPLE"
 }
```

### Example
<a name="API_ListNodesSummary_Example_2"></a>

This example illustrates one usage of ListNodesSummary.

#### Sample Response
<a name="API_ListNodesSummary_Example_2_Response"></a>

```
{
    "Summary": [
        {
            "Count": "26",
            "Region": "us-east-1"
        },
        {
            "Count": "7",
            "Region": "us-east-2"
        }
    ]
}
```

## See Also
<a name="API_ListNodesSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListNodesSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListNodesSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListNodesSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListNodesSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListNodesSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListNodesSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListNodesSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListNodesSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListNodesSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListNodesSummary) 

# ListOpsItemEvents
<a name="API_ListOpsItemEvents"></a>

Returns a list of all OpsItem events in the current AWS Region and AWS account. You can limit the results to events associated with specific OpsItems by specifying a filter.

## Request Syntax
<a name="API_ListOpsItemEvents_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListOpsItemEvents_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_ListOpsItemEvents_RequestSyntax) **   <a name="systemsmanager-ListOpsItemEvents-request-Filters"></a>
One or more OpsItem filters. Use a filter to return a more specific list of results.   
Type: Array of [OpsItemEventFilter](API_OpsItemEventFilter.md) objects  
Required: No

 ** [MaxResults](#API_ListOpsItemEvents_RequestSyntax) **   <a name="systemsmanager-ListOpsItemEvents-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListOpsItemEvents_RequestSyntax) **   <a name="systemsmanager-ListOpsItemEvents-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

## Response Syntax
<a name="API_ListOpsItemEvents_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Summaries": [ 
      { 
         "CreatedBy": { 
            "Arn": "string"
         },
         "CreatedTime": number,
         "Detail": "string",
         "DetailType": "string",
         "EventId": "string",
         "OpsItemId": "string",
         "Source": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListOpsItemEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListOpsItemEvents_ResponseSyntax) **   <a name="systemsmanager-ListOpsItemEvents-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.   
Type: String

 ** [Summaries](#API_ListOpsItemEvents_ResponseSyntax) **   <a name="systemsmanager-ListOpsItemEvents-response-Summaries"></a>
A list of event information for the specified OpsItems.  
Type: Array of [OpsItemEventSummary](API_OpsItemEventSummary.md) objects

## Errors
<a name="API_ListOpsItemEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsItemInvalidParameterException **   
A specified parameter argument isn't valid. Verify the available arguments and try again.  
HTTP Status Code: 400

 ** OpsItemLimitExceededException **   
The request caused OpsItems to exceed one or more quotas.  
HTTP Status Code: 400

 ** OpsItemNotFoundException **   
The specified OpsItem ID doesn't exist. Verify the ID and try again.  
HTTP Status Code: 400

## See Also
<a name="API_ListOpsItemEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListOpsItemEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListOpsItemEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListOpsItemEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListOpsItemEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListOpsItemEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListOpsItemEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListOpsItemEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListOpsItemEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListOpsItemEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListOpsItemEvents) 

# ListOpsItemRelatedItems
<a name="API_ListOpsItemRelatedItems"></a>

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in AWS Systems Manager.

## Request Syntax
<a name="API_ListOpsItemRelatedItems_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "OpsItemId": "string"
}
```

## Request Parameters
<a name="API_ListOpsItemRelatedItems_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_ListOpsItemRelatedItems_RequestSyntax) **   <a name="systemsmanager-ListOpsItemRelatedItems-request-Filters"></a>
One or more OpsItem filters. Use a filter to return a more specific list of results.   
Type: Array of [OpsItemRelatedItemsFilter](API_OpsItemRelatedItemsFilter.md) objects  
Required: No

 ** [MaxResults](#API_ListOpsItemRelatedItems_RequestSyntax) **   <a name="systemsmanager-ListOpsItemRelatedItems-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListOpsItemRelatedItems_RequestSyntax) **   <a name="systemsmanager-ListOpsItemRelatedItems-request-NextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Required: No

 ** [OpsItemId](#API_ListOpsItemRelatedItems_RequestSyntax) **   <a name="systemsmanager-ListOpsItemRelatedItems-request-OpsItemId"></a>
The ID of the OpsItem for which you want to list all related-item resources.  
Type: String  
Pattern: `^(oi)-[0-9a-f]{12}$`   
Required: No

## Response Syntax
<a name="API_ListOpsItemRelatedItems_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Summaries": [ 
      { 
         "AssociationId": "string",
         "AssociationType": "string",
         "CreatedBy": { 
            "Arn": "string"
         },
         "CreatedTime": number,
         "LastModifiedBy": { 
            "Arn": "string"
         },
         "LastModifiedTime": number,
         "OpsItemId": "string",
         "ResourceType": "string",
         "ResourceUri": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListOpsItemRelatedItems_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListOpsItemRelatedItems_ResponseSyntax) **   <a name="systemsmanager-ListOpsItemRelatedItems-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

 ** [Summaries](#API_ListOpsItemRelatedItems_ResponseSyntax) **   <a name="systemsmanager-ListOpsItemRelatedItems-response-Summaries"></a>
A list of related-item resources for the specified OpsItem.  
Type: Array of [OpsItemRelatedItemSummary](API_OpsItemRelatedItemSummary.md) objects

## Errors
<a name="API_ListOpsItemRelatedItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsItemInvalidParameterException **   
A specified parameter argument isn't valid. Verify the available arguments and try again.  
HTTP Status Code: 400

## Examples
<a name="API_ListOpsItemRelatedItems_Examples"></a>

### Example
<a name="API_ListOpsItemRelatedItems_Example_1"></a>

This example illustrates one usage of ListOpsItemRelatedItems.

#### Sample Request
<a name="API_ListOpsItemRelatedItems_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListOpsItemRelatedItems
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm.list-ops-item-related-items
X-Amz-Date: 20240910T180314Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240910/us-east-1/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 32

{
	"OpsItemId": "oi-f99f2EXAMPLE"
}
```

#### Sample Response
<a name="API_ListOpsItemRelatedItems_Example_1_Response"></a>

```
{
    "Summaries": [
        {
            "OpsItemId": "oi-f99f2EXAMPLE",
            "AssociationId": "e2036148-cccb-490e-ac2a-390e5EXAMPLE",
            "ResourceType": "AWS::SSMIncidents::IncidentRecord",
            "AssociationType": "IsParentOf",
            "ResourceUri": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa",
            "CreatedBy": {
                "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse"
            },
            "CreatedTime": "2024-08-11T18:47:14.994000+00:00",
            "LastModifiedBy": {
                "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse"
            },
            "LastModifiedTime": "2024-08-11T18:47:14.994000+00:00"
        }
    ]
}
```

## See Also
<a name="API_ListOpsItemRelatedItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListOpsItemRelatedItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListOpsItemRelatedItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListOpsItemRelatedItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListOpsItemRelatedItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListOpsItemRelatedItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListOpsItemRelatedItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListOpsItemRelatedItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListOpsItemRelatedItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListOpsItemRelatedItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListOpsItemRelatedItems) 

# ListOpsMetadata
<a name="API_ListOpsMetadata"></a>

 AWS Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

## Request Syntax
<a name="API_ListOpsMetadata_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListOpsMetadata_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_ListOpsMetadata_RequestSyntax) **   <a name="systemsmanager-ListOpsMetadata-request-Filters"></a>
One or more filters to limit the number of OpsMetadata objects returned by the call.  
Type: Array of [OpsMetadataFilter](API_OpsMetadataFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [MaxResults](#API_ListOpsMetadata_RequestSyntax) **   <a name="systemsmanager-ListOpsMetadata-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListOpsMetadata_RequestSyntax) **   <a name="systemsmanager-ListOpsMetadata-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListOpsMetadata_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "OpsMetadataList": [ 
      { 
         "CreationDate": number,
         "LastModifiedDate": number,
         "LastModifiedUser": "string",
         "OpsMetadataArn": "string",
         "ResourceId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListOpsMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListOpsMetadata_ResponseSyntax) **   <a name="systemsmanager-ListOpsMetadata-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

 ** [OpsMetadataList](#API_ListOpsMetadata_ResponseSyntax) **   <a name="systemsmanager-ListOpsMetadata-response-OpsMetadataList"></a>
Returns a list of OpsMetadata objects.  
Type: Array of [OpsMetadata](API_OpsMetadata.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

## Errors
<a name="API_ListOpsMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsMetadataInvalidArgumentException **   
One of the arguments passed is invalid.   
HTTP Status Code: 400

## See Also
<a name="API_ListOpsMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListOpsMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListOpsMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListOpsMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListOpsMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListOpsMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListOpsMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListOpsMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListOpsMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListOpsMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListOpsMetadata) 

# ListResourceComplianceSummaries
<a name="API_ListResourceComplianceSummaries"></a>

Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

## Request Syntax
<a name="API_ListResourceComplianceSummaries_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Key": "string",
         "Type": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListResourceComplianceSummaries_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_ListResourceComplianceSummaries_RequestSyntax) **   <a name="systemsmanager-ListResourceComplianceSummaries-request-Filters"></a>
One or more filters. Use a filter to return a more specific list of results.  
Type: Array of [ComplianceStringFilter](API_ComplianceStringFilter.md) objects  
Required: No

 ** [MaxResults](#API_ListResourceComplianceSummaries_RequestSyntax) **   <a name="systemsmanager-ListResourceComplianceSummaries-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListResourceComplianceSummaries_RequestSyntax) **   <a name="systemsmanager-ListResourceComplianceSummaries-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

## Response Syntax
<a name="API_ListResourceComplianceSummaries_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "ResourceComplianceSummaryItems": [ 
      { 
         "ComplianceType": "string",
         "CompliantSummary": { 
            "CompliantCount": number,
            "SeveritySummary": { 
               "CriticalCount": number,
               "HighCount": number,
               "InformationalCount": number,
               "LowCount": number,
               "MediumCount": number,
               "UnspecifiedCount": number
            }
         },
         "ExecutionSummary": { 
            "ExecutionId": "string",
            "ExecutionTime": number,
            "ExecutionType": "string"
         },
         "NonCompliantSummary": { 
            "NonCompliantCount": number,
            "SeveritySummary": { 
               "CriticalCount": number,
               "HighCount": number,
               "InformationalCount": number,
               "LowCount": number,
               "MediumCount": number,
               "UnspecifiedCount": number
            }
         },
         "OverallSeverity": "string",
         "ResourceId": "string",
         "ResourceType": "string",
         "Status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListResourceComplianceSummaries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListResourceComplianceSummaries_ResponseSyntax) **   <a name="systemsmanager-ListResourceComplianceSummaries-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

 ** [ResourceComplianceSummaryItems](#API_ListResourceComplianceSummaries_ResponseSyntax) **   <a name="systemsmanager-ListResourceComplianceSummaries-response-ResourceComplianceSummaryItems"></a>
A summary count for specified or targeted managed nodes. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.   
Type: Array of [ResourceComplianceSummaryItem](API_ResourceComplianceSummaryItem.md) objects

## Errors
<a name="API_ListResourceComplianceSummaries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidFilter **   
The filter name isn't valid. Verify that you entered the correct name and try again.  
HTTP Status Code: 400

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_ListResourceComplianceSummaries_Examples"></a>

### Example
<a name="API_ListResourceComplianceSummaries_Example_1"></a>

This example illustrates one usage of ListResourceComplianceSummaries.

#### Sample Request
<a name="API_ListResourceComplianceSummaries_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListResourceComplianceSummaries
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240401T185225Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2
```

#### Sample Response
<a name="API_ListResourceComplianceSummaries_Example_1_Response"></a>

```
{
    "ResourceComplianceSummaryItems": [
        {
            "ComplianceType": "Association",
            "CompliantSummary": {
                "CompliantCount": 3,
                "SeveritySummary": {
                    "CriticalCount": 0,
                    "HighCount": 1,
                    "InformationalCount": 0,
                    "LowCount": 0,
                    "MediumCount": 0,
                    "UnspecifiedCount": 2
                }
            },
            "ExecutionSummary": {
                "ExecutionTime": 1585766022
            },
            "NonCompliantSummary": {
                "NonCompliantCount": 0,
                "SeveritySummary": {
                    "CriticalCount": 0,
                    "HighCount": 0,
                    "InformationalCount": 0,
                    "LowCount": 0,
                    "MediumCount": 0,
                    "UnspecifiedCount": 0
                }
            },
            "OverallSeverity": "HIGH",
            "ResourceId": "i-04bf6ad63bEXAMPLE",
            "ResourceType": "ManagedInstance",
            "Status": "COMPLIANT"
        },
        {
            "ComplianceType": "Patch",
            "CompliantSummary": {
                "CompliantCount": 27,
                "SeveritySummary": {
                    "CriticalCount": 0,
                    "HighCount": 0,
                    "InformationalCount": 0,
                    "LowCount": 0,
                    "MediumCount": 0,
                    "UnspecifiedCount": 27
                }
            },
            "ExecutionSummary": {
                "ExecutionId": "b95523e7-28e5-488e-a753-fd1d3EXAMPLE",
                "ExecutionTime": 1585244656,
                "ExecutionType": "Command"
            },
            "NonCompliantSummary": {
                "NonCompliantCount": 1,
                "SeveritySummary": {
                    "CriticalCount": 0,
                    "HighCount": 0,
                    "InformationalCount": 0,
                    "LowCount": 0,
                    "MediumCount": 0,
                    "UnspecifiedCount": 1
                }
            },
            "OverallSeverity": "UNSPECIFIED",
            "ResourceId": "i-04bf6ad63bEXAMPLE",
            "ResourceType": "ManagedInstance",
            "Status": "NON_COMPLIANT"
        }
    ]
}
```

## See Also
<a name="API_ListResourceComplianceSummaries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListResourceComplianceSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListResourceComplianceSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListResourceComplianceSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListResourceComplianceSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListResourceComplianceSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListResourceComplianceSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListResourceComplianceSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListResourceComplianceSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListResourceComplianceSummaries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListResourceComplianceSummaries) 

# ListResourceDataSync
<a name="API_ListResourceDataSync"></a>

Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

The number of sync configurations might be too large to return using a single call to `ListResourceDataSync`. You can limit the number of sync configurations returned by using the `MaxResults` parameter. To determine whether there are more sync configurations to list, check the value of `NextToken` in the output. If there are more sync configurations to list, you can request them by specifying the `NextToken` returned in the call to the parameter of a subsequent call. 

## Request Syntax
<a name="API_ListResourceDataSync_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "SyncType": "string"
}
```

## Request Parameters
<a name="API_ListResourceDataSync_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListResourceDataSync_RequestSyntax) **   <a name="systemsmanager-ListResourceDataSync-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListResourceDataSync_RequestSyntax) **   <a name="systemsmanager-ListResourceDataSync-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Type: String  
Required: No

 ** [SyncType](#API_ListResourceDataSync_RequestSyntax) **   <a name="systemsmanager-ListResourceDataSync-request-SyncType"></a>
View a list of resource data syncs according to the sync type. Specify `SyncToDestination` to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify `SyncFromSource` to view resource data syncs from AWS Organizations or from multiple AWS Regions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Syntax
<a name="API_ListResourceDataSync_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "ResourceDataSyncItems": [ 
      { 
         "LastStatus": "string",
         "LastSuccessfulSyncTime": number,
         "LastSyncStatusMessage": "string",
         "LastSyncTime": number,
         "S3Destination": { 
            "AWSKMSKeyARN": "string",
            "BucketName": "string",
            "DestinationDataSharing": { 
               "DestinationDataSharingType": "string"
            },
            "Prefix": "string",
            "Region": "string",
            "SyncFormat": "string"
         },
         "SyncCreatedTime": number,
         "SyncLastModifiedTime": number,
         "SyncName": "string",
         "SyncSource": { 
            "AwsOrganizationsSource": { 
               "OrganizationalUnits": [ 
                  { 
                     "OrganizationalUnitId": "string"
                  }
               ],
               "OrganizationSourceType": "string"
            },
            "EnableAllOpsDataSources": boolean,
            "IncludeFutureRegions": boolean,
            "SourceRegions": [ "string" ],
            "SourceType": "string",
            "State": "string"
         },
         "SyncType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListResourceDataSync_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListResourceDataSync_ResponseSyntax) **   <a name="systemsmanager-ListResourceDataSync-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String

 ** [ResourceDataSyncItems](#API_ListResourceDataSync_ResponseSyntax) **   <a name="systemsmanager-ListResourceDataSync-response-ResourceDataSyncItems"></a>
A list of your current resource data sync configurations and their statuses.  
Type: Array of [ResourceDataSyncItem](API_ResourceDataSyncItem.md) objects

## Errors
<a name="API_ListResourceDataSync_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidNextToken **   
The specified token isn't valid.  
HTTP Status Code: 400

 ** ResourceDataSyncInvalidConfigurationException **   
The specified sync configuration is invalid.  
HTTP Status Code: 400

## Examples
<a name="API_ListResourceDataSync_Examples"></a>

### Example
<a name="API_ListResourceDataSync_Example_1"></a>

This example illustrates one usage of ListResourceDataSync.

#### Sample Request
<a name="API_ListResourceDataSync_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListResourceDataSync
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240330T143820Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2
```

#### Sample Response
<a name="API_ListResourceDataSync_Example_1_Response"></a>

```
{
    "ResourceDataSyncItems": [
        {
            "LastStatus": "Successful",
            "LastSuccessfulSyncTime": 1585578819.829,
            "LastSyncStatusMessage": "The sync was successfully completed",
            "LastSyncTime": 1585578819.829,
            "S3Destination": {
                "BucketName": "amzn-s3-demo-bucket",
                "Prefix": "amzn-s3-demo-bucket-prefix",
                "Region": "us-east-2",
                "SyncFormat": "JsonSerDe"
            },
            "SyncCreatedTime": 1585330479.404,
            "SyncLastModifiedTime": 1585330479.404,
            "SyncName": "exampleSync"
        }
    ]
}
```

## See Also
<a name="API_ListResourceDataSync_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListResourceDataSync) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListResourceDataSync) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListResourceDataSync) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListResourceDataSync) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListResourceDataSync) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListResourceDataSync) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListResourceDataSync) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListResourceDataSync) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListResourceDataSync) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListResourceDataSync) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Returns a list of the tags assigned to the specified resource.

For information about the ID format for each supported resource type, see [AddTagsToResource](API_AddTagsToResource.md).

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceId": "string",
   "ResourceType": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceId](#API_ListTagsForResource_RequestSyntax) **   <a name="systemsmanager-ListTagsForResource-request-ResourceId"></a>
The resource ID for which you want to see a list of tags.  
Type: String  
Required: Yes

 ** [ResourceType](#API_ListTagsForResource_RequestSyntax) **   <a name="systemsmanager-ListTagsForResource-request-ResourceType"></a>
Returns a list of tags for a specific resource type.  
Type: String  
Valid Values: `Document | ManagedInstance | MaintenanceWindow | Parameter | PatchBaseline | OpsItem | OpsMetadata | Automation | Association`   
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "TagList": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TagList](#API_ListTagsForResource_ResponseSyntax) **   <a name="systemsmanager-ListTagsForResource-response-TagList"></a>
A list of tags.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidResourceId **   
The resource ID isn't valid. Verify that you entered the correct ID and try again.  
HTTP Status Code: 400

 ** InvalidResourceType **   
The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.  
HTTP Status Code: 400

## Examples
<a name="API_ListTagsForResource_Examples"></a>

### Example
<a name="API_ListTagsForResource_Example_1"></a>

This example illustrates one usage of ListTagsForResource.

#### Sample Request
<a name="API_ListTagsForResource_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListTagsForResource
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T003710Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 71

{
    "ResourceType": "PatchBaseline",
    "ResourceId": "pb-0c10e65780EXAMPLE"
}
```

#### Sample Response
<a name="API_ListTagsForResource_Example_1_Response"></a>

```
{
    "TagList": [
        {
            "Key": "Platform",
            "Value": "Windows Server"
        },
        {
            "Key": "Environment",
            "Value": "Production"
        },
        {
            "Key": "Region",
            "Value": "EMEA"
        }
    ]
}
```

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ListTagsForResource) 

# ModifyDocumentPermission
<a name="API_ModifyDocumentPermission"></a>

Shares a AWS Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify *All* as the account ID.

## Request Syntax
<a name="API_ModifyDocumentPermission_RequestSyntax"></a>

```
{
   "AccountIdsToAdd": [ "string" ],
   "AccountIdsToRemove": [ "string" ],
   "Name": "string",
   "PermissionType": "string",
   "SharedDocumentVersion": "string"
}
```

## Request Parameters
<a name="API_ModifyDocumentPermission_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AccountIdsToAdd](#API_ModifyDocumentPermission_RequestSyntax) **   <a name="systemsmanager-ModifyDocumentPermission-request-AccountIdsToAdd"></a>
The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or *All*. You must specify a value for this parameter or the `AccountIdsToRemove` parameter.  
Type: Array of strings  
Array Members: Maximum number of 20 items.  
Pattern: `(?i)all|[0-9]{12}`   
Required: No

 ** [AccountIdsToRemove](#API_ModifyDocumentPermission_RequestSyntax) **   <a name="systemsmanager-ModifyDocumentPermission-request-AccountIdsToRemove"></a>
The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or *All*. This action has a higher priority than `AccountIdsToAdd`. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the `AccountIdsToAdd` parameter.  
Type: Array of strings  
Array Members: Maximum number of 20 items.  
Pattern: `(?i)all|[0-9]{12}`   
Required: No

 ** [Name](#API_ModifyDocumentPermission_RequestSyntax) **   <a name="systemsmanager-ModifyDocumentPermission-request-Name"></a>
The name of the document that you want to share.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

 ** [PermissionType](#API_ModifyDocumentPermission_RequestSyntax) **   <a name="systemsmanager-ModifyDocumentPermission-request-PermissionType"></a>
The permission type for the document. The permission type can be *Share*.  
Type: String  
Valid Values: `Share`   
Required: Yes

 ** [SharedDocumentVersion](#API_ModifyDocumentPermission_RequestSyntax) **   <a name="systemsmanager-ModifyDocumentPermission-request-SharedDocumentVersion"></a>
(Optional) The version of the document to share. If it isn't specified, the system choose the `Default` version to share.  
Type: String  
Length Constraints: Maximum length of 8.  
Pattern: `([$]LATEST|[$]DEFAULT|[$]ALL)`   
Required: No

## Response Elements
<a name="API_ModifyDocumentPermission_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_ModifyDocumentPermission_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DocumentLimitExceeded **   
You can have at most 500 active SSM documents.  
HTTP Status Code: 400

 ** DocumentPermissionLimit **   
The document can't be shared with more AWS accounts. You can specify a maximum of 20 accounts per API operation to share a private document.  
By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents.  
If you need to increase the quota for privately or publicly shared Systems Manager documents, contact AWS Support.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidPermissionType **   
The permission type isn't supported. *Share* is the only supported permission type.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyDocumentPermission_Examples"></a>

### Example
<a name="API_ModifyDocumentPermission_Example_1"></a>

This example illustrates one usage of ModifyDocumentPermission.

#### Sample Request
<a name="API_ModifyDocumentPermission_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ModifyDocumentPermission
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T152441Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 78

{
    "Name": "Example",
    "PermissionType": "Share",
    "AccountIdsToAdd": [
        "444455556666"
    ]
}
```

#### Sample Response
<a name="API_ModifyDocumentPermission_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_ModifyDocumentPermission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ModifyDocumentPermission) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ModifyDocumentPermission) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ModifyDocumentPermission) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ModifyDocumentPermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ModifyDocumentPermission) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ModifyDocumentPermission) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ModifyDocumentPermission) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ModifyDocumentPermission) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ModifyDocumentPermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ModifyDocumentPermission) 

# PutComplianceItems
<a name="API_PutComplianceItems"></a>

Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

ComplianceType can be one of the following:
+ ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
+ ExecutionType: Specify patch, association, or Custom:`string`.
+ ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.
**Important**  
For State Manager associations, this represents the time when compliance status was captured by the Systems Manager service during its internal compliance aggregation workflow, not necessarily when the association was executed on the managed node. State Manager updates compliance information for all associations on an instance whenever any association executes, which may result in multiple associations showing the same execution time.
+ Id: The patch, association, or custom compliance ID.
+ Title: A title.
+ Status: The status of the compliance item. For example, `approved` for patches, or `Failed` for associations.
+ Severity: A patch severity. For example, `Critical`.
+ DocumentName: An SSM document name. For example, `AWS-RunPatchBaseline`.
+ DocumentVersion: An SSM document version number. For example, 4.
+ Classification: A patch classification. For example, `security updates`.
+ PatchBaselineId: A patch baseline ID.
+ PatchSeverity: A patch severity. For example, `Critical`.
+ PatchState: A patch state. For example, `InstancesWithFailedPatches`.
+ PatchGroup: The name of a patch group.
+ InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: `yyyy-MM-dd'T'HH:mm:ss'Z'` 

## Request Syntax
<a name="API_PutComplianceItems_RequestSyntax"></a>

```
{
   "ComplianceType": "string",
   "ExecutionSummary": { 
      "ExecutionId": "string",
      "ExecutionTime": number,
      "ExecutionType": "string"
   },
   "ItemContentHash": "string",
   "Items": [ 
      { 
         "Details": { 
            "string" : "string" 
         },
         "Id": "string",
         "Severity": "string",
         "Status": "string",
         "Title": "string"
      }
   ],
   "ResourceId": "string",
   "ResourceType": "string",
   "UploadType": "string"
}
```

## Request Parameters
<a name="API_PutComplianceItems_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ComplianceType](#API_PutComplianceItems_RequestSyntax) **   <a name="systemsmanager-PutComplianceItems-request-ComplianceType"></a>
Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:`string`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9_\-]\w+|Custom:[a-zA-Z0-9_\-]\w+`   
Required: Yes

 ** [ExecutionSummary](#API_PutComplianceItems_RequestSyntax) **   <a name="systemsmanager-PutComplianceItems-request-ExecutionSummary"></a>
A summary of the call execution that includes an execution ID, the type of execution (for example, `Command`), and the date/time of the execution using a datetime object that is saved in the following format: `yyyy-MM-dd'T'HH:mm:ss'Z'`   
Type: [ComplianceExecutionSummary](API_ComplianceExecutionSummary.md) object  
Required: Yes

 ** [ItemContentHash](#API_PutComplianceItems_RequestSyntax) **   <a name="systemsmanager-PutComplianceItems-request-ItemContentHash"></a>
MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** [Items](#API_PutComplianceItems_RequestSyntax) **   <a name="systemsmanager-PutComplianceItems-request-Items"></a>
Information about the compliance as defined by the resource type. For example, for a patch compliance type, `Items` includes information about the PatchSeverity, Classification, and so on.  
Type: Array of [ComplianceItemEntry](API_ComplianceItemEntry.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10000 items.  
Required: Yes

 ** [ResourceId](#API_PutComplianceItems_RequestSyntax) **   <a name="systemsmanager-PutComplianceItems-request-ResourceId"></a>
Specify an ID for this resource. For a managed node, this is the node ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ResourceType](#API_PutComplianceItems_RequestSyntax) **   <a name="systemsmanager-PutComplianceItems-request-ResourceType"></a>
Specify the type of resource. `ManagedInstance` is currently the only supported resource type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: Yes

 ** [UploadType](#API_PutComplianceItems_RequestSyntax) **   <a name="systemsmanager-PutComplianceItems-request-UploadType"></a>
The mode for uploading compliance items. You can specify `COMPLETE` or `PARTIAL`. In `COMPLETE` mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.  
In `PARTIAL` mode, the system overwrites compliance information for a specific association. The association must be configured with `SyncCompliance` set to `MANUAL`. By default, all requests use `COMPLETE` mode.  
This attribute is only valid for association compliance.
Type: String  
Valid Values: `COMPLETE | PARTIAL`   
Required: No

## Response Elements
<a name="API_PutComplianceItems_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutComplianceItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ComplianceTypeCountLimitExceededException **   
You specified too many custom compliance types. You can specify a maximum of 10 different types.   
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidItemContentException **   
One or more content items isn't valid.  
HTTP Status Code: 400

 ** InvalidResourceId **   
The resource ID isn't valid. Verify that you entered the correct ID and try again.  
HTTP Status Code: 400

 ** InvalidResourceType **   
The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.  
HTTP Status Code: 400

 ** ItemSizeLimitExceededException **   
The inventory item size has exceeded the size limit.  
HTTP Status Code: 400

 ** TotalSizeLimitExceededException **   
The size of inventory data has exceeded the total size limit for the resource.  
HTTP Status Code: 400

## Examples
<a name="API_PutComplianceItems_Examples"></a>

### Example
<a name="API_PutComplianceItems_Example_1"></a>

This example illustrates one usage of PutComplianceItems.

#### Sample Request
<a name="API_PutComplianceItems_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-west-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.PutComplianceItems
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.27 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ssm.put-compliance-items
X-Amz-Date: 20240811T170036Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240811/us-west-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 260

{
  "ResourceId": "i-02573cafcfEXAMPLE",
  "ResourceType": "ManagedInstance",
  "ComplianceType": "Custom:AVCheck",
  "ExecutionSummary": {
    "ExecutionTime": 1628697600
  },
  "Items": [
    {
      "Id": "Version2.0",
      "Title": "ScanHost",
      "Severity": "CRITICAL",
      "Status": "COMPLIANT"
    }
  ]
}
```

#### Sample Response
<a name="API_PutComplianceItems_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_PutComplianceItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/PutComplianceItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/PutComplianceItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/PutComplianceItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/PutComplianceItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/PutComplianceItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/PutComplianceItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/PutComplianceItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/PutComplianceItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/PutComplianceItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/PutComplianceItems) 

# PutInventory
<a name="API_PutInventory"></a>

Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

## Request Syntax
<a name="API_PutInventory_RequestSyntax"></a>

```
{
   "InstanceId": "string",
   "Items": [ 
      { 
         "CaptureTime": "string",
         "Content": [ 
            { 
               "string" : "string" 
            }
         ],
         "ContentHash": "string",
         "Context": { 
            "string" : "string" 
         },
         "SchemaVersion": "string",
         "TypeName": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_PutInventory_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceId](#API_PutInventory_RequestSyntax) **   <a name="systemsmanager-PutInventory-request-InstanceId"></a>
An managed node ID where you want to add or update inventory items.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: Yes

 ** [Items](#API_PutInventory_RequestSyntax) **   <a name="systemsmanager-PutInventory-request-Items"></a>
The inventory items that you want to add or update on managed nodes.  
Type: Array of [InventoryItem](API_InventoryItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 30 items.  
Required: Yes

## Response Syntax
<a name="API_PutInventory_ResponseSyntax"></a>

```
{
   "Message": "string"
}
```

## Response Elements
<a name="API_PutInventory_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_PutInventory_ResponseSyntax) **   <a name="systemsmanager-PutInventory-response-Message"></a>
Information about the request.  
Type: String

## Errors
<a name="API_PutInventory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CustomSchemaCountLimitExceededException **   
You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidInventoryItemContextException **   
You specified invalid keys or values in the `Context` attribute for `InventoryItem`. Verify the keys and values, and try again.  
HTTP Status Code: 400

 ** InvalidItemContentException **   
One or more content items isn't valid.  
HTTP Status Code: 400

 ** InvalidTypeNameException **   
The parameter type name isn't valid.  
HTTP Status Code: 400

 ** ItemContentMismatchException **   
The inventory item has invalid content.   
HTTP Status Code: 400

 ** ItemSizeLimitExceededException **   
The inventory item size has exceeded the size limit.  
HTTP Status Code: 400

 ** SubTypeCountLimitExceededException **   
The sub-type count exceeded the limit for the inventory type.  
HTTP Status Code: 400

 ** TotalSizeLimitExceededException **   
The size of inventory data has exceeded the total size limit for the resource.  
HTTP Status Code: 400

 ** UnsupportedInventoryItemContextException **   
The `Context` attribute that you specified for the `InventoryItem` isn't allowed for this inventory type. You can only use the `Context` attribute with inventory types like `AWS:ComplianceItem`.  
HTTP Status Code: 400

 ** UnsupportedInventorySchemaVersionException **   
Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type.  
HTTP Status Code: 400

## Examples
<a name="API_PutInventory_Examples"></a>

### Example
<a name="API_PutInventory_Example_1"></a>

This example illustrates one usage of PutInventory.

#### Sample Request
<a name="API_PutInventory_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.PutInventory
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240401T181858Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 180

{
    "InstanceId": "i-0cb99161f6EXAMPLE",
    "Items": [
        {
            "TypeName": "Custom:StageInfo",
            "SchemaVersion": "1.0",
            "CaptureTime": "2020-03-31T08:00:00Z",
            "Content": [
                {
                    "Stage": "PreProd"
                }
            ]
        }
    ]
}
```

#### Sample Response
<a name="API_PutInventory_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_PutInventory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/PutInventory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/PutInventory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/PutInventory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/PutInventory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/PutInventory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/PutInventory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/PutInventory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/PutInventory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/PutInventory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/PutInventory) 

# PutParameter
<a name="API_PutParameter"></a>

Create or update a parameter in Parameter Store.

## Request Syntax
<a name="API_PutParameter_RequestSyntax"></a>

```
{
   "AllowedPattern": "string",
   "DataType": "string",
   "Description": "string",
   "KeyId": "string",
   "Name": "string",
   "Overwrite": boolean,
   "Policies": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Tier": "string",
   "Type": "string",
   "Value": "string"
}
```

## Request Parameters
<a name="API_PutParameter_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AllowedPattern](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-AllowedPattern"></a>
A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\$1d\$1\$1   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [DataType](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-DataType"></a>
The data type for a `String` parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.  
 **The following data type values are supported.**   
+  `text` 
+  `aws:ec2:image` 
+  `aws:ssm:integration` 
When you create a `String` parameter and specify `aws:ec2:image`, AWS Systems Manager validates the parameter value is in the required format, such as `ami-12345abcdeEXAMPLE`, and that the specified AMI is available in your AWS account.  
If the action is successful, the service sends back an HTTP 200 response which indicates a successful `PutParameter` call for all cases except for data type `aws:ec2:image`. If you call `PutParameter` with `aws:ec2:image` data type, a successful HTTP 200 response does not guarantee that your parameter was successfully created or updated. The `aws:ec2:image` value is validated asynchronously, and the `PutParameter` call returns before the validation is complete. If you submit an invalid AMI value, the PutParameter operation will return success, but the asynchronous validation will fail and the parameter will not be created or updated. To monitor whether your `aws:ec2:image` parameters are created successfully, see [Setting up notifications or trigger actions based on Parameter Store events](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html). For more information about AMI format validation , see [Native parameter support for Amazon Machine Image IDs](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html). 
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [Description](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-Description"></a>
Information about the parameter that you want to add to the system. Optional but recommended.  
Don't enter personally identifiable information in this field.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [KeyId](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-KeyId"></a>
The AWS Key Management Service (AWS KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the `SecureString` data type.  
If you don't specify a key ID, the system uses the default key associated with your AWS account, which is not as secure as using a custom key.  
+ To use a custom AWS KMS key, choose the `SecureString` data type with the `Key ID` parameter.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([a-zA-Z0-9:/_-]+)$`   
Required: No

 ** [Name](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-Name"></a>
The fully qualified name of the parameter that you want to create or update.  
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: `/Dev/DBServer/MySQL/db-string13`   
Naming Constraints:  
+ Parameter names are case sensitive.
+ A parameter name must be unique within an AWS Region 
+ A parameter name can't be prefixed with "`aws`" or "`ssm`" (case-insensitive).
+ Parameter names can include only the following symbols and letters: `a-zA-Z0-9_.-` 

  In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: `/Dev/Production/East/Project-ABC/MyParameter` 
+ Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a `ValidationException` error.
+ Parameter hierarchies are limited to a maximum depth of fifteen levels.
For additional information about valid values for parameter names, see [Creating Systems Manager parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html) in the * AWS Systems Manager User Guide*.  
The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager. The maximum length for a parameter name that you specify is 1011 characters.  
This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: `arn:aws:ssm:us-east-2:111122223333:parameter/`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [Overwrite](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-Overwrite"></a>
Overwrite an existing parameter. The default value is `false`.  
Type: Boolean  
Required: No

 ** [Policies](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-Policies"></a>
One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in AWS Systems Manager supports the following policy types:  
Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the *parameter* doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.  
ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.  
NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.  
All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [Tags](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-Tags"></a>
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:  
+  `Key=Resource,Value=S3bucket` 
+  `Key=OS,Value=Windows` 
+  `Key=ParameterType,Value=LicenseKey` 
To add tags to an existing Systems Manager parameter, use the [AddTagsToResource](API_AddTagsToResource.md) operation.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

 ** [Tier](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-Tier"></a>
The parameter tier to assign to a parameter.  
Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost.   
Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see [Managing parameter tiers](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html) in the * AWS Systems Manager User Guide*.  
You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.   
If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.   
 **Using the Default Tier Configuration**   
In `PutParameter` requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.  
The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:  
+  **Advanced**: With this option, Parameter Store evaluates all requests as advanced parameters. 
+  **Intelligent-Tiering**: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced. 

  If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.

  This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary. 
Options that require an advanced parameter include the following:  
+ The content size of the parameter is more than 4 KB.
+ The parameter uses a parameter policy.
+ More than 10,000 parameters already exist in your AWS account in the current AWS Region.
For more information about configuring the default tier option, see [Specifying a default parameter tier](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#ps-default-tier) in the * AWS Systems Manager User Guide*.  
Type: String  
Valid Values: `Standard | Advanced | Intelligent-Tiering`   
Required: No

 ** [Type](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-Type"></a>
The type of parameter that you want to create.  
 `SecureString` isn't currently supported for AWS CloudFormation templates.
Items in a `StringList` must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the `String` data type.  
Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.
Type: String  
Valid Values: `String | StringList | SecureString`   
Required: No

 ** [Value](#API_PutParameter_RequestSyntax) **   <a name="systemsmanager-PutParameter-request-Value"></a>
The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.  
Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets `{{}}` or `{{ssm:parameter-name}}` in a parameter value.
Type: String  
Required: Yes

## Response Syntax
<a name="API_PutParameter_ResponseSyntax"></a>

```
{
   "Tier": "string",
   "Version": number
}
```

## Response Elements
<a name="API_PutParameter_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tier](#API_PutParameter_ResponseSyntax) **   <a name="systemsmanager-PutParameter-response-Tier"></a>
The tier assigned to the parameter.  
Type: String  
Valid Values: `Standard | Advanced | Intelligent-Tiering` 

 ** [Version](#API_PutParameter_ResponseSyntax) **   <a name="systemsmanager-PutParameter-response-Version"></a>
The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API operations or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.  
Type: Long

## Errors
<a name="API_PutParameter_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** HierarchyLevelLimitExceededException **   
A hierarchy can have a maximum of 15 levels. For more information, see [Requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html) in the * AWS Systems Manager User Guide*.     
 ** message **   
A hierarchy can have a maximum of 15 levels. For more information, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the * AWS Systems Manager User Guide*. 
HTTP Status Code: 400

 ** HierarchyTypeMismatchException **   
Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a `String` type to a `SecureString` type. You must create a new, unique parameter.    
 ** message **   
Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a `String` type to a `SecureString` type. You must create a new, unique parameter.
HTTP Status Code: 400

 ** IncompatiblePolicyException **   
There is a conflict in the policies specified for this parameter. You can't, for example, specify two Expiration policies for a parameter. Review your policies, and try again.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidAllowedPatternException **   
The request doesn't meet the regular expression requirement.    
 ** message **   
The request doesn't meet the regular expression requirement.
HTTP Status Code: 400

 ** InvalidKeyId **   
The query key ID isn't valid.  
HTTP Status Code: 400

 ** InvalidPolicyAttributeException **   
A policy attribute or its value is invalid.   
HTTP Status Code: 400

 ** InvalidPolicyTypeException **   
The policy type isn't supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.  
HTTP Status Code: 400

 ** ParameterAlreadyExists **   
The parameter already exists. You can't create duplicate parameters.  
HTTP Status Code: 400

 ** ParameterLimitExceeded **   
You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try again.  
HTTP Status Code: 400

 ** ParameterMaxVersionLimitExceeded **   
Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a *label* attached to it, Parameter Store won't delete the version and instead presents this error message:  
 `An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.`   
This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see [Move a parameter label (console)](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-console-move) or [Move a parameter label (CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-cli-move) in the * AWS Systems Manager User Guide*.   
HTTP Status Code: 400

 ** ParameterPatternMismatchException **   
The parameter name isn't valid.    
 ** message **   
The parameter name isn't valid.
HTTP Status Code: 400

 ** PoliciesLimitExceededException **   
You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

 ** UnsupportedParameterType **   
The parameter type isn't supported.  
HTTP Status Code: 400

## Examples
<a name="API_PutParameter_Examples"></a>

### Example
<a name="API_PutParameter_Example_1"></a>

This example illustrates one usage of PutParameter.

#### Sample Request
<a name="API_PutParameter_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 136
X-Amz-Target: AmazonSSM.PutParameter
X-Amz-Date: 20240316T000626Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Overwrite": true,
    "Type": "String",
    "Name": "EC2TestServerType",
    "Value": "t2.large",
    "Description": "Instance type for Test servers"
}
```

#### Sample Response
<a name="API_PutParameter_Example_1_Response"></a>

```
{
    "Version": 2
}
```

## See Also
<a name="API_PutParameter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/PutParameter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/PutParameter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/PutParameter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/PutParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/PutParameter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/PutParameter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/PutParameter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/PutParameter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/PutParameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/PutParameter) 

# PutResourcePolicy
<a name="API_PutResourcePolicy"></a>

Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an AWS account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
+  `OpsItemGroup` - The resource policy for `OpsItemGroup` enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems).
+  `Parameter` - The resource policy is used to share a parameter with other accounts using AWS Resource Access Manager (AWS RAM). 

  To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see [Managing parameter tiers](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html). For information about changing an existing standard parameter to an advanced parameter, see [Changing a standard parameter to an advanced parameter](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#parameter-store-advanced-parameters-enabling).

  To share a `SecureString` parameter, it must be encrypted with a customer managed key, and you must share the key separately through AWS Key Management Service. AWS managed keys cannot be shared. Parameters encrypted with the default AWS managed key can be updated to use a customer managed key instead. For AWS KMS key definitions, see [AWS KMS concepts](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) in the * AWS Key Management Service Developer Guide*.
**Important**  
While you can share a parameter using the Systems Manager `PutResourcePolicy` operation, we recommend using AWS Resource Access Manager (AWS RAM) instead. This is because using `PutResourcePolicy` requires the extra step of promoting the parameter to a standard AWS RAM Resource Share using the AWS RAM [PromoteResourceShareCreatedFromPolicy](https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) API operation. Otherwise, the parameter won't be returned by the Systems Manager [DescribeParameters](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribeParameters.html) API operation using the `--shared` option.  
For more information, see [Sharing a parameter](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html#share) in the * AWS Systems Manager User Guide* 

## Request Syntax
<a name="API_PutResourcePolicy_RequestSyntax"></a>

```
{
   "Policy": "string",
   "PolicyHash": "string",
   "PolicyId": "string",
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_PutResourcePolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Policy](#API_PutResourcePolicy_RequestSyntax) **   <a name="systemsmanager-PutResourcePolicy-request-Policy"></a>
A policy you want to associate with a resource.  
Type: String  
Pattern: `^(?!\s*$).+`   
Required: Yes

 ** [PolicyHash](#API_PutResourcePolicy_RequestSyntax) **   <a name="systemsmanager-PutResourcePolicy-request-PolicyHash"></a>
ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.  
Type: String  
Required: No

 ** [PolicyId](#API_PutResourcePolicy_RequestSyntax) **   <a name="systemsmanager-PutResourcePolicy-request-PolicyId"></a>
The policy ID.  
Type: String  
Required: No

 ** [ResourceArn](#API_PutResourcePolicy_RequestSyntax) **   <a name="systemsmanager-PutResourcePolicy-request-ResourceArn"></a>
Amazon Resource Name (ARN) of the resource to which you want to attach a policy.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

## Response Syntax
<a name="API_PutResourcePolicy_ResponseSyntax"></a>

```
{
   "PolicyHash": "string",
   "PolicyId": "string"
}
```

## Response Elements
<a name="API_PutResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PolicyHash](#API_PutResourcePolicy_ResponseSyntax) **   <a name="systemsmanager-PutResourcePolicy-response-PolicyHash"></a>
ID of the current policy version.  
Type: String

 ** [PolicyId](#API_PutResourcePolicy_ResponseSyntax) **   <a name="systemsmanager-PutResourcePolicy-response-PolicyId"></a>
The policy ID. To update a policy, you must specify `PolicyId` and `PolicyHash`.  
Type: String

## Errors
<a name="API_PutResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** MalformedResourcePolicyDocumentException **   
The specified policy document is malformed or invalid, or excessive `PutResourcePolicy` or `DeleteResourcePolicy` calls have been made.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified parameter to be shared could not be found.  
HTTP Status Code: 400

 ** ResourcePolicyConflictException **   
The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.  
HTTP Status Code: 400

 ** ResourcePolicyInvalidParameterException **   
One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.  
HTTP Status Code: 400

 ** ResourcePolicyLimitExceededException **   
The [PutResourcePolicy](#API_PutResourcePolicy) API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached to `OpsItemGroup`. Verify these limits and try again.  
HTTP Status Code: 400

 ** ResourcePolicyNotFoundException **   
No policies with the specified policy ID and hash could be found.  
HTTP Status Code: 400

## See Also
<a name="API_PutResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/PutResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/PutResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/PutResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/PutResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/PutResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/PutResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/PutResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/PutResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/PutResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/PutResourcePolicy) 

# RegisterDefaultPatchBaseline
<a name="API_RegisterDefaultPatchBaseline"></a>

Defines the default patch baseline for the relevant operating system.

To reset the AWS-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed` instead of `pb-0574b43a65ea646ed`.

## Request Syntax
<a name="API_RegisterDefaultPatchBaseline_RequestSyntax"></a>

```
{
   "BaselineId": "string"
}
```

## Request Parameters
<a name="API_RegisterDefaultPatchBaseline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BaselineId](#API_RegisterDefaultPatchBaseline_RequestSyntax) **   <a name="systemsmanager-RegisterDefaultPatchBaseline-request-BaselineId"></a>
The ID of the patch baseline that should be the default patch baseline.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$`   
Required: Yes

## Response Syntax
<a name="API_RegisterDefaultPatchBaseline_ResponseSyntax"></a>

```
{
   "BaselineId": "string"
}
```

## Response Elements
<a name="API_RegisterDefaultPatchBaseline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BaselineId](#API_RegisterDefaultPatchBaseline_ResponseSyntax) **   <a name="systemsmanager-RegisterDefaultPatchBaseline-response-BaselineId"></a>
The ID of the default patch baseline.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$` 

## Errors
<a name="API_RegisterDefaultPatchBaseline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidResourceId **   
The resource ID isn't valid. Verify that you entered the correct ID and try again.  
HTTP Status Code: 400

## Examples
<a name="API_RegisterDefaultPatchBaseline_Examples"></a>

### Example
<a name="API_RegisterDefaultPatchBaseline_Example_1"></a>

This example illustrates one usage of RegisterDefaultPatchBaseline.

#### Sample Request
<a name="API_RegisterDefaultPatchBaseline_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 38
X-Amz-Target: AmazonSSM.RegisterDefaultPatchBaseline
X-Amz-Date: 20240309T025821Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

#### Sample Response
<a name="API_RegisterDefaultPatchBaseline_Example_1_Response"></a>

```
{
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

## See Also
<a name="API_RegisterDefaultPatchBaseline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/RegisterDefaultPatchBaseline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/RegisterDefaultPatchBaseline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/RegisterDefaultPatchBaseline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/RegisterDefaultPatchBaseline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/RegisterDefaultPatchBaseline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/RegisterDefaultPatchBaseline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/RegisterDefaultPatchBaseline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/RegisterDefaultPatchBaseline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/RegisterDefaultPatchBaseline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/RegisterDefaultPatchBaseline) 

# RegisterPatchBaselineForPatchGroup
<a name="API_RegisterPatchBaselineForPatchGroup"></a>

Registers a patch baseline for a patch group.

## Request Syntax
<a name="API_RegisterPatchBaselineForPatchGroup_RequestSyntax"></a>

```
{
   "BaselineId": "string",
   "PatchGroup": "string"
}
```

## Request Parameters
<a name="API_RegisterPatchBaselineForPatchGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BaselineId](#API_RegisterPatchBaselineForPatchGroup_RequestSyntax) **   <a name="systemsmanager-RegisterPatchBaselineForPatchGroup-request-BaselineId"></a>
The ID of the patch baseline to register with the patch group.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$`   
Required: Yes

 ** [PatchGroup](#API_RegisterPatchBaselineForPatchGroup_RequestSyntax) **   <a name="systemsmanager-RegisterPatchBaselineForPatchGroup-request-PatchGroup"></a>
The name of the patch group to be registered with the patch baseline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## Response Syntax
<a name="API_RegisterPatchBaselineForPatchGroup_ResponseSyntax"></a>

```
{
   "BaselineId": "string",
   "PatchGroup": "string"
}
```

## Response Elements
<a name="API_RegisterPatchBaselineForPatchGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BaselineId](#API_RegisterPatchBaselineForPatchGroup_ResponseSyntax) **   <a name="systemsmanager-RegisterPatchBaselineForPatchGroup-response-BaselineId"></a>
The ID of the patch baseline the patch group was registered with.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$` 

 ** [PatchGroup](#API_RegisterPatchBaselineForPatchGroup_ResponseSyntax) **   <a name="systemsmanager-RegisterPatchBaselineForPatchGroup-response-PatchGroup"></a>
The name of the patch group registered with the patch baseline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 

## Errors
<a name="API_RegisterPatchBaselineForPatchGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AlreadyExistsException **   
Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.  
HTTP Status Code: 400

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidResourceId **   
The resource ID isn't valid. Verify that you entered the correct ID and try again.  
HTTP Status Code: 400

 ** ResourceLimitExceededException **   
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.  
For information about resource quotas in Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

## Examples
<a name="API_RegisterPatchBaselineForPatchGroup_Examples"></a>

### Example
<a name="API_RegisterPatchBaselineForPatchGroup_Example_1"></a>

This example illustrates one usage of RegisterPatchBaselineForPatchGroup.

#### Sample Request
<a name="API_RegisterPatchBaselineForPatchGroup_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 74
X-Amz-Target: AmazonSSM.RegisterPatchBaselineForPatchGroup
X-Amz-Date: 20240309T060234Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "PatchGroup": "mypatchgroup",
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

#### Sample Response
<a name="API_RegisterPatchBaselineForPatchGroup_Example_1_Response"></a>

```
{
    "PatchGroup": "mypatchgroup",
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

## See Also
<a name="API_RegisterPatchBaselineForPatchGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup) 

# RegisterTargetWithMaintenanceWindow
<a name="API_RegisterTargetWithMaintenanceWindow"></a>

Registers a target with a maintenance window.

## Request Syntax
<a name="API_RegisterTargetWithMaintenanceWindow_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "Description": "string",
   "Name": "string",
   "OwnerInformation": "string",
   "ResourceType": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "WindowId": "string"
}
```

## Request Parameters
<a name="API_RegisterTargetWithMaintenanceWindow_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_RegisterTargetWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTargetWithMaintenanceWindow-request-ClientToken"></a>
User-provided idempotency token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [Description](#API_RegisterTargetWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTargetWithMaintenanceWindow-request-Description"></a>
An optional description for the target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [Name](#API_RegisterTargetWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTargetWithMaintenanceWindow-request-Name"></a>
An optional name for the target.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: No

 ** [OwnerInformation](#API_RegisterTargetWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTargetWithMaintenanceWindow-request-OwnerInformation"></a>
User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [ResourceType](#API_RegisterTargetWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTargetWithMaintenanceWindow-request-ResourceType"></a>
The type of target being registered with the maintenance window.  
Type: String  
Valid Values: `INSTANCE | RESOURCE_GROUP`   
Required: Yes

 ** [Targets](#API_RegisterTargetWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTargetWithMaintenanceWindow-request-Targets"></a>
The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.  
If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.
You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.  
 **Example 1**: Specify managed node IDs  
 `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>`   
 **Example 2**: Use tag key-pairs applied to managed nodes  
 `Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>`   
 **Example 3**: Use tag-keys applied to managed nodes  
 `Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>`   
 **Example 4**: Use resource group names  
 `Key=resource-groups:Name,Values=<resource-group-name>`   
 **Example 5**: Use filters for resource group types  
 `Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>`   
For `Key=resource-groups:ResourceTypeFilters`, specify resource types in the following format  
 `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC` 
For more information about these examples formats, including the best use case for each one, see [Examples: Register targets with a maintenance window](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html) in the * AWS Systems Manager User Guide*.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: Yes

 ** [WindowId](#API_RegisterTargetWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTargetWithMaintenanceWindow-request-WindowId"></a>
The ID of the maintenance window the target should be registered with.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

## Response Syntax
<a name="API_RegisterTargetWithMaintenanceWindow_ResponseSyntax"></a>

```
{
   "WindowTargetId": "string"
}
```

## Response Elements
<a name="API_RegisterTargetWithMaintenanceWindow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [WindowTargetId](#API_RegisterTargetWithMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-RegisterTargetWithMaintenanceWindow-response-WindowTargetId"></a>
The ID of the target definition in this maintenance window.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_RegisterTargetWithMaintenanceWindow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** IdempotentParameterMismatch **   
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.   
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceLimitExceededException **   
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.  
For information about resource quotas in Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

## Examples
<a name="API_RegisterTargetWithMaintenanceWindow_Examples"></a>

### Example
<a name="API_RegisterTargetWithMaintenanceWindow_Example_1"></a>

This example illustrates one usage of RegisterTargetWithMaintenanceWindow.

#### Sample Request
<a name="API_RegisterTargetWithMaintenanceWindow_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.RegisterTargetWithMaintenanceWindow
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T003144Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target,Signature=39c3b3042cd2aEXAMPLE
Content-Length: 191

{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "ResourceType": "INSTANCE",
    "Targets": [
        {
            "Key": "InstanceIds",
            "Values": [
                "i-07782c72faEXAMPLE"
            ]
        }
    ],
    "ClientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_RegisterTargetWithMaintenanceWindow_Example_1_Response"></a>

```
{
    "WindowTargetId": "7f4813bb-df25-4e59-b34f-c9e83EXAMPLE"
}
```

## See Also
<a name="API_RegisterTargetWithMaintenanceWindow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow) 

# RegisterTaskWithMaintenanceWindow
<a name="API_RegisterTaskWithMaintenanceWindow"></a>

Adds a new task to a maintenance window.

## Request Syntax
<a name="API_RegisterTaskWithMaintenanceWindow_RequestSyntax"></a>

```
{
   "AlarmConfiguration": { 
      "Alarms": [ 
         { 
            "Name": "string"
         }
      ],
      "IgnorePollAlarmFailure": boolean
   },
   "ClientToken": "string",
   "CutoffBehavior": "string",
   "Description": "string",
   "LoggingInfo": { 
      "S3BucketName": "string",
      "S3KeyPrefix": "string",
      "S3Region": "string"
   },
   "MaxConcurrency": "string",
   "MaxErrors": "string",
   "Name": "string",
   "Priority": number,
   "ServiceRoleArn": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "TaskArn": "string",
   "TaskInvocationParameters": { 
      "Automation": { 
         "DocumentVersion": "string",
         "Parameters": { 
            "string" : [ "string" ]
         }
      },
      "Lambda": { 
         "ClientContext": "string",
         "Payload": blob,
         "Qualifier": "string"
      },
      "RunCommand": { 
         "CloudWatchOutputConfig": { 
            "CloudWatchLogGroupName": "string",
            "CloudWatchOutputEnabled": boolean
         },
         "Comment": "string",
         "DocumentHash": "string",
         "DocumentHashType": "string",
         "DocumentVersion": "string",
         "NotificationConfig": { 
            "NotificationArn": "string",
            "NotificationEvents": [ "string" ],
            "NotificationType": "string"
         },
         "OutputS3BucketName": "string",
         "OutputS3KeyPrefix": "string",
         "Parameters": { 
            "string" : [ "string" ]
         },
         "ServiceRoleArn": "string",
         "TimeoutSeconds": number
      },
      "StepFunctions": { 
         "Input": "string",
         "Name": "string"
      }
   },
   "TaskParameters": { 
      "string" : { 
         "Values": [ "string" ]
      }
   },
   "TaskType": "string",
   "WindowId": "string"
}
```

## Request Parameters
<a name="API_RegisterTaskWithMaintenanceWindow_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AlarmConfiguration](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-AlarmConfiguration"></a>
The CloudWatch alarm you want to apply to your maintenance window task.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object  
Required: No

 ** [ClientToken](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-ClientToken"></a>
User-provided idempotency token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [CutoffBehavior](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-CutoffBehavior"></a>
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.   
+  `CONTINUE_TASK`: When the cutoff time is reached, any tasks that are running continue. The default value.
+  `CANCEL_TASK`:
  + For Automation, AWS Lambda, AWS Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
  + For Run Command tasks: When the cutoff time is reached, the system sends a [CancelCommand](API_CancelCommand.md) operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is `TIMED_OUT`.
Type: String  
Valid Values: `CONTINUE_TASK | CANCEL_TASK`   
Required: No

 ** [Description](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-Description"></a>
An optional description for the task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [LoggingInfo](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-LoggingInfo"></a>
A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.   
 `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how AWS Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md).
Type: [LoggingInfo](API_LoggingInfo.md) object  
Required: No

 ** [MaxConcurrency](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-MaxConcurrency"></a>
The maximum number of targets this task can be run for, in parallel.  
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases.  
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1`. This value doesn't affect the running of your task.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$`   
Required: No

 ** [MaxErrors](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-MaxErrors"></a>
The maximum number of errors allowed before this task stops being scheduled.  
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases.  
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1`. This value doesn't affect the running of your task.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$`   
Required: No

 ** [Name](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-Name"></a>
An optional name for the task.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: No

 ** [Priority](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-Priority"></a>
The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [ServiceRoleArn](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-ServiceRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run `RegisterTaskWithMaintenanceWindow`.  
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see [Setting up Maintenance Windows](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html) in the in the * AWS Systems Manager User Guide*.  
Type: String  
Required: No

 ** [Targets](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-Targets"></a>
The targets (either managed nodes or maintenance window targets).  
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that don't specify targets, see [Registering maintenance window tasks without targets](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) in the * AWS Systems Manager User Guide*.
Specify managed nodes using the following format:   
 `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`   
Specify maintenance window targets using the following format:  
 `Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>`   
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [TaskArn](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-TaskArn"></a>
The ARN of the task to run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: Yes

 ** [TaskInvocationParameters](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-TaskInvocationParameters"></a>
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.   
Type: [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md) object  
Required: No

 ** [TaskParameters](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-TaskParameters"></a>
The parameters that should be passed to the task when it is run.  
 `TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md).
Type: String to [MaintenanceWindowTaskParameterValueExpression](API_MaintenanceWindowTaskParameterValueExpression.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [TaskType](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-TaskType"></a>
The type of task being registered.  
Type: String  
Valid Values: `RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA`   
Required: Yes

 ** [WindowId](#API_RegisterTaskWithMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-request-WindowId"></a>
The ID of the maintenance window the task should be added to.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

## Response Syntax
<a name="API_RegisterTaskWithMaintenanceWindow_ResponseSyntax"></a>

```
{
   "WindowTaskId": "string"
}
```

## Response Elements
<a name="API_RegisterTaskWithMaintenanceWindow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [WindowTaskId](#API_RegisterTaskWithMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-RegisterTaskWithMaintenanceWindow-response-WindowTaskId"></a>
The ID of the task in the maintenance window.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_RegisterTaskWithMaintenanceWindow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** FeatureNotAvailableException **   
You attempted to register a `LAMBDA` or `STEP_FUNCTIONS` task in a region where the corresponding service isn't available.   
HTTP Status Code: 400

 ** IdempotentParameterMismatch **   
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.   
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceLimitExceededException **   
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.  
For information about resource quotas in Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

## Examples
<a name="API_RegisterTaskWithMaintenanceWindow_Examples"></a>

### Example
<a name="API_RegisterTaskWithMaintenanceWindow_Example_1"></a>

This example illustrates one usage of RegisterTaskWithMaintenanceWindow.

#### Sample Request
<a name="API_RegisterTaskWithMaintenanceWindow_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.RegisterTaskWithMaintenanceWindow
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T181553Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 362

{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "Targets": [
        {
            "Key": "InstanceIds",
            "Values": [
                "i-02573cafcfEXAMPLE"
            ]
        }
    ],
    "TaskArn": "AWS-RunShellScript",
    "TaskType": "RUN_COMMAND",
    "TaskInvocationParameters": {
        "RunCommand": {
            "Parameters": {
                "commands": [
                    "df"
                ]
            }
        }
    },
    "Priority": 10,
    "MaxConcurrency": "1",
    "MaxErrors": "1",
    "ClientToken": "8a3f60db-1d39-4938-a566-c2ec2EXAMPLE"
}
```

#### Sample Response
<a name="API_RegisterTaskWithMaintenanceWindow_Example_1_Response"></a>

```
{
    "WindowTaskId": "216ae877-0be9-4746-a19d-ed654EXAMPLE"
}
```

## See Also
<a name="API_RegisterTaskWithMaintenanceWindow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow) 

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

Removes tag keys from the specified resource.

## Request Syntax
<a name="API_RemoveTagsFromResource_RequestSyntax"></a>

```
{
   "ResourceId": "string",
   "ResourceType": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_RemoveTagsFromResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceId](#API_RemoveTagsFromResource_RequestSyntax) **   <a name="systemsmanager-RemoveTagsFromResource-request-ResourceId"></a>
The ID of the resource from which you want to remove tags. For example:  
ManagedInstance: mi-012345abcde  
MaintenanceWindow: mw-012345abcde  
 `Automation`: `example-c160-4567-8519-012345abcde`   
PatchBaseline: pb-012345abcde  
OpsMetadata object: `ResourceID` for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, `ResourceID` is created from the strings that come after the word `opsmetadata` in the ARN. For example, an OpsMetadata object with an ARN of `arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager` has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or `/aws/ssm/MyGroup/appmanager`.  
For the Document and Parameter values, use the name of the resource.  
The `ManagedInstance` type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID\$1number. For example, mi-1a2b3c4d5e6f.
Type: String  
Required: Yes

 ** [ResourceType](#API_RemoveTagsFromResource_RequestSyntax) **   <a name="systemsmanager-RemoveTagsFromResource-request-ResourceType"></a>
The type of resource from which you want to remove a tag.  
The `ManagedInstance` type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`.
Type: String  
Valid Values: `Document | ManagedInstance | MaintenanceWindow | Parameter | PatchBaseline | OpsItem | OpsMetadata | Automation | Association`   
Required: Yes

 ** [TagKeys](#API_RemoveTagsFromResource_RequestSyntax) **   <a name="systemsmanager-RemoveTagsFromResource-request-TagKeys"></a>
Tag keys that you want to remove from the specified resource.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## Response Elements
<a name="API_RemoveTagsFromResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_RemoveTagsFromResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidResourceId **   
The resource ID isn't valid. Verify that you entered the correct ID and try again.  
HTTP Status Code: 400

 ** InvalidResourceType **   
The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_RemoveTagsFromResource_Examples"></a>

### Example
<a name="API_RemoveTagsFromResource_Example_1"></a>

This example illustrates one usage of RemoveTagsFromResource.

#### Sample Request
<a name="API_RemoveTagsFromResource_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.RemoveTagsFromResource
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T004031Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 99

{
    "ResourceType": "PatchBaseline",
    "ResourceId": "pb-0c10e65780EXAMPLE",
    "TagKeys": [
        "Environment"
    ]
}
```

#### Sample Response
<a name="API_RemoveTagsFromResource_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_RemoveTagsFromResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/RemoveTagsFromResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/RemoveTagsFromResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/RemoveTagsFromResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/RemoveTagsFromResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/RemoveTagsFromResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/RemoveTagsFromResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/RemoveTagsFromResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/RemoveTagsFromResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/RemoveTagsFromResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/RemoveTagsFromResource) 

# ResetServiceSetting
<a name="API_ResetServiceSetting"></a>

 `ServiceSetting` is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a `SettingId` object to a setting value. AWS services teams define the default value for a `SettingId`. You can't create a new `SettingId`, but you can overwrite the default value if you have the `ssm:UpdateServiceSetting` permission for the setting. Use the [GetServiceSetting](API_GetServiceSetting.md) API operation to view the current value. Use the [UpdateServiceSetting](API_UpdateServiceSetting.md) API operation to change the default setting. 

Reset the service setting for the account to the default value as provisioned by the AWS service team. 

## Request Syntax
<a name="API_ResetServiceSetting_RequestSyntax"></a>

```
{
   "SettingId": "string"
}
```

## Request Parameters
<a name="API_ResetServiceSetting_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [SettingId](#API_ResetServiceSetting_RequestSyntax) **   <a name="systemsmanager-ResetServiceSetting-request-SettingId"></a>
The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.  
+  `/ssm/appmanager/appmanager-enabled` 
+  `/ssm/automation/customer-script-log-destination` 
+  `/ssm/automation/customer-script-log-group-name` 
+ /ssm/automation/enable-adaptive-concurrency
+  `/ssm/documents/console/public-sharing-permission` 
+  `/ssm/managed-instance/activation-tier` 
+  `/ssm/managed-instance/default-ec2-instance-management-role` 
+  `/ssm/opsinsights/opscenter` 
+  `/ssm/parameter-store/default-parameter-tier` 
+  `/ssm/parameter-store/high-throughput-enabled` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Response Syntax
<a name="API_ResetServiceSetting_ResponseSyntax"></a>

```
{
   "ServiceSetting": { 
      "ARN": "string",
      "LastModifiedDate": number,
      "LastModifiedUser": "string",
      "SettingId": "string",
      "SettingValue": "string",
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_ResetServiceSetting_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ServiceSetting](#API_ResetServiceSetting_ResponseSyntax) **   <a name="systemsmanager-ResetServiceSetting-response-ServiceSetting"></a>
The current, effective service setting after calling the ResetServiceSetting API operation.  
Type: [ServiceSetting](API_ServiceSetting.md) object

## Errors
<a name="API_ResetServiceSetting_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ServiceSettingNotFound **   
The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the AWS service team.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_ResetServiceSetting_Examples"></a>

### Example
<a name="API_ResetServiceSetting_Example_1"></a>

This example illustrates one usage of ResetServiceSetting.

#### Sample Request
<a name="API_ResetServiceSetting_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ResetServiceSetting
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T153659Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 110

{
    "SettingId": "arn:aws:ssm:us-east-2:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled"
}
```

#### Sample Response
<a name="API_ResetServiceSetting_Example_1_Response"></a>

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

## See Also
<a name="API_ResetServiceSetting_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ResetServiceSetting) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ResetServiceSetting) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ResetServiceSetting) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ResetServiceSetting) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ResetServiceSetting) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ResetServiceSetting) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ResetServiceSetting) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ResetServiceSetting) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ResetServiceSetting) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ResetServiceSetting) 

# ResumeSession
<a name="API_ResumeSession"></a>

Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

**Note**  
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.

## Request Syntax
<a name="API_ResumeSession_RequestSyntax"></a>

```
{
   "SessionId": "string"
}
```

## Request Parameters
<a name="API_ResumeSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [SessionId](#API_ResumeSession_RequestSyntax) **   <a name="systemsmanager-ResumeSession-request-SessionId"></a>
The ID of the disconnected session to resume.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 96.  
Required: Yes

## Response Syntax
<a name="API_ResumeSession_ResponseSyntax"></a>

```
{
   "SessionId": "string",
   "StreamUrl": "string",
   "TokenValue": "string"
}
```

## Response Elements
<a name="API_ResumeSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SessionId](#API_ResumeSession_ResponseSyntax) **   <a name="systemsmanager-ResumeSession-response-SessionId"></a>
The ID of the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 96.

 ** [StreamUrl](#API_ResumeSession_ResponseSyntax) **   <a name="systemsmanager-ResumeSession-response-StreamUrl"></a>
A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the managed node. Format: `wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)`.  
 **region** represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as `us-east-2` for the US East (Ohio) Region. For a list of supported **region** values, see the **Region** column in [Systems Manager service endpoints](https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) in the *Amazon Web Services General Reference*.  
 **session-id** represents the ID of a Session Manager session, such as `1a2b3c4dEXAMPLE`.  
Type: String

 ** [TokenValue](#API_ResumeSession_ResponseSyntax) **   <a name="systemsmanager-ResumeSession-response-TokenValue"></a>
An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 300.

## Errors
<a name="API_ResumeSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_ResumeSession_Examples"></a>

### Example
<a name="API_ResumeSession_Example_1"></a>

This example illustrates one usage of ResumeSession.

#### Sample Request
<a name="API_ResumeSession_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ResumeSession
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T181144Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 50

{
    "SessionId": "John-Doe-0402960697EXAMPLE"
}
```

#### Sample Response
<a name="API_ResumeSession_Example_1_Response"></a>

```
{{
    "SessionId": "John-Doe-0402960697EXAMPLE",
    "StreamUrl": "wss://ssmmessages.us-east-2.amazonaws.com/v1/data-channel/John-Doe-0402960697EXAMPLE?role=publish_subscribe",
    "TokenValue": "EXAMPLENPKTm3/39c3b3042cd2aEXAMPLE/a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE"
}
```

## See Also
<a name="API_ResumeSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/ResumeSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/ResumeSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/ResumeSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/ResumeSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ResumeSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/ResumeSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/ResumeSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/ResumeSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ResumeSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/ResumeSession) 

# SendAutomationSignal
<a name="API_SendAutomationSignal"></a>

Sends a signal to an Automation execution to change the current behavior or status of the execution. 

## Request Syntax
<a name="API_SendAutomationSignal_RequestSyntax"></a>

```
{
   "AutomationExecutionId": "string",
   "Payload": { 
      "string" : [ "string" ]
   },
   "SignalType": "string"
}
```

## Request Parameters
<a name="API_SendAutomationSignal_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AutomationExecutionId](#API_SendAutomationSignal_RequestSyntax) **   <a name="systemsmanager-SendAutomationSignal-request-AutomationExecutionId"></a>
The unique identifier for an existing Automation execution that you want to send the signal to.  
Type: String  
Length Constraints: Fixed length of 36.  
Required: Yes

 ** [Payload](#API_SendAutomationSignal_RequestSyntax) **   <a name="systemsmanager-SendAutomationSignal-request-Payload"></a>
The data sent with the signal. The data schema depends on the type of signal used in the request.  
For `Approve` and `Reject` signal types, the payload is an optional comment that you can send with the signal type. For example:  
 `Comment="Looks good"`   
For `StartStep` and `Resume` signal types, you must send the name of the Automation step to start or resume as the payload. For example:  
 `StepName="step1"`   
For the `StopStep` signal type, you must send the step execution ID as the payload. For example:  
 `StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"`   
Type: String to array of strings map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 50.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** [SignalType](#API_SendAutomationSignal_RequestSyntax) **   <a name="systemsmanager-SendAutomationSignal-request-SignalType"></a>
The type of signal to send to an Automation execution.   
Type: String  
Valid Values: `Approve | Reject | StartStep | StopStep | Resume | Revoke`   
Required: Yes

## Response Elements
<a name="API_SendAutomationSignal_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_SendAutomationSignal_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AutomationExecutionNotFoundException **   
There is no automation execution information for the requested automation execution ID.  
HTTP Status Code: 400

 ** AutomationStepNotFoundException **   
The specified step name and execution ID don't exist. Verify the information and try again.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidAutomationSignalException **   
The signal isn't valid for the current Automation execution.  
HTTP Status Code: 400

## Examples
<a name="API_SendAutomationSignal_Examples"></a>

### Example
<a name="API_SendAutomationSignal_Example_1"></a>

This example illustrates one usage of SendAutomationSignal.

#### Sample Request
<a name="API_SendAutomationSignal_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.SendAutomationSignal
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T162449Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 165

{
    "AutomationExecutionId": "b2bc0e75-4d48-4b7b-be9b-0cb5cEXAMPLE",
    "SignalType": "StopStep",
    "Payload": {
        "StepExecutionId": [
            "33d93afd-9535-4dd5-a06b-c91bdEXAMPLE"
        ]
    }
}
```

#### Sample Response
<a name="API_SendAutomationSignal_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_SendAutomationSignal_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/SendAutomationSignal) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/SendAutomationSignal) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/SendAutomationSignal) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/SendAutomationSignal) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/SendAutomationSignal) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/SendAutomationSignal) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/SendAutomationSignal) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/SendAutomationSignal) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/SendAutomationSignal) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/SendAutomationSignal) 

# SendCommand
<a name="API_SendCommand"></a>

Runs commands on one or more managed nodes.

## Request Syntax
<a name="API_SendCommand_RequestSyntax"></a>

```
{
   "AlarmConfiguration": { 
      "Alarms": [ 
         { 
            "Name": "string"
         }
      ],
      "IgnorePollAlarmFailure": boolean
   },
   "CloudWatchOutputConfig": { 
      "CloudWatchLogGroupName": "string",
      "CloudWatchOutputEnabled": boolean
   },
   "Comment": "string",
   "DocumentHash": "string",
   "DocumentHashType": "string",
   "DocumentName": "string",
   "DocumentVersion": "string",
   "InstanceIds": [ "string" ],
   "MaxConcurrency": "string",
   "MaxErrors": "string",
   "NotificationConfig": { 
      "NotificationArn": "string",
      "NotificationEvents": [ "string" ],
      "NotificationType": "string"
   },
   "OutputS3BucketName": "string",
   "OutputS3KeyPrefix": "string",
   "OutputS3Region": "string",
   "Parameters": { 
      "string" : [ "string" ]
   },
   "ServiceRoleArn": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "TimeoutSeconds": number
}
```

## Request Parameters
<a name="API_SendCommand_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AlarmConfiguration](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-AlarmConfiguration"></a>
The CloudWatch alarm you want to apply to your command.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object  
Required: No

 ** [CloudWatchOutputConfig](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-CloudWatchOutputConfig"></a>
Enables AWS Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a tool in AWS Systems Manager.  
Type: [CloudWatchOutputConfig](API_CloudWatchOutputConfig.md) object  
Required: No

 ** [Comment](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-Comment"></a>
User-specified information about the command, such as a brief description of what the command should do.  
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [DocumentHash](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-DocumentHash"></a>
The Sha256 or Sha1 hash created by the system when the document was created.   
Sha1 hashes have been deprecated.
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** [DocumentHashType](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-DocumentHashType"></a>
Sha256 or Sha1.  
Sha1 hashes have been deprecated.
Type: String  
Valid Values: `Sha256 | Sha1`   
Required: No

 ** [DocumentName](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-DocumentName"></a>
The name of the AWS Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see [Sharing SSM documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html) in the * AWS Systems Manager User Guide*.  
If you specify a document name or ARN that hasn't been shared with your account, you receive an `InvalidDocument` error. 
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: Yes

 ** [DocumentVersion](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-DocumentVersion"></a>
The SSM document version to use in the request. You can specify \$1DEFAULT, \$1LATEST, or a specific version number. If you run commands by using the AWS Command Line Interface (AWS CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:  
--document-version "\$1\$1DEFAULT"  
--document-version "\$1\$1LATEST"  
--document-version "3"  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [InstanceIds](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-InstanceIds"></a>
The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.  
To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the `Targets` option instead. Using `Targets`, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.  
For more information about how to use targets, see [Run commands at scale](https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) in the * AWS Systems Manager User Guide*.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: No

 ** [MaxConcurrency](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-MaxConcurrency"></a>
(Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is `50`. For more information about how to use `MaxConcurrency`, see [Using concurrency controls](https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity) in the * AWS Systems Manager User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$`   
Required: No

 ** [MaxErrors](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-MaxErrors"></a>
The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of `MaxErrors`, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is `0`. For more information about how to use `MaxErrors`, see [Using error controls](https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors) in the * AWS Systems Manager User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$`   
Required: No

 ** [NotificationConfig](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-NotificationConfig"></a>
Configurations for sending notifications.  
Type: [NotificationConfig](API_NotificationConfig.md) object  
Required: No

 ** [OutputS3BucketName](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-OutputS3BucketName"></a>
The name of the S3 bucket where command execution responses should be stored.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Required: No

 ** [OutputS3KeyPrefix](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-OutputS3KeyPrefix"></a>
The directory structure within the S3 bucket where the responses should be stored.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [OutputS3Region](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-OutputS3Region"></a>
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the AWS Region of the S3 bucket.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 20.  
Required: No

 ** [Parameters](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-Parameters"></a>
The required and optional parameters specified in the document being run.  
Type: String to array of strings map  
Required: No

 ** [ServiceRoleArn](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-ServiceRoleArn"></a>
The ARN of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.  
This role must provide the `sns:Publish` permission for your notification topic. For information about creating and using this service role, see [Monitoring Systems Manager status changes using Amazon SNS notifications](https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) in the * AWS Systems Manager User Guide*.  
Type: String  
Required: No

 ** [Targets](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-Targets"></a>
An array of search criteria that targets managed nodes using a `Key,Value` combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using `Targets`, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.  
To send a command to a smaller number of managed nodes, you can use the `InstanceIds` option instead.  
For more information about how to use targets, see [Run commands at scale](https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) in the * AWS Systems Manager User Guide*.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [TimeoutSeconds](#API_SendCommand_RequestSyntax) **   <a name="systemsmanager-SendCommand-request-TimeoutSeconds"></a>
If this time is reached and the command hasn't already started running, it won't run.  
Type: Integer  
Valid Range: Minimum value of 30. Maximum value of 2592000.  
Required: No

## Response Syntax
<a name="API_SendCommand_ResponseSyntax"></a>

```
{
   "Command": { 
      "AlarmConfiguration": { 
         "Alarms": [ 
            { 
               "Name": "string"
            }
         ],
         "IgnorePollAlarmFailure": boolean
      },
      "CloudWatchOutputConfig": { 
         "CloudWatchLogGroupName": "string",
         "CloudWatchOutputEnabled": boolean
      },
      "CommandId": "string",
      "Comment": "string",
      "CompletedCount": number,
      "DeliveryTimedOutCount": number,
      "DocumentName": "string",
      "DocumentVersion": "string",
      "ErrorCount": number,
      "ExpiresAfter": number,
      "InstanceIds": [ "string" ],
      "MaxConcurrency": "string",
      "MaxErrors": "string",
      "NotificationConfig": { 
         "NotificationArn": "string",
         "NotificationEvents": [ "string" ],
         "NotificationType": "string"
      },
      "OutputS3BucketName": "string",
      "OutputS3KeyPrefix": "string",
      "OutputS3Region": "string",
      "Parameters": { 
         "string" : [ "string" ]
      },
      "RequestedDateTime": number,
      "ServiceRole": "string",
      "Status": "string",
      "StatusDetails": "string",
      "TargetCount": number,
      "Targets": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ],
      "TimeoutSeconds": number,
      "TriggeredAlarms": [ 
         { 
            "Name": "string",
            "State": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_SendCommand_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Command](#API_SendCommand_ResponseSyntax) **   <a name="systemsmanager-SendCommand-response-Command"></a>
The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.  
Type: [Command](API_Command.md) object

## Errors
<a name="API_SendCommand_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DuplicateInstanceId **   
You can't specify a managed node ID in more than one association.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentVersion **   
The document version isn't valid or doesn't exist.  
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** InvalidNotificationConfig **   
One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notification Service topic.  
HTTP Status Code: 400

 ** InvalidOutputFolder **   
The S3 bucket doesn't exist.  
HTTP Status Code: 400

 ** InvalidParameters **   
You must specify values for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.  
HTTP Status Code: 400

 ** InvalidRole **   
The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see [Monitoring Systems Manager status changes using Amazon SNS notifications](https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) in the * AWS Systems Manager User Guide*.  
HTTP Status Code: 400

 ** MaxDocumentSizeExceeded **   
The size limit of a document is 64 KB.  
HTTP Status Code: 400

 ** UnsupportedPlatformType **   
The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.  
HTTP Status Code: 400

## Examples
<a name="API_SendCommand_Examples"></a>

### Example
<a name="API_SendCommand_Example_1"></a>

This example illustrates one usage of SendCommand.

#### Sample Request
<a name="API_SendCommand_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.SendCommand
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T000322Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 153

{
    "CloudWatchOutputConfig": {
        "CloudWatchLogGroupName": "my-log-group",
        "CloudWatchOutputEnabled": true
    },
    "DocumentName": "AWS-ConfigureCloudWatch",
    "DocumentVersion": "1",
    "InstanceIds": [
        "i-07be1baa4aEXAMPLE",
        "i-017431b35cEXAMPLE",
        "i-09c350ed76EXAMPLE"
    ],
    "MaxConcurrency": "2",
    "MaxErrors": "1",
    "NotificationConfig": {
        "NotificationArn": "arn:aws:sns:us-east-2:111122223333:my-us-east-2-notification-arn",
        "NotificationEvents": [
            "Failed",
            "Success"
        ],
        "NotificationType": "Command"
    },
    "OutputS3BucketName": "amzn-s3-demo-bucket",
    "OutputS3KeyPrefix": "my-prefix",
    "OutputS3Region": "us-east-2",
    "Parameters": {
        "string": []
    },
    "TimeoutSeconds": 30
}
```

#### Sample Response
<a name="API_SendCommand_Example_1_Response"></a>

```
{
    "Command": {
        "CommandId": "b94bf1dc-fe7d-4e88-851d-e85e5EXAMPLE",
        "DocumentName": "AWS-ConfigureCloudWatch",
        "DocumentVersion": "1",
        "Comment": "",
        "ExpiresAfter": 1582250177.7,
        "Parameters": {
            "properties": [
                ""
            ],
            "status": [
                "Enabled"
            ]
        },
        "InstanceIds": [],
        "Targets": [
            {
                "Key": "InstanceIds",
                "Values": [
                    "i-07be1baa4aEXAMPLE",
                    "i-017431b35cEXAMPLE",
                    "i-09c350ed76EXAMPLE"
                ]
            }
        ],
        "RequestedDateTime": 1582245977.7,
        "Status": "Pending",
        "StatusDetails": "Pending",
        "OutputS3BucketName": "amzn-s3-demo-bucket",
        "OutputS3KeyPrefix": "my-prefix",
        "MaxConcurrency": "2",
        "MaxErrors": "1",
        "TargetCount": 0,
        "CompletedCount": 0,
        "ErrorCount": 0,
        "DeliveryTimedOutCount": 0,
        "ServiceRole": "arn:aws:iam::111122223333:role/my-SNS-notifications-role",
        "NotificationConfig": {
            "NotificationArn": "arn:aws:sns:us-east-2:111122223333:my-us-east-2-notification-arn",
            "NotificationEvents": [
                "Failed",
                "Success"
            ],
            "NotificationType": "Command"
        },
        "CloudWatchOutputConfig": {
            "CloudWatchLogGroupName": "my-log-group",
            "CloudWatchOutputEnabled": true
        }
    }
}
```

## See Also
<a name="API_SendCommand_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/SendCommand) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/SendCommand) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/SendCommand) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/SendCommand) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/SendCommand) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/SendCommand) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/SendCommand) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/SendCommand) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/SendCommand) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/SendCommand) 

# StartAccessRequest
<a name="API_StartAccessRequest"></a>

Starts the workflow for just-in-time node access sessions.

## Request Syntax
<a name="API_StartAccessRequest_RequestSyntax"></a>

```
{
   "Reason": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ]
}
```

## Request Parameters
<a name="API_StartAccessRequest_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Reason](#API_StartAccessRequest_RequestSyntax) **   <a name="systemsmanager-StartAccessRequest-request-Reason"></a>
A brief description explaining why you are requesting access to the node.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [Tags](#API_StartAccessRequest_RequestSyntax) **   <a name="systemsmanager-StartAccessRequest-request-Tags"></a>
Key-value pairs of metadata you want to assign to the access request.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

 ** [Targets](#API_StartAccessRequest_RequestSyntax) **   <a name="systemsmanager-StartAccessRequest-request-Targets"></a>
The node you are requesting access to.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: Yes

## Response Syntax
<a name="API_StartAccessRequest_ResponseSyntax"></a>

```
{
   "AccessRequestId": "string"
}
```

## Response Elements
<a name="API_StartAccessRequest_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccessRequestId](#API_StartAccessRequest_ResponseSyntax) **   <a name="systemsmanager-StartAccessRequest-response-AccessRequestId"></a>
The ID of the access request.  
Type: String  
Pattern: `^(oi)-[0-9a-f]{12}$` 

## Errors
<a name="API_StartAccessRequest_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requester doesn't have permissions to perform the requested operation.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified parameter to be shared could not be found.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeds the service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account.    
 ** QuotaCode **   
The quota code recognized by the AWS Service Quotas service.  
 ** ResourceId **   
The unique ID of the resource referenced in the failed request.  
 ** ResourceType **   
The resource type of the resource referenced in the failed request.  
 ** ServiceCode **   
The code for the AWS service that owns the quota.
HTTP Status Code: 400

 ** ThrottlingException **   
The request or operation couldn't be performed because the service is throttling requests.    
 ** QuotaCode **   
The quota code recognized by the AWS Service Quotas service.  
 ** ServiceCode **   
The code for the AWS service that owns the quota.
HTTP Status Code: 400

 ** ValidationException **   
The request isn't valid. Verify that you entered valid contents for the command and try again.    
 ** ReasonCode **   
The reason code for the invalid request.
HTTP Status Code: 400

## See Also
<a name="API_StartAccessRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/StartAccessRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/StartAccessRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/StartAccessRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/StartAccessRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/StartAccessRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/StartAccessRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/StartAccessRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/StartAccessRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/StartAccessRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/StartAccessRequest) 

# StartAssociationsOnce
<a name="API_StartAssociationsOnce"></a>

Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.

## Request Syntax
<a name="API_StartAssociationsOnce_RequestSyntax"></a>

```
{
   "AssociationIds": [ "string" ]
}
```

## Request Parameters
<a name="API_StartAssociationsOnce_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AssociationIds](#API_StartAssociationsOnce_RequestSyntax) **   <a name="systemsmanager-StartAssociationsOnce-request-AssociationIds"></a>
The association IDs that you want to run immediately and only one time.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`   
Required: Yes

## Response Elements
<a name="API_StartAssociationsOnce_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StartAssociationsOnce_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociationDoesNotExist **   
The specified association doesn't exist.  
HTTP Status Code: 400

 ** InvalidAssociation **   
The association isn't valid or doesn't exist.   
HTTP Status Code: 400

## Examples
<a name="API_StartAssociationsOnce_Examples"></a>

### Example
<a name="API_StartAssociationsOnce_Example_1"></a>

This example illustrates one usage of StartAssociationsOnce.

#### Sample Request
<a name="API_StartAssociationsOnce_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.StartAssociationsOnce
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T163434Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 60

{
    "AssociationIds": [
        "4332cf28-050d-4fa1-a4df-11b39EXAMPLE"
    ]
}
```

#### Sample Response
<a name="API_StartAssociationsOnce_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_StartAssociationsOnce_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/StartAssociationsOnce) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/StartAssociationsOnce) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/StartAssociationsOnce) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/StartAssociationsOnce) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/StartAssociationsOnce) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/StartAssociationsOnce) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/StartAssociationsOnce) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/StartAssociationsOnce) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/StartAssociationsOnce) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/StartAssociationsOnce) 

# StartAutomationExecution
<a name="API_StartAutomationExecution"></a>

Initiates execution of an Automation runbook.

## Request Syntax
<a name="API_StartAutomationExecution_RequestSyntax"></a>

```
{
   "AlarmConfiguration": { 
      "Alarms": [ 
         { 
            "Name": "string"
         }
      ],
      "IgnorePollAlarmFailure": boolean
   },
   "ClientToken": "string",
   "DocumentName": "string",
   "DocumentVersion": "string",
   "MaxConcurrency": "string",
   "MaxErrors": "string",
   "Mode": "string",
   "Parameters": { 
      "string" : [ "string" ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TargetLocations": [ 
      { 
         "Accounts": [ "string" ],
         "ExcludeAccounts": [ "string" ],
         "ExecutionRoleName": "string",
         "IncludeChildOrganizationUnits": boolean,
         "Regions": [ "string" ],
         "TargetLocationAlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "TargetLocationMaxConcurrency": "string",
         "TargetLocationMaxErrors": "string",
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "TargetsMaxConcurrency": "string",
         "TargetsMaxErrors": "string"
      }
   ],
   "TargetLocationsURL": "string",
   "TargetMaps": [ 
      { 
         "string" : [ "string" ]
      }
   ],
   "TargetParameterName": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ]
}
```

## Request Parameters
<a name="API_StartAutomationExecution_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AlarmConfiguration](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-AlarmConfiguration"></a>
The CloudWatch alarm you want to apply to your automation.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object  
Required: No

 ** [ClientToken](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-ClientToken"></a>
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}`   
Required: No

 ** [DocumentName](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-DocumentName"></a>
The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see [Sharing SSM documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-ssm-sharing.html) in the * AWS Systems Manager User Guide*.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: Yes

 ** [DocumentVersion](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-DocumentVersion"></a>
The version of the Automation runbook to use for this execution.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [MaxConcurrency](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-MaxConcurrency"></a>
The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is `10`.  
If both this parameter and the `TargetLocation:TargetsMaxConcurrency` are supplied, `TargetLocation:TargetsMaxConcurrency` takes precedence.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$`   
Required: No

 ** [MaxErrors](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-MaxErrors"></a>
The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.  
Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.  
If this parameter and the `TargetLocation:TargetsMaxErrors` parameter are both supplied, `TargetLocation:TargetsMaxErrors` takes precedence.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$`   
Required: No

 ** [Mode](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-Mode"></a>
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.  
Type: String  
Valid Values: `Auto | Interactive`   
Required: No

 ** [Parameters](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-Parameters"></a>
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.  
Type: String to array of strings map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 50.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** [Tags](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-Tags"></a>
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:  
+  `Key=environment,Value=test` 
+  `Key=OS,Value=Windows` 
The `Array Members` maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the `StartAutomationExecution` action, you can specify a maximum of 5 tags. You can, however, use the [AddTagsToResource](API_AddTagsToResource.md) action to add up to a total of 50 tags to an existing automation configuration.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

 ** [TargetLocations](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-TargetLocations"></a>
A location is a combination of AWS Regions and/or AWS accounts where you want to run the automation. Use this operation to start an automation in multiple AWS Regions and multiple AWS accounts. For more information, see [Running automations in multiple AWS Regions and accounts](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html) in the * AWS Systems Manager User Guide*.   
Type: Array of [TargetLocation](API_TargetLocation.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: No

 ** [TargetLocationsURL](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-TargetLocationsURL"></a>
Specify a publicly accessible URL for a file that contains the `TargetLocations` body. Currently, only files in presigned Amazon S3 buckets are supported.   
Type: String  
Pattern: `^https:\/\/[-a-zA-Z0-9@:%._\+~#=]{1,253}\.s3(\.[a-z\d-]{9,16})?\.amazonaws\.com\/.{1,2000}`   
Required: No

 ** [TargetMaps](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-TargetMaps"></a>
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.  
Type: Array of string to array of strings maps  
Array Members: Minimum number of 0 items. Maximum number of 300 items.  
Map Entries: Maximum number of 20 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 50.  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

 ** [TargetParameterName](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-TargetParameterName"></a>
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

 ** [Targets](#API_StartAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StartAutomationExecution-request-Targets"></a>
A key-value mapping to target resources. Required if you specify TargetParameterName.  
If both this parameter and the `TargetLocation:Targets` parameter are supplied, `TargetLocation:Targets` takes precedence.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

## Response Syntax
<a name="API_StartAutomationExecution_ResponseSyntax"></a>

```
{
   "AutomationExecutionId": "string"
}
```

## Response Elements
<a name="API_StartAutomationExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AutomationExecutionId](#API_StartAutomationExecution_ResponseSyntax) **   <a name="systemsmanager-StartAutomationExecution-response-AutomationExecutionId"></a>
The unique ID of a newly scheduled automation execution.  
Type: String  
Length Constraints: Fixed length of 36.

## Errors
<a name="API_StartAutomationExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AutomationDefinitionNotFoundException **   
An Automation runbook with the specified name couldn't be found.  
HTTP Status Code: 400

 ** AutomationDefinitionVersionNotFoundException **   
An Automation runbook with the specified name and version couldn't be found.  
HTTP Status Code: 400

 ** AutomationExecutionLimitExceededException **   
The number of simultaneously running Automation executions exceeded the allowable limit.  
HTTP Status Code: 400

 ** IdempotentParameterMismatch **   
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.   
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidAutomationExecutionParametersException **   
The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.  
HTTP Status Code: 400

 ** InvalidTarget **   
The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.  
HTTP Status Code: 400

## Examples
<a name="API_StartAutomationExecution_Examples"></a>

### Example
<a name="API_StartAutomationExecution_Example_1"></a>

This example illustrates one usage of StartAutomationExecution.

#### Sample Request
<a name="API_StartAutomationExecution_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.StartAutomationExecution
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T162110Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 86

{
    "DocumentName": "Example",
    "Parameters": {
        "InstanceId": [
            "i-02573cafcfEXAMPLE"
        ]
    }
}
```

#### Sample Response
<a name="API_StartAutomationExecution_Example_1_Response"></a>

```
{
    "AutomationExecutionId": "832a6fba-f4f0-4b2a-ab85-587adEXAMPLE"
}
```

## See Also
<a name="API_StartAutomationExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/StartAutomationExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/StartAutomationExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/StartAutomationExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/StartAutomationExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/StartAutomationExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/StartAutomationExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/StartAutomationExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/StartAutomationExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/StartAutomationExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/StartAutomationExecution) 

# StartChangeRequestExecution
<a name="API_StartChangeRequestExecution"></a>

**Important**  
 AWS Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Change Manager availability change](https://docs.aws.amazon.com/systems-manager/latest/userguide/change-manager-availability-change.html).

Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.

## Request Syntax
<a name="API_StartChangeRequestExecution_RequestSyntax"></a>

```
{
   "AutoApprove": boolean,
   "ChangeDetails": "string",
   "ChangeRequestName": "string",
   "ClientToken": "string",
   "DocumentName": "string",
   "DocumentVersion": "string",
   "Parameters": { 
      "string" : [ "string" ]
   },
   "Runbooks": [ 
      { 
         "DocumentName": "string",
         "DocumentVersion": "string",
         "MaxConcurrency": "string",
         "MaxErrors": "string",
         "Parameters": { 
            "string" : [ "string" ]
         },
         "TargetLocations": [ 
            { 
               "Accounts": [ "string" ],
               "ExcludeAccounts": [ "string" ],
               "ExecutionRoleName": "string",
               "IncludeChildOrganizationUnits": boolean,
               "Regions": [ "string" ],
               "TargetLocationAlarmConfiguration": { 
                  "Alarms": [ 
                     { 
                        "Name": "string"
                     }
                  ],
                  "IgnorePollAlarmFailure": boolean
               },
               "TargetLocationMaxConcurrency": "string",
               "TargetLocationMaxErrors": "string",
               "Targets": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ],
               "TargetsMaxConcurrency": "string",
               "TargetsMaxErrors": "string"
            }
         ],
         "TargetMaps": [ 
            { 
               "string" : [ "string" ]
            }
         ],
         "TargetParameterName": "string",
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ]
      }
   ],
   "ScheduledEndTime": number,
   "ScheduledTime": number,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_StartChangeRequestExecution_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AutoApprove](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-AutoApprove"></a>
Indicates whether the change request can be approved automatically without the need for manual approvals.  
If `AutoApprovable` is enabled in a change template, then setting `AutoApprove` to `true` in `StartChangeRequestExecution` creates a change request that bypasses approver review.  
Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is `CLOSED`, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again `OPEN`. 
Type: Boolean  
Required: No

 ** [ChangeDetails](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-ChangeDetails"></a>
User-provided details about the change. If no details are provided, content specified in the **Template information** section of the associated change template is added.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32768.  
Required: No

 ** [ChangeRequestName](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-ChangeRequestName"></a>
The name of the change request associated with the runbook workflow to be run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** [ClientToken](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-ClientToken"></a>
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}`   
Required: No

 ** [DocumentName](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-DocumentName"></a>
The name of the change template document to run during the runbook workflow.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: Yes

 ** [DocumentVersion](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-DocumentVersion"></a>
The version of the change template document to run during the runbook workflow.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [Parameters](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-Parameters"></a>
A key-value map of parameters that match the declared parameters in the change template document.  
Type: String to array of strings map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 50.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** [Runbooks](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-Runbooks"></a>
Information about the Automation runbooks that are run during the runbook workflow.  
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Type: Array of [Runbook](API_Runbook.md) objects  
Array Members: Fixed number of 1 item.  
Required: Yes

 ** [ScheduledEndTime](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-ScheduledEndTime"></a>
The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.  
Type: Timestamp  
Required: No

 ** [ScheduledTime](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-ScheduledTime"></a>
The date and time specified in the change request to run the Automation runbooks.  
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Type: Timestamp  
Required: No

 ** [Tags](#API_StartChangeRequestExecution_RequestSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-request-Tags"></a>
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:  
+  `Key=Environment,Value=Production` 
+  `Key=Region,Value=us-east-2` 
The `Array Members` maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the `StartChangeRequestExecution` action, you can specify a maximum of 5 tags. You can, however, use the [AddTagsToResource](API_AddTagsToResource.md) action to add up to a total of 50 tags to an existing change request configuration.
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 1000 items.  
Required: No

## Response Syntax
<a name="API_StartChangeRequestExecution_ResponseSyntax"></a>

```
{
   "AutomationExecutionId": "string"
}
```

## Response Elements
<a name="API_StartChangeRequestExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AutomationExecutionId](#API_StartChangeRequestExecution_ResponseSyntax) **   <a name="systemsmanager-StartChangeRequestExecution-response-AutomationExecutionId"></a>
The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.)   
Type: String  
Length Constraints: Fixed length of 36.

## Errors
<a name="API_StartChangeRequestExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AutomationDefinitionNotApprovedException **   
Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.  
HTTP Status Code: 400

 ** AutomationDefinitionNotFoundException **   
An Automation runbook with the specified name couldn't be found.  
HTTP Status Code: 400

 ** AutomationDefinitionVersionNotFoundException **   
An Automation runbook with the specified name and version couldn't be found.  
HTTP Status Code: 400

 ** AutomationExecutionLimitExceededException **   
The number of simultaneously running Automation executions exceeded the allowable limit.  
HTTP Status Code: 400

 ** IdempotentParameterMismatch **   
Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.   
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidAutomationExecutionParametersException **   
The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.  
HTTP Status Code: 400

## Examples
<a name="API_StartChangeRequestExecution_Examples"></a>

### Example
<a name="API_StartChangeRequestExecution_Example_1"></a>

This example illustrates one usage of StartChangeRequestExecution.

#### Sample Request
<a name="API_StartChangeRequestExecution_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.StartChangeRequestExecution
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.12 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ssm.start-change-request-execution
X-Amz-Date: 20240820T192759Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240820/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 1247

{
    "ChangeRequestName": "MyChangeRequest",
    "DocumentName": "AWS-HelloWorldChangeTemplate",
    "DocumentVersion": "$DEFAULT",
    "ScheduledTime": 1640833200,
    "ScheduledEndTime": 1640833500,
    "Tags": [
        {
            "Key": "Purpose",
            "Value": "Testing"
        }
    ],
    "Parameters": {
        "Approver": [
            "JohnDoe"
        ],
        "ApproverType": [
            "IamUser"
        ],
        "ApproverSnsTopicArn": [
            "arn:aws:sns:us-east-2:111122223333:MyNotificationTopic"
        ]
    },
    "Runbooks": [
        {
            "DocumentName": "AWS-HelloWorld",
            "DocumentVersion": "1",
            "MaxConcurrency": "1",
            "MaxErrors": "1",
            "Parameters": {
                "AutomationAssumeRole": [
                    "arn:aws:iam::111122223333:role/MyChangeManagerAssumeRole"
                ]
            }
        }
    ],
    "ChangeDetails": "### Document Name: HelloWorldChangeTemplate\n\n## What does this document do?\nThis change template demonstrates the feature set available for creating change templates for Change Manager. This template starts a Runbook workflow for the Automation document called AWS-HelloWorld.\n\n## Input Parameters\n* ApproverSnsTopicArn: (Required) Amazon Simple Notification Service ARN for approvers.\n* Approver: (Required) The name of the approver to send this request to.\n* ApproverType: (Required) The type of reviewer.\n  * Allowed Values: IamUser, IamGroup, IamRole, SSOGroup, SSOUser\n\n## Output Parameters\nThis document has no outputs \n"
}
```

#### Sample Response
<a name="API_StartChangeRequestExecution_Example_1_Response"></a>

```
{
    "AutomationExecutionId": "dddd1c6c-849d-4ee0-acc1-0be9dEXAMPLE"
}
```

## See Also
<a name="API_StartChangeRequestExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/StartChangeRequestExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/StartChangeRequestExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/StartChangeRequestExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/StartChangeRequestExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/StartChangeRequestExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/StartChangeRequestExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/StartChangeRequestExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/StartChangeRequestExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/StartChangeRequestExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/StartChangeRequestExecution) 

# StartExecutionPreview
<a name="API_StartExecutionPreview"></a>

Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.

## Request Syntax
<a name="API_StartExecutionPreview_RequestSyntax"></a>

```
{
   "DocumentName": "string",
   "DocumentVersion": "string",
   "ExecutionInputs": { ... }
}
```

## Request Parameters
<a name="API_StartExecutionPreview_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DocumentName](#API_StartExecutionPreview_RequestSyntax) **   <a name="systemsmanager-StartExecutionPreview-request-DocumentName"></a>
The name of the Automation runbook to run. The result of the execution preview indicates what the impact would be of running this runbook.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

 ** [DocumentVersion](#API_StartExecutionPreview_RequestSyntax) **   <a name="systemsmanager-StartExecutionPreview-request-DocumentVersion"></a>
The version of the Automation runbook to run. The default value is `$DEFAULT`.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [ExecutionInputs](#API_StartExecutionPreview_RequestSyntax) **   <a name="systemsmanager-StartExecutionPreview-request-ExecutionInputs"></a>
Information about the inputs that can be specified for the preview operation.   
Type: [ExecutionInputs](API_ExecutionInputs.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_StartExecutionPreview_ResponseSyntax"></a>

```
{
   "ExecutionPreviewId": "string"
}
```

## Response Elements
<a name="API_StartExecutionPreview_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ExecutionPreviewId](#API_StartExecutionPreview_ResponseSyntax) **   <a name="systemsmanager-StartExecutionPreview-response-ExecutionPreviewId"></a>
The ID of the execution preview generated by the system.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}` 

## Errors
<a name="API_StartExecutionPreview_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ValidationException **   
The request isn't valid. Verify that you entered valid contents for the command and try again.    
 ** ReasonCode **   
The reason code for the invalid request.
HTTP Status Code: 400

## Examples
<a name="API_StartExecutionPreview_Examples"></a>

### Example
<a name="API_StartExecutionPreview_Example_1"></a>

This example illustrates one usage of StartExecutionPreview.

#### Sample Request
<a name="API_StartExecutionPreview_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.StartExecutionPreview
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20241125T162110Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 86

{
    "DocumentName": "MyExampleDocument"
}
```

### Example
<a name="API_StartExecutionPreview_Example_2"></a>

This example illustrates one usage of StartExecutionPreview.

#### Sample Response
<a name="API_StartExecutionPreview_Example_2_Response"></a>

```
{
    "ExecutionPreviewId": "2f27d6e5-9676-4708-b8bd-aef0aEXAMPLE"
}
```

## See Also
<a name="API_StartExecutionPreview_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/StartExecutionPreview) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/StartExecutionPreview) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/StartExecutionPreview) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/StartExecutionPreview) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/StartExecutionPreview) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/StartExecutionPreview) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/StartExecutionPreview) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/StartExecutionPreview) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/StartExecutionPreview) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/StartExecutionPreview) 

# StartSession
<a name="API_StartSession"></a>

Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

**Note**  
 AWS CLI usage: `start-session` is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see [Install the Session Manager plugin for the AWS CLI](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) in the * AWS Systems Manager User Guide*.  
 AWS Tools for PowerShell usage: Start-SSMSession isn't currently supported by AWS Tools for PowerShell on Windows local machines.

## Request Syntax
<a name="API_StartSession_RequestSyntax"></a>

```
{
   "DocumentName": "string",
   "Parameters": { 
      "string" : [ "string" ]
   },
   "Reason": "string",
   "Target": "string"
}
```

## Request Parameters
<a name="API_StartSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DocumentName](#API_StartSession_RequestSyntax) **   <a name="systemsmanager-StartSession-request-DocumentName"></a>
The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, `SSM-SessionManagerRunShell`. You can call the [GetDocument](API_GetDocument.md) API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see [Start a session](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html) in the * AWS Systems Manager User Guide*.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: No

 ** [Parameters](#API_StartSession_RequestSyntax) **   <a name="systemsmanager-StartSession-request-Parameters"></a>
The values you want to specify for the parameters defined in the Session document. For more information about these parameters, see [Create a Session Manager preferences document](https://docs.aws.amazon.com/systems-manager/latest/userguide/getting-started-create-preferences-cli.html) in the * AWS Systems Manager User Guide*.  
Type: String to array of strings map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Length Constraints: Minimum length of 1. Maximum length of 65535.  
Required: No

 ** [Reason](#API_StartSession_RequestSyntax) **   <a name="systemsmanager-StartSession-request-Reason"></a>
The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^.{1,256}$`   
Required: No

 ** [Target](#API_StartSession_RequestSyntax) **   <a name="systemsmanager-StartSession-request-Target"></a>
The managed node to connect to for the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 400.  
Required: Yes

## Response Syntax
<a name="API_StartSession_ResponseSyntax"></a>

```
{
   "SessionId": "string",
   "StreamUrl": "string",
   "TokenValue": "string"
}
```

## Response Elements
<a name="API_StartSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SessionId](#API_StartSession_ResponseSyntax) **   <a name="systemsmanager-StartSession-response-SessionId"></a>
The ID of the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 96.

 ** [StreamUrl](#API_StartSession_ResponseSyntax) **   <a name="systemsmanager-StartSession-response-StreamUrl"></a>
A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node. Format: `wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)`   
 **region** represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as `us-east-2` for the US East (Ohio) Region. For a list of supported **region** values, see the **Region** column in [Systems Manager service endpoints](https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) in the *Amazon Web Services General Reference*.  
 **session-id** represents the ID of a Session Manager session, such as `1a2b3c4dEXAMPLE`.  
Type: String

 ** [TokenValue](#API_StartSession_ResponseSyntax) **   <a name="systemsmanager-StartSession-response-TokenValue"></a>
An encrypted token value containing session and caller information. This token is used to authenticate the connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share your session's token.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 300.

## Errors
<a name="API_StartSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** TargetNotConnected **   
The specified target managed node for the session isn't fully configured for use with Session Manager. For more information, see [Setting up Session Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html) in the * AWS Systems Manager User Guide*. This error is also returned if you attempt to start a session on a managed node that is located in a different account or Region  
HTTP Status Code: 400

## Examples
<a name="API_StartSession_Examples"></a>

### Example
<a name="API_StartSession_Example_1"></a>

This example illustrates one usage of StartSession.

#### Sample Request
<a name="API_StartSession_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.StartSession
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T181823Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 33

{
    "Target": "i-02573cafcfEXAMPLE"
}
```

#### Sample Response
<a name="API_StartSession_Example_1_Response"></a>

```
{
    "SessionId": "John-Doe-0dc5b7af96EXAMPLE",
    "StreamUrl": "wss://ssmmessages.us-east-2.amazonaws.com/v1/data-channel/John-Doe-0dc5b7af96EXAMPLE?role=publish_subscribe",
    "TokenValue": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE/39c3b3042cd2aEXAMPLE"
}
```

## See Also
<a name="API_StartSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/StartSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/StartSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/StartSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/StartSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/StartSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/StartSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/StartSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/StartSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/StartSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/StartSession) 

# StopAutomationExecution
<a name="API_StopAutomationExecution"></a>

Stop an Automation that is currently running.

## Request Syntax
<a name="API_StopAutomationExecution_RequestSyntax"></a>

```
{
   "AutomationExecutionId": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_StopAutomationExecution_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AutomationExecutionId](#API_StopAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StopAutomationExecution-request-AutomationExecutionId"></a>
The execution ID of the Automation to stop.  
Type: String  
Length Constraints: Fixed length of 36.  
Required: Yes

 ** [Type](#API_StopAutomationExecution_RequestSyntax) **   <a name="systemsmanager-StopAutomationExecution-request-Type"></a>
The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.  
Type: String  
Valid Values: `Complete | Cancel`   
Required: No

## Response Elements
<a name="API_StopAutomationExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopAutomationExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AutomationExecutionNotFoundException **   
There is no automation execution information for the requested automation execution ID.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidAutomationStatusUpdateException **   
The specified update status operation isn't valid.  
HTTP Status Code: 400

## Examples
<a name="API_StopAutomationExecution_Examples"></a>

### Example
<a name="API_StopAutomationExecution_Example_1"></a>

This example illustrates one usage of StopAutomationExecution.

#### Sample Request
<a name="API_StopAutomationExecution_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.StopAutomationExecution
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T171100Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 65

{
    "AutomationExecutionId": "f7d1f82d-6cde-4f7a-aa53-d485bEXAMPLE"
}
```

#### Sample Response
<a name="API_StopAutomationExecution_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_StopAutomationExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/StopAutomationExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/StopAutomationExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/StopAutomationExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/StopAutomationExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/StopAutomationExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/StopAutomationExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/StopAutomationExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/StopAutomationExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/StopAutomationExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/StopAutomationExecution) 

# TerminateSession
<a name="API_TerminateSession"></a>

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.

## Request Syntax
<a name="API_TerminateSession_RequestSyntax"></a>

```
{
   "SessionId": "string"
}
```

## Request Parameters
<a name="API_TerminateSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [SessionId](#API_TerminateSession_RequestSyntax) **   <a name="systemsmanager-TerminateSession-request-SessionId"></a>
The ID of the session to terminate.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 96.  
Required: Yes

## Response Syntax
<a name="API_TerminateSession_ResponseSyntax"></a>

```
{
   "SessionId": "string"
}
```

## Response Elements
<a name="API_TerminateSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SessionId](#API_TerminateSession_ResponseSyntax) **   <a name="systemsmanager-TerminateSession-response-SessionId"></a>
The ID of the session that has been terminated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 96.

## Errors
<a name="API_TerminateSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_TerminateSession_Examples"></a>

### Example
<a name="API_TerminateSession_Example_1"></a>

This example illustrates one usage of TerminateSession.

#### Sample Request
<a name="API_TerminateSession_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.TerminateSession
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T182708Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 50

{
    "SessionId": "John-Doe-0402960697EXAMPLE"
}
```

#### Sample Response
<a name="API_TerminateSession_Example_1_Response"></a>

```
{
    "SessionId": "John-Doe-0402960697EXAMPLE"
}
```

## See Also
<a name="API_TerminateSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/TerminateSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/TerminateSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/TerminateSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/TerminateSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/TerminateSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/TerminateSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/TerminateSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/TerminateSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/TerminateSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/TerminateSession) 

# UnlabelParameterVersion
<a name="API_UnlabelParameterVersion"></a>

Remove a label or labels from a parameter.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a `ValidationException` error.

## Request Syntax
<a name="API_UnlabelParameterVersion_RequestSyntax"></a>

```
{
   "Labels": [ "string" ],
   "Name": "string",
   "ParameterVersion": number
}
```

## Request Parameters
<a name="API_UnlabelParameterVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Labels](#API_UnlabelParameterVersion_RequestSyntax) **   <a name="systemsmanager-UnlabelParameterVersion-request-Labels"></a>
One or more labels to delete from the specified parameter version.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Name](#API_UnlabelParameterVersion_RequestSyntax) **   <a name="systemsmanager-UnlabelParameterVersion-request-Name"></a>
The name of the parameter from which you want to delete one or more labels.  
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [ParameterVersion](#API_UnlabelParameterVersion_RequestSyntax) **   <a name="systemsmanager-UnlabelParameterVersion-request-ParameterVersion"></a>
The specific version of the parameter which you want to delete one or more labels from. If it isn't present, the call will fail.  
Type: Long  
Required: Yes

## Response Syntax
<a name="API_UnlabelParameterVersion_ResponseSyntax"></a>

```
{
   "InvalidLabels": [ "string" ],
   "RemovedLabels": [ "string" ]
}
```

## Response Elements
<a name="API_UnlabelParameterVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InvalidLabels](#API_UnlabelParameterVersion_ResponseSyntax) **   <a name="systemsmanager-UnlabelParameterVersion-response-InvalidLabels"></a>
The labels that aren't attached to the given parameter version.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [RemovedLabels](#API_UnlabelParameterVersion_ResponseSyntax) **   <a name="systemsmanager-UnlabelParameterVersion-response-RemovedLabels"></a>
A list of all labels deleted from the parameter.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_UnlabelParameterVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ParameterNotFound **   
The parameter couldn't be found. Verify the name and try again.  
For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is *not* recorded in AWS CloudTrail event logs.
HTTP Status Code: 400

 ** ParameterVersionNotFound **   
The specified parameter version wasn't found. Verify the parameter name and version, and try again.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_UnlabelParameterVersion_Examples"></a>

### Example
<a name="API_UnlabelParameterVersion_Example_1"></a>

This example illustrates one usage of UnlabelParameterVersion.

#### Sample Request
<a name="API_UnlabelParameterVersion_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-west-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UnlabelParameterVersion
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240712T183221Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 67

{
    "Name": "MyParameter",
    "ParameterVersion": 2,
    "Labels": [
        "label"
    ]
}
```

#### Sample Response
<a name="API_UnlabelParameterVersion_Example_1_Response"></a>

```
{
    "InvalidLabels": [],
    "RemovedLabels": [
        "label"
    ]
}
```

## See Also
<a name="API_UnlabelParameterVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UnlabelParameterVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UnlabelParameterVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UnlabelParameterVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UnlabelParameterVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UnlabelParameterVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UnlabelParameterVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UnlabelParameterVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UnlabelParameterVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UnlabelParameterVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UnlabelParameterVersion) 

# UpdateAssociation
<a name="API_UpdateAssociation"></a>

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call `UpdateAssociation`, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the `Name` parameter. Before calling this API action, we recommend that you call the [DescribeAssociation](API_DescribeAssociation.md) API operation and make a note of all optional parameters required for your `UpdateAssociation` call.

In order to call this API operation, a user, group, or role must be granted permission to call the [DescribeAssociation](API_DescribeAssociation.md) API operation. If you don't have permission to call `DescribeAssociation`, then you receive the following error: `An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>` 

**Important**  
When you update an association, the association immediately runs against the specified targets. You can add the `ApplyOnlyAtCronInterval` parameter to run the association during the next schedule run.

## Request Syntax
<a name="API_UpdateAssociation_RequestSyntax"></a>

```
{
   "AlarmConfiguration": { 
      "Alarms": [ 
         { 
            "Name": "string"
         }
      ],
      "IgnorePollAlarmFailure": boolean
   },
   "ApplyOnlyAtCronInterval": boolean,
   "AssociationId": "string",
   "AssociationName": "string",
   "AssociationVersion": "string",
   "AutomationTargetParameterName": "string",
   "CalendarNames": [ "string" ],
   "ComplianceSeverity": "string",
   "DocumentVersion": "string",
   "Duration": number,
   "MaxConcurrency": "string",
   "MaxErrors": "string",
   "Name": "string",
   "OutputLocation": { 
      "S3Location": { 
         "OutputS3BucketName": "string",
         "OutputS3KeyPrefix": "string",
         "OutputS3Region": "string"
      }
   },
   "Parameters": { 
      "string" : [ "string" ]
   },
   "ScheduleExpression": "string",
   "ScheduleOffset": number,
   "SyncCompliance": "string",
   "TargetLocations": [ 
      { 
         "Accounts": [ "string" ],
         "ExcludeAccounts": [ "string" ],
         "ExecutionRoleName": "string",
         "IncludeChildOrganizationUnits": boolean,
         "Regions": [ "string" ],
         "TargetLocationAlarmConfiguration": { 
            "Alarms": [ 
               { 
                  "Name": "string"
               }
            ],
            "IgnorePollAlarmFailure": boolean
         },
         "TargetLocationMaxConcurrency": "string",
         "TargetLocationMaxErrors": "string",
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "TargetsMaxConcurrency": "string",
         "TargetsMaxErrors": "string"
      }
   ],
   "TargetMaps": [ 
      { 
         "string" : [ "string" ]
      }
   ],
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ]
}
```

## Request Parameters
<a name="API_UpdateAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AlarmConfiguration](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-AlarmConfiguration"></a>
The details for the CloudWatch alarm you want to apply to an automation or command.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object  
Required: No

 ** [ApplyOnlyAtCronInterval](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-ApplyOnlyAtCronInterval"></a>
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify `true` for `ApplyOnlyAtCronInterval` if you want the association to run only according to the schedule you specified.  
If you chose this option when you created an association and later you edit that association or you make changes to the Automation runbook or SSM document on which that association is based, State Manager applies the association at the next specified cron interval. For example, if you chose the `Latest` version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously set `ApplyOnlyAtCronInterval` to `true`. If this option wasn't selected, State Manager immediately runs the association.  
For more information, see [Understanding when associations are applied to resources](https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#state-manager-about-scheduling) and [About target updates with Automation runbooks](https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#runbook-target-updates) in the * AWS Systems Manager User Guide*.  
This parameter isn't supported for rate expressions.  
You can reset this parameter. To do so, specify the `no-apply-only-at-cron-interval` parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.  
Type: Boolean  
Required: No

 ** [AssociationId](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-AssociationId"></a>
The ID of the association you want to update.   
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`   
Required: Yes

 ** [AssociationName](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-AssociationName"></a>
The name of the association that you want to update.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: No

 ** [AssociationVersion](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-AssociationVersion"></a>
This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify `$LATEST`, or omit this parameter.  
Type: String  
Pattern: `([$]LATEST)|([1-9][0-9]*)`   
Required: No

 ** [AutomationTargetParameterName](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-AutomationTargetParameterName"></a>
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in AWS Systems Manager.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

 ** [CalendarNames](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-CalendarNames"></a>
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see [AWS Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) in the * AWS Systems Manager User Guide*.  
Type: Array of strings  
Required: No

 ** [ComplianceSeverity](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-ComplianceSeverity"></a>
The severity level to assign to the association.  
Type: String  
Valid Values: `CRITICAL | HIGH | MEDIUM | LOW | UNSPECIFIED`   
Required: No

 ** [DocumentVersion](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-DocumentVersion"></a>
The document version you want update for the association.   
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the `default` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to `default`.
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [Duration](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-Duration"></a>
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.   
The `Duration` parameter applies only when both these conditions are true:  
+ The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution. 
+ The command specifies the ` [ApplyOnlyAtCronInterval](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_UpdateAssociation.html#systemsmanager-UpdateAssociation-request-ApplyOnlyAtCronInterval) ` parameter, which means that the association doesn't run immediately after it is updated, but only according to the specified schedule.
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 24.  
Required: No

 ** [MaxConcurrency](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-MaxConcurrency"></a>
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.  
If a new managed node starts and attempts to run an association while Systems Manager is running `MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$`   
Required: No

 ** [MaxErrors](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-MaxErrors"></a>
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set `MaxError` to 10%, then the system stops sending the request when the sixth error is received.  
Executions that are already running an association when `MaxErrors` is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set `MaxConcurrency` to 1 so that executions proceed one at a time.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$`   
Required: No

 ** [Name](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-Name"></a>
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.  
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.  
For Systems Manager document (SSM document) that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:  
 `arn:aws:ssm:region:account-id:document/document-name `   
For example:  
 `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`   
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, `AWS-ApplyPatchBaseline` or `My-Document`.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: No

 ** [OutputLocation](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-OutputLocation"></a>
An S3 bucket where you want to store the results of this request.  
Type: [InstanceAssociationOutputLocation](API_InstanceAssociationOutputLocation.md) object  
Required: No

 ** [Parameters](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-Parameters"></a>
The parameters you want to update for the association. If you create a parameter using Parameter Store, a tool in AWS Systems Manager, you can reference the parameter using `{{ssm:parameter-name}}`.  
Type: String to array of strings map  
Required: No

 ** [ScheduleExpression](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-ScheduleExpression"></a>
The cron expression used to schedule the association that you want to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [ScheduleOffset](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-ScheduleOffset"></a>
Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of `cron(0 0 ? * THU#2 *)`, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see [Reference: Cron and rate expressions for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html) in the * AWS Systems Manager User Guide*.   
To use offsets, you must specify the `ApplyOnlyAtCronInterval` parameter. This option tells the system not to run an association immediately after you create it. 
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 6.  
Required: No

 ** [SyncCompliance](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-SyncCompliance"></a>
The mode for generating association compliance. You can specify `AUTO` or `MANUAL`. In `AUTO` mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is `COMPLIANT`. If the association execution doesn't run successfully, the association is `NON-COMPLIANT`.  
In `MANUAL` mode, you must specify the `AssociationId` as a parameter for the [PutComplianceItems](API_PutComplianceItems.md) API operation. In this case, compliance data isn't managed by State Manager, a tool in AWS Systems Manager. It is managed by your direct call to the [PutComplianceItems](API_PutComplianceItems.md) API operation.  
By default, all associations use `AUTO` mode.  
Type: String  
Valid Values: `AUTO | MANUAL`   
Required: No

 ** [TargetLocations](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-TargetLocations"></a>
A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.  
 `IncludeChildOrganizationUnits`, `ExcludeAccounts`, `TargetsMaxErrors`, `TargetsMaxConcurrency`, `Targets`, `TargetLocationAlarmConfiguration` parameters are not supported by State Manager.
Type: Array of [TargetLocation](API_TargetLocation.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: No

 ** [TargetMaps](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-TargetMaps"></a>
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.  
Type: Array of string to array of strings maps  
Array Members: Minimum number of 0 items. Maximum number of 300 items.  
Map Entries: Maximum number of 20 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 50.  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

 ** [Targets](#API_UpdateAssociation_RequestSyntax) **   <a name="systemsmanager-UpdateAssociation-request-Targets"></a>
The targets of the association.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

## Response Syntax
<a name="API_UpdateAssociation_ResponseSyntax"></a>

```
{
   "AssociationDescription": { 
      "AlarmConfiguration": { 
         "Alarms": [ 
            { 
               "Name": "string"
            }
         ],
         "IgnorePollAlarmFailure": boolean
      },
      "ApplyOnlyAtCronInterval": boolean,
      "AssociationId": "string",
      "AssociationName": "string",
      "AssociationVersion": "string",
      "AutomationTargetParameterName": "string",
      "CalendarNames": [ "string" ],
      "ComplianceSeverity": "string",
      "Date": number,
      "DocumentVersion": "string",
      "Duration": number,
      "InstanceId": "string",
      "LastExecutionDate": number,
      "LastSuccessfulExecutionDate": number,
      "LastUpdateAssociationDate": number,
      "MaxConcurrency": "string",
      "MaxErrors": "string",
      "Name": "string",
      "OutputLocation": { 
         "S3Location": { 
            "OutputS3BucketName": "string",
            "OutputS3KeyPrefix": "string",
            "OutputS3Region": "string"
         }
      },
      "Overview": { 
         "AssociationStatusAggregatedCount": { 
            "string" : number 
         },
         "DetailedStatus": "string",
         "Status": "string"
      },
      "Parameters": { 
         "string" : [ "string" ]
      },
      "ScheduleExpression": "string",
      "ScheduleOffset": number,
      "Status": { 
         "AdditionalInfo": "string",
         "Date": number,
         "Message": "string",
         "Name": "string"
      },
      "SyncCompliance": "string",
      "TargetLocations": [ 
         { 
            "Accounts": [ "string" ],
            "ExcludeAccounts": [ "string" ],
            "ExecutionRoleName": "string",
            "IncludeChildOrganizationUnits": boolean,
            "Regions": [ "string" ],
            "TargetLocationAlarmConfiguration": { 
               "Alarms": [ 
                  { 
                     "Name": "string"
                  }
               ],
               "IgnorePollAlarmFailure": boolean
            },
            "TargetLocationMaxConcurrency": "string",
            "TargetLocationMaxErrors": "string",
            "Targets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ],
            "TargetsMaxConcurrency": "string",
            "TargetsMaxErrors": "string"
         }
      ],
      "TargetMaps": [ 
         { 
            "string" : [ "string" ]
         }
      ],
      "Targets": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ],
      "TriggeredAlarms": [ 
         { 
            "Name": "string",
            "State": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_UpdateAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociationDescription](#API_UpdateAssociation_ResponseSyntax) **   <a name="systemsmanager-UpdateAssociation-response-AssociationDescription"></a>
The description of the association that was updated.  
Type: [AssociationDescription](API_AssociationDescription.md) object

## Errors
<a name="API_UpdateAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociationDoesNotExist **   
The specified association doesn't exist.  
HTTP Status Code: 400

 ** AssociationVersionLimitExceeded **   
You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.   
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidAssociationVersion **   
The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the `$LATEST` parameter to view the latest version of the association.  
HTTP Status Code: 400

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentVersion **   
The document version isn't valid or doesn't exist.  
HTTP Status Code: 400

 ** InvalidOutputLocation **   
The output location isn't valid or doesn't exist.  
HTTP Status Code: 400

 ** InvalidParameters **   
You must specify values for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.  
HTTP Status Code: 400

 ** InvalidSchedule **   
The schedule is invalid. Verify your cron or rate expression and try again.  
HTTP Status Code: 400

 ** InvalidTarget **   
The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.  
HTTP Status Code: 400

 ** InvalidTargetMaps **   
TargetMap parameter isn't valid.  
HTTP Status Code: 400

 ** InvalidUpdate **   
The update isn't valid.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateAssociation_Examples"></a>

### Example
<a name="API_UpdateAssociation_Example_1"></a>

This example illustrates one usage of UpdateAssociation.

#### Sample Request
<a name="API_UpdateAssociation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateAssociation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T171857Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 87

{
    "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
    "ComplianceSeverity": "HIGH"
}
```

#### Sample Response
<a name="API_UpdateAssociation_Example_1_Response"></a>

```
{
    "AssociationDescription": {
        "ApplyOnlyAtCronInterval": false,
        "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
        "AssociationVersion": "2",
        "ComplianceSeverity": "HIGH",
        "Date": 1561053271.583,
        "DocumentVersion": "$DEFAULT",
        "LastExecutionDate": 1582037438.692,
        "LastSuccessfulExecutionDate": 1582037438.692,
        "LastUpdateAssociationDate": 1585156739.103,
        "Name": "AWS-UpdateSSMAgent",
        "Overview": {
            "DetailedStatus": "Creating",
            "Status": "Pending"
        },
        "Targets": [
            {
                "Key": "tag:ssm",
                "Values": [
                    "true"
                ]
            }
        ]
    }
}
```

## See Also
<a name="API_UpdateAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateAssociation) 

# UpdateAssociationStatus
<a name="API_UpdateAssociationStatus"></a>

Updates the status of the AWS Systems Manager document (SSM document) associated with the specified managed node.

 `UpdateAssociationStatus` is primarily used by the AWS Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the `InstanceId` legacy parameter.

## Request Syntax
<a name="API_UpdateAssociationStatus_RequestSyntax"></a>

```
{
   "AssociationStatus": { 
      "AdditionalInfo": "string",
      "Date": number,
      "Message": "string",
      "Name": "string"
   },
   "InstanceId": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_UpdateAssociationStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AssociationStatus](#API_UpdateAssociationStatus_RequestSyntax) **   <a name="systemsmanager-UpdateAssociationStatus-request-AssociationStatus"></a>
The association status.  
Type: [AssociationStatus](API_AssociationStatus.md) object  
Required: Yes

 ** [InstanceId](#API_UpdateAssociationStatus_RequestSyntax) **   <a name="systemsmanager-UpdateAssociationStatus-request-InstanceId"></a>
The managed node ID.  
Type: String  
Pattern: `(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)`   
Required: Yes

 ** [Name](#API_UpdateAssociationStatus_RequestSyntax) **   <a name="systemsmanager-UpdateAssociationStatus-request-Name"></a>
The name of the SSM document.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$`   
Required: Yes

## Response Syntax
<a name="API_UpdateAssociationStatus_ResponseSyntax"></a>

```
{
   "AssociationDescription": { 
      "AlarmConfiguration": { 
         "Alarms": [ 
            { 
               "Name": "string"
            }
         ],
         "IgnorePollAlarmFailure": boolean
      },
      "ApplyOnlyAtCronInterval": boolean,
      "AssociationId": "string",
      "AssociationName": "string",
      "AssociationVersion": "string",
      "AutomationTargetParameterName": "string",
      "CalendarNames": [ "string" ],
      "ComplianceSeverity": "string",
      "Date": number,
      "DocumentVersion": "string",
      "Duration": number,
      "InstanceId": "string",
      "LastExecutionDate": number,
      "LastSuccessfulExecutionDate": number,
      "LastUpdateAssociationDate": number,
      "MaxConcurrency": "string",
      "MaxErrors": "string",
      "Name": "string",
      "OutputLocation": { 
         "S3Location": { 
            "OutputS3BucketName": "string",
            "OutputS3KeyPrefix": "string",
            "OutputS3Region": "string"
         }
      },
      "Overview": { 
         "AssociationStatusAggregatedCount": { 
            "string" : number 
         },
         "DetailedStatus": "string",
         "Status": "string"
      },
      "Parameters": { 
         "string" : [ "string" ]
      },
      "ScheduleExpression": "string",
      "ScheduleOffset": number,
      "Status": { 
         "AdditionalInfo": "string",
         "Date": number,
         "Message": "string",
         "Name": "string"
      },
      "SyncCompliance": "string",
      "TargetLocations": [ 
         { 
            "Accounts": [ "string" ],
            "ExcludeAccounts": [ "string" ],
            "ExecutionRoleName": "string",
            "IncludeChildOrganizationUnits": boolean,
            "Regions": [ "string" ],
            "TargetLocationAlarmConfiguration": { 
               "Alarms": [ 
                  { 
                     "Name": "string"
                  }
               ],
               "IgnorePollAlarmFailure": boolean
            },
            "TargetLocationMaxConcurrency": "string",
            "TargetLocationMaxErrors": "string",
            "Targets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ],
            "TargetsMaxConcurrency": "string",
            "TargetsMaxErrors": "string"
         }
      ],
      "TargetMaps": [ 
         { 
            "string" : [ "string" ]
         }
      ],
      "Targets": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ],
      "TriggeredAlarms": [ 
         { 
            "Name": "string",
            "State": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_UpdateAssociationStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociationDescription](#API_UpdateAssociationStatus_ResponseSyntax) **   <a name="systemsmanager-UpdateAssociationStatus-response-AssociationDescription"></a>
Information about the association.  
Type: [AssociationDescription](API_AssociationDescription.md) object

## Errors
<a name="API_UpdateAssociationStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AssociationDoesNotExist **   
The specified association doesn't exist.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

 ** StatusUnchanged **   
The updated status is the same as the current status.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateAssociationStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateAssociationStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateAssociationStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateAssociationStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateAssociationStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateAssociationStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateAssociationStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateAssociationStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateAssociationStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateAssociationStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateAssociationStatus) 

# UpdateDocument
<a name="API_UpdateDocument"></a>

Updates one or more values for an SSM document.

## Request Syntax
<a name="API_UpdateDocument_RequestSyntax"></a>

```
{
   "Attachments": [ 
      { 
         "Key": "string",
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "Content": "string",
   "DisplayName": "string",
   "DocumentFormat": "string",
   "DocumentVersion": "string",
   "Name": "string",
   "TargetType": "string",
   "VersionName": "string"
}
```

## Request Parameters
<a name="API_UpdateDocument_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Attachments](#API_UpdateDocument_RequestSyntax) **   <a name="systemsmanager-UpdateDocument-request-Attachments"></a>
A list of key-value pairs that describe attachments to a version of a document.  
Type: Array of [AttachmentsSource](API_AttachmentsSource.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

 ** [Content](#API_UpdateDocument_RequestSyntax) **   <a name="systemsmanager-UpdateDocument-request-Content"></a>
A valid JSON or YAML string.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [DisplayName](#API_UpdateDocument_RequestSyntax) **   <a name="systemsmanager-UpdateDocument-request-DisplayName"></a>
The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^[\w\.\-\:\/ ]*$`   
Required: No

 ** [DocumentFormat](#API_UpdateDocument_RequestSyntax) **   <a name="systemsmanager-UpdateDocument-request-DocumentFormat"></a>
Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.  
Type: String  
Valid Values: `YAML | JSON | TEXT`   
Required: No

 ** [DocumentVersion](#API_UpdateDocument_RequestSyntax) **   <a name="systemsmanager-UpdateDocument-request-DocumentVersion"></a>
The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the `$LATEST` variable.  
If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the `apply-only-at-cron-interval` parameter.
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [Name](#API_UpdateDocument_RequestSyntax) **   <a name="systemsmanager-UpdateDocument-request-Name"></a>
The name of the SSM document that you want to update.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

 ** [TargetType](#API_UpdateDocument_RequestSyntax) **   <a name="systemsmanager-UpdateDocument-request-TargetType"></a>
Specify a new target type for the document.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `^\/[\w\.\-\:\/]*$`   
Required: No

 ** [VersionName](#API_UpdateDocument_RequestSyntax) **   <a name="systemsmanager-UpdateDocument-request-VersionName"></a>
An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{1,128}$`   
Required: No

## Response Syntax
<a name="API_UpdateDocument_ResponseSyntax"></a>

```
{
   "DocumentDescription": { 
      "ApprovedVersion": "string",
      "AttachmentsInformation": [ 
         { 
            "Name": "string"
         }
      ],
      "Author": "string",
      "Category": [ "string" ],
      "CategoryEnum": [ "string" ],
      "CreatedDate": number,
      "DefaultVersion": "string",
      "Description": "string",
      "DisplayName": "string",
      "DocumentFormat": "string",
      "DocumentType": "string",
      "DocumentVersion": "string",
      "Hash": "string",
      "HashType": "string",
      "LatestVersion": "string",
      "Name": "string",
      "Owner": "string",
      "Parameters": [ 
         { 
            "DefaultValue": "string",
            "Description": "string",
            "Name": "string",
            "Type": "string"
         }
      ],
      "PendingReviewVersion": "string",
      "PlatformTypes": [ "string" ],
      "Requires": [ 
         { 
            "Name": "string",
            "RequireType": "string",
            "Version": "string",
            "VersionName": "string"
         }
      ],
      "ReviewInformation": [ 
         { 
            "ReviewedTime": number,
            "Reviewer": "string",
            "Status": "string"
         }
      ],
      "ReviewStatus": "string",
      "SchemaVersion": "string",
      "Sha1": "string",
      "Status": "string",
      "StatusInformation": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TargetType": "string",
      "VersionName": "string"
   }
}
```

## Response Elements
<a name="API_UpdateDocument_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DocumentDescription](#API_UpdateDocument_ResponseSyntax) **   <a name="systemsmanager-UpdateDocument-response-DocumentDescription"></a>
A description of the document that was updated.  
Type: [DocumentDescription](API_DocumentDescription.md) object

## Errors
<a name="API_UpdateDocument_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DocumentVersionLimitExceeded **   
The document has too many versions. Delete one or more document versions and try again.  
HTTP Status Code: 400

 ** DuplicateDocumentContent **   
The content of the association document matches another document. Change the content of the document and try again.  
HTTP Status Code: 400

 ** DuplicateDocumentVersionName **   
The version name has already been used in this document. Specify a different version name, and then try again.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentContent **   
The content for the document isn't valid.    
 ** Message **   
A description of the validation error.
HTTP Status Code: 400

 ** InvalidDocumentOperation **   
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.  
HTTP Status Code: 400

 ** InvalidDocumentSchemaVersion **   
The version of the document schema isn't supported.  
HTTP Status Code: 400

 ** InvalidDocumentVersion **   
The document version isn't valid or doesn't exist.  
HTTP Status Code: 400

 ** MaxDocumentSizeExceeded **   
The size limit of a document is 64 KB.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateDocument_Examples"></a>

### Example
<a name="API_UpdateDocument_Example_1"></a>

This example illustrates one usage of UpdateDocument.

#### Sample Request
<a name="API_UpdateDocument_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateDocument
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T180432Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 953

{
    "Content": "---\ndescription: \"CreateImage\"\nschemaVersion: '0.3'\nassumeRole: \"{{ AutomationAssumeRole }}\"--truncated--",
    "Name": "CreateImage",
    "DocumentVersion": "$LATEST",
    "DocumentFormat": "YAML"
}
```

#### Sample Response
<a name="API_UpdateDocument_Example_1_Response"></a>

```
{
    "DocumentDescription": {
        "CreatedDate": 1585159474.781,
        "DefaultVersion": "1",
        "Description": "Example",
        "DisplayName": "ExampleDoc",
        "DocumentFormat": "YAML",
        "DocumentType": "Automation",
        "DocumentVersion": "2",
        "Hash": "ff7430df11be00b0593ac116b2570d488bd37a2a2fa7ddf49da67976eEXAMPLE",
        "HashType": "Sha256",
        "LatestVersion": "2",
        "Name": "CreateImage",
        "Owner": "111122223333",
        "Parameters": [
            {
                "DefaultValue": "",
                "Description": "(Optional) 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.",
                "Name": "AutomationAssumeRole",
                "Type": "String"
            },
            {
                "DefaultValue": "",
                "Description": "(Required) The Instance Id whose root EBS volume you want to restore the latest Snapshot.",
                "Name": "InstanceId",
                "Type": "String"
            }
        ],
        "PlatformTypes": [
            "Windows",
            "Linux"
        ],
        "SchemaVersion": "0.3",
        "Status": "Updating",
        "Tags": []
    }
}
```

## See Also
<a name="API_UpdateDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateDocument) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateDocument) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateDocument) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateDocument) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateDocument) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateDocument) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateDocument) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateDocument) 

# UpdateDocumentDefaultVersion
<a name="API_UpdateDocumentDefaultVersion"></a>

Set the default version of a document. 

**Note**  
If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the `apply-only-at-cron-interval` parameter.

## Request Syntax
<a name="API_UpdateDocumentDefaultVersion_RequestSyntax"></a>

```
{
   "DocumentVersion": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_UpdateDocumentDefaultVersion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DocumentVersion](#API_UpdateDocumentDefaultVersion_RequestSyntax) **   <a name="systemsmanager-UpdateDocumentDefaultVersion-request-DocumentVersion"></a>
The version of a custom document that you want to set as the default version.  
Type: String  
Pattern: `(^[1-9][0-9]*$)`   
Required: Yes

 ** [Name](#API_UpdateDocumentDefaultVersion_RequestSyntax) **   <a name="systemsmanager-UpdateDocumentDefaultVersion-request-Name"></a>
The name of a custom document that you want to set as the default version.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

## Response Syntax
<a name="API_UpdateDocumentDefaultVersion_ResponseSyntax"></a>

```
{
   "Description": { 
      "DefaultVersion": "string",
      "DefaultVersionName": "string",
      "Name": "string"
   }
}
```

## Response Elements
<a name="API_UpdateDocumentDefaultVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Description](#API_UpdateDocumentDefaultVersion_ResponseSyntax) **   <a name="systemsmanager-UpdateDocumentDefaultVersion-response-Description"></a>
The description of a custom document that you want to set as the default version.  
Type: [DocumentDefaultVersionDescription](API_DocumentDefaultVersionDescription.md) object

## Errors
<a name="API_UpdateDocumentDefaultVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentSchemaVersion **   
The version of the document schema isn't supported.  
HTTP Status Code: 400

 ** InvalidDocumentVersion **   
The document version isn't valid or doesn't exist.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateDocumentDefaultVersion_Examples"></a>

### Example
<a name="API_UpdateDocumentDefaultVersion_Example_1"></a>

This example illustrates one usage of UpdateDocumentDefaultVersion.

#### Sample Request
<a name="API_UpdateDocumentDefaultVersion_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateDocumentDefaultVersion
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T183926Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 47

{
    "Name": "Example",
    "DocumentVersion": "2"
}
```

#### Sample Response
<a name="API_UpdateDocumentDefaultVersion_Example_1_Response"></a>

```
{
    "Description": {
        "DefaultVersion": "2",
        "Name": "Example"
    }
}
```

## See Also
<a name="API_UpdateDocumentDefaultVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateDocumentDefaultVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateDocumentDefaultVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateDocumentDefaultVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateDocumentDefaultVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateDocumentDefaultVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateDocumentDefaultVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateDocumentDefaultVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateDocumentDefaultVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateDocumentDefaultVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateDocumentDefaultVersion) 

# UpdateDocumentMetadata
<a name="API_UpdateDocumentMetadata"></a>

**Important**  
 AWS Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Change Manager availability change](https://docs.aws.amazon.com/systems-manager/latest/userguide/change-manager-availability-change.html).

Updates information related to approval reviews for a specific version of a change template in Change Manager.

## Request Syntax
<a name="API_UpdateDocumentMetadata_RequestSyntax"></a>

```
{
   "DocumentReviews": { 
      "Action": "string",
      "Comment": [ 
         { 
            "Content": "string",
            "Type": "string"
         }
      ]
   },
   "DocumentVersion": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_UpdateDocumentMetadata_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DocumentReviews](#API_UpdateDocumentMetadata_RequestSyntax) **   <a name="systemsmanager-UpdateDocumentMetadata-request-DocumentReviews"></a>
The change template review details to update.  
Type: [DocumentReviews](API_DocumentReviews.md) object  
Required: Yes

 ** [DocumentVersion](#API_UpdateDocumentMetadata_RequestSyntax) **   <a name="systemsmanager-UpdateDocumentMetadata-request-DocumentVersion"></a>
The version of a change template in which to update approval metadata.  
Type: String  
Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`   
Required: No

 ** [Name](#API_UpdateDocumentMetadata_RequestSyntax) **   <a name="systemsmanager-UpdateDocumentMetadata-request-Name"></a>
The name of the change template for which a version's metadata is to be updated.  
Type: String  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: Yes

## Response Elements
<a name="API_UpdateDocumentMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateDocumentMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidDocument **   
The specified SSM document doesn't exist.    
 ** Message **   
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. 
HTTP Status Code: 400

 ** InvalidDocumentOperation **   
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.  
HTTP Status Code: 400

 ** InvalidDocumentVersion **   
The document version isn't valid or doesn't exist.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateDocumentMetadata_Examples"></a>

### Example
<a name="API_UpdateDocumentMetadata_Example_1"></a>

This example illustrates one usage of UpdateDocumentMetadata.

#### Sample Request
<a name="API_UpdateDocumentMetadata_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateDocumentMetadata
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240730T154930Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240730/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 68

{
    "DocumentReviews": [
        {
            "Action": "Approve",
            "Comment": [
                {
                    "Type": "Comment",
                    "Content": "Approved!"
                }
            ]
        }
    ]
}
```

#### Sample Response
<a name="API_UpdateDocumentMetadata_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateDocumentMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateDocumentMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateDocumentMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateDocumentMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateDocumentMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateDocumentMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateDocumentMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateDocumentMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateDocumentMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateDocumentMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateDocumentMetadata) 

# UpdateMaintenanceWindow
<a name="API_UpdateMaintenanceWindow"></a>

Updates an existing maintenance window. Only specified parameters are modified.

**Note**  
The value you specify for `Duration` determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for `Cutoff`. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for `Cutoff` is one hour, no maintenance window tasks can start after 5 PM.

## Request Syntax
<a name="API_UpdateMaintenanceWindow_RequestSyntax"></a>

```
{
   "AllowUnassociatedTargets": boolean,
   "Cutoff": number,
   "Description": "string",
   "Duration": number,
   "Enabled": boolean,
   "EndDate": "string",
   "Name": "string",
   "Replace": boolean,
   "Schedule": "string",
   "ScheduleOffset": number,
   "ScheduleTimezone": "string",
   "StartDate": "string",
   "WindowId": "string"
}
```

## Request Parameters
<a name="API_UpdateMaintenanceWindow_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AllowUnassociatedTargets](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-AllowUnassociatedTargets"></a>
Whether targets must be registered with the maintenance window before tasks can be defined for those targets.  
Type: Boolean  
Required: No

 ** [Cutoff](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-Cutoff"></a>
The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: No

 ** [Description](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-Description"></a>
An optional description for the update request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [Duration](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-Duration"></a>
The duration of the maintenance window in hours.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 24.  
Required: No

 ** [Enabled](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-Enabled"></a>
Whether the maintenance window is enabled.  
Type: Boolean  
Required: No

 ** [EndDate](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-EndDate"></a>
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. `EndDate` allows you to set a date and time in the future when the maintenance window will no longer run.  
Type: String  
Required: No

 ** [Name](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-Name"></a>
The name of the maintenance window.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: No

 ** [Replace](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-Replace"></a>
If `True`, then all fields that are required by the [CreateMaintenanceWindow](API_CreateMaintenanceWindow.md) operation are also required for this API request. Optional fields that aren't specified are set to null.   
Type: Boolean  
Required: No

 ** [Schedule](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-Schedule"></a>
The schedule of the maintenance window in the form of a cron or rate expression.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [ScheduleOffset](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-ScheduleOffset"></a>
The number of days to wait after the date and time specified by a cron expression before running the maintenance window.  
For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.  
 `cron(30 23 ? * TUE#3 *)`   
If the schedule offset is `2`, the maintenance window won't run until two days later.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 6.  
Required: No

 ** [ScheduleTimezone](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-ScheduleTimezone"></a>
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los\$1Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database](https://www.iana.org/time-zones) on the IANA website.  
Type: String  
Required: No

 ** [StartDate](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-StartDate"></a>
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. `StartDate` allows you to delay activation of the maintenance window until the specified future date.  
When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date. 
Type: String  
Required: No

 ** [WindowId](#API_UpdateMaintenanceWindow_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-request-WindowId"></a>
The ID of the maintenance window to update.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

## Response Syntax
<a name="API_UpdateMaintenanceWindow_ResponseSyntax"></a>

```
{
   "AllowUnassociatedTargets": boolean,
   "Cutoff": number,
   "Description": "string",
   "Duration": number,
   "Enabled": boolean,
   "EndDate": "string",
   "Name": "string",
   "Schedule": "string",
   "ScheduleOffset": number,
   "ScheduleTimezone": "string",
   "StartDate": "string",
   "WindowId": "string"
}
```

## Response Elements
<a name="API_UpdateMaintenanceWindow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AllowUnassociatedTargets](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-AllowUnassociatedTargets"></a>
Whether targets must be registered with the maintenance window before tasks can be defined for those targets.  
Type: Boolean

 ** [Cutoff](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-Cutoff"></a>
The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.

 ** [Description](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-Description"></a>
An optional description of the update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [Duration](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-Duration"></a>
The duration of the maintenance window in hours.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 24.

 ** [Enabled](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-Enabled"></a>
Whether the maintenance window is enabled.  
Type: Boolean

 ** [EndDate](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-EndDate"></a>
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.  
Type: String

 ** [Name](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-Name"></a>
The name of the maintenance window.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$` 

 ** [Schedule](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-Schedule"></a>
The schedule of the maintenance window in the form of a cron or rate expression.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [ScheduleOffset](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-ScheduleOffset"></a>
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 6.

 ** [ScheduleTimezone](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-ScheduleTimezone"></a>
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los\$1Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database](https://www.iana.org/time-zones) on the IANA website.  
Type: String

 ** [StartDate](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-StartDate"></a>
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.  
Type: String

 ** [WindowId](#API_UpdateMaintenanceWindow_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindow-response-WindowId"></a>
The ID of the created maintenance window.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$` 

## Errors
<a name="API_UpdateMaintenanceWindow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_UpdateMaintenanceWindow_Examples"></a>

### Example
<a name="API_UpdateMaintenanceWindow_Example_1"></a>

This example illustrates one usage of UpdateMaintenanceWindow.

#### Sample Request
<a name="API_UpdateMaintenanceWindow_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 160
X-Amz-Target: AmazonSSM.UpdateMaintenanceWindow
X-Amz-Date: 20240312T203703Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Duration": 10,
    "WindowId": "mw-0c50858d01EXAMPLE",
    "Name": "Default-Maintenance-Window",
    "Description": "Standard maintenance windows for production servers"
}
```

#### Sample Response
<a name="API_UpdateMaintenanceWindow_Example_1_Response"></a>

```
{
    "AllowUnassociatedTargets": true,
    "Cutoff": 4,
    "Description": "Standard maintenance windows for production servers",
    "Duration": 10,
    "Enabled": true,
    "Name": "Default-Maintenance-Window",
    "Schedule": "rate(3 minutes)",
    "WindowId": "mw-0c50858d01EXAMPLE"
}
```

## See Also
<a name="API_UpdateMaintenanceWindow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateMaintenanceWindow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateMaintenanceWindow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateMaintenanceWindow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateMaintenanceWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateMaintenanceWindow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateMaintenanceWindow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateMaintenanceWindow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateMaintenanceWindow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateMaintenanceWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateMaintenanceWindow) 

# UpdateMaintenanceWindowTarget
<a name="API_UpdateMaintenanceWindowTarget"></a>

Modifies the target of an existing maintenance window. You can change the following:
+ Name
+ Description
+ Owner
+ IDs for an ID target
+ Tags for a Tag target
+ From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see [Target](API_Target.md).

**Note**  
If a parameter is null, then the corresponding field isn't modified.

## Request Syntax
<a name="API_UpdateMaintenanceWindowTarget_RequestSyntax"></a>

```
{
   "Description": "string",
   "Name": "string",
   "OwnerInformation": "string",
   "Replace": boolean,
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "WindowId": "string",
   "WindowTargetId": "string"
}
```

## Request Parameters
<a name="API_UpdateMaintenanceWindowTarget_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateMaintenanceWindowTarget_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-request-Description"></a>
An optional description for the update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [Name](#API_UpdateMaintenanceWindowTarget_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-request-Name"></a>
A name for the update.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: No

 ** [OwnerInformation](#API_UpdateMaintenanceWindowTarget_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-request-OwnerInformation"></a>
User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [Replace](#API_UpdateMaintenanceWindowTarget_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-request-Replace"></a>
If `True`, then all fields that are required by the [RegisterTargetWithMaintenanceWindow](API_RegisterTargetWithMaintenanceWindow.md) operation are also required for this API request. Optional fields that aren't specified are set to null.  
Type: Boolean  
Required: No

 ** [Targets](#API_UpdateMaintenanceWindowTarget_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-request-Targets"></a>
The targets to add or replace.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [WindowId](#API_UpdateMaintenanceWindowTarget_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-request-WindowId"></a>
The maintenance window ID with which to modify the target.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

 ** [WindowTargetId](#API_UpdateMaintenanceWindowTarget_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-request-WindowTargetId"></a>
The target ID to modify.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_UpdateMaintenanceWindowTarget_ResponseSyntax"></a>

```
{
   "Description": "string",
   "Name": "string",
   "OwnerInformation": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "WindowId": "string",
   "WindowTargetId": "string"
}
```

## Response Elements
<a name="API_UpdateMaintenanceWindowTarget_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Description](#API_UpdateMaintenanceWindowTarget_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-response-Description"></a>
The updated description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [Name](#API_UpdateMaintenanceWindowTarget_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-response-Name"></a>
The updated name.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$` 

 ** [OwnerInformation](#API_UpdateMaintenanceWindowTarget_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-response-OwnerInformation"></a>
The updated owner.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [Targets](#API_UpdateMaintenanceWindowTarget_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-response-Targets"></a>
The updated targets.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

 ** [WindowId](#API_UpdateMaintenanceWindowTarget_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-response-WindowId"></a>
The maintenance window ID specified in the update request.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$` 

 ** [WindowTargetId](#API_UpdateMaintenanceWindowTarget_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTarget-response-WindowTargetId"></a>
The target ID specified in the update request.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_UpdateMaintenanceWindowTarget_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_UpdateMaintenanceWindowTarget_Examples"></a>

### Example
<a name="API_UpdateMaintenanceWindowTarget_Example_1"></a>

This example illustrates one usage of UpdateMaintenanceWindowTarget.

#### Sample Request
<a name="API_UpdateMaintenanceWindowTarget_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateMaintenanceWindowTarget
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T005329Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 233

{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE",
    "Targets": [
        {
            "Key": "InstanceIds",
            "Values": [
                "i-07782c72faEXAMPLE"
            ]
        }
    ],
    "Name": "MyNewTaskName",
    "Description": "My new task description"
}
```

#### Sample Response
<a name="API_UpdateMaintenanceWindowTarget_Example_1_Response"></a>

```
{
    "Description": "My new task description",
    "Name": "MyNewTaskName",
    "Targets": [
        {
            "Key": "InstanceIds",
            "Values": [
                "i-07782c72faEXAMPLE"
            ]
        }
    ],
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE"
}
```

## See Also
<a name="API_UpdateMaintenanceWindowTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateMaintenanceWindowTarget) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateMaintenanceWindowTarget) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateMaintenanceWindowTarget) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateMaintenanceWindowTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateMaintenanceWindowTarget) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateMaintenanceWindowTarget) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateMaintenanceWindowTarget) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateMaintenanceWindowTarget) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateMaintenanceWindowTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateMaintenanceWindowTarget) 

# UpdateMaintenanceWindowTask
<a name="API_UpdateMaintenanceWindowTask"></a>

Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
+  `TaskARN`. For example, you can change a `RUN_COMMAND` task from `AWS-RunPowerShellScript` to `AWS-RunShellScript`.
+  `ServiceRoleArn` 
+  `TaskInvocationParameters` 
+  `Priority` 
+  `MaxConcurrency` 
+  `MaxErrors` 

**Note**  
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that don't specify targets, see [Registering maintenance window tasks without targets](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) in the * AWS Systems Manager User Guide*.

If the value for a parameter in `UpdateMaintenanceWindowTask` is null, then the corresponding field isn't modified. If you set `Replace` to true, then all fields required by the [RegisterTaskWithMaintenanceWindow](API_RegisterTaskWithMaintenanceWindow.md) operation are required for this request. Optional fields that aren't specified are set to null.

**Important**  
When you update a maintenance window task that has options specified in `TaskInvocationParameters`, you must provide again all the `TaskInvocationParameters` values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified `TaskInvocationParameters` values for `Comment`, `NotificationConfig`, and `OutputS3BucketName`. If you update the maintenance window task and specify only a different `OutputS3BucketName` value, the values for `Comment` and `NotificationConfig` are removed.

## Request Syntax
<a name="API_UpdateMaintenanceWindowTask_RequestSyntax"></a>

```
{
   "AlarmConfiguration": { 
      "Alarms": [ 
         { 
            "Name": "string"
         }
      ],
      "IgnorePollAlarmFailure": boolean
   },
   "CutoffBehavior": "string",
   "Description": "string",
   "LoggingInfo": { 
      "S3BucketName": "string",
      "S3KeyPrefix": "string",
      "S3Region": "string"
   },
   "MaxConcurrency": "string",
   "MaxErrors": "string",
   "Name": "string",
   "Priority": number,
   "Replace": boolean,
   "ServiceRoleArn": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "TaskArn": "string",
   "TaskInvocationParameters": { 
      "Automation": { 
         "DocumentVersion": "string",
         "Parameters": { 
            "string" : [ "string" ]
         }
      },
      "Lambda": { 
         "ClientContext": "string",
         "Payload": blob,
         "Qualifier": "string"
      },
      "RunCommand": { 
         "CloudWatchOutputConfig": { 
            "CloudWatchLogGroupName": "string",
            "CloudWatchOutputEnabled": boolean
         },
         "Comment": "string",
         "DocumentHash": "string",
         "DocumentHashType": "string",
         "DocumentVersion": "string",
         "NotificationConfig": { 
            "NotificationArn": "string",
            "NotificationEvents": [ "string" ],
            "NotificationType": "string"
         },
         "OutputS3BucketName": "string",
         "OutputS3KeyPrefix": "string",
         "Parameters": { 
            "string" : [ "string" ]
         },
         "ServiceRoleArn": "string",
         "TimeoutSeconds": number
      },
      "StepFunctions": { 
         "Input": "string",
         "Name": "string"
      }
   },
   "TaskParameters": { 
      "string" : { 
         "Values": [ "string" ]
      }
   },
   "WindowId": "string",
   "WindowTaskId": "string"
}
```

## Request Parameters
<a name="API_UpdateMaintenanceWindowTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AlarmConfiguration](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-AlarmConfiguration"></a>
The CloudWatch alarm you want to apply to your maintenance window task.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object  
Required: No

 ** [CutoffBehavior](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-CutoffBehavior"></a>
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.   
+  `CONTINUE_TASK`: When the cutoff time is reached, any tasks that are running continue. The default value.
+  `CANCEL_TASK`:
  + For Automation, AWS Lambda, AWS Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
  + For Run Command tasks: When the cutoff time is reached, the system sends a [CancelCommand](API_CancelCommand.md) operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is `TIMED_OUT`.
Type: String  
Valid Values: `CONTINUE_TASK | CANCEL_TASK`   
Required: No

 ** [Description](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-Description"></a>
The new task description to specify.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [LoggingInfo](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-LoggingInfo"></a>
The new logging location in Amazon S3 to specify.  
 `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how AWS Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md).
Type: [LoggingInfo](API_LoggingInfo.md) object  
Required: No

 ** [MaxConcurrency](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-MaxConcurrency"></a>
The new `MaxConcurrency` value you want to specify. `MaxConcurrency` is the number of targets that are allowed to run this task, in parallel.  
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases.  
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1`. This value doesn't affect the running of your task.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$`   
Required: No

 ** [MaxErrors](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-MaxErrors"></a>
The new `MaxErrors` value to specify. `MaxErrors` is the maximum number of errors that are allowed before the task stops being scheduled.  
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases.  
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1`. This value doesn't affect the running of your task.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$`   
Required: No

 ** [Name](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-Name"></a>
The new task name to specify.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: No

 ** [Priority](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-Priority"></a>
The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [Replace](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-Replace"></a>
If True, then all fields that are required by the [RegisterTaskWithMaintenanceWindow](API_RegisterTaskWithMaintenanceWindow.md) operation are also required for this API request. Optional fields that aren't specified are set to null.  
Type: Boolean  
Required: No

 ** [ServiceRoleArn](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-ServiceRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run `RegisterTaskWithMaintenanceWindow`.  
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see [Setting up Maintenance Windows](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html) in the in the * AWS Systems Manager User Guide*.  
Type: String  
Required: No

 ** [Targets](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-Targets"></a>
The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format `Key=instanceids,Values=instanceID_1,instanceID_2`. Tags are specified using the format ` Key=tag_name,Values=tag_value`.   
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that don't specify targets, see [Registering maintenance window tasks without targets](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) in the * AWS Systems Manager User Guide*.
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [TaskArn](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-TaskArn"></a>
The task ARN to modify.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: No

 ** [TaskInvocationParameters](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-TaskInvocationParameters"></a>
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.  
When you update a maintenance window task that has options specified in `TaskInvocationParameters`, you must provide again all the `TaskInvocationParameters` values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified `TaskInvocationParameters` values for `Comment`, `NotificationConfig`, and `OutputS3BucketName`. If you update the maintenance window task and specify only a different `OutputS3BucketName` value, the values for `Comment` and `NotificationConfig` are removed.
Type: [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md) object  
Required: No

 ** [TaskParameters](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-TaskParameters"></a>
The parameters to modify.  
 `TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md).
The map has the following format:  
Key: string, between 1 and 255 characters  
Value: an array of strings, each string is between 1 and 255 characters  
Type: String to [MaintenanceWindowTaskParameterValueExpression](API_MaintenanceWindowTaskParameterValueExpression.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [WindowId](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-WindowId"></a>
The maintenance window ID that contains the task to modify.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$`   
Required: Yes

 ** [WindowTaskId](#API_UpdateMaintenanceWindowTask_RequestSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-request-WindowTaskId"></a>
The task ID to modify.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$`   
Required: Yes

## Response Syntax
<a name="API_UpdateMaintenanceWindowTask_ResponseSyntax"></a>

```
{
   "AlarmConfiguration": { 
      "Alarms": [ 
         { 
            "Name": "string"
         }
      ],
      "IgnorePollAlarmFailure": boolean
   },
   "CutoffBehavior": "string",
   "Description": "string",
   "LoggingInfo": { 
      "S3BucketName": "string",
      "S3KeyPrefix": "string",
      "S3Region": "string"
   },
   "MaxConcurrency": "string",
   "MaxErrors": "string",
   "Name": "string",
   "Priority": number,
   "ServiceRoleArn": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "TaskArn": "string",
   "TaskInvocationParameters": { 
      "Automation": { 
         "DocumentVersion": "string",
         "Parameters": { 
            "string" : [ "string" ]
         }
      },
      "Lambda": { 
         "ClientContext": "string",
         "Payload": blob,
         "Qualifier": "string"
      },
      "RunCommand": { 
         "CloudWatchOutputConfig": { 
            "CloudWatchLogGroupName": "string",
            "CloudWatchOutputEnabled": boolean
         },
         "Comment": "string",
         "DocumentHash": "string",
         "DocumentHashType": "string",
         "DocumentVersion": "string",
         "NotificationConfig": { 
            "NotificationArn": "string",
            "NotificationEvents": [ "string" ],
            "NotificationType": "string"
         },
         "OutputS3BucketName": "string",
         "OutputS3KeyPrefix": "string",
         "Parameters": { 
            "string" : [ "string" ]
         },
         "ServiceRoleArn": "string",
         "TimeoutSeconds": number
      },
      "StepFunctions": { 
         "Input": "string",
         "Name": "string"
      }
   },
   "TaskParameters": { 
      "string" : { 
         "Values": [ "string" ]
      }
   },
   "WindowId": "string",
   "WindowTaskId": "string"
}
```

## Response Elements
<a name="API_UpdateMaintenanceWindowTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AlarmConfiguration](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-AlarmConfiguration"></a>
The details for the CloudWatch alarm you applied to your maintenance window task.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object

 ** [CutoffBehavior](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-CutoffBehavior"></a>
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.   
Type: String  
Valid Values: `CONTINUE_TASK | CANCEL_TASK` 

 ** [Description](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-Description"></a>
The updated task description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [LoggingInfo](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-LoggingInfo"></a>
The updated logging information in Amazon S3.  
 `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how AWS Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md).
Type: [LoggingInfo](API_LoggingInfo.md) object

 ** [MaxConcurrency](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-MaxConcurrency"></a>
The updated `MaxConcurrency` value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$` 

 ** [MaxErrors](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-MaxErrors"></a>
The updated `MaxErrors` value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 7.  
Pattern: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$` 

 ** [Name](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-Name"></a>
The updated task name.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$` 

 ** [Priority](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-Priority"></a>
The updated priority value.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [ServiceRoleArn](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-ServiceRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run `RegisterTaskWithMaintenanceWindow`.  
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see [Setting up Maintenance Windows](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html) in the in the * AWS Systems Manager User Guide*.  
Type: String

 ** [Targets](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-Targets"></a>
The updated target values.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

 ** [TaskArn](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-TaskArn"></a>
The updated task ARN value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.

 ** [TaskInvocationParameters](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-TaskInvocationParameters"></a>
The updated parameter values.  
Type: [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md) object

 ** [TaskParameters](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-TaskParameters"></a>
The updated parameter values.  
 `TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](API_MaintenanceWindowTaskInvocationParameters.md).
Type: String to [MaintenanceWindowTaskParameterValueExpression](API_MaintenanceWindowTaskParameterValueExpression.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [WindowId](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-WindowId"></a>
The ID of the maintenance window that was updated.  
Type: String  
Length Constraints: Fixed length of 20.  
Pattern: `^mw-[0-9a-f]{17}$` 

 ** [WindowTaskId](#API_UpdateMaintenanceWindowTask_ResponseSyntax) **   <a name="systemsmanager-UpdateMaintenanceWindowTask-response-WindowTaskId"></a>
The task ID of the maintenance window that was updated.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$` 

## Errors
<a name="API_UpdateMaintenanceWindowTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_UpdateMaintenanceWindowTask_Examples"></a>

### Example
<a name="API_UpdateMaintenanceWindowTask_Example_1"></a>

This example illustrates one usage of UpdateMaintenanceWindowTask.

#### Sample Request
<a name="API_UpdateMaintenanceWindowTask_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateMaintenanceWindowTask
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240225T010531Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 244

{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE",
    "Priority": 2,
    "MaxConcurrency": "10",
    "MaxErrors": "3",
    "Name": "MyRevisedMaintenanceWindowTask",
    "Description": "My updated maintenance window task",
    "ServiceRoleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm.amazonaws.com/MyCustomMaintenanceWindowTaskRole"
}
```

#### Sample Response
<a name="API_UpdateMaintenanceWindowTask_Example_1_Response"></a>

```
{
    "Description": "My updated maintenance window task",
    "MaxConcurrency": "10",
    "MaxErrors": "3",
    "Name": "MyRevisedMaintenanceWindowTask",
    "Priority": 2,
    "ServiceRoleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm.amazonaws.com/MyCustomMaintenanceWindowTaskRole",
    "Targets": [
        {
            "Key": "WindowTargetIds",
            "Values": [
                "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE"
            ]
        }
    ],
    "TaskArn": "AWS-ApplyPatchBaseline",
    "TaskInvocationParameters": {
        "RunCommand": {
            "Comment": "",
            "Parameters": {
                "Operation": [
                    "Install"
                ],
                "SnapshotId": [
                    ""
                ]
            },
            "TimeoutSeconds": 600
        }
    },
    "TaskParameters": {},
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE"
}
```

## See Also
<a name="API_UpdateMaintenanceWindowTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateMaintenanceWindowTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateMaintenanceWindowTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateMaintenanceWindowTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateMaintenanceWindowTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateMaintenanceWindowTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateMaintenanceWindowTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateMaintenanceWindowTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateMaintenanceWindowTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateMaintenanceWindowTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateMaintenanceWindowTask) 

# UpdateManagedInstanceRole
<a name="API_UpdateManagedInstanceRole"></a>

Changes the AWS Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see [CreateActivation](API_CreateActivation.md).

## Request Syntax
<a name="API_UpdateManagedInstanceRole_RequestSyntax"></a>

```
{
   "IamRole": "string",
   "InstanceId": "string"
}
```

## Request Parameters
<a name="API_UpdateManagedInstanceRole_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [IamRole](#API_UpdateManagedInstanceRole_RequestSyntax) **   <a name="systemsmanager-UpdateManagedInstanceRole-request-IamRole"></a>
The name of the AWS Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the AWS Systems Manager service principal `ssm.amazonaws.com`. For more information, see [Create the IAM service role required for Systems Manager in hybrid and multicloud environments](https://docs.aws.amazon.com/systems-manager/latest/userguide/hybrid-multicloud-service-role.html) in the * AWS Systems Manager User Guide*.  
You can't specify an IAM service-linked role for this parameter. You must create a unique role.
Type: String  
Length Constraints: Maximum length of 64.  
Required: Yes

 ** [InstanceId](#API_UpdateManagedInstanceRole_RequestSyntax) **   <a name="systemsmanager-UpdateManagedInstanceRole-request-InstanceId"></a>
The ID of the managed node where you want to update the role.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 124.  
Pattern: `(^mi-[0-9a-f]{17}$)|(^eks_c:[0-9A-Za-z][A-Za-z0-9\-_]{0,99}_\w{17}$)`   
Required: Yes

## Response Elements
<a name="API_UpdateManagedInstanceRole_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateManagedInstanceRole_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** InvalidInstanceId **   
The following problems can cause this exception:  
+ You don't have permission to access the managed node.
+  AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
+ SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
+ The managed node isn't in a valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.
HTTP Status Code: 400

## Examples
<a name="API_UpdateManagedInstanceRole_Examples"></a>

### Example
<a name="API_UpdateManagedInstanceRole_Example_1"></a>

This example illustrates one usage of UpdateManagedInstanceRole.

#### Sample Request
<a name="API_UpdateManagedInstanceRole_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateManagedInstanceRole
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T191724Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 56

{
    "InstanceId": "mi-0ce084dd39EXAMPLE",
    "IamRole": "SSM"
}
```

#### Sample Response
<a name="API_UpdateManagedInstanceRole_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateManagedInstanceRole_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateManagedInstanceRole) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateManagedInstanceRole) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateManagedInstanceRole) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateManagedInstanceRole) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateManagedInstanceRole) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateManagedInstanceRole) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateManagedInstanceRole) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateManagedInstanceRole) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateManagedInstanceRole) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateManagedInstanceRole) 

# UpdateOpsItem
<a name="API_UpdateOpsItem"></a>

Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see [Set up OpsCenter](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) in the * AWS Systems Manager User Guide*.

Operations engineers and IT professionals use AWS Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see [AWS Systems Manager OpsCenter](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the * AWS Systems Manager User Guide*. 

## Request Syntax
<a name="API_UpdateOpsItem_RequestSyntax"></a>

```
{
   "ActualEndTime": number,
   "ActualStartTime": number,
   "Category": "string",
   "Description": "string",
   "Notifications": [ 
      { 
         "Arn": "string"
      }
   ],
   "OperationalData": { 
      "string" : { 
         "Type": "string",
         "Value": "string"
      }
   },
   "OperationalDataToDelete": [ "string" ],
   "OpsItemArn": "string",
   "OpsItemId": "string",
   "PlannedEndTime": number,
   "PlannedStartTime": number,
   "Priority": number,
   "RelatedOpsItems": [ 
      { 
         "OpsItemId": "string"
      }
   ],
   "Severity": "string",
   "Status": "string",
   "Title": "string"
}
```

## Request Parameters
<a name="API_UpdateOpsItem_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ActualEndTime](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-ActualEndTime"></a>
The time a runbook workflow ended. Currently reported only for the OpsItem type `/aws/changerequest`.  
Type: Timestamp  
Required: No

 ** [ActualStartTime](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-ActualStartTime"></a>
The time a runbook workflow started. Currently reported only for the OpsItem type `/aws/changerequest`.  
Type: Timestamp  
Required: No

 ** [Category](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-Category"></a>
Specify a new category for an OpsItem.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^(?!\s*$).+`   
Required: No

 ** [Description](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-Description"></a>
User-defined text that contains information about the OpsItem, in Markdown format.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\s\S]*\S[\s\S]*`   
Required: No

 ** [Notifications](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-Notifications"></a>
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.  
Type: Array of [OpsItemNotification](API_OpsItemNotification.md) objects  
Required: No

 ** [OperationalData](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-OperationalData"></a>
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.  
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.  
Operational data keys *can't* begin with the following: `amazon`, `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the [DescribeOpsItems](API_DescribeOpsItems.md) API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the [GetOpsItem](API_GetOpsItem.md) API operation).  
Use the `/aws/resources` key in OperationalData to specify a related resource in the request. Use the `/aws/automations` key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see [Creating OpsItems manually](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html) in the * AWS Systems Manager User Guide*.  
Type: String to [OpsItemDataValue](API_OpsItemDataValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!\s*$).+`   
Required: No

 ** [OperationalDataToDelete](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-OperationalDataToDelete"></a>
Keys that you want to remove from the OperationalData map.  
Type: Array of strings  
Required: No

 ** [OpsItemArn](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-OpsItemArn"></a>
The OpsItem Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[0-9]{12}:opsitem.*`   
Required: No

 ** [OpsItemId](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-OpsItemId"></a>
The ID of the OpsItem.  
Type: String  
Pattern: `^(oi)-[0-9a-f]{12}$`   
Required: Yes

 ** [PlannedEndTime](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-PlannedEndTime"></a>
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type `/aws/changerequest`.  
Type: Timestamp  
Required: No

 ** [PlannedStartTime](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-PlannedStartTime"></a>
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type `/aws/changerequest`.  
Type: Timestamp  
Required: No

 ** [Priority](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-Priority"></a>
The importance of this OpsItem in relation to other OpsItems in the system.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 5.  
Required: No

 ** [RelatedOpsItems](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-RelatedOpsItems"></a>
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.  
Type: Array of [RelatedOpsItem](API_RelatedOpsItem.md) objects  
Required: No

 ** [Severity](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-Severity"></a>
Specify a new severity for an OpsItem.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^(?!\s*$).+`   
Required: No

 ** [Status](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-Status"></a>
The OpsItem status. For more information, see [Editing OpsItem details](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html) in the * AWS Systems Manager User Guide*.  
Type: String  
Valid Values: `Open | InProgress | Resolved | Pending | TimedOut | Cancelling | Cancelled | Failed | CompletedWithSuccess | CompletedWithFailure | Scheduled | RunbookInProgress | PendingChangeCalendarOverride | ChangeCalendarOverrideApproved | ChangeCalendarOverrideRejected | PendingApproval | Approved | Revoked | Rejected | Closed`   
Required: No

 ** [Title](#API_UpdateOpsItem_RequestSyntax) **   <a name="systemsmanager-UpdateOpsItem-request-Title"></a>
A short heading that describes the nature of the OpsItem and the impacted resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^(?!\s*$).+`   
Required: No

## Response Elements
<a name="API_UpdateOpsItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateOpsItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsItemAccessDeniedException **   
You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the AWS Organizations management account.  
HTTP Status Code: 400

 ** OpsItemAlreadyExistsException **   
The OpsItem already exists.  
HTTP Status Code: 400

 ** OpsItemConflictException **   
The specified OpsItem is in the process of being deleted.  
HTTP Status Code: 400

 ** OpsItemInvalidParameterException **   
A specified parameter argument isn't valid. Verify the available arguments and try again.  
HTTP Status Code: 400

 ** OpsItemLimitExceededException **   
The request caused OpsItems to exceed one or more quotas.  
HTTP Status Code: 400

 ** OpsItemNotFoundException **   
The specified OpsItem ID doesn't exist. Verify the ID and try again.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateOpsItem_Examples"></a>

### Example
<a name="API_UpdateOpsItem_Example_1"></a>

This example illustrates one usage of UpdateOpsItem.

#### Sample Request
<a name="API_UpdateOpsItem_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateOpsItem
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240401T184738Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 54

{
    "Status": "Resolved",
    "OpsItemId": "oi-1f050EXAMPLE"
}
```

#### Sample Response
<a name="API_UpdateOpsItem_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateOpsItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateOpsItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateOpsItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateOpsItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateOpsItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateOpsItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateOpsItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateOpsItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateOpsItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateOpsItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateOpsItem) 

# UpdateOpsMetadata
<a name="API_UpdateOpsMetadata"></a>

 AWS Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.

## Request Syntax
<a name="API_UpdateOpsMetadata_RequestSyntax"></a>

```
{
   "KeysToDelete": [ "string" ],
   "MetadataToUpdate": { 
      "string" : { 
         "Value": "string"
      }
   },
   "OpsMetadataArn": "string"
}
```

## Request Parameters
<a name="API_UpdateOpsMetadata_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [KeysToDelete](#API_UpdateOpsMetadata_RequestSyntax) **   <a name="systemsmanager-UpdateOpsMetadata-request-KeysToDelete"></a>
The metadata keys to delete from the OpsMetadata object.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^(?!\s*$).+`   
Required: No

 ** [MetadataToUpdate](#API_UpdateOpsMetadata_RequestSyntax) **   <a name="systemsmanager-UpdateOpsMetadata-request-MetadataToUpdate"></a>
Metadata to add to an OpsMetadata object.  
Type: String to [MetadataValue](API_MetadataValue.md) object map  
Map Entries: Maximum number of 5 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `^(?!\s*$).+`   
Required: No

 ** [OpsMetadataArn](#API_UpdateOpsMetadata_RequestSyntax) **   <a name="systemsmanager-UpdateOpsMetadata-request-OpsMetadataArn"></a>
The Amazon Resource Name (ARN) of the OpsMetadata Object to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:opsmetadata\/([a-zA-Z0-9-_\.\/]*)`   
Required: Yes

## Response Syntax
<a name="API_UpdateOpsMetadata_ResponseSyntax"></a>

```
{
   "OpsMetadataArn": "string"
}
```

## Response Elements
<a name="API_UpdateOpsMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [OpsMetadataArn](#API_UpdateOpsMetadata_ResponseSyntax) **   <a name="systemsmanager-UpdateOpsMetadata-response-OpsMetadataArn"></a>
The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:opsmetadata\/([a-zA-Z0-9-_\.\/]*)` 

## Errors
<a name="API_UpdateOpsMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** OpsMetadataInvalidArgumentException **   
One of the arguments passed is invalid.   
HTTP Status Code: 400

 ** OpsMetadataKeyLimitExceededException **   
The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.  
HTTP Status Code: 400

 ** OpsMetadataNotFoundException **   
The OpsMetadata object doesn't exist.   
HTTP Status Code: 400

 ** OpsMetadataTooManyUpdatesException **   
The system is processing too many concurrent updates. Wait a few moments and try again.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateOpsMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateOpsMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateOpsMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateOpsMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateOpsMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateOpsMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateOpsMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateOpsMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateOpsMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateOpsMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateOpsMetadata) 

# UpdatePatchBaseline
<a name="API_UpdatePatchBaseline"></a>

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

**Note**  
For information about valid key-value pairs in `PatchFilters` for each supported operating system type, see [PatchFilter](API_PatchFilter.md).

## Request Syntax
<a name="API_UpdatePatchBaseline_RequestSyntax"></a>

```
{
   "ApprovalRules": { 
      "PatchRules": [ 
         { 
            "ApproveAfterDays": number,
            "ApproveUntilDate": "string",
            "ComplianceLevel": "string",
            "EnableNonSecurity": boolean,
            "PatchFilterGroup": { 
               "PatchFilters": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         }
      ]
   },
   "ApprovedPatches": [ "string" ],
   "ApprovedPatchesComplianceLevel": "string",
   "ApprovedPatchesEnableNonSecurity": boolean,
   "AvailableSecurityUpdatesComplianceStatus": "string",
   "BaselineId": "string",
   "Description": "string",
   "GlobalFilters": { 
      "PatchFilters": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "Name": "string",
   "RejectedPatches": [ "string" ],
   "RejectedPatchesAction": "string",
   "Replace": boolean,
   "Sources": [ 
      { 
         "Configuration": "string",
         "Name": "string",
         "Products": [ "string" ]
      }
   ]
}
```

## Request Parameters
<a name="API_UpdatePatchBaseline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApprovalRules](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-ApprovalRules"></a>
A set of rules used to include patches in the baseline.  
Type: [PatchRuleGroup](API_PatchRuleGroup.md) object  
Required: No

 ** [ApprovedPatches](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-ApprovedPatches"></a>
A list of explicitly approved patches for the baseline.  
For information about accepted formats for lists of approved patches and rejected patches, see [Package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the * AWS Systems Manager User Guide*.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [ApprovedPatchesComplianceLevel](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-ApprovedPatchesComplianceLevel"></a>
Assigns a new compliance severity level to an existing patch baseline.  
Type: String  
Valid Values: `CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED`   
Required: No

 ** [ApprovedPatchesEnableNonSecurity](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-ApprovedPatchesEnableNonSecurity"></a>
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is `false`. Applies to Linux managed nodes only.  
Type: Boolean  
Required: No

 ** [AvailableSecurityUpdatesComplianceStatus](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-AvailableSecurityUpdatesComplianceStatus"></a>
Indicates the status to be assigned to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.  
Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.  
Supported for Windows Server managed nodes only.  
Type: String  
Valid Values: `COMPLIANT | NON_COMPLIANT`   
Required: No

 ** [BaselineId](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-BaselineId"></a>
The ID of the patch baseline to update.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$`   
Required: Yes

 ** [Description](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-Description"></a>
A description of the patch baseline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** [GlobalFilters](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-GlobalFilters"></a>
A set of global filters used to include patches in the baseline.  
The `GlobalFilters` parameter can be configured only by using the AWS CLI or an AWS SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.
Type: [PatchFilterGroup](API_PatchFilterGroup.md) object  
Required: No

 ** [Name](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-Name"></a>
The name of the patch baseline.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$`   
Required: No

 ** [RejectedPatches](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-RejectedPatches"></a>
A list of explicitly rejected patches for the baseline.  
For information about accepted formats for lists of approved patches and rejected patches, see [Package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the * AWS Systems Manager User Guide*.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [RejectedPatchesAction](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-RejectedPatchesAction"></a>
The action for Patch Manager to take on patches included in the `RejectedPackages` list.    
ALLOW\$1AS\$1DEPENDENCY  
 **Linux and macOS**: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as `INSTALLED_OTHER`. This is the default action if no option is specified.  
 **Windows Server**: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as `INSTALLED_OTHER`. Any package not already installed on the node is skipped. This is the default action if no option is specified.  
BLOCK  
 **All OSs**: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances.   
State value assignment for patch compliance:  
+ If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as `INSTALLED_REJECTED`.
+ If an update attempts to install a dependency package that is now rejected by the baseline, when previous versions of the package were not rejected, the package being updated is reported as `MISSING` for `SCAN` operations and as `FAILED` for `INSTALL` operations.
Type: String  
Valid Values: `ALLOW_AS_DEPENDENCY | BLOCK`   
Required: No

 ** [Replace](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-Replace"></a>
If True, then all fields that are required by the [CreatePatchBaseline](API_CreatePatchBaseline.md) operation are also required for this API request. Optional fields that aren't specified are set to null.  
Type: Boolean  
Required: No

 ** [Sources](#API_UpdatePatchBaseline_RequestSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-request-Sources"></a>
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.  
Type: Array of [PatchSource](API_PatchSource.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

## Response Syntax
<a name="API_UpdatePatchBaseline_ResponseSyntax"></a>

```
{
   "ApprovalRules": { 
      "PatchRules": [ 
         { 
            "ApproveAfterDays": number,
            "ApproveUntilDate": "string",
            "ComplianceLevel": "string",
            "EnableNonSecurity": boolean,
            "PatchFilterGroup": { 
               "PatchFilters": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         }
      ]
   },
   "ApprovedPatches": [ "string" ],
   "ApprovedPatchesComplianceLevel": "string",
   "ApprovedPatchesEnableNonSecurity": boolean,
   "AvailableSecurityUpdatesComplianceStatus": "string",
   "BaselineId": "string",
   "CreatedDate": number,
   "Description": "string",
   "GlobalFilters": { 
      "PatchFilters": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "ModifiedDate": number,
   "Name": "string",
   "OperatingSystem": "string",
   "RejectedPatches": [ "string" ],
   "RejectedPatchesAction": "string",
   "Sources": [ 
      { 
         "Configuration": "string",
         "Name": "string",
         "Products": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_UpdatePatchBaseline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApprovalRules](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-ApprovalRules"></a>
A set of rules used to include patches in the baseline.  
Type: [PatchRuleGroup](API_PatchRuleGroup.md) object

 ** [ApprovedPatches](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-ApprovedPatches"></a>
A list of explicitly approved patches for the baseline.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [ApprovedPatchesComplianceLevel](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-ApprovedPatchesComplianceLevel"></a>
The compliance severity level assigned to the patch baseline after the update completed.  
Type: String  
Valid Values: `CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED` 

 ** [ApprovedPatchesEnableNonSecurity](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-ApprovedPatchesEnableNonSecurity"></a>
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is `false`. Applies to Linux managed nodes only.  
Type: Boolean

 ** [AvailableSecurityUpdatesComplianceStatus](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-AvailableSecurityUpdatesComplianceStatus"></a>
Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. This preference is specified when the `CreatePatchBaseline` or `UpdatePatchBaseline` commands are run.  
Applies to Windows Server managed nodes only.  
Type: String  
Valid Values: `COMPLIANT | NON_COMPLIANT` 

 ** [BaselineId](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-BaselineId"></a>
The ID of the deleted patch baseline.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-:/]{20,128}$` 

 ** [CreatedDate](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-CreatedDate"></a>
The date when the patch baseline was created.  
Type: Timestamp

 ** [Description](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-Description"></a>
A description of the patch baseline.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [GlobalFilters](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-GlobalFilters"></a>
A set of global filters used to exclude patches from the baseline.  
Type: [PatchFilterGroup](API_PatchFilterGroup.md) object

 ** [ModifiedDate](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-ModifiedDate"></a>
The date when the patch baseline was last modified.  
Type: Timestamp

 ** [Name](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-Name"></a>
The name of the patch baseline.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_\-.]{3,128}$` 

 ** [OperatingSystem](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-OperatingSystem"></a>
The operating system rule used by the updated patch baseline.  
Type: String  
Valid Values: `WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023` 

 ** [RejectedPatches](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-RejectedPatches"></a>
A list of explicitly rejected patches for the baseline.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [RejectedPatchesAction](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-RejectedPatchesAction"></a>
The action specified to take on patches included in the `RejectedPatches` list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.  
Type: String  
Valid Values: `ALLOW_AS_DEPENDENCY | BLOCK` 

 ** [Sources](#API_UpdatePatchBaseline_ResponseSyntax) **   <a name="systemsmanager-UpdatePatchBaseline-response-Sources"></a>
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.  
Type: Array of [PatchSource](API_PatchSource.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

## Errors
<a name="API_UpdatePatchBaseline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DoesNotExistException **   
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.  
For information about resource quotas in AWS Systems Manager, see [Systems Manager service quotas](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the *Amazon Web Services General Reference*.  
HTTP Status Code: 400

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

## Examples
<a name="API_UpdatePatchBaseline_Examples"></a>

### Example
<a name="API_UpdatePatchBaseline_Example_1"></a>

This example illustrates one usage of UpdatePatchBaseline.

#### Sample Request
<a name="API_UpdatePatchBaseline_Example_1_Request"></a>

```
POST / HTTP/1.1
   Host: ssm.us-east-2.amazonaws.com
   Accept-Encoding: identity
   Content-Length: 306
   X-Amz-Target: AmazonSSM.UpdatePatchBaseline
   X-Amz-Date: 20240309T023346Z
   User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
   Content-Type: application/x-amz-json-1.1
   Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
   SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
  
  {
    "ApprovalRules": {
        "PatchRules": [
            {
                "PatchFilterGroup": {
                    "PatchFilters": [
                        {
                            "Values": [
                                "Critical",
                                "Important"
                            ],
                            "Key": "MSRC_SEVERITY"
                        },
                        {
                            "Values": [
                                "SecurityUpdates",
                                "Updates",
                                "UpdateRollups",
                                "CriticalUpdates"
                            ],
                            "Key": "CLASSIFICATION"
                        }
                    ]
                },
                "ApproveAfterDays": 3
            }
        ]
    },
    "BaselineId": "pb-0c10e65780EXAMPLE"
}
```

#### Sample Response
<a name="API_UpdatePatchBaseline_Example_1_Response"></a>

```
{
    "ApprovalRules": {
        "PatchRules": [
            {
                "ApproveAfterDays": 3,
                "ComplianceLevel": "UNSPECIFIED",
                "EnableNonSecurity": false,
                "PatchFilterGroup": {
                    "PatchFilters": [
                        {
                            "Key": "MSRC_SEVERITY",
                            "Values": [
                                "Critical",
                                "Important"
                            ]
                        },
                        {
                            "Key": "CLASSIFICATION",
                            "Values": [
                                "SecurityUpdates",
                                "Updates",
                                "UpdateRollups",
                                "CriticalUpdates"
                            ]
                        }
                    ]
                }
            }
        ]
    },
    "ApprovedPatches": [],
    "ApprovedPatchesComplianceLevel": "UNSPECIFIED",
    "ApprovedPatchesEnableNonSecurity": false,
    "BaselineId": "pb-0c10e65780EXAMPLE",
    "Description": "Baseline containing all updates approved for production systems",
    "GlobalFilters": {
        "PatchFilters": []
    },
    "CreatedDate": 1520562237.968,
    "ModifiedDate": 1520562239.765,
    "Name": "my-Windows-Server-patch-baseline",
    "OperatingSystem": "WINDOWS",
    "RejectedPatches": [],
    "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY",
    "Sources": []
}
```

## See Also
<a name="API_UpdatePatchBaseline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdatePatchBaseline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdatePatchBaseline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdatePatchBaseline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdatePatchBaseline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdatePatchBaseline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdatePatchBaseline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdatePatchBaseline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdatePatchBaseline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdatePatchBaseline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdatePatchBaseline) 

# UpdateResourceDataSync
<a name="API_UpdateResourceDataSync"></a>

Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the `Include only the current account` option, you can't edit that sync later and choose the `Include all accounts from my AWS Organizations configuration` option. Instead, you must delete the first resource data sync, and create a new one.

**Note**  
This API operation only supports a resource data sync that was created with a SyncFromSource `SyncType`.

## Request Syntax
<a name="API_UpdateResourceDataSync_RequestSyntax"></a>

```
{
   "SyncName": "string",
   "SyncSource": { 
      "AwsOrganizationsSource": { 
         "OrganizationalUnits": [ 
            { 
               "OrganizationalUnitId": "string"
            }
         ],
         "OrganizationSourceType": "string"
      },
      "EnableAllOpsDataSources": boolean,
      "IncludeFutureRegions": boolean,
      "SourceRegions": [ "string" ],
      "SourceType": "string"
   },
   "SyncType": "string"
}
```

## Request Parameters
<a name="API_UpdateResourceDataSync_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [SyncName](#API_UpdateResourceDataSync_RequestSyntax) **   <a name="systemsmanager-UpdateResourceDataSync-request-SyncName"></a>
The name of the resource data sync you want to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** [SyncSource](#API_UpdateResourceDataSync_RequestSyntax) **   <a name="systemsmanager-UpdateResourceDataSync-request-SyncSource"></a>
Specify information about the data sources to synchronize.  
Type: [ResourceDataSyncSource](API_ResourceDataSyncSource.md) object  
Required: Yes

 ** [SyncType](#API_UpdateResourceDataSync_RequestSyntax) **   <a name="systemsmanager-UpdateResourceDataSync-request-SyncType"></a>
The type of resource data sync. The supported `SyncType` is SyncFromSource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

## Response Elements
<a name="API_UpdateResourceDataSync_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateResourceDataSync_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ResourceDataSyncConflictException **   
Another `UpdateResourceDataSync` request is being processed. Wait a few minutes and try again.  
HTTP Status Code: 400

 ** ResourceDataSyncInvalidConfigurationException **   
The specified sync configuration is invalid.  
HTTP Status Code: 400

 ** ResourceDataSyncNotFoundException **   
The specified sync name wasn't found.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateResourceDataSync_Examples"></a>

### Example
<a name="API_UpdateResourceDataSync_Example_1"></a>

This example illustrates one usage of UpdateResourceDataSync.

#### Sample Request
<a name="API_UpdateResourceDataSync_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateResourceDataSync
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240327T160454Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240327/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 161

{
    "SyncName": "exampleSync",
    "SyncType": "SyncFromSource",
    "SyncSource": {
        "SourceType": "SingleAccountMultiRegions",
        "SourceRegions": [
            "us-east-2",
            "us-west-2"
        ]
    }
}
```

#### Sample Response
<a name="API_UpdateResourceDataSync_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateResourceDataSync_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateResourceDataSync) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateResourceDataSync) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateResourceDataSync) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateResourceDataSync) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateResourceDataSync) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateResourceDataSync) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateResourceDataSync) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateResourceDataSync) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateResourceDataSync) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateResourceDataSync) 

# UpdateServiceSetting
<a name="API_UpdateServiceSetting"></a>

 `ServiceSetting` is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a `SettingId` object to a setting value. AWS services teams define the default value for a `SettingId`. You can't create a new `SettingId`, but you can overwrite the default value if you have the `ssm:UpdateServiceSetting` permission for the setting. Use the [GetServiceSetting](API_GetServiceSetting.md) API operation to view the current value. Or, use the [ResetServiceSetting](API_ResetServiceSetting.md) to change the value back to the original value defined by the AWS service team.

Update the service setting for the account. 

## Request Syntax
<a name="API_UpdateServiceSetting_RequestSyntax"></a>

```
{
   "SettingId": "string",
   "SettingValue": "string"
}
```

## Request Parameters
<a name="API_UpdateServiceSetting_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [SettingId](#API_UpdateServiceSetting_RequestSyntax) **   <a name="systemsmanager-UpdateServiceSetting-request-SettingId"></a>
The Amazon Resource Name (ARN) of the service setting to update. For example, `arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled`. The setting ID can be one of the following.  
+  `/ssm/appmanager/appmanager-enabled` 
+  `/ssm/automation/customer-script-log-destination` 
+  `/ssm/automation/customer-script-log-group-name` 
+ /ssm/automation/enable-adaptive-concurrency
+  `/ssm/documents/console/public-sharing-permission` 
+  `/ssm/managed-instance/activation-tier` 
+  `/ssm/managed-instance/default-ec2-instance-management-role` 
+  `/ssm/opsinsights/opscenter` 
+  `/ssm/parameter-store/default-parameter-tier` 
+  `/ssm/parameter-store/high-throughput-enabled` 
Permissions to update the `/ssm/managed-instance/default-ec2-instance-management-role` setting should only be provided to administrators. Implement least privilege access when allowing individuals to configure or modify the Default Host Management Configuration.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

 ** [SettingValue](#API_UpdateServiceSetting_RequestSyntax) **   <a name="systemsmanager-UpdateServiceSetting-request-SettingValue"></a>
The new value to specify for the service setting. The following list specifies the available values for each setting.  
+ For `/ssm/appmanager/appmanager-enabled`, enter `True` or `False`.
+ For `/ssm/automation/customer-script-log-destination`, enter `CloudWatch`.
+ For `/ssm/automation/customer-script-log-group-name`, enter the name of an Amazon CloudWatch Logs log group.
+ For `/ssm/documents/console/public-sharing-permission`, enter `Enable` or `Disable`.
+ For `/ssm/managed-instance/activation-tier`, enter `standard` or `advanced`.
+ For `/ssm/managed-instance/default-ec2-instance-management-role`, enter the name of an IAM role. 
+  For `/ssm/opsinsights/opscenter`, enter `Enabled` or `Disabled`. 
+ For `/ssm/parameter-store/default-parameter-tier`, enter `Standard`, `Advanced`, or `Intelligent-Tiering` 
+ For `/ssm/parameter-store/high-throughput-enabled`, enter `true` or `false`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

## Response Elements
<a name="API_UpdateServiceSetting_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateServiceSetting_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An error occurred on the server side.  
HTTP Status Code: 500

 ** ServiceSettingNotFound **   
The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the AWS service team.  
HTTP Status Code: 400

 ** TooManyUpdates **   
There are concurrent updates for a resource that supports one update at a time.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateServiceSetting_Examples"></a>

### Example
<a name="API_UpdateServiceSetting_Example_1"></a>

This example illustrates one usage of UpdateServiceSetting.

#### Sample Request
<a name="API_UpdateServiceSetting_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateServiceSetting
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T154927Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 134

{
    "SettingId": "arn:aws:ssm:us-east-2:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled",
    "SettingValue": "true"
}
```

#### Sample Response
<a name="API_UpdateServiceSetting_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateServiceSetting_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-2014-11-06/UpdateServiceSetting) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-2014-11-06/UpdateServiceSetting) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/UpdateServiceSetting) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-2014-11-06/UpdateServiceSetting) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateServiceSetting) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-2014-11-06/UpdateServiceSetting) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-2014-11-06/UpdateServiceSetting) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-2014-11-06/UpdateServiceSetting) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateServiceSetting) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/UpdateServiceSetting)