Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
systems-manager-api-126	systems-manager-api.pdf	126	Request Parameters For information about the parameters that are common to all actions, see Common Parameters. Request Parameters API Version 2014-11-06 669 AWS Systems Manager API Reference The request accepts the following data in JSON format. AlarmConﬁguration The CloudWatch alarm you want to apply to your maintenance window task. Type: AlarmConﬁguration object Required: No ClientToken User-provided idempotency token. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No CutoﬀBehavior Indicates whether tasks should continue to run after the cutoﬀ time speciﬁed in the maintenance windows is reached. • CONTINUE_TASK: When the cutoﬀ time is reached, any tasks that are running continue. The default value. • CANCEL_TASK: • For Automation, AWS Lambda, AWS Step Functions tasks: When the cutoﬀ time is reached, any task invocations that are already running continue, but no new task invocations are started. • For Run Command tasks: When the cutoﬀ time is reached, the system sends a CancelCommand 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 Request Parameters API Version 2014-11-06 670 AWS Systems Manager Description An optional description for the task. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LoggingInfo A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to. Note 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. Type: LoggingInfo object Required: No MaxConcurrency The maximum number of targets this task can be run for, in parallel. Note Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases. For maintenance window tasks without a target speciﬁed, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't aﬀect the running of your task. Type: String Request Parameters API Version 2014-11-06 671 AWS Systems Manager API Reference 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 The maximum number of errors allowed before this task stops being scheduled. Note Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases. For maintenance window tasks without a target speciﬁed, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't aﬀect 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 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 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. Request Parameters API Version 2014-11-06 672 AWS Systems Manager Type: Integer Valid Range: Minimum value of 0. Required: No ServiceRoleArn API Reference 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 in the in the AWS Systems Manager User Guide. Type: String Required: No Targets The targets (either managed nodes or maintenance window targets). Note One or more targets must be speciﬁed 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 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: Request Parameters
systems-manager-api-127	systems-manager-api.pdf	127	Windows in the in the AWS Systems Manager User Guide. Type: String Required: No Targets The targets (either managed nodes or maintenance window targets). Note One or more targets must be speciﬁed 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 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: Request Parameters API Version 2014-11-06 673 AWS Systems Manager API Reference Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2> Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No TaskArn The ARN of the task to run. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Required: Yes TaskInvocationParameters The parameters that the task should use during execution. Populate only the ﬁelds that match the task type. All other ﬁelds should be empty. Type: MaintenanceWindowTaskInvocationParameters object Required: No TaskParameters The parameters that should be passed to the task when it is run. Note 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. Type: String to MaintenanceWindowTaskParameterValueExpression object map Key Length Constraints: Minimum length of 1. Maximum length of 255. Request Parameters API Version 2014-11-06 674 API Reference AWS Systems Manager Required: No TaskType The type of task being registered. Type: String Valid Values: RUN_COMMAND \| AUTOMATION \| STEP_FUNCTIONS \| LAMBDA Required: Yes WindowId 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 { "WindowTaskId": "string" } Response Elements 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 The ID of the task in the maintenance window. Type: String Response Syntax API Version 2014-11-06 675 AWS Systems Manager API Reference 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 For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID speciﬁed 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 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. Errors API Version 2014-11-06 676 AWS Systems Manager API Reference For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 Examples Example This example illustrates one usage of RegisterTaskWithMaintenanceWindow. Sample Request 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" Examples API Version 2014-11-06 677 AWS Systems Manager ] } } }, "Priority": 10, "MaxConcurrency": "1", "MaxErrors": "1", API Reference "ClientToken": "8a3f60db-1d39-4938-a566-c2ec2EXAMPLE" } Sample Response { "WindowTaskId": "216ae877-0be9-4746-a19d-ed654EXAMPLE" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 678 AWS Systems Manager API Reference RemoveTagsFromResource Removes tag keys from the speciﬁed resource. Request Syntax { "ResourceId": "string", "ResourceType": "string", "TagKeys": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceId The ID of the resource from which you want to remove tags. For example: ManagedInstance: mi-012345abcde MaintenanceWindow:
systems-manager-api-128	systems-manager-api.pdf	128	SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 678 AWS Systems Manager API Reference RemoveTagsFromResource Removes tag keys from the speciﬁed resource. Request Syntax { "ResourceId": "string", "ResourceType": "string", "TagKeys": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceId 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. Speciﬁcally, 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. RemoveTagsFromResource API Version 2014-11-06 679 AWS Systems Manager Note API Reference 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 Required: Yes ResourceType The type of resource from which you want to remove a tag. Note 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 Tag keys that you want to remove from the speciﬁed resource. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes Request Parameters API Version 2014-11-06 680 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. 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 Example This example illustrates one usage of RemoveTagsFromResource. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Response Elements API Version 2014-11-06 681 AWS Systems Manager API Reference 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 {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 682 AWS Systems Manager API Reference ResetServiceSetting ServiceSetting is an account-level setting for an AWS service. This setting deﬁnes 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 deﬁne 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 operation to view the current value. Use the UpdateServiceSetting 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 { "SettingId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SettingId 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
systems-manager-api-129	systems-manager-api.pdf	129	Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting 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 { "SettingId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SettingId 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 ResetServiceSetting API Version 2014-11-06 683 AWS Systems Manager API Reference • /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 { "ServiceSetting": { "ARN": "string", "LastModifiedDate": number, "LastModifiedUser": "string", "SettingId": "string", "SettingValue": "string", "Status": "string" } } Response Elements 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 The current, eﬀective service setting after calling the ResetServiceSetting API operation. Type: ServiceSetting object Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2014-11-06 684 AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 ServiceSettingNotFound API Reference The speciﬁed 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 Example This example illustrates one usage of ResetServiceSetting. Sample Request 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" } Examples API Version 2014-11-06 685 AWS Systems Manager Sample Response { "ServiceSetting": { API Reference "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 For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 686 AWS Systems Manager ResumeSession API Reference 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 { "SessionId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SessionId The ID of the disconnected session to resume. Type: String Length Constraints: Minimum length of 1. Maximum length of 96. Required: Yes Response Syntax { "SessionId": "string", "StreamUrl": "string", "TokenValue": "string" } ResumeSession API Version 2014-11-06 687 AWS Systems Manager Response Elements API Reference 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 The ID of the session. Type: String Length Constraints: Minimum length of 1. Maximum length of 96. StreamUrl 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 identiﬁer 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 in the Amazon Web Services General Reference. session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE. Type: String TokenValue 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 For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2014-11-06 688 AWS Systems Manager DoesNotExistException API Reference Error returned when the ID speciﬁed 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 in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server
systems-manager-api-130	systems-manager-api.pdf	130	information. Used to authenticate the connection to the managed node. Type: String Length Constraints: Minimum length of 0. Maximum length of 300. Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2014-11-06 688 AWS Systems Manager DoesNotExistException API Reference Error returned when the ID speciﬁed 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 in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of ResumeSession. Sample Request 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 {{ Examples API Version 2014-11-06 689 AWS Systems Manager API Reference "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 For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 690 AWS Systems Manager API Reference SendAutomationSignal Sends a signal to an Automation execution to change the current behavior or status of the execution. Request Syntax { "AutomationExecutionId": "string", "Payload": { "string" : [ "string" ] }, "SignalType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AutomationExecutionId The unique identiﬁer for an existing Automation execution that you want to send the signal to. Type: String Length Constraints: Fixed length of 36. Required: Yes Payload 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: SendAutomationSignal API Version 2014-11-06 691 AWS Systems Manager StepName="step1" API Reference 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 The type of signal to send to an Automation execution. Type: String Valid Values: Approve \| Reject \| StartStep \| StopStep \| Resume \| Revoke Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID. HTTP Status Code: 400 Response Elements API Version 2014-11-06 692 AWS Systems Manager API Reference AutomationStepNotFoundException The speciﬁed 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 Example This example illustrates one usage of SendAutomationSignal. Sample Request 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" Examples API Version 2014-11-06 693 API Reference AWS Systems Manager ] } } Sample Response {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 694 API Reference AWS Systems Manager SendCommand Runs commands on one or more managed nodes. Request Syntax { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "string", "CloudWatchOutputEnabled": boolean
systems-manager-api-131	systems-manager-api.pdf	131	SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 694 API Reference AWS Systems Manager SendCommand Runs commands on one or more managed nodes. Request Syntax { "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" ] SendCommand API Version 2014-11-06 695 AWS Systems Manager } ], "TimeoutSeconds": number } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AlarmConﬁguration The CloudWatch alarm you want to apply to your command. Type: AlarmConﬁguration object Required: No CloudWatchOutputConﬁg Enables AWS Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a tool in AWS Systems Manager. Type: CloudWatchOutputConﬁg object Required: No Comment User-speciﬁed 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 The Sha256 or Sha1 hash created by the system when the document was created. Request Parameters API Version 2014-11-06 696 API Reference AWS Systems Manager Note Sha1 hashes have been deprecated. Type: String Length Constraints: Maximum length of 256. Required: No DocumentHashType Sha256 or Sha1. Note Sha1 hashes have been deprecated. Type: String Valid Values: Sha256 \| Sha1 Required: No DocumentName 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 in the AWS Systems Manager User Guide. Note 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}$ Request Parameters API Version 2014-11-06 697 AWS Systems Manager Required: Yes DocumentVersion API Reference The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a speciﬁc version number. If you run commands by using the AWS Command Line Interface (AWS CLI), then you must escape the ﬁrst 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 "\$DEFAULT" --document-version "\$LATEST" --document-version "3" Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No InstanceIds 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 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 Request Parameters API Version 2014-11-06 698 AWS Systems Manager MaxConcurrency API Reference (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 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 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 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 NotiﬁcationConﬁg Conﬁgurations for
systems-manager-api-132	systems-manager-api.pdf	132	Constraints: Minimum length of 1. Maximum length of 7. Pattern: ^([1-9][0-9]\|[1-9][0-9]%\|[1-9]%\|100%)$ Required: No MaxErrors 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 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 NotiﬁcationConﬁg Conﬁgurations for sending notiﬁcations. Type: NotiﬁcationConﬁg object Required: No OutputS3BucketName 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. Request Parameters API Version 2014-11-06 699 AWS Systems Manager Required: No OutputS3KeyPreﬁx API Reference The directory structure within the S3 bucket where the responses should be stored. Type: String Length Constraints: Maximum length of 500. Required: No OutputS3Region (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 The required and optional parameters speciﬁed in the document being run. Type: String to array of strings map Required: No ServiceRoleArn The ARN of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notiﬁcation Service (Amazon SNS) notiﬁcations for Run Command commands. This role must provide the sns:Publish permission for your notiﬁcation topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notiﬁcations in the AWS Systems Manager User Guide. Type: String Required: No Targets 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 Request Parameters API Version 2014-11-06 700 AWS Systems Manager API Reference 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 in the AWS Systems Manager User Guide. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No TimeoutSeconds 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 { "Command": { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "string", "CloudWatchOutputEnabled": boolean }, "CommandId": "string", "Comment": "string", Response Syntax API Version 2014-11-06 701 AWS Systems Manager API Reference "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 Syntax API Version 2014-11-06 702 AWS Systems Manager Response Elements API Reference 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 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 object Errors For information about the errors that are common to all actions, see Common Errors. 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 speciﬁed SSM document doesn't exist. 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. Response Elements API Version 2014-11-06 703 AWS Systems Manager API Reference • 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 InvalidNotiﬁcationConﬁg One or more conﬁguration items
systems-manager-api-133	systems-manager-api.pdf	133	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. Response Elements API Version 2014-11-06 703 AWS Systems Manager API Reference • 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 InvalidNotiﬁcationConﬁg One or more conﬁguration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notiﬁcation 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 deﬁned in the SSM document. HTTP Status Code: 400 InvalidRole The role name can't contain invalid characters. Also verify that you speciﬁed an IAM role for notiﬁcations that includes the required trust policy. For information about conﬁguring the IAM role for Run Command notiﬁcations, see Monitoring Systems Manager status changes using Amazon SNS notiﬁcations 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. Errors API Version 2014-11-06 704 API Reference AWS Systems Manager HTTP Status Code: 400 Examples Example This example illustrates one usage of SendCommand. Sample Request 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" ], Examples API Version 2014-11-06 705 AWS Systems Manager API Reference "NotificationType": "Command" }, "OutputS3BucketName": "amzn-s3-demo-bucket", "OutputS3KeyPrefix": "my-prefix", "OutputS3Region": "us-east-2", "Parameters": { "string": [] }, "TimeoutSeconds": 30 } Sample Response { "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", Examples API Version 2014-11-06 706 AWS Systems Manager API Reference "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 For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 707 AWS Systems Manager API Reference See Also API Version 2014-11-06 708 AWS Systems Manager StartAccessRequest Starts the workﬂow for just-in-time node access sessions. API Reference Request Syntax { "Reason": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Targets": [ { "Key": "string", "Values": [ "string" ] } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Reason 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 Key-value pairs of metadata you want to assign to the access request. Type: Array of Tag objects StartAccessRequest API Version 2014-11-06 709 AWS Systems Manager API Reference Array Members: Maximum number of 1000 items. Required: No Targets The node you are requesting access to. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: Yes Response Syntax { "AccessRequestId": "string" } Response Elements 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 The ID of the access request. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The requester doesn't have permissions to perform the requested operation. Response Syntax API Version 2014-11-06 710 AWS Systems Manager HTTP Status Code:
systems-manager-api-134	systems-manager-api.pdf	134	Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: Yes Response Syntax { "AccessRequestId": "string" } Response Elements 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 The ID of the access request. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The requester doesn't have permissions to perform the requested operation. Response Syntax API Version 2014-11-06 710 AWS Systems Manager HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 ResourceNotFoundException API Reference The speciﬁed 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. HTTP Status Code: 400 ThrottlingException The request or operation couldn't be performed because the service is throttling requests. HTTP Status Code: 400 ValidationException The request isn't valid. Verify that you entered valid contents for the command and try again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2014-11-06 711 AWS Systems Manager • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 712 AWS Systems Manager API Reference StartAssociationsOnce Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations. Request Syntax { "AssociationIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AssociationIds 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 If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AssociationDoesNotExist The speciﬁed association doesn't exist. StartAssociationsOnce API Version 2014-11-06 713 API Reference AWS Systems Manager HTTP Status Code: 400 InvalidAssociation The association isn't valid or doesn't exist. HTTP Status Code: 400 Examples Example This example illustrates one usage of StartAssociationsOnce. Sample Request 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 {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Examples API Version 2014-11-06 714 API Reference AWS Systems Manager • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 715 AWS Systems Manager API Reference StartAutomationExecution Initiates execution of an Automation runbook. Request Syntax { "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" } ], StartAutomationExecution API Version 2014-11-06 716 AWS Systems Manager API Reference "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 For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AlarmConﬁguration The CloudWatch alarm you want to apply to your automation. Type: AlarmConﬁguration object Required: No Request Parameters API Version 2014-11-06 717 AWS Systems Manager ClientToken API Reference User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
systems-manager-api-135	systems-manager-api.pdf	135	} ], "TargetLocationsURL": "string", "TargetMaps": [ { "string" : [ "string" ] } ], "TargetParameterName": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AlarmConﬁguration The CloudWatch alarm you want to apply to your automation. Type: AlarmConﬁguration object Required: No Request Parameters API Version 2014-11-06 717 AWS Systems Manager ClientToken API Reference 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 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 in the AWS Systems Manager User Guide. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: Yes DocumentVersion The version of the Automation runbook to use for this execution. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No MaxConcurrency 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. Request Parameters API Version 2014-11-06 718 AWS Systems Manager Type: String API Reference 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 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 ﬁrst 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 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 Request Parameters API Version 2014-11-06 719 AWS Systems Manager Required: No Parameters API Reference 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 Optional metadata that you assign to a resource. You can specify a maximum of ﬁve tags for an automation. Tags enable you to categorize a resource in diﬀerent 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 Note 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 action to add up to a total of 50 tags to an existing automation conﬁguration. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No Request Parameters API Version 2014-11-06 720 AWS Systems Manager TargetLocations API Reference 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 in the AWS Systems Manager User Guide. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetLocationsURL Specify a publicly accessible URL for a ﬁle that contains the TargetLocations body. Currently, only ﬁles 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
systems-manager-api-136	systems-manager-api.pdf	136	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 in the AWS Systems Manager User Guide. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetLocationsURL Specify a publicly accessible URL for a ﬁle that contains the TargetLocations body. Currently, only ﬁles 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 A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be speciﬁed 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 Request Parameters API Version 2014-11-06 721 AWS Systems Manager TargetParameterName API Reference 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 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 objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No Response Syntax { "AutomationExecutionId": "string" } Response Elements 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 The unique ID of a newly scheduled automation execution. Type: String Response Syntax API Version 2014-11-06 722 AWS Systems Manager API Reference Length Constraints: Fixed length of 36. Errors For information about the errors that are common to all actions, see Common Errors. AutomationDeﬁnitionNotFoundException An Automation runbook with the speciﬁed name couldn't be found. HTTP Status Code: 400 AutomationDeﬁnitionVersionNotFoundException An Automation runbook with the speciﬁed 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 speciﬁed Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the speciﬁed Automation document. HTTP Status Code: 400 Errors API Version 2014-11-06 723 AWS Systems Manager InvalidTarget API Reference The target isn't valid or doesn't exist. It might not be conﬁgured for Systems Manager or you might not have permission to perform the operation. HTTP Status Code: 400 Examples Example This example illustrates one usage of StartAutomationExecution. Sample Request 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 { "AutomationExecutionId": "832a6fba-f4f0-4b2a-ab85-587adEXAMPLE" } Examples API Version 2014-11-06 724 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 725 AWS Systems Manager API Reference StartChangeRequestExecution Creates a change request for Change Manager. The Automation runbooks speciﬁed in the change request run only after all required approvals for the change request have been received. Request Syntax { "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", StartChangeRequestExecution API Version 2014-11-06 726 AWS Systems Manager API Reference "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" } ], "TargetMaps": [ { "string" : [ "string" ] } ], "TargetParameterName": "string",
systems-manager-api-137	systems-manager-api.pdf	137	{ "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", StartChangeRequestExecution API Version 2014-11-06 726 AWS Systems Manager API Reference "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 For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Request Parameters API Version 2014-11-06 727 AWS Systems Manager AutoApprove API Reference 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. Note 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 User-provided details about the change. If no details are provided, content speciﬁed 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 The name of the change request associated with the runbook workﬂow to be run. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No ClientToken The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused. Request Parameters API Version 2014-11-06 728 AWS Systems Manager Type: String Length Constraints: Fixed length of 36. API Reference 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 The name of the change template document to run during the runbook workﬂow. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: Yes DocumentVersion The version of the change template document to run during the runbook workﬂow. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]*$) Required: No Parameters 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 Request Parameters API Version 2014-11-06 729 AWS Systems Manager Runbooks API Reference Information about the Automation runbooks that are run during the runbook workﬂow. Note The Automation runbooks speciﬁed for the runbook workﬂow can't run until all required approvals for the change request have been received. Type: Array of Runbook objects Array Members: Fixed number of 1 item. Required: Yes ScheduledEndTime The time that the requester expects the runbook workﬂow related to the change request to complete. The time is an estimate only that the requester provides for reviewers. Type: Timestamp Required: No ScheduledTime The date and time speciﬁed in the change request to run the Automation runbooks. Note The Automation runbooks speciﬁed for the runbook workﬂow can't run until all required approvals for the change request have been received. Type: Timestamp Required: No Tags Optional metadata that you assign to a resource. You can specify a maximum of ﬁve tags for a change request. Tags enable you to categorize a resource in diﬀerent ways, such as by purpose, Request Parameters API Version 2014-11-06 730 AWS Systems Manager API Reference 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 Note 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 action to add up to a total of 50 tags to an existing change request conﬁguration. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No Response Syntax { "AutomationExecutionId": "string" } Response Elements 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 The unique ID of a runbook workﬂow operation. (A runbook workﬂow is a type
systems-manager-api-138	systems-manager-api.pdf	138	reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request conﬁguration. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No Response Syntax { "AutomationExecutionId": "string" } Response Elements 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 The unique ID of a runbook workﬂow operation. (A runbook workﬂow is a type of Automation operation.) Type: String Length Constraints: Fixed length of 36. Response Syntax API Version 2014-11-06 731 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. AutomationDeﬁnitionNotApprovedException 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 AutomationDeﬁnitionNotFoundException An Automation runbook with the speciﬁed name couldn't be found. HTTP Status Code: 400 AutomationDeﬁnitionVersionNotFoundException An Automation runbook with the speciﬁed 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 speciﬁed Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the speciﬁed Automation document. Errors API Version 2014-11-06 732 AWS Systems Manager HTTP Status Code: 400 Examples Example API Reference This example illustrates one usage of StartChangeRequestExecution. Sample Request 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": [ Examples API Version 2014-11-06 733 AWS Systems Manager API Reference "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 { "AutomationExecutionId": "dddd1c6c-849d-4ee0-acc1-0be9dEXAMPLE" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2014-11-06 734 AWS Systems Manager • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 735 AWS Systems Manager API Reference StartExecutionPreview Initiates the process of creating a preview showing the eﬀects that running a speciﬁed Automation runbook would have on the targeted resources. Request Syntax { "DocumentName": "string", "DocumentVersion": "string", "ExecutionInputs": { ... } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DocumentName 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 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 Information about the inputs that can be speciﬁed for the preview operation. StartExecutionPreview API Version 2014-11-06 736 AWS Systems Manager API Reference Type: ExecutionInputs object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No Response Syntax { "ExecutionPreviewId": "string" } Response Elements 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 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 For information about the errors that
systems-manager-api-139	systems-manager-api.pdf	139	can be speciﬁed for the preview operation. StartExecutionPreview API Version 2014-11-06 736 AWS Systems Manager API Reference Type: ExecutionInputs object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No Response Syntax { "ExecutionPreviewId": "string" } Response Elements 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 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 For information about the errors that are common to all actions, see Common Errors. 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. Response Syntax API Version 2014-11-06 737 API Reference AWS Systems Manager HTTP Status Code: 400 Examples Example This example illustrates one usage of StartExecutionPreview. Sample Request 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 This example illustrates one usage of StartExecutionPreview. Sample Response { "ExecutionPreviewId": "2f27d6e5-9676-4708-b8bd-aef0aEXAMPLE" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Examples API Version 2014-11-06 738 API Reference AWS Systems Manager • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 739 AWS Systems Manager StartSession API Reference 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 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 { "DocumentName": "string", "Parameters": { "string" : [ "string" ] }, "Reason": "string", "Target": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DocumentName The name of the SSM document you want to use to deﬁne the type of session, input parameters, or preferences for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a StartSession API Version 2014-11-06 740 AWS Systems Manager API Reference session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the AWS Systems Manager User Guide. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: No Parameters The values you want to specify for the parameters deﬁned in the Session document. For more information about these parameters, see Create a Session Manager preferences document 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 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 The managed node to connect to for the session. Type: String Length Constraints: Minimum length of 1. Maximum length of 400. Required: Yes Request Parameters API Version 2014-11-06 741 API Reference AWS Systems Manager Response Syntax { "SessionId": "string", "StreamUrl": "string", "TokenValue": "string" } Response Elements 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 The ID of the session. Type: String Length Constraints: Minimum length of 1. Maximum length of 96. StreamUrl 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 identiﬁer 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
systems-manager-api-140	systems-manager-api.pdf	140	200 response. The following data is returned in JSON format by the service. SessionId The ID of the session. Type: String Length Constraints: Minimum length of 1. Maximum length of 96. StreamUrl 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 identiﬁer 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 in the Amazon Web Services General Reference. session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE. Type: String TokenValue 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. Response Syntax API Version 2014-11-06 742 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 300. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The speciﬁed SSM document doesn't exist. HTTP Status Code: 400 TargetNotConnected The speciﬁed target managed node for the session isn't fully conﬁgured for use with Session Manager. For more information, see Setting up Session Manager 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 diﬀerent account or Region HTTP Status Code: 400 Examples Example This example illustrates one usage of StartSession. Sample Request 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 Errors API Version 2014-11-06 743 AWS Systems Manager API Reference 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 { "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 For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 744 AWS Systems Manager API Reference StopAutomationExecution Stop an Automation that is currently running. Request Syntax { "AutomationExecutionId": "string", "Type": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AutomationExecutionId The execution ID of the Automation to stop. Type: String Length Constraints: Fixed length of 36. Required: Yes Type 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 If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. StopAutomationExecution API Version 2014-11-06 745 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. 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 speciﬁed update status operation isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of StopAutomationExecution. Sample Request 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 { Errors API Version 2014-11-06 746 AWS Systems Manager API Reference "AutomationExecutionId": "f7d1f82d-6cde-4f7a-aa53-d485bEXAMPLE" } Sample Response {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 747 AWS Systems Manager TerminateSession API Reference 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 { "SessionId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format.
systems-manager-api-141	systems-manager-api.pdf	141	Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 747 AWS Systems Manager TerminateSession API Reference 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 { "SessionId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SessionId The ID of the session to terminate. Type: String Length Constraints: Minimum length of 1. Maximum length of 96. Required: Yes Response Syntax { "SessionId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TerminateSession API Version 2014-11-06 748 AWS Systems Manager SessionId API Reference The ID of the session that has been terminated. Type: String Length Constraints: Minimum length of 1. Maximum length of 96. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of TerminateSession. Sample Request 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" } Errors API Version 2014-11-06 749 AWS Systems Manager Sample Response { "SessionId": "John-Doe-0402960697EXAMPLE" } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 750 AWS Systems Manager API Reference UnlabelParameterVersion Remove a label or labels from a parameter. Request Syntax { "Labels": [ "string" ], "Name": "string", "ParameterVersion": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Labels One or more labels to delete from the speciﬁed 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 The name of the parameter from which you want to delete one or more labels. Note You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. Type: String UnlabelParameterVersion API Version 2014-11-06 751 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ParameterVersion The speciﬁc 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 { "InvalidLabels": [ "string" ], "RemovedLabels": [ "string" ] } Response Elements 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 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 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. Response Syntax API Version 2014-11-06 752 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 100. Errors For information about the errors that are common to all actions, see Common Errors. 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. Note For the DeleteParameter and GetParameter actions, if the speciﬁed parameter doesn't exist, the ParameterNotFound exception is not recorded in AWS CloudTrail event logs. HTTP Status Code: 400 ParameterVersionNotFound The speciﬁed 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 Example This example illustrates one usage of UnlabelParameterVersion. Errors API Version 2014-11-06 753 AWS Systems Manager Sample Request 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 API Reference 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
systems-manager-api-142	systems-manager-api.pdf	142	exist, the ParameterNotFound exception is not recorded in AWS CloudTrail event logs. HTTP Status Code: 400 ParameterVersionNotFound The speciﬁed 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 Example This example illustrates one usage of UnlabelParameterVersion. Errors API Version 2014-11-06 753 AWS Systems Manager Sample Request 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 API Reference 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 { "InvalidLabels": [], "RemovedLabels": [ "label" ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2014-11-06 754 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 755 AWS Systems Manager UpdateAssociation API Reference 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 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 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 speciﬁed targets. You can add the ApplyOnlyAtCronInterval parameter to run the association during the next schedule run. Request Syntax { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "ApplyOnlyAtCronInterval": boolean, "AssociationId": "string", "AssociationName": "string", "AssociationVersion": "string", "AutomationTargetParameterName": "string", UpdateAssociation API Version 2014-11-06 756 AWS Systems Manager API Reference "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", Request Syntax API Version 2014-11-06 757 AWS Systems Manager API Reference "TargetsMaxErrors": "string" } ], "TargetMaps": [ { "string" : [ "string" ] } ], "Targets": [ { "Key": "string", "Values": [ "string" ] } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AlarmConﬁguration The details for the CloudWatch alarm you want to apply to an automation or command. Type: AlarmConﬁguration object Required: No ApplyOnlyAtCronInterval By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you speciﬁed. Specify true for ApplyOnlyAtCronInterval if you want the association to run only according to the schedule you speciﬁed. 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 speciﬁed 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 diﬀerent document version on the Documents page, State Manager applies the association at the next speciﬁed cron interval if you previously Request Parameters API Version 2014-11-06 758 AWS Systems Manager API Reference 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 and About target updates with Automation runbooks in the AWS Systems Manager User Guide. This parameter isn't supported for
systems-manager-api-143	systems-manager-api.pdf	143	if you chose the Latest version of an SSM document when you created an association and you edit the association by choosing a diﬀerent document version on the Documents page, State Manager applies the association at the next speciﬁed cron interval if you previously Request Parameters API Version 2014-11-06 758 AWS Systems Manager API Reference 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 and About target updates with Automation runbooks 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 speciﬁed. Type: Boolean Required: No AssociationId 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 The name of the association that you want to update. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No AssociationVersion 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]) Request Parameters API Version 2014-11-06 759 AWS Systems Manager Required: No AutomationTargetParameterName API Reference Choose the parameter that will deﬁne 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 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 in the AWS Systems Manager User Guide. Type: Array of strings Required: No ComplianceSeverity The severity level to assign to the association. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| UNSPECIFIED Required: No DocumentVersion The document version you want update for the association. Important 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 Request Parameters API Version 2014-11-06 760 AWS Systems Manager API Reference 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 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 oﬄine 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 speciﬁes the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is updated, but only according to the speciﬁed schedule. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Required: No MaxConcurrency 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 speciﬁed for MaxConcurrency. Type: String Request Parameters API Version 2014-11-06 761 AWS Systems Manager API Reference 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 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 ﬁrst error is returned. If you run an association on 50 managed nodes and set
systems-manager-api-144	systems-manager-api.pdf	144	Constraints: Minimum length of 1. Maximum length of 7. Pattern: ^([1-9][0-9]\|[1-9][0-9]%\|[1-9]%\|100%)$ Required: No MaxErrors 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 ﬁrst 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 The name of the SSM Command document or Automation runbook that contains the conﬁguration information for the managed node. You can specify AWS-predeﬁned 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: Request Parameters API Version 2014-11-06 762 AWS Systems Manager API Reference arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predeﬁned 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 An S3 bucket where you want to store the results of this request. Type: InstanceAssociationOutputLocation object Required: No Parameters 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 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 ScheduleOﬀset Number of days to wait after the scheduled day to run an association. For example, if you speciﬁed a cron schedule of cron(0 0 ? * THU#2 *), you could specify an oﬀset 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 in the AWS Systems Manager User Guide. Request Parameters API Version 2014-11-06 763 AWS Systems Manager Note API Reference To use oﬀsets, 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 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 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 operation. By default, all associations use AUTO mode. Type: String Valid Values: AUTO \| MANUAL Required: No TargetLocations 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. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No Request Parameters API Version 2014-11-06 764 AWS Systems Manager TargetMaps API Reference A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be speciﬁed 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 The targets of the association. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No Response Syntax { "AssociationDescription": { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean
systems-manager-api-145	systems-manager-api.pdf	145	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 The targets of the association. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No Response Syntax { "AssociationDescription": { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "ApplyOnlyAtCronInterval": boolean, "AssociationId": "string", "AssociationName": "string", "AssociationVersion": "string", Response Syntax API Version 2014-11-06 765 AWS Systems Manager API Reference "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", Response Syntax API Version 2014-11-06 766 AWS Systems Manager API Reference "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 Syntax API Version 2014-11-06 767 AWS Systems Manager Response Elements API Reference 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 The description of the association that was updated. Type: AssociationDescription object Errors For information about the errors that are common to all actions, see Common Errors. AssociationDoesNotExist The speciﬁed 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 speciﬁed 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 Response Elements API Version 2014-11-06 768 API Reference AWS Systems Manager InvalidDocument The speciﬁed SSM document doesn't exist. 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 deﬁned 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 conﬁgured 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. Errors API Version 2014-11-06 769 AWS Systems Manager HTTP Status Code: 400 TooManyUpdates API Reference There are concurrent updates for a resource that supports one update at a time. HTTP Status Code: 400 Examples Example This example illustrates one usage of UpdateAssociation. Sample Request 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 { "AssociationDescription": { "ApplyOnlyAtCronInterval": false, "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "AssociationVersion": "2", "ComplianceSeverity": "HIGH", "Date": 1561053271.583, Examples API Version 2014-11-06 770 AWS Systems Manager API Reference "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 For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 771 AWS Systems Manager API Reference
systems-manager-api-146	systems-manager-api.pdf	146	"Pending" }, "Targets": [ { "Key": "tag:ssm", "Values": [ "true" ] } ] } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 771 AWS Systems Manager API Reference UpdateAssociationStatus Updates the status of the AWS Systems Manager document (SSM document) associated with the speciﬁed 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 { "AssociationStatus": { "AdditionalInfo": "string", "Date": number, "Message": "string", "Name": "string" }, "InstanceId": "string", "Name": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AssociationStatus The association status. Type: AssociationStatus object Required: Yes InstanceId The managed node ID. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) UpdateAssociationStatus API Version 2014-11-06 772 API Reference AWS Systems Manager Required: Yes Name The name of the SSM document. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: Yes Response Syntax { "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", Response Syntax API Version 2014-11-06 773 AWS Systems Manager API Reference "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" ] Response Syntax API Version 2014-11-06 774 AWS Systems Manager } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" } API Reference ], "TargetMaps": [ { "string" : [ "string" ] } ], "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TriggeredAlarms": [ { "Name": "string", "State": "string" } ] } } Response Elements 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 Information about the association. Type: AssociationDescription object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2014-11-06 775 API Reference AWS Systems Manager AssociationDoesNotExist The speciﬁed association doesn't exist. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The speciﬁed SSM document 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 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 For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2014-11-06 776 API Reference AWS Systems Manager • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 777 AWS Systems Manager UpdateDocument Updates one or more values for an SSM document. Request Syntax API Reference { "Attachments": [ { "Key": "string", "Name": "string", "Values": [ "string" ] } ], "Content": "string", "DisplayName": "string", "DocumentFormat": "string", "DocumentVersion": "string", "Name": "string", "TargetType": "string", "VersionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request
systems-manager-api-147	systems-manager-api.pdf	147	Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 777 AWS Systems Manager UpdateDocument Updates one or more values for an SSM document. Request Syntax API Reference { "Attachments": [ { "Key": "string", "Name": "string", "Values": [ "string" ] } ], "Content": "string", "DisplayName": "string", "DocumentFormat": "string", "DocumentVersion": "string", "Name": "string", "TargetType": "string", "VersionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Attachments A list of key-value pairs that describe attachments to a version of a document. Type: Array of AttachmentsSource objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No Content A valid JSON or YAML string. Type: String UpdateDocument API Version 2014-11-06 778 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Required: Yes DisplayName The friendly name of the SSM document that you want to update. This value can diﬀer 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 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 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. 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. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Request Parameters API Version 2014-11-06 779 API Reference AWS Systems Manager Required: No Name The name of the SSM document that you want to update. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: Yes TargetType Specify a new target type for the document. Type: String Length Constraints: Maximum length of 200. Pattern: ^\/[\w\.\-\:\/]*$ Required: No VersionName An optional ﬁeld 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 { "DocumentDescription": { "ApprovedVersion": "string", "AttachmentsInformation": [ { "Name": "string" } ], "Author": "string", Response Syntax API Version 2014-11-06 780 AWS Systems Manager API Reference "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", Response Syntax API Version 2014-11-06 781 AWS Systems Manager API Reference "Tags": [ { "Key": "string", "Value": "string" } ], "TargetType": "string", "VersionName": "string" } } Response Elements 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 A description of the document that was updated. Type: DocumentDescription object Errors For information about the errors that are common to all actions, see Common Errors. 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 diﬀerent version name, and then try again. Response Elements API Version 2014-11-06 782 API Reference AWS Systems Manager HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The speciﬁed SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentContent The content for the document isn't valid. 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 Errors API Version 2014-11-06 783 API Reference AWS Systems Manager Examples
systems-manager-api-148	systems-manager-api.pdf	148	The speciﬁed SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentContent The content for the document isn't valid. 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 Errors API Version 2014-11-06 783 API Reference AWS Systems Manager Examples Example This example illustrates one usage of UpdateDocument. Sample Request 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 { "DocumentDescription": { "CreatedDate": 1585159474.781, "DefaultVersion": "1", "Description": "Example", "DisplayName": "ExampleDoc", "DocumentFormat": "YAML", "DocumentType": "Automation", "DocumentVersion": "2", "Hash": "ff7430df11be00b0593ac116b2570d488bd37a2a2fa7ddf49da67976eEXAMPLE", "HashType": "Sha256", "LatestVersion": "2", "Name": "CreateImage", Examples API Version 2014-11-06 784 AWS Systems Manager API Reference "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 For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2014-11-06 785 AWS Systems Manager • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 786 AWS Systems Manager API Reference UpdateDocumentDefaultVersion 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 { "DocumentVersion": "string", "Name": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DocumentVersion 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 The name of a custom document that you want to set as the default version. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ UpdateDocumentDefaultVersion API Version 2014-11-06 787 API Reference AWS Systems Manager Required: Yes Response Syntax { "Description": { "DefaultVersion": "string", "DefaultVersionName": "string", "Name": "string" } } Response Elements 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 The description of a custom document that you want to set as the default version. Type: DocumentDefaultVersionDescription object Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The speciﬁed SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentSchemaVersion The version of the document schema isn't supported. Response Syntax API Version 2014-11-06 788 API Reference AWS Systems Manager HTTP Status Code: 400 InvalidDocumentVersion The document version isn't valid or doesn't exist. HTTP Status Code: 400 Examples Example This example illustrates one usage of UpdateDocumentDefaultVersion. Sample Request 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 { "Description": { "DefaultVersion": "2", "Name": "Example" } } Examples API Version 2014-11-06 789 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 790 AWS Systems Manager API Reference UpdateDocumentMetadata Updates information related to approval reviews for a speciﬁc version of a change template in Change Manager. Request Syntax { "DocumentReviews": { "Action": "string", "Comment": [ { "Content": "string",
systems-manager-api-149	systems-manager-api.pdf	149	SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 790 AWS Systems Manager API Reference UpdateDocumentMetadata Updates information related to approval reviews for a speciﬁc version of a change template in Change Manager. Request Syntax { "DocumentReviews": { "Action": "string", "Comment": [ { "Content": "string", "Type": "string" } ] }, "DocumentVersion": "string", "Name": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DocumentReviews The change template review details to update. Type: DocumentReviews object Required: Yes DocumentVersion The version of a change template in which to update approval metadata. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]*$) UpdateDocumentMetadata API Version 2014-11-06 791 AWS Systems Manager Required: No Name API Reference 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 If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The speciﬁed SSM document doesn't exist. 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 Response Elements API Version 2014-11-06 792 API Reference AWS Systems Manager Examples Example This example illustrates one usage of UpdateDocumentMetadata. Sample Request 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 {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Examples API Version 2014-11-06 793 API Reference AWS Systems Manager • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 794 AWS Systems Manager API Reference UpdateMaintenanceWindow Updates an existing maintenance window. Only speciﬁed parameters are modiﬁed. Note The value you specify for Duration determines the speciﬁc 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 { "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 For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. UpdateMaintenanceWindow API Version 2014-11-06 795 AWS Systems Manager AllowUnassociatedTargets API Reference Whether targets must be registered with the maintenance window before tasks can be deﬁned for those targets. Type: Boolean Required: No Cutoﬀ 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 An optional description for the update request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Duration The duration of the maintenance window in hours. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Required: No Enabled Whether the maintenance window is enabled. Type: Boolean Required: No Request Parameters API Version 2014-11-06 796 AWS Systems Manager EndDate API Reference 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 The name of the maintenance window. Type: String Length Constraints: Minimum length of 3. Maximum length of
systems-manager-api-150	systems-manager-api.pdf	150	window in hours. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Required: No Enabled Whether the maintenance window is enabled. Type: Boolean Required: No Request Parameters API Version 2014-11-06 796 AWS Systems Manager EndDate API Reference 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 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 If True, then all ﬁelds that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional ﬁelds that aren't speciﬁed are set to null. Type: Boolean Required: No Schedule 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 ScheduleOﬀset The number of days to wait after the date and time speciﬁed by a cron expression before running the maintenance window. Request Parameters API Version 2014-11-06 797 AWS Systems Manager API Reference 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 oﬀset 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 The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. Type: String Required: No StartDate 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 speciﬁed future date. Note 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 The ID of the maintenance window to update. Type: String Request Parameters API Version 2014-11-06 798 AWS Systems Manager API Reference Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes Response Syntax { "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 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 Whether targets must be registered with the maintenance window before tasks can be deﬁned for those targets. Type: Boolean Cutoﬀ The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution. Type: Integer Response Syntax API Version 2014-11-06 799 AWS Systems Manager API Reference Valid Range: Minimum value of 0. Maximum value of 23. Description An optional description of the update. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Duration The duration of the maintenance window in hours. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Enabled Whether the maintenance window is enabled. Type: Boolean EndDate 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 speciﬁed time. Type: String Name 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 The schedule of the maintenance window in the form of a cron or rate expression. Type: String Response Elements API Version 2014-11-06 800 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 256. ScheduleOﬀset 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 The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. Type: String StartDate 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 speciﬁed time. Type: String WindowId The ID of the created maintenance window. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Errors For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID speciﬁed for a resource,
systems-manager-api-151	systems-manager-api.pdf	151	in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. Type: String StartDate 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 speciﬁed time. Type: String WindowId The ID of the created maintenance window. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Errors For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID speciﬁed for a resource, such as a maintenance window or patch baseline, doesn't exist. Errors API Version 2014-11-06 801 AWS Systems Manager API Reference For information about resource quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of UpdateMaintenanceWindow. Sample Request 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 { "AllowUnassociatedTargets": true, Examples API Version 2014-11-06 802 AWS Systems Manager "Cutoff": 4, API Reference "Description": "Standard maintenance windows for production servers", "Duration": 10, "Enabled": true, "Name": "Default-Maintenance-Window", "Schedule": "rate(3 minutes)", "WindowId": "mw-0c50858d01EXAMPLE" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 803 AWS Systems Manager API Reference UpdateMaintenanceWindowTarget Modiﬁes 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. Note If a parameter is null, then the corresponding ﬁeld isn't modiﬁed. Request Syntax { "Description": "string", "Name": "string", "OwnerInformation": "string", "Replace": boolean, "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "WindowId": "string", "WindowTargetId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. UpdateMaintenanceWindowTarget API Version 2014-11-06 804 AWS Systems Manager API Reference The request accepts the following data in JSON format. Description An optional description for the update. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Name 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 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 If True, then all ﬁelds that are required by the RegisterTargetWithMaintenanceWindow operation are also required for this API request. Optional ﬁelds that aren't speciﬁed are set to null. Type: Boolean Required: No Request Parameters API Version 2014-11-06 805 API Reference AWS Systems Manager Targets The targets to add or replace. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No WindowId 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 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 { "Description": "string", "Name": "string", "OwnerInformation": "string", "Targets": [ Response Syntax API Version 2014-11-06 806 AWS Systems Manager API Reference { "Key": "string", "Values": [ "string" ] } ], "WindowId": "string", "WindowTargetId": "string" } Response Elements 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 The updated description. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Name The updated name. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ OwnerInformation The updated owner. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Targets The updated targets. Response Elements API Version 2014-11-06 807 AWS Systems Manager API Reference Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. WindowId
systems-manager-api-152	systems-manager-api.pdf	152	sends back an HTTP 200 response. The following data is returned in JSON format by the service. Description The updated description. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Name The updated name. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ OwnerInformation The updated owner. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Targets The updated targets. Response Elements API Version 2014-11-06 807 AWS Systems Manager API Reference Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. WindowId The maintenance window ID speciﬁed in the update request. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ WindowTargetId The target ID speciﬁed 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 For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID speciﬁed 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 in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Errors API Version 2014-11-06 808 AWS Systems Manager Examples Example API Reference This example illustrates one usage of UpdateMaintenanceWindowTarget. Sample Request 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 { "Description": "My new task description", "Name": "MyNewTaskName", "Targets": [ { "Key": "InstanceIds", Examples API Version 2014-11-06 809 AWS Systems Manager API Reference "Values": [ "i-07782c72faEXAMPLE" ] } ], "WindowId": "mw-0c50858d01EXAMPLE", "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 810 AWS Systems Manager API Reference UpdateMaintenanceWindowTask Modiﬁes 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 speciﬁed 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 in the AWS Systems Manager User Guide. If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding ﬁeld isn't modiﬁed. If you set Replace to true, then all ﬁelds required by the RegisterTaskWithMaintenanceWindow operation are required for this request. Optional ﬁelds that aren't speciﬁed are set to null. Important When you update a maintenance window task that has options speciﬁed 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 speciﬁed TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance UpdateMaintenanceWindowTask API Version 2014-11-06 811 AWS Systems Manager API Reference window task and specify only a diﬀerent OutputS3BucketName value, the values for Comment and NotificationConfig are removed. Request Syntax { "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" ] } }, Request Syntax API Version 2014-11-06 812 API Reference AWS Systems Manager "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 Syntax API Version
systems-manager-api-153	systems-manager-api.pdf	153	"string" : [ "string" ] } }, Request Syntax API Version 2014-11-06 812 API Reference AWS Systems Manager "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 Syntax API Version 2014-11-06 813 AWS Systems Manager Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AlarmConﬁguration The CloudWatch alarm you want to apply to your maintenance window task. Type: AlarmConﬁguration object Required: No CutoﬀBehavior Indicates whether tasks should continue to run after the cutoﬀ time speciﬁed in the maintenance windows is reached. • CONTINUE_TASK: When the cutoﬀ time is reached, any tasks that are running continue. The default value. • CANCEL_TASK: • For Automation, AWS Lambda, AWS Step Functions tasks: When the cutoﬀ time is reached, any task invocations that are already running continue, but no new task invocations are started. • For Run Command tasks: When the cutoﬀ time is reached, the system sends a CancelCommand 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 The new task description to specify. Request Parameters API Version 2014-11-06 814 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LoggingInfo The new logging location in Amazon S3 to specify. Note 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. Type: LoggingInfo object Required: No MaxConcurrency The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task, in parallel. Note Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases. For maintenance window tasks without a target speciﬁed, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't aﬀect the running of your task. Type: String Length Constraints: Minimum length of 1. Maximum length of 7. Request Parameters API Version 2014-11-06 815 AWS Systems Manager API Reference Pattern: ^([1-9][0-9]\|[1-9][0-9]%\|[1-9]%\|100%)$ Required: No MaxErrors The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled. Note Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases. For maintenance window tasks without a target speciﬁed, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't aﬀect 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 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 The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel. Request Parameters API Version 2014-11-06 816 AWS Systems Manager Type: Integer Valid Range: Minimum value of 0. Required: No Replace API Reference If True, then all ﬁelds that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional ﬁelds that aren't speciﬁed are set to null. Type: Boolean Required: No ServiceRoleArn 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
systems-manager-api-154	systems-manager-api.pdf	154	No ServiceRoleArn 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 in the in the AWS Systems Manager User Guide. Type: String Required: No Targets The targets (either managed nodes or tags) to modify. Managed nodes are speciﬁed using the format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are speciﬁed using the format Key=tag_name,Values=tag_value. Note One or more targets must be speciﬁed for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task Request Parameters API Version 2014-11-06 817 AWS Systems Manager API Reference 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 in the AWS Systems Manager User Guide. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No TaskArn The task ARN to modify. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Required: No TaskInvocationParameters The parameters that the task should use during execution. Populate only the ﬁelds that match the task type. All other ﬁelds should be empty. Important When you update a maintenance window task that has options speciﬁed 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 speciﬁed TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a diﬀerent OutputS3BucketName value, the values for Comment and NotificationConfig are removed. Type: MaintenanceWindowTaskInvocationParameters object Required: No Request Parameters API Version 2014-11-06 818 AWS Systems Manager TaskParameters The parameters to modify. Note API Reference 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. 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 object map Key Length Constraints: Minimum length of 1. Maximum length of 255. Required: No WindowId 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 The task ID to modify. Type: String Request Parameters API Version 2014-11-06 819 AWS Systems Manager API Reference 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 { "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" ] Response Syntax API Version 2014-11-06 820 API Reference AWS Systems Manager } }, "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 Syntax API Version 2014-11-06 821 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AlarmConﬁguration The details for the CloudWatch alarm you applied to your maintenance window task. Type: AlarmConﬁguration object CutoﬀBehavior The speciﬁcation for whether tasks should continue to run after the cutoﬀ time speciﬁed in the maintenance windows is reached. Type: String Valid Values: CONTINUE_TASK \| CANCEL_TASK Description The updated task description. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. LoggingInfo The updated logging information in Amazon S3. Note LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead
systems-manager-api-155	systems-manager-api.pdf	155	The following data is returned in JSON format by the service. AlarmConﬁguration The details for the CloudWatch alarm you applied to your maintenance window task. Type: AlarmConﬁguration object CutoﬀBehavior The speciﬁcation for whether tasks should continue to run after the cutoﬀ time speciﬁed in the maintenance windows is reached. Type: String Valid Values: CONTINUE_TASK \| CANCEL_TASK Description The updated task description. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. LoggingInfo The updated logging information in Amazon S3. Note 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. Type: LoggingInfo object Response Elements API Version 2014-11-06 822 API Reference AWS Systems Manager MaxConcurrency 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 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 The updated task name. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Priority The updated priority value. Type: Integer Valid Range: Minimum value of 0. ServiceRoleArn 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. Response Elements API Version 2014-11-06 823 AWS Systems Manager API Reference 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 in the in the AWS Systems Manager User Guide. Type: String Targets The updated target values. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. TaskArn The updated task ARN value. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. TaskInvocationParameters The updated parameter values. Type: MaintenanceWindowTaskInvocationParameters object TaskParameters The updated parameter values. Note 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. Type: String to MaintenanceWindowTaskParameterValueExpression object map Response Elements API Version 2014-11-06 824 AWS Systems Manager API Reference Key Length Constraints: Minimum length of 1. Maximum length of 255. WindowId The ID of the maintenance window that was updated. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ WindowTaskId 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 For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID speciﬁed 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 in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Errors API Version 2014-11-06 825 AWS Systems Manager Examples Example API Reference This example illustrates one usage of UpdateMaintenanceWindowTask. Sample Request 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 { "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": [ Examples API Version 2014-11-06 826 API Reference AWS Systems Manager { "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 For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2014-11-06 827 AWS Systems Manager • AWS SDK for Python •
systems-manager-api-156	systems-manager-api.pdf	156	"Parameters": { "Operation": [ "Install" ], "SnapshotId": [ "" ] }, "TimeoutSeconds": 600 } }, "TaskParameters": {}, "WindowId": "mw-0c50858d01EXAMPLE", "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2014-11-06 827 AWS Systems Manager • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 828 AWS Systems Manager API Reference UpdateManagedInstanceRole 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 ﬁrst assigned to these hybrid nodes during the activation process. For more information, see CreateActivation. Request Syntax { "IamRole": "string", "InstanceId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. IamRole 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 in the AWS Systems Manager User Guide. Note 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 The ID of the managed node where you want to update the role. UpdateManagedInstanceRole API Version 2014-11-06 829 AWS Systems Manager Type: String API Reference 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 If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. 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 Example This example illustrates one usage of UpdateManagedInstanceRole. Response Elements API Version 2014-11-06 830 AWS Systems Manager Sample Request API Reference 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 {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 831 AWS Systems Manager API Reference See Also API Version 2014-11-06 832 AWS Systems Manager UpdateOpsItem API Reference 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 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 in the AWS Systems Manager User Guide. Request Syntax { "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", UpdateOpsItem API Version 2014-11-06 833 AWS Systems Manager "Title": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ActualEndTime The time a runbook workﬂow ended. Currently reported only for the OpsItem type /aws/ changerequest. Type: Timestamp Required: No ActualStartTime The time a runbook workﬂow started. Currently reported only for the OpsItem type /aws/ changerequest. Type: Timestamp
systems-manager-api-157	systems-manager-api.pdf	157	[ "string" ], "OpsItemArn": "string", "OpsItemId": "string", "PlannedEndTime": number, "PlannedStartTime": number, "Priority": number, "RelatedOpsItems": [ { "OpsItemId": "string" } ], "Severity": "string", "Status": "string", UpdateOpsItem API Version 2014-11-06 833 AWS Systems Manager "Title": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ActualEndTime The time a runbook workﬂow ended. Currently reported only for the OpsItem type /aws/ changerequest. Type: Timestamp Required: No ActualStartTime The time a runbook workﬂow started. Currently reported only for the OpsItem type /aws/ changerequest. Type: Timestamp Required: No Category Specify a new category for an OpsItem. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^(?!\s$).+ Required: No Description User-deﬁned text that contains information about the OpsItem, in Markdown format. Type: String Request Parameters API Version 2014-11-06 834 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\s\S]\S[\s\S]* Required: No Notiﬁcations The Amazon Resource Name (ARN) of an SNS topic where notiﬁcations are sent when this OpsItem is edited or changed. Type: Array of OpsItemNotiﬁcation objects Required: No OperationalData 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 ﬁles, 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. Important 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 operation) can view and search on the speciﬁed data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem 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 in the AWS Systems Manager User Guide. Request Parameters API Version 2014-11-06 835 AWS Systems Manager API Reference Type: String to OpsItemDataValue object map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!\s$).+ Required: No OperationalDataToDelete Keys that you want to remove from the OperationalData map. Type: Array of strings Required: No OpsItemArn 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 The ID of the OpsItem. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Required: Yes PlannedEndTime The time speciﬁed in a change request for a runbook workﬂow to end. Currently supported only for the OpsItem type /aws/changerequest. Type: Timestamp Required: No Request Parameters API Version 2014-11-06 836 AWS Systems Manager PlannedStartTime API Reference The time speciﬁed in a change request for a runbook workﬂow to start. Currently supported only for the OpsItem type /aws/changerequest. Type: Timestamp Required: No Priority 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 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 objects Required: No Severity Specify a new severity for an OpsItem. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^(?!\s$).+ Required: No Status The OpsItem status. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide. Request Parameters API Version 2014-11-06 837 AWS Systems Manager Type: String API Reference 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 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 If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 OpsItemAccessDeniedException You don't have permission
systems-manager-api-158	systems-manager-api.pdf	158	PendingChangeCalendarOverride \| ChangeCalendarOverrideApproved \| ChangeCalendarOverrideRejected \| PendingApproval \| Approved \| Revoked \| Rejected \| Closed Required: No Title 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 If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 OpsItemAccessDeniedException You don't have permission to view OpsItems in the speciﬁed account. Verify that your account is conﬁgured either as a Systems Manager delegated administrator or that you are logged into the AWS Organizations management account. HTTP Status Code: 400 Response Elements API Version 2014-11-06 838 AWS Systems Manager OpsItemAlreadyExistsException The OpsItem already exists. HTTP Status Code: 400 OpsItemConﬂictException API Reference The speciﬁed OpsItem is in the process of being deleted. HTTP Status Code: 400 OpsItemInvalidParameterException A speciﬁed 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 speciﬁed OpsItem ID doesn't exist. Verify the ID and try again. HTTP Status Code: 400 Examples Example This example illustrates one usage of UpdateOpsItem. Sample Request 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 Examples API Version 2014-11-06 839 AWS Systems Manager API Reference 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 {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 840 AWS Systems Manager API Reference UpdateOpsMetadata AWS Systems Manager calls this API operation when you edit OpsMetadata in Application Manager. Request Syntax { "KeysToDelete": [ "string" ], "MetadataToUpdate": { "string" : { "Value": "string" } }, "OpsMetadataArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. KeysToDelete 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 Metadata to add to an OpsMetadata object. Type: String to MetadataValue object map Map Entries: Maximum number of 5 items. UpdateOpsMetadata API Version 2014-11-06 841 AWS Systems Manager API Reference Key Length Constraints: Minimum length of 1. Maximum length of 256. Key Pattern: ^(?!\s$).+ Required: No OpsMetadataArn 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 { "OpsMetadataArn": "string" } Response Elements 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 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-_\.\/]*) Response Syntax API Version 2014-11-06 842 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. 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 For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2014-11-06 843 AWS Systems Manager • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 844 AWS Systems Manager API Reference UpdatePatchBaseline Modiﬁes an existing
systems-manager-api-159	systems-manager-api.pdf	159	400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2014-11-06 843 AWS Systems Manager • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 844 AWS Systems Manager API Reference UpdatePatchBaseline Modiﬁes an existing patch baseline. Fields not speciﬁed in the request are left unchanged. Note For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter. Request Syntax { "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" ] UpdatePatchBaseline API Version 2014-11-06 845 API Reference AWS Systems Manager } ] }, "Name": "string", "RejectedPatches": [ "string" ], "RejectedPatchesAction": "string", "Replace": boolean, "Sources": [ { "Configuration": "string", "Name": "string", "Products": [ "string" ] } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ApprovalRules A set of rules used to include patches in the baseline. Type: PatchRuleGroup object Required: No ApprovedPatches 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 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. Request Parameters API Version 2014-11-06 846 AWS Systems Manager Required: No ApprovedPatchesComplianceLevel API Reference Assigns a new compliance severity level to an existing patch baseline. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| INFORMATIONAL \| UNSPECIFIED Required: No ApprovedPatchesEnableNonSecurity 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 Indicates the status to be assigned to security patches that are available but not approved because they don't meet the installation criteria speciﬁed in the patch baseline. Example scenario: Security patches that you might want installed can be skipped if you have speciﬁed a long period to wait after a patch is released before installation. If an update to the patch is released during your speciﬁed 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 The ID of the patch baseline to update. Request Parameters API Version 2014-11-06 847 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Required: Yes Description A description of the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No GlobalFilters A set of global ﬁlters used to include patches in the baseline. Important The GlobalFilters parameter can be conﬁgured only by using the AWS CLI or an AWS SDK. It can't be conﬁgured from the Patch Manager console, and its value isn't displayed in the console. Type: PatchFilterGroup object Required: No Name 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 Request Parameters API Version 2014-11-06 848 AWS Systems Manager RejectedPatches API Reference 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 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 The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOW_AS_DEPENDENCY 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 speciﬁed. Windows Server: Windows Server doesn't support the concept
systems-manager-api-160	systems-manager-api.pdf	160	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 The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOW_AS_DEPENDENCY 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 speciﬁed. 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 speciﬁed. 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. 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. Type: String Valid Values: ALLOW_AS_DEPENDENCY \| BLOCK Required: No Request Parameters API Version 2014-11-06 849 AWS Systems Manager Replace API Reference If True, then all ﬁelds that are required by the CreatePatchBaseline operation are also required for this API request. Optional ﬁelds that aren't speciﬁed are set to null. Type: Boolean Required: No Sources 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 objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No Response Syntax { "ApprovalRules": { "PatchRules": [ { "ApproveAfterDays": number, "ApproveUntilDate": "string", "ComplianceLevel": "string", "EnableNonSecurity": boolean, "PatchFilterGroup": { "PatchFilters": [ { "Key": "string", "Values": [ "string" ] } ] } } ] }, "ApprovedPatches": [ "string" ], "ApprovedPatchesComplianceLevel": "string", Response Syntax API Version 2014-11-06 850 AWS Systems Manager API Reference "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 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 A set of rules used to include patches in the baseline. Type: PatchRuleGroup object ApprovedPatches A list of explicitly approved patches for the baseline. Type: Array of strings Response Elements API Version 2014-11-06 851 AWS Systems Manager API Reference Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 100. ApprovedPatchesComplianceLevel The compliance severity level assigned to the patch baseline after the update completed. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| INFORMATIONAL \| UNSPECIFIED ApprovedPatchesEnableNonSecurity 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 Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. This preference is speciﬁed when the CreatePatchBaseline or UpdatePatchBaseline commands are run. Applies to Windows Server managed nodes only. Type: String Valid Values: COMPLIANT \| NON_COMPLIANT BaselineId 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 The date when the patch baseline was created. Response Elements API Version 2014-11-06 852 API Reference AWS Systems Manager Type: Timestamp Description A description of the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. GlobalFilters A set of global ﬁlters used to exclude patches from the baseline. Type: PatchFilterGroup object ModiﬁedDate The date when the patch baseline was last modiﬁed. Type: Timestamp Name 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 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 A list of explicitly rejected patches for the baseline. Response Elements API Version 2014-11-06 853 AWS Systems Manager Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 100. RejectedPatchesAction The action speciﬁed
systems-manager-api-161	systems-manager-api.pdf	161	length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ OperatingSystem 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 A list of explicitly rejected patches for the baseline. Response Elements API Version 2014-11-06 853 AWS Systems Manager Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 100. RejectedPatchesAction The action speciﬁed 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 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 objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Errors For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID speciﬁed 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 in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Errors API Version 2014-11-06 854 API Reference AWS Systems Manager Examples Example This example illustrates one usage of UpdatePatchBaseline. Sample Request 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" } Examples API Version 2014-11-06 855 AWS Systems Manager API Reference ] }, "ApproveAfterDays": 3 } ] }, "BaselineId": "pb-0c10e65780EXAMPLE" } Sample Response { "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", Examples API Version 2014-11-06 856 AWS Systems Manager API Reference "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 For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 857 AWS Systems Manager API Reference UpdateResourceDataSync 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 ﬁrst 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 { "SyncName": "string", "SyncSource": { "AwsOrganizationsSource": { "OrganizationalUnits": [ { "OrganizationalUnitId": "string" } ], "OrganizationSourceType": "string" }, "EnableAllOpsDataSources": boolean, "IncludeFutureRegions": boolean, "SourceRegions": [ "string" ], "SourceType": "string" }, "SyncType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. UpdateResourceDataSync API Version 2014-11-06 858 AWS Systems Manager SyncName API Reference 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 Specify information about the data sources to synchronize. Type: ResourceDataSyncSource object Required: Yes SyncType 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 If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server
systems-manager-api-162	systems-manager-api.pdf	162	you want to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes SyncSource Specify information about the data sources to synchronize. Type: ResourceDataSyncSource object Required: Yes SyncType 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 If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 ResourceDataSyncConﬂictException Another UpdateResourceDataSync request is being processed. Wait a few minutes and try again. Response Elements API Version 2014-11-06 859 API Reference AWS Systems Manager HTTP Status Code: 400 ResourceDataSyncInvalidConﬁgurationException The speciﬁed sync conﬁguration is invalid. HTTP Status Code: 400 ResourceDataSyncNotFoundException The speciﬁed sync name wasn't found. HTTP Status Code: 400 Examples Example This example illustrates one usage of UpdateResourceDataSync. Sample Request 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" ] } Examples API Version 2014-11-06 860 AWS Systems Manager } Sample Response {} See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 861 AWS Systems Manager API Reference UpdateServiceSetting ServiceSetting is an account-level setting for an AWS service. This setting deﬁnes 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 deﬁne 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 operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value deﬁned by the AWS service team. Update the service setting for the account. Request Syntax { "SettingId": "string", "SettingValue": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SettingId 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 UpdateServiceSetting API Version 2014-11-06 862 AWS Systems Manager API Reference • /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 Note 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 conﬁgure or modify the Default Host Management Conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: Yes SettingValue The new value to specify for the service setting. The following list speciﬁes 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. Request Parameters API Version 2014-11-06 863 AWS Systems Manager API Reference • 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 If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 ServiceSettingNotFound The speciﬁed 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.
systems-manager-api-163	systems-manager-api.pdf	163	Length Constraints: Minimum length of 1. Maximum length of 4096. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 ServiceSettingNotFound The speciﬁed 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 Example This example illustrates one usage of UpdateServiceSetting. Response Elements API Version 2014-11-06 864 AWS Systems Manager Sample Request 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 API Reference 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 {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2014-11-06 865 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 866 AWS Systems Manager Data Types API Reference The AWS Systems Manager API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AccountSharingInfo • Activation • Alarm • AlarmConﬁguration • AlarmStateInformation • Association • AssociationDescription • AssociationExecution • AssociationExecutionFilter • AssociationExecutionTarget • AssociationExecutionTargetsFilter • AssociationFilter • AssociationOverview • AssociationStatus • AssociationVersionInfo • AttachmentContent • AttachmentInformation • AttachmentsSource • AutomationExecution • AutomationExecutionFilter API Version 2014-11-06 867 AWS Systems Manager • AutomationExecutionInputs • AutomationExecutionMetadata • AutomationExecutionPreview • BaselineOverride • CloudWatchOutputConﬁg • Command • CommandFilter • CommandInvocation • CommandPlugin • ComplianceExecutionSummary • ComplianceItem • ComplianceItemEntry • ComplianceStringFilter • ComplianceSummaryItem • CompliantSummary • CreateAssociationBatchRequestEntry • Credentials • DescribeActivationsFilter • DocumentDefaultVersionDescription • DocumentDescription • DocumentFilter • DocumentIdentiﬁer • DocumentKeyValuesFilter • DocumentMetadataResponseInfo • DocumentParameter • DocumentRequires • DocumentReviewCommentSource • DocumentReviewerResponseSource • DocumentReviews • DocumentVersionInfo API Reference API Version 2014-11-06 868 AWS Systems Manager • EﬀectivePatch • ExecutionInputs • ExecutionPreview • FailedCreateAssociation • FailureDetails • GetResourcePoliciesResponseEntry • InstanceAggregatedAssociationOverview • InstanceAssociation • InstanceAssociationOutputLocation • InstanceAssociationOutputUrl • InstanceAssociationStatusInfo • InstanceInfo • InstanceInformation • InstanceInformationFilter • InstanceInformationStringFilter • InstancePatchState • InstancePatchStateFilter • InstanceProperty • InstancePropertyFilter • InstancePropertyStringFilter • InventoryAggregator • InventoryDeletionStatusItem • InventoryDeletionSummary • InventoryDeletionSummaryItem • InventoryFilter • InventoryGroup • InventoryItem • InventoryItemAttribute • InventoryItemSchema • InventoryResultEntity API Reference API Version 2014-11-06 869 AWS Systems Manager • InventoryResultItem • LoggingInfo • MaintenanceWindowAutomationParameters • MaintenanceWindowExecution • MaintenanceWindowExecutionTaskIdentity • MaintenanceWindowExecutionTaskInvocationIdentity • MaintenanceWindowFilter • MaintenanceWindowIdentity • MaintenanceWindowIdentityForTarget • MaintenanceWindowLambdaParameters • MaintenanceWindowRunCommandParameters • MaintenanceWindowStepFunctionsParameters • MaintenanceWindowTarget • MaintenanceWindowTask • MaintenanceWindowTaskInvocationParameters • MaintenanceWindowTaskParameterValueExpression • MetadataValue • Node • NodeAggregator • NodeFilter • NodeOwnerInfo • NodeType • NonCompliantSummary • NotiﬁcationConﬁg • OpsAggregator • OpsEntity • OpsEntityItem • OpsFilter • OpsItem • OpsItemDataValue API Reference API Version 2014-11-06 870 AWS Systems Manager • OpsItemEventFilter • OpsItemEventSummary • OpsItemFilter • OpsItemIdentity • OpsItemNotiﬁcation • OpsItemRelatedItemsFilter • OpsItemRelatedItemSummary • OpsItemSummary • OpsMetadata • OpsMetadataFilter • OpsResultAttribute • OutputSource • Parameter • ParameterHistory • ParameterInlinePolicy • ParameterMetadata • ParametersFilter • ParameterStringFilter • ParentStepDetails • Patch • PatchBaselineIdentity • PatchComplianceData • PatchFilter • PatchFilterGroup • PatchGroupPatchBaselineMapping • PatchOrchestratorFilter • PatchRule • PatchRuleGroup • PatchSource • PatchStatus API Reference API Version 2014-11-06 871 AWS Systems Manager • ProgressCounters • RegistrationMetadataItem • RelatedOpsItem • ResolvedTargets • ResourceComplianceSummaryItem • ResourceDataSyncAwsOrganizationsSource • ResourceDataSyncDestinationDataSharing • ResourceDataSyncItem • ResourceDataSyncOrganizationalUnit • ResourceDataSyncS3Destination • ResourceDataSyncSource • ResourceDataSyncSourceWithState • ResultAttribute • ReviewInformation • Runbook • S3OutputLocation • S3OutputUrl • ScheduledWindowExecution • ServiceSetting • Session • SessionFilter • SessionManagerOutputUrl • SeveritySummary • StepExecution • StepExecutionFilter • Tag • Target • TargetLocation • TargetPreview API Reference API Version 2014-11-06 872 AWS Systems Manager AccountSharingInfo API Reference Information includes the AWS account ID where the current document is shared and the version shared with that account. Contents AccountId The AWS account ID where the current document is shared. Type: String Pattern: (?i)all\|[0-9]{12} Required: No SharedDocumentVersion The version of the current document shared with the account. Type: String Length Constraints: Maximum length of 8. Pattern: ([$]LATEST\|[$]DEFAULT\|[$]ALL) Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AccountSharingInfo API Version
systems-manager-api-164	systems-manager-api.pdf	164	Reference Information includes the AWS account ID where the current document is shared and the version shared with that account. Contents AccountId The AWS account ID where the current document is shared. Type: String Pattern: (?i)all\|[0-9]{12} Required: No SharedDocumentVersion The version of the current document shared with the account. Type: String Length Constraints: Maximum length of 8. Pattern: ([$]LATEST\|[$]DEFAULT\|[$]ALL) Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AccountSharingInfo API Version 2014-11-06 873 AWS Systems Manager Activation API Reference An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can conﬁgure those servers or VMs using Run Command. A server or VM that has been registered with AWS Systems Manager is called a managed node. Contents ActivationId The ID created by Systems Manager when you submitted the activation. Type: String Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ Required: No CreatedDate The date the activation was created. Type: Timestamp Required: No DefaultInstanceName A name for the managed node when it is created. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Required: No Description A user deﬁned description of the activation. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Activation API Version 2014-11-06 874 AWS Systems Manager Required: No ExpirationDate API Reference The date when this activation can no longer be used to register managed nodes. Type: Timestamp Required: No Expired Whether or not the activation is expired. Type: Boolean Required: No IamRole The AWS Identity and Access Management (IAM) role to assign to the managed node. Type: String Length Constraints: Maximum length of 64. Required: No RegistrationLimit The maximum number of managed nodes that can be registered using this activation. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No RegistrationsCount The number of managed nodes already registered with this activation. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No Contents API Version 2014-11-06 875 API Reference AWS Systems Manager Tags Tags assigned to the activation. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 876 AWS Systems Manager Alarm A CloudWatch alarm you apply to an automation or command. API Reference Contents Name The name of your CloudWatch alarm. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^(?!\s$).+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Alarm API Version 2014-11-06 877 AWS Systems Manager AlarmConﬁguration API Reference The details for the CloudWatch alarm you want to apply to an automation or command. Contents Alarms The name of the CloudWatch alarm speciﬁed in the conﬁguration. Type: Array of Alarm objects Array Members: Fixed number of 1 item. Required: Yes IgnorePollAlarmFailure When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AlarmConﬁguration API Version 2014-11-06 878 AWS Systems Manager API Reference AlarmStateInformation The details about the state of your CloudWatch alarm. Contents Name The name of your CloudWatch alarm. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^(?!\s*$).+ Required: Yes State The state of your CloudWatch alarm. Type: String Valid Values: UNKNOWN \| ALARM Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AlarmStateInformation API Version 2014-11-06 879 AWS Systems Manager Association API Reference Describes an association of a AWS Systems Manager document (SSM document) and a managed node. Contents AssociationId The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule. 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 AssociationName The
systems-manager-api-165	systems-manager-api.pdf	165	See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AlarmStateInformation API Version 2014-11-06 879 AWS Systems Manager Association API Reference Describes an association of a AWS Systems Manager document (SSM document) and a managed node. Contents AssociationId The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule. 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 AssociationName The association name. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No AssociationVersion The association version. Type: String Pattern: ([$]LATEST)\|([1-9][0-9]) Required: No DocumentVersion The version of the document used in the association. 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. Association API Version 2014-11-06 880 AWS Systems Manager API Reference Important 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 The number of hours that an association can run on speciﬁed targets. After the resulting cutoﬀ time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Required: No InstanceId The managed node ID. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) Required: No LastExecutionDate The date on which the association was last run. Type: Timestamp Contents API Version 2014-11-06 881 API Reference AWS Systems Manager Required: No Name The name of the SSM document. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: No Overview Information about the association. Type: AssociationOverview object Required: No ScheduleExpression A cron expression that speciﬁes a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No ScheduleOﬀset Number of days to wait after the scheduled day to run an association. Type: Integer Valid Range: Minimum value of 1. Maximum value of 6. Required: No TargetMaps A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be speciﬁed together. Type: Array of string to array of strings maps Contents API Version 2014-11-06 882 AWS Systems Manager API Reference 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 The managed nodes targeted by the request to create an association. You can target all managed nodes in an AWS account by specifying the InstanceIds key with a value of . Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 883 AWS Systems Manager API Reference AssociationDescription Describes the parameters for a document. Contents AlarmConﬁguration The details for the CloudWatch alarm you want to apply to an automation or command. Type: AlarmConﬁguration object Required: No ApplyOnlyAtCronInterval By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you speciﬁed. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions. Type: Boolean Required: No AssociationId The association ID. 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 AssociationName The association name. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ AssociationDescription API Version 2014-11-06 884 API Reference AWS Systems Manager Required: No AssociationVersion The association version. Type: String Pattern: ([$]LATEST)\|([1-9][0-9]) Required: No AutomationTargetParameterName Choose the parameter that will deﬁne 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 The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations
systems-manager-api-166	systems-manager-api.pdf	166	Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ AssociationDescription API Version 2014-11-06 884 API Reference AWS Systems Manager Required: No AssociationVersion The association version. Type: String Pattern: ([$]LATEST)\|([1-9][0-9]) Required: No AutomationTargetParameterName Choose the parameter that will deﬁne 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 The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide. Type: Array of strings Required: No ComplianceSeverity The severity level that is assigned to the association. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| UNSPECIFIED Required: No Contents API Version 2014-11-06 885 API Reference AWS Systems Manager Date The date when the association was made. Type: Timestamp Required: No DocumentVersion The document version. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No Duration The number of hours that an association can run on speciﬁed targets. After the resulting cutoﬀ time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Required: No InstanceId The managed node ID. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) Required: No LastExecutionDate The date on which the association was last run. Type: Timestamp Required: No Contents API Version 2014-11-06 886 AWS Systems Manager LastSuccessfulExecutionDate The last date on which the association was successfully run. API Reference Type: Timestamp Required: No LastUpdateAssociationDate The date when the association was last updated. Type: Timestamp Required: No MaxConcurrency 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 speciﬁed 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 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 ﬁrst 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. Contents API Version 2014-11-06 887 AWS Systems Manager API Reference 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 The name of the SSM document. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: No OutputLocation An S3 bucket where you want to store the output details of the request. Type: InstanceAssociationOutputLocation object Required: No Overview Information about the association. Type: AssociationOverview object Required: No Parameters A description of the parameters for a document. Type: String to array of strings map Required: No Contents API Version 2014-11-06 888 AWS Systems Manager ScheduleExpression API Reference A cron expression that speciﬁes a schedule when the association runs. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No ScheduleOﬀset Number of days to wait after the scheduled day to run an association. Type: Integer Valid Range: Minimum value of 1. Maximum value of 6. Required: No Status The association status. Type: AssociationStatus object Required: No SyncCompliance 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 operation. In this case, compliance data isn't managed by State Manager, a
systems-manager-api-167	systems-manager-api.pdf	167	Valid Range: Minimum value of 1. Maximum value of 6. Required: No Status The association status. Type: AssociationStatus object Required: No SyncCompliance 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 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 operation. By default, all associations use AUTO mode. Type: String Valid Values: AUTO \| MANUAL Contents API Version 2014-11-06 889 AWS Systems Manager Required: No TargetLocations API Reference The combination of AWS Regions and AWS accounts where you want to run the association. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetMaps A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be speciﬁed 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 The managed nodes targeted by the request. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No TriggeredAlarms The CloudWatch alarm that was invoked during the association. Type: Array of AlarmStateInformation objects Contents API Version 2014-11-06 890 AWS Systems Manager API Reference Array Members: Fixed number of 1 item. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 891 AWS Systems Manager API Reference AssociationExecution Includes information about the speciﬁed association. Contents AlarmConﬁguration The details for the CloudWatch alarm you want to apply to an automation or command. Type: AlarmConﬁguration object Required: No AssociationId The association ID. 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 The association version. Type: String Pattern: ([$]LATEST)\|([1-9][0-9]) Required: No CreatedTime The time the execution started. Type: Timestamp Required: No DetailedStatus Detailed status information about the execution. AssociationExecution API Version 2014-11-06 892 AWS Systems Manager Type: String Required: No ExecutionId The execution ID for the association. Type: String API Reference 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 LastExecutionDate The date of the last execution. Type: Timestamp Required: No ResourceCountByStatus An aggregate status of the resources in the execution based on the status type. Type: String Required: No Status The status of the association execution. Type: String Required: No TriggeredAlarms The CloudWatch alarms that were invoked by the association. Type: Array of AlarmStateInformation objects Array Members: Fixed number of 1 item. Contents API Version 2014-11-06 893 AWS Systems Manager Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 894 AWS Systems Manager API Reference AssociationExecutionFilter Filters used in the request. Contents Key The key value used in the request. Type: String Valid Values: ExecutionId \| Status \| CreatedTime Required: Yes Type The ﬁlter type speciﬁed in the request. Type: String Valid Values: EQUAL \| LESS_THAN \| GREATER_THAN Required: Yes Value The value speciﬁed for the key. Type: String Length Constraints: Minimum length of 1. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 AssociationExecutionFilter API Version 2014-11-06 895 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 896 AWS Systems Manager API Reference AssociationExecutionTarget Includes information about the speciﬁed association execution. Contents AssociationId The association ID. 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 The association version. Type: String Pattern: ([$]LATEST)\|([1-9][0-9]) Required: No DetailedStatus Detailed information about the execution status. Type: String Required: No ExecutionId The execution ID. 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} AssociationExecutionTarget API Version 2014-11-06 897 API Reference AWS Systems Manager Required: No LastExecutionDate The date of the last execution. Type: Timestamp Required: No OutputSource The location where the association details are saved. Type: OutputSource object Required: No ResourceId The resource ID, for example, the managed node ID
systems-manager-api-168	systems-manager-api.pdf	168	Manager API Reference AssociationExecutionTarget Includes information about the speciﬁed association execution. Contents AssociationId The association ID. 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 The association version. Type: String Pattern: ([$]LATEST)\|([1-9][0-9]) Required: No DetailedStatus Detailed information about the execution status. Type: String Required: No ExecutionId The execution ID. 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} AssociationExecutionTarget API Version 2014-11-06 897 API Reference AWS Systems Manager Required: No LastExecutionDate The date of the last execution. Type: Timestamp Required: No OutputSource The location where the association details are saved. Type: OutputSource object Required: No ResourceId The resource ID, for example, the managed node ID where the association ran. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No ResourceType The resource type, for example, EC2. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Required: No Status The association execution status. Type: String Required: No Contents API Version 2014-11-06 898 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 899 AWS Systems Manager API Reference AssociationExecutionTargetsFilter Filters for the association execution. Contents Key The key value used in the request. Type: String Valid Values: Status \| ResourceId \| ResourceType Required: Yes Value The value speciﬁed for the key. Type: String Length Constraints: Minimum length of 1. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AssociationExecutionTargetsFilter API Version 2014-11-06 900 API Reference AWS Systems Manager AssociationFilter Describes a ﬁlter. Contents key The name of the ﬁlter. Note InstanceId has been deprecated. Type: String Valid Values: InstanceId \| Name \| AssociationId \| AssociationStatusName \| LastExecutedBefore \| LastExecutedAfter \| AssociationName \| ResourceGroupName Required: Yes value The ﬁlter value. Type: String Length Constraints: Minimum length of 1. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 AssociationFilter API Version 2014-11-06 901 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 902 AWS Systems Manager API Reference AssociationOverview Information about the association. Contents AssociationStatusAggregatedCount Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status. Type: String to integer map Required: No DetailedStatus A detailed status of the association. Type: String Required: No Status The status of the association. Status can be: Pending, Success, or Failed. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AssociationOverview API Version 2014-11-06 903 API Reference AWS Systems Manager AssociationStatus Describes an association status. Contents Date The date when the status changed. Type: Timestamp Required: Yes Message The reason for the status. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes Name The status. Type: String Valid Values: Pending \| Success \| Failed Required: Yes AdditionalInfo A user-deﬁned string. Type: String Length Constraints: Maximum length of 1024. Required: No AssociationStatus API Version 2014-11-06 904 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 905 AWS Systems Manager API Reference AssociationVersionInfo Information about the association version. Contents ApplyOnlyAtCronInterval By default, when you create new associations, the system runs it immediately after it is created and then according to the schedule you speciﬁed. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions. Type: Boolean Required: No AssociationId The ID created by the system when the association was created. 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 AssociationName The name speciﬁed for the association version when the association version was created. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No AssociationVersion The association version. Type: String Pattern: ([$]LATEST)\|([1-9][0-9]) AssociationVersionInfo API Version 2014-11-06 906 AWS Systems Manager Required: No CalendarNames API Reference The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more
systems-manager-api-169	systems-manager-api.pdf	169	for rate expressions. Type: Boolean Required: No AssociationId The ID created by the system when the association was created. 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 AssociationName The name speciﬁed for the association version when the association version was created. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No AssociationVersion The association version. Type: String Pattern: ([$]LATEST)\|([1-9][0-9]) AssociationVersionInfo API Version 2014-11-06 906 AWS Systems Manager Required: No CalendarNames API Reference The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide. Type: Array of strings Required: No ComplianceSeverity The severity level that is assigned to the association. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| UNSPECIFIED Required: No CreatedDate The date the association version was created. Type: Timestamp Required: No DocumentVersion The version of an AWS Systems Manager document (SSM document) used when the association version was created. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No Duration The number of hours that an association can run on speciﬁed targets. After the resulting cutoﬀ time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets. Contents API Version 2014-11-06 907 AWS Systems Manager Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Required: No MaxConcurrency API Reference 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 speciﬁed 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 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 ﬁrst 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. Contents API Version 2014-11-06 908 AWS Systems Manager API Reference Pattern: ^([1-9][0-9]\|[0]\|[1-9][0-9]%\|[0-9]%\|100%)$ Required: No Name The name speciﬁed when the association was created. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: No OutputLocation The location in Amazon S3 speciﬁed for the association when the association version was created. Type: InstanceAssociationOutputLocation object Required: No Parameters Parameters speciﬁed when the association version was created. Type: String to array of strings map Required: No ScheduleExpression The cron or rate schedule speciﬁed for the association when the association version was created. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No ScheduleOﬀset Number of days to wait after the scheduled day to run an association. Type: Integer Contents API Version 2014-11-06 909 AWS Systems Manager API Reference Valid Range: Minimum value of 1. Maximum value of 6. Required: No SyncCompliance 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 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 operation. By default, all associations use AUTO mode. Type: String Valid Values: AUTO \| MANUAL Required: No TargetLocations The combination of AWS Regions and AWS accounts where you wanted to run the association when this association version was created. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100
systems-manager-api-170	systems-manager-api.pdf	170	is NON-COMPLIANT. In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems 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 operation. By default, all associations use AUTO mode. Type: String Valid Values: AUTO \| MANUAL Required: No TargetLocations The combination of AWS Regions and AWS accounts where you wanted to run the association when this association version was created. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetMaps A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be speciﬁed 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. Contents API Version 2014-11-06 910 AWS Systems Manager API Reference 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 The targets speciﬁed for the association when the association version was created. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 911 AWS Systems Manager AttachmentContent API Reference A structure that includes attributes that describe a document attachment. Contents Hash The cryptographic hash value of the document content. Type: String Length Constraints: Maximum length of 256. Required: No HashType The hash algorithm used to calculate the hash value. Type: String Valid Values: Sha256 Required: No Name The name of an attachment. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No Size The size of an attachment in bytes. Type: Long Required: No Url The URL location of the attachment content. AttachmentContent API Version 2014-11-06 912 AWS Systems Manager Type: String Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 913 AWS Systems Manager API Reference AttachmentInformation An attribute of an attachment, such as the attachment name. Contents Name The name of the attachment. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AttachmentInformation API Version 2014-11-06 914 AWS Systems Manager AttachmentsSource API Reference Identifying information about a document attachment, including the ﬁle name and a key-value pair that identiﬁes the location of an attachment to a document. Contents Key The key of a key-value pair that identiﬁes the location of an attachment to a document. Type: String Valid Values: SourceUrl \| S3FileUrl \| AttachmentReference Required: No Name The name of the document attachment ﬁle. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No Values The value of a key-value pair that identiﬁes the location of an attachment to a document. The format for Value depends on the type of key you specify. • For the key SourceUrl, the value is an S3 bucket location. For example: "Values": [ "s3://amzn-s3-demo-bucket/my-prefix" ] • For the key S3FileUrl, the value is a ﬁle in an S3 bucket. For example: "Values": [ "s3://amzn-s3-demo-bucket/my-prefix/my-file.py" ] • For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a ﬁle attached to that document version that you want to reuse. For example: "Values": [ "MyOtherDocument/3/my-other-file.py" ] AttachmentsSource API Version 2014-11-06 915 AWS Systems Manager API Reference However, if the SSM document is shared with you from another account, the full SSM document ARN must be speciﬁed instead of the document name only. For example: "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/ OtherAccountDocument/3/their-file.py" ] Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 916 AWS Systems Manager API Reference AutomationExecution Detailed information about the current state of an individual Automation execution. Contents AlarmConﬁguration The details for the CloudWatch alarm applied to your automation.
systems-manager-api-171	systems-manager-api.pdf	171	example: "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/ OtherAccountDocument/3/their-file.py" ] Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 916 AWS Systems Manager API Reference AutomationExecution Detailed information about the current state of an individual Automation execution. Contents AlarmConﬁguration The details for the CloudWatch alarm applied to your automation. Type: AlarmConﬁguration object Required: No AssociationId The ID of a State Manager association used in the Automation operation. Type: String Required: No AutomationExecutionId The execution ID. Type: String Length Constraints: Fixed length of 36. Required: No AutomationExecutionStatus The execution status of the Automation. Type: String Valid Values: Pending \| InProgress \| Waiting \| Success \| TimedOut \| Cancelling \| Cancelled \| Failed \| PendingApproval \| Approved \| Rejected \| Scheduled \| RunbookInProgress \| PendingChangeCalendarOverride \| ChangeCalendarOverrideApproved \| ChangeCalendarOverrideRejected \| CompletedWithSuccess \| CompletedWithFailure \| Exited AutomationExecution API Version 2014-11-06 917 AWS Systems Manager Required: No AutomationSubtype API Reference The subtype of the Automation operation. Currently, the only supported value is ChangeRequest. Type: String Valid Values: ChangeRequest \| AccessRequest Required: No ChangeRequestName The name of the Change Manager change request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No CurrentAction The action of the step that is currently running. Type: String Required: No CurrentStepName The name of the step that is currently running. Type: String Required: No DocumentName The name of the Automation runbook used during the execution. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Contents API Version 2014-11-06 918 AWS Systems Manager Required: No DocumentVersion API Reference The version of the document to use during execution. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No ExecutedBy The Amazon Resource Name (ARN) of the user who ran the automation. Type: String Required: No ExecutionEndTime The time the execution ﬁnished. Type: Timestamp Required: No ExecutionStartTime The time the execution started. Type: Timestamp Required: No FailureMessage A message describing why an execution has failed, if the status is set to Failed. Type: String Required: No MaxConcurrency The MaxConcurrency value speciﬁed by the user when the execution started. Contents API Version 2014-11-06 919 AWS Systems Manager Type: String API Reference 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 The MaxErrors value speciﬁed by the user when the execution started. 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 The automation execution mode. Type: String Valid Values: Auto \| Interactive Required: No OpsItemId The ID of an OpsItem that is created to represent a Change Manager change request. Type: String Required: No Outputs The list of execution outputs as deﬁned 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. Contents API Version 2014-11-06 920 AWS Systems Manager API Reference Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 512. Required: No Parameters The key-value map of execution parameters, which were supplied when calling StartAutomationExecution. 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 ParentAutomationExecutionId The AutomationExecutionId of the parent automation. Type: String Length Constraints: Fixed length of 36. Required: No ProgressCounters An aggregate of step execution statuses displayed in the AWS Systems Manager console for a multi-Region and multi-account Automation execution. Type: ProgressCounters object Required: No ResolvedTargets A list of resolved targets in the rate control execution. Contents API Version 2014-11-06 921 AWS Systems Manager API Reference Type: ResolvedTargets object Required: No Runbooks Information about the Automation runbooks that are run as part of a runbook workﬂow. Note The Automation runbooks speciﬁed for the runbook workﬂow can't run until all required approvals for the change request have been received. Type: Array of Runbook objects Array Members: Fixed number of 1 item. Required: No ScheduledTime The date and time the Automation operation is scheduled to start. Type: Timestamp Required: No StepExecutions A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order. Type: Array of StepExecution objects Required: No StepExecutionsTruncated A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation
systems-manager-api-172	systems-manager-api.pdf	172	required approvals for the change request have been received. Type: Array of Runbook objects Array Members: Fixed number of 1 item. Required: No ScheduledTime The date and time the Automation operation is scheduled to start. Type: Timestamp Required: No StepExecutions A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order. Type: Array of StepExecution objects Required: No StepExecutionsTruncated A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions. Type: Boolean Contents API Version 2014-11-06 922 AWS Systems Manager Required: No Target The target of the execution. Type: String Required: No TargetLocations API Reference The combination of AWS Regions and/or AWS accounts where you want to run the Automation. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetLocationsURL A publicly accessible URL for a ﬁle that contains the TargetLocations body. Currently, only ﬁles 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 The speciﬁed key-value mapping of document parameters to target resources. 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. Contents API Version 2014-11-06 923 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 50. Required: No TargetParameterName The parameter name. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Required: No Targets The speciﬁed targets. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No TriggeredAlarms The CloudWatch alarm that was invoked by the automation. Type: Array of AlarmStateInformation objects Array Members: Fixed number of 1 item. Required: No Variables Variables deﬁned for the automation. 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. Contents API Version 2014-11-06 924 AWS Systems Manager Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 925 AWS Systems Manager API Reference AutomationExecutionFilter A ﬁlter used to match speciﬁc automation executions. This is used to limit the scope of Automation execution information returned. Contents Key One or more keys to limit the results. Type: String Valid Values: DocumentNamePrefix \| ExecutionStatus \| ExecutionId \| ParentExecutionId \| CurrentAction \| StartTimeBefore \| StartTimeAfter \| AutomationType \| TagKey \| TargetResourceGroup \| AutomationSubtype \| OpsItemId Required: Yes Values The values used to limit the execution information associated with the ﬁlter's key. 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 150. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AutomationExecutionFilter API Version 2014-11-06 926 AWS Systems Manager API Reference See Also API Version 2014-11-06 927 AWS Systems Manager API Reference AutomationExecutionInputs Information about the optional inputs that can be speciﬁed for an automation execution preview. Contents Parameters Information about parameters that can be speciﬁed for the preview operation. 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 TargetLocations Information about the AWS Regions and AWS accounts targeted by the Automation execution preview operation. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetLocationsURL A publicly accessible URL for a ﬁle that contains the TargetLocations body. Currently, only ﬁles 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 AutomationExecutionInputs API Version 2014-11-06 928 AWS Systems Manager TargetMaps API Reference A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be speciﬁed together. Type: Array of string to array of strings maps Array Members: Minimum number
systems-manager-api-173	systems-manager-api.pdf	173	and AWS accounts targeted by the Automation execution preview operation. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetLocationsURL A publicly accessible URL for a ﬁle that contains the TargetLocations body. Currently, only ﬁles 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 AutomationExecutionInputs API Version 2014-11-06 928 AWS Systems Manager TargetMaps API Reference A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be speciﬁed 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 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 Information about the resources that would be included in the actual runbook execution, if it were to be run. Both Targets and TargetMaps can't be speciﬁed together. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2014-11-06 929 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 930 AWS Systems Manager API Reference AutomationExecutionMetadata Details about a speciﬁc Automation execution. Contents AlarmConﬁguration The details for the CloudWatch alarm applied to your automation. Type: AlarmConﬁguration object Required: No AssociationId The ID of a State Manager association used in the Automation operation. Type: String Required: No AutomationExecutionId The execution ID. Type: String Length Constraints: Fixed length of 36. Required: No AutomationExecutionStatus The status of the execution. Type: String Valid Values: Pending \| InProgress \| Waiting \| Success \| TimedOut \| Cancelling \| Cancelled \| Failed \| PendingApproval \| Approved \| Rejected \| Scheduled \| RunbookInProgress \| PendingChangeCalendarOverride \| ChangeCalendarOverrideApproved \| ChangeCalendarOverrideRejected \| CompletedWithSuccess \| CompletedWithFailure \| Exited AutomationExecutionMetadata API Version 2014-11-06 931 AWS Systems Manager Required: No AutomationSubtype API Reference The subtype of the Automation operation. Currently, the only supported value is ChangeRequest. Type: String Valid Values: ChangeRequest \| AccessRequest Required: No AutomationType Use this ﬁlter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and AWS accounts. For more information, see Running automations in multiple AWS Regions and accounts in the AWS Systems Manager User Guide. Type: String Valid Values: CrossAccount \| Local Required: No ChangeRequestName The name of the Change Manager change request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No CurrentAction The action of the step that is currently running. Type: String Required: No CurrentStepName The name of the step that is currently running. Contents API Version 2014-11-06 932 API Reference AWS Systems Manager Type: String Required: No DocumentName The name of the Automation runbook used during execution. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No DocumentVersion The document version used during the execution. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No ExecutedBy The IAM role ARN of the user who ran the automation. Type: String Required: No ExecutionEndTime The time the execution ﬁnished. This isn't populated if the execution is still in progress. Type: Timestamp Required: No ExecutionStartTime The time the execution started. Type: Timestamp Required: No Contents API Version 2014-11-06 933 AWS Systems Manager FailureMessage API Reference The list of execution outputs as deﬁned in the Automation runbook. Type: String Required: No LogFile An S3 bucket where execution information is stored. Type: String Required: No MaxConcurrency The MaxConcurrency value speciﬁed by the user when starting the automation. 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 The MaxErrors value speciﬁed by the user when starting the automation. 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 The Automation execution mode. Type: String Contents API Version 2014-11-06 934 AWS Systems Manager API Reference Valid Values: Auto \| Interactive Required: No OpsItemId The ID of an OpsItem that is created to represent a Change Manager change request. Type: String Required: No Outputs The list of execution outputs as deﬁned 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
systems-manager-api-174	systems-manager-api.pdf	174	of 1. Maximum length of 7. Pattern: ^([1-9][0-9]\|[0]\|[1-9][0-9]%\|[0-9]%\|100%)$ Required: No Mode The Automation execution mode. Type: String Contents API Version 2014-11-06 934 AWS Systems Manager API Reference Valid Values: Auto \| Interactive Required: No OpsItemId The ID of an OpsItem that is created to represent a Change Manager change request. Type: String Required: No Outputs The list of execution outputs as deﬁned 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 ParentAutomationExecutionId The execution ID of the parent automation. Type: String Length Constraints: Fixed length of 36. Required: No ResolvedTargets A list of targets that resolved during the execution. Type: ResolvedTargets object Required: No Contents API Version 2014-11-06 935 AWS Systems Manager Runbooks API Reference Information about the Automation runbooks that are run during a runbook workﬂow in Change Manager. Note The Automation runbooks speciﬁed for the runbook workﬂow can't run until all required approvals for the change request have been received. Type: Array of Runbook objects Array Members: Fixed number of 1 item. Required: No ScheduledTime The date and time the Automation operation is scheduled to start. Type: Timestamp Required: No Target The list of execution outputs as deﬁned in the Automation runbook. Type: String Required: No TargetLocationsURL A publicly accessible URL for a ﬁle that contains the TargetLocations body. Currently, only ﬁles 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 Contents API Version 2014-11-06 936 AWS Systems Manager TargetMaps API Reference The speciﬁed key-value mapping of document parameters to target resources. 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 The list of execution outputs as deﬁned in the Automation runbook. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Required: No Targets The targets deﬁned by the user when starting the automation. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No TriggeredAlarms The CloudWatch alarm that was invoked by the automation. Type: Array of AlarmStateInformation objects Array Members: Fixed number of 1 item. Contents API Version 2014-11-06 937 AWS Systems Manager Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 938 AWS Systems Manager API Reference AutomationExecutionPreview Information about the results of the execution preview. Contents Regions Information about the AWS Regions targeted by the execution preview. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No StepPreviews Information about the type of impact a runbook step would have on a resource. • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources. • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe, List, Get, and similar read-only API actions. • Undetermined: An undetermined step invokes executions performed by another orchestration service like AWS Lambda, AWS Step Functions, or AWS Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined. Type: String to integer map Valid Keys: Mutating \| NonMutating \| Undetermined Required: No TargetPreviews Information that provides a preview of what the impact of running the speciﬁed Automation runbook would be. Type: Array of TargetPreview objects AutomationExecutionPreview API Version 2014-11-06 939 AWS Systems Manager API Reference Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No TotalAccounts Information about the AWS accounts that were included in the execution preview. Type: Integer Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 940 AWS Systems Manager BaselineOverride Deﬁnes the basic information about a patch baseline override. API Reference Contents ApprovalRules A set of rules deﬁning the approval rules for a patch baseline. Type:
systems-manager-api-175	systems-manager-api.pdf	175	number of 0 items. Maximum number of 50 items. Required: No TotalAccounts Information about the AWS accounts that were included in the execution preview. Type: Integer Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 940 AWS Systems Manager BaselineOverride Deﬁnes the basic information about a patch baseline override. API Reference Contents ApprovalRules A set of rules deﬁning the approval rules for a patch baseline. Type: PatchRuleGroup object Required: No ApprovedPatches 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 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 Deﬁnes the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| INFORMATIONAL \| UNSPECIFIED Required: No ApprovedPatchesEnableNonSecurity 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. BaselineOverride API Version 2014-11-06 941 AWS Systems Manager Type: Boolean Required: No AvailableSecurityUpdatesComplianceStatus API Reference Indicates whether managed nodes for which there are available security-related patches that have not been approved by the baseline are being deﬁned as COMPLIANT or NON_COMPLIANT. This option is speciﬁed when the CreatePatchBaseline or UpdatePatchBaseline commands are run. Applies to Windows Server managed nodes only. Type: String Valid Values: COMPLIANT \| NON_COMPLIANT Required: No GlobalFilters A set of patch ﬁlters, typically used for approval rules. Type: PatchFilterGroup object Required: No OperatingSystem The operating system rule used by the patch baseline override. 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 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 in the AWS Systems Manager User Guide. Contents API Version 2014-11-06 942 AWS Systems Manager Type: Array of strings API Reference 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 The action for Patch Manager to take on patches included in the RejectedPackages 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 Required: No Sources 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 objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 943 AWS Systems Manager API Reference CloudWatchOutputConﬁg Conﬁguration options for sending command output to Amazon CloudWatch Logs. Contents CloudWatchLogGroupName The name of the CloudWatch Logs log group where you want to send command output. If you don't specify a group name, AWS Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No CloudWatchOutputEnabled Enables Systems Manager to send command output to CloudWatch Logs. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CloudWatchOutputConﬁg API Version 2014-11-06 944 AWS Systems Manager Command Describes a command request. Contents AlarmConﬁguration API Reference The details for the CloudWatch alarm applied to your command. Type: AlarmConﬁguration object Required: No CloudWatchOutputConﬁg Amazon CloudWatch Logs information where you want AWS Systems Manager to send the command output. Type: CloudWatchOutputConﬁg object Required: No CommandId A unique identiﬁer for this command. Type: String Length Constraints: Fixed length of 36. Required: No Comment User-speciﬁed information about the command, such as a brief description of what the command should do.
systems-manager-api-176	systems-manager-api.pdf	176	C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CloudWatchOutputConﬁg API Version 2014-11-06 944 AWS Systems Manager Command Describes a command request. Contents AlarmConﬁguration API Reference The details for the CloudWatch alarm applied to your command. Type: AlarmConﬁguration object Required: No CloudWatchOutputConﬁg Amazon CloudWatch Logs information where you want AWS Systems Manager to send the command output. Type: CloudWatchOutputConﬁg object Required: No CommandId A unique identiﬁer for this command. Type: String Length Constraints: Fixed length of 36. Required: No Comment User-speciﬁed 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 Command API Version 2014-11-06 945 AWS Systems Manager CompletedCount API Reference The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable. Type: Integer Required: No DeliveryTimedOutCount The number of targets for which the status is Delivery Timed Out. Type: Integer Required: No DocumentName The name of the document requested for execution. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No DocumentVersion The Systems Manager document (SSM document) version. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No ErrorCount The number of targets for which the status is Failed or Execution Timed Out. Type: Integer Required: No Contents API Version 2014-11-06 946 AWS Systems Manager ExpiresAfter API Reference If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the AWS Systems Manager User Guide. Type: Timestamp Required: No InstanceIds The managed node IDs against which this command 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 MaxConcurrency The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see AWS Systems Manager Run Command 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 The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see AWS Systems Manager Run Command in the AWS Systems Manager User Guide. Contents API Version 2014-11-06 947 AWS Systems Manager Type: String API Reference 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 NotiﬁcationConﬁg Conﬁgurations for sending notiﬁcations about command status changes. Type: NotiﬁcationConﬁg object Required: No OutputS3BucketName The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Required: No OutputS3KeyPreﬁx The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. Type: String Length Constraints: Maximum length of 500. Required: No OutputS3Region (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. Contents API Version 2014-11-06 948 AWS Systems Manager Required: No Parameters API Reference The parameter values to be inserted in the document when running the command. Type: String to array of strings map Required: No RequestedDateTime The date and time the command was requested. Type: Timestamp Required: No ServiceRole The AWS Identity and Access Management (IAM) service role that Run Command, a tool in AWS Systems Manager, uses to act on your behalf when sending notiﬁcations about command status changes. Type: String Required: No Status The status of the command. Type: String Valid Values: Pending \| InProgress \| Success \| Cancelled \| Failed \| TimedOut \| Cancelling Required: No StatusDetails A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show diﬀerent results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Contents API Version 2014-11-06 949 AWS Systems Manager API Reference • Pending: The command hasn't been sent to any managed nodes. • In Progress: The command has been sent to at least one managed
systems-manager-api-177	systems-manager-api.pdf	177	Cancelled \| Failed \| TimedOut \| Cancelling Required: No StatusDetails A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show diﬀerent results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Contents API Version 2014-11-06 949 AWS Systems Manager API Reference • Pending: The command hasn't been sent to any managed nodes. • In Progress: The command has been sent to at least one managed node but hasn't reached a ﬁnal state on all managed nodes. • Success: The command successfully ran on all invocations. This is a terminal state. • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state. • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state. • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state. • Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state. • Cancelled: The command was terminated before it was completed. This is a terminal state. • Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state. • Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Required: No TargetCount The number of targets for the command. Type: Integer Required: No Targets An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call. Contents API Version 2014-11-06 950 AWS Systems Manager API Reference Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No TimeoutSeconds The TimeoutSeconds value speciﬁed for a command. Type: Integer Valid Range: Minimum value of 30. Maximum value of 2592000. Required: No TriggeredAlarms The CloudWatch alarm that was invoked by the command. Type: Array of AlarmStateInformation objects Array Members: Fixed number of 1 item. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 951 AWS Systems Manager CommandFilter Describes a command ﬁlter. Note API Reference A managed node ID can't be speciﬁed when a command status is Pending because the command hasn't run on the node yet. Contents key The name of the ﬁlter. Note The ExecutionStage ﬁlter can't be used with the ListCommandInvocations operation, only with ListCommands. Type: String Valid Values: InvokedAfter \| InvokedBefore \| Status \| ExecutionStage \| DocumentName Required: Yes value The ﬁlter value. Valid values for each ﬁlter key are as follows: • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2024-07-07T00:00:00Z to see a list of command executions occurring July 7, 2021, and later. • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2024-07-07T00:00:00Z to see a list of command executions from before July 7, 2021. • Status: Specify a valid command status to see a list of all command executions with that status. The status choices depend on the API you call. CommandFilter API Version 2014-11-06 952 AWS Systems Manager API Reference The status values you can specify for ListCommands are: • Pending • InProgress • Success • Cancelled • Failed • TimedOut (this includes both Delivery and Execution time outs) • AccessDenied • DeliveryTimedOut • ExecutionTimedOut • Incomplete • NoInstancesInTag • LimitExceeded The status values you can specify for ListCommandInvocations are: • Pending • InProgress • Delayed • Success • Cancelled • Failed • TimedOut (this includes both Delivery and Execution time outs) • AccessDenied • DeliveryTimedOut • ExecutionTimedOut • Undeliverable • InvalidPlatform • Terminated • DocumentName: Specify name of the AWS Systems Manager document (SSM document) Contents for which you want to see command execution results. For example, specify AWS- API Version 2014-11-06 953 AWS Systems Manager API Reference RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on managed nodes. • ExecutionStage: Specify one of the following values (ListCommands operations only): • Executing: Returns a
systems-manager-api-178	systems-manager-api.pdf	178	• InProgress • Delayed • Success • Cancelled • Failed • TimedOut (this includes both Delivery and Execution time outs) • AccessDenied • DeliveryTimedOut • ExecutionTimedOut • Undeliverable • InvalidPlatform • Terminated • DocumentName: Specify name of the AWS Systems Manager document (SSM document) Contents for which you want to see command execution results. For example, specify AWS- API Version 2014-11-06 953 AWS Systems Manager API Reference RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on managed nodes. • ExecutionStage: Specify one of the following values (ListCommands operations only): • Executing: Returns a list of command executions that are currently still running. • Complete: Returns a list of command executions that have already completed. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 954 AWS Systems Manager API Reference CommandInvocation An invocation is a copy of a command sent to a speciﬁc 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. A command invocation returns status and detail information about a command you ran. Contents CloudWatchOutputConﬁg Amazon CloudWatch Logs information where you want AWS Systems Manager to send the command output. Type: CloudWatchOutputConﬁg object Required: No CommandId The command against which this invocation was requested. Type: String Length Constraints: Fixed length of 36. Required: No CommandPlugins Plugins processed by the command. Type: Array of CommandPlugin objects Required: No Comment User-speciﬁed information about the command, such as a brief description of what the command should do. Type: String CommandInvocation API Version 2014-11-06 955 AWS Systems Manager API Reference Length Constraints: Maximum length of 100. Required: No DocumentName The document name that was requested for execution. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No DocumentVersion The Systems Manager document (SSM document) version. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]*$) Required: No InstanceId The managed node ID in which this invocation was requested. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) Required: No InstanceName The fully qualiﬁed host name of the managed node. Type: String Length Constraints: Maximum length of 255. Required: No NotiﬁcationConﬁg Conﬁgurations for sending notiﬁcations about command status changes on a per managed node basis. Contents API Version 2014-11-06 956 AWS Systems Manager API Reference Type: NotiﬁcationConﬁg object Required: No RequestedDateTime The time and date the request was sent to this managed node. Type: Timestamp Required: No ServiceRole The AWS Identity and Access Management (IAM) service role that Run Command, a tool in AWS Systems Manager, uses to act on your behalf when sending notiﬁcations about command status changes on a per managed node basis. Type: String Required: No StandardErrorUrl The URL to the plugin's StdErr ﬁle in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was deﬁned for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin deﬁned for the command, and the S3 bucket was deﬁned for the command. Type: String Required: No StandardOutputUrl The URL to the plugin's StdOut ﬁle in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was deﬁned for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin deﬁned for the command, and the S3 bucket was deﬁned for the command. Type: String Required: No Contents API Version 2014-11-06 957 AWS Systems Manager Status API Reference Whether or not the invocation succeeded, failed, or is pending. Type: String Valid Values: Pending \| InProgress \| Delayed \| Success \| Cancelled \| TimedOut \| Failed \| Cancelling Required: No StatusDetails A detailed status of the command execution for each invocation (each managed node targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show diﬀerent results than Status. For more information about these statuses, see Understanding command statuses 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. • Success: The execution of the command or plugin was successfully completed. 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
systems-manager-api-179	systems-manager-api.pdf	179	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. • Success: The execution of the command or plugin was successfully completed. 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: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. • Failed: The command wasn't successful 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 managed node might not exist or might not be responding. Undeliverable invocations don't count against Contents API Version 2014-11-06 958 AWS Systems Manager API Reference 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. • Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Required: No TraceOutput Gets the trace output sent by the agent. Type: String Length Constraints: Maximum length of 2500. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 959 AWS Systems Manager CommandPlugin Describes plugin details. Contents Name API Reference The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent. Type: String Length Constraints: Minimum length of 4. Required: No Output Output of the plugin execution. Type: String Length Constraints: Maximum length of 2500. Required: No OutputS3BucketName The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response: amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript amzn-s3-demo-bucket is the name of the S3 bucket; my-prefix is the name of the S3 preﬁx; i-02573cafcfEXAMPLE is the managed node ID; awsrunShellScript is the name of the plugin. CommandPlugin API Version 2014-11-06 960 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 63. Required: No OutputS3KeyPreﬁx The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response: amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript amzn-s3-demo-bucket is the name of the S3 bucket; my-prefix is the name of the S3 preﬁx; i-02573cafcfEXAMPLE is the managed node ID; awsrunShellScript is the name of the plugin. Type: String Length Constraints: Maximum length of 500. Required: No OutputS3Region (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, AWS Systems Manager automatically determines the S3 bucket region. Type: String Length Constraints: Minimum length of 3. Maximum length of 20. Required: No ResponseCode A numeric response code generated after running the plugin. Type: Integer Contents API Version 2014-11-06 961 AWS Systems Manager Required: No ResponseFinishDateTime API Reference The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent. Type: Timestamp Required: No ResponseStartDateTime The time the plugin started running. Type: Timestamp Required: No StandardErrorUrl The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty. Type: String Required: No StandardOutputUrl The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for the command wasn't speciﬁed, then this string is empty. Type: String Required: No Status The status of this plugin. You can run a document with multiple plugins. Type: String Valid Values: Pending \| InProgress \| Success \| TimedOut \| Cancelled \| Failed Required: No Contents API Version 2014-11-06 962 AWS Systems Manager StatusDetails API Reference A detailed status of
systems-manager-api-180	systems-manager-api.pdf	180	written by the plugin to stderr. If execution isn't yet complete, then this string is empty. Type: String Required: No StandardOutputUrl The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for the command wasn't speciﬁed, then this string is empty. Type: String Required: No Status The status of this plugin. You can run a document with multiple plugins. Type: String Valid Values: Pending \| InProgress \| Success \| TimedOut \| Cancelled \| Failed Required: No Contents API Version 2014-11-06 962 AWS Systems Manager StatusDetails API Reference A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show diﬀerent results than Status. For more information about these statuses, see Understanding command statuses 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. • Success: The execution of the command or plugin was successfully completed. 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: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. • Failed: The command wasn't successful 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 managed node might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they 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. Required: No Contents API Version 2014-11-06 963 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 964 AWS Systems Manager API Reference ComplianceExecutionSummary 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' Contents ExecutionTime The time the execution ran as a datetime object that is saved in the following format: yyyy- MM-dd'T'HH:mm:ss'Z' Type: Timestamp Required: Yes ExecutionId An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls. Type: String Length Constraints: Maximum length of 100. Required: No ExecutionType The type of execution. For example, Command is a valid execution type. Type: String Length Constraints: Maximum length of 50. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: ComplianceExecutionSummary API Version 2014-11-06 965 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 966 AWS Systems Manager ComplianceItem API Reference Information about the compliance as deﬁned by the resource type. For example, for a patch resource type, Items includes information about the PatchSeverity, Classiﬁcation, and so on. Contents ComplianceType The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types. 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: No Details A "Key": "Value" tag combination for the compliance item. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 64. Value Length Constraints: Minimum length of 0. Maximum length of 4096. Required: No ExecutionSummary A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution
systems-manager-api-181	systems-manager-api.pdf	181	so on. Contents ComplianceType The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types. 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: No Details A "Key": "Value" tag combination for the compliance item. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 64. Value Length Constraints: Minimum length of 0. Maximum length of 4096. Required: No ExecutionSummary A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time. Type: ComplianceExecutionSummary object Required: No Id An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320. ComplianceItem API Version 2014-11-06 967 AWS Systems Manager Type: String Required: No ResourceId API Reference An ID for the resource. For a managed node, this is the node ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No ResourceType 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: No Severity The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspeciﬁed. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| INFORMATIONAL \| UNSPECIFIED Required: No Status The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable). Type: String Valid Values: COMPLIANT \| NON_COMPLIANT Required: No Contents API Version 2014-11-06 968 AWS Systems Manager Title API Reference A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services. Type: String Length Constraints: Maximum length of 500. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 969 AWS Systems Manager API Reference ComplianceItemEntry Information about a compliance item. Contents Severity The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspeciﬁed. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| INFORMATIONAL \| UNSPECIFIED Required: Yes Status The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT. Type: String Valid Values: COMPLIANT \| NON_COMPLIANT Required: Yes Details A "Key": "Value" tag combination for the compliance item. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 64. Value Length Constraints: Minimum length of 0. Maximum length of 4096. Required: No Id The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article. Type: String ComplianceItemEntry API Version 2014-11-06 970 AWS Systems Manager Required: No Title API Reference The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services. Type: String Length Constraints: Maximum length of 500. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 971 AWS Systems Manager API Reference ComplianceStringFilter One or more ﬁlters. Use a ﬁlter to return a more speciﬁc list of results. Contents Key The name of the ﬁlter. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: No Type The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan. Type: String Valid Values: EQUAL \| NOT_EQUAL \| BEGIN_WITH \| LESS_THAN \| GREATER_THAN Required: No Values The value for which to search. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ ComplianceStringFilter API Version 2014-11-06 972 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 973 AWS Systems Manager API Reference ComplianceSummaryItem A summary of compliance information by compliance type. Contents ComplianceType The type of compliance item. For example, the compliance type can be Association, Patch, or
systems-manager-api-182	systems-manager-api.pdf	182	Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ ComplianceStringFilter API Version 2014-11-06 972 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 973 AWS Systems Manager API Reference ComplianceSummaryItem A summary of compliance information by compliance type. Contents ComplianceType The type of compliance item. For example, the compliance type can be 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: No CompliantSummary A list of COMPLIANT items for the speciﬁed compliance type. Type: CompliantSummary object Required: No NonCompliantSummary A list of NON_COMPLIANT items for the speciﬁed compliance type. Type: NonCompliantSummary object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 ComplianceSummaryItem API Version 2014-11-06 974 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 975 AWS Systems Manager API Reference CompliantSummary A summary of resources that are compliant. The summary is organized according to the resource count for each compliance type. Contents CompliantCount The total number of resources that are compliant. Type: Integer Required: No SeveritySummary A summary of the compliance severity by compliance type. Type: SeveritySummary object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CompliantSummary API Version 2014-11-06 976 AWS Systems Manager API Reference CreateAssociationBatchRequestEntry Describes the association of a AWS Systems Manager document (SSM document) and a managed node. Contents Name The name of the SSM document that contains the conﬁguration information for the managed node. You can specify Command or Automation runbooks. You can specify AWS-predeﬁned documents, documents you created, or a document that is shared with you from another account. For SSM documents 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-predeﬁned 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 AlarmConﬁguration The details for the CloudWatch alarm you want to apply to an automation or command. Type: AlarmConﬁguration object Required: No CreateAssociationBatchRequestEntry API Version 2014-11-06 977 AWS Systems Manager ApplyOnlyAtCronInterval API Reference By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you speciﬁed and when target changes are detected. Specify true for ApplyOnlyAtCronInterval if you want the association to run only according to the schedule you speciﬁed. For more information, see Understanding when associations are applied to resources and >About target updates with Automation runbooks in the AWS Systems Manager User Guide. This parameter isn't supported for rate expressions. Type: Boolean Required: No AssociationName Specify a descriptive name for the association. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No AutomationTargetParameterName Specify the target for the association. 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 The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide. Type: Array of strings Contents API Version 2014-11-06 978 AWS Systems Manager Required: No ComplianceSeverity API Reference The severity level to assign to the association. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| UNSPECIFIED Required: No DocumentVersion The document version. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]*$) Required: No Duration 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 oﬄine 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 speciﬁes the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is
systems-manager-api-183	systems-manager-api.pdf	183	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 oﬄine 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 speciﬁes the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is created, but only according to the speciﬁed schedule. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Required: No InstanceId The managed node ID. Contents API Version 2014-11-06 979 AWS Systems Manager Note API Reference 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 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 speciﬁed 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 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 Contents API Version 2014-11-06 980 AWS Systems Manager API Reference system stops sending requests after the ﬁrst 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 OutputLocation An S3 bucket where you want to store the results of this request. Type: InstanceAssociationOutputLocation object Required: No Parameters A description of the parameters for a document. Type: String to array of strings map Required: No ScheduleExpression A cron expression that speciﬁes a schedule when the association runs. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No ScheduleOﬀset Number of days to wait after the scheduled day to run an association. Contents API Version 2014-11-06 981 AWS Systems Manager Type: Integer Valid Range: Minimum value of 1. Maximum value of 6. Required: No SyncCompliance API Reference 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 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 operation. By default, all associations use AUTO mode. Type: String Valid Values: AUTO \| MANUAL Required: No TargetLocations Use this action to create an association in multiple Regions and multiple accounts. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetMaps A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be speciﬁed together. Type: Array of string to array of strings maps Array Members: Minimum number of 0 items. Maximum number of 300 items. Contents API Version 2014-11-06 982 AWS Systems Manager API Reference Map Entries: Maximum number of
systems-manager-api-184	systems-manager-api.pdf	184	associations use AUTO mode. Type: String Valid Values: AUTO \| MANUAL Required: No TargetLocations Use this action to create an association in multiple Regions and multiple accounts. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetMaps A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be speciﬁed together. Type: Array of string to array of strings maps Array Members: Minimum number of 0 items. Maximum number of 300 items. Contents API Version 2014-11-06 982 AWS Systems Manager API Reference 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 The managed nodes targeted by the request. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 983 AWS Systems Manager Credentials API Reference The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. Contents AccessKeyId The access key ID that identiﬁes the temporary security credentials. Type: String Pattern: \w{16,128} Required: Yes ExpirationTime The datetime on which the current credentials expire. Type: Timestamp Required: Yes SecretAccessKey The secret access key that can be used to sign requests. Type: String Required: Yes SessionToken The token that users must pass to the service API to use the temporary credentials. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Credentials API Version 2014-11-06 984 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 985 AWS Systems Manager API Reference DescribeActivationsFilter Filter for the DescribeActivation API. Contents FilterKey The name of the ﬁlter. Type: String Valid Values: ActivationIds \| DefaultInstanceName \| IamRole Required: No FilterValues The ﬁlter values. Type: Array of strings Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DescribeActivationsFilter API Version 2014-11-06 986 AWS Systems Manager API Reference DocumentDefaultVersionDescription A default version of a document. Contents DefaultVersion The default version of the document. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No DefaultVersionName The default version of the artifact associated with the document. Type: String Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Required: No Name The name of the document. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 DocumentDefaultVersionDescription API Version 2014-11-06 987 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 988 AWS Systems Manager API Reference DocumentDescription Describes an AWS Systems Manager document (SSM document). Contents ApprovedVersion The version of the document currently approved for use in the organization. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No AttachmentsInformation Details about the document attachments, including names, locations, sizes, and so on. Type: Array of AttachmentInformation objects Required: No Author The user in your organization who created the document. Type: String Required: No Category The classiﬁcation of a document to help you identify and categorize its use. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 3 items. Length Constraints: Maximum length of 128. Required: No CategoryEnum The value that identiﬁes a document's category. DocumentDescription API Version 2014-11-06 989 AWS Systems Manager Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 3 items. Length Constraints: Maximum length of 128. Required: No CreatedDate The date when the document was created. Type: Timestamp Required: No DefaultVersion The default version. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No Description A description of the document. Type: String Required: No DisplayName The friendly name of the SSM document. This value can diﬀer for each version of the document. If you want to update this value, see UpdateDocument. Type: String Length Constraints: Maximum length of 1024. Pattern: ^[\w\.\-\:\/ ]$ Required: No Contents API Version 2014-11-06 990 API Reference AWS Systems Manager DocumentFormat The document format, either JSON or YAML. Type: String Valid Values: YAML \| JSON \| TEXT Required: No DocumentType The type of document. Type: String Valid Values: Command \| Policy \|
systems-manager-api-185	systems-manager-api.pdf	185	default version. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No Description A description of the document. Type: String Required: No DisplayName The friendly name of the SSM document. This value can diﬀer for each version of the document. If you want to update this value, see UpdateDocument. Type: String Length Constraints: Maximum length of 1024. Pattern: ^[\w\.\-\:\/ ]$ Required: No Contents API Version 2014-11-06 990 API Reference AWS Systems Manager DocumentFormat The document format, either JSON or YAML. Type: String Valid Values: YAML \| JSON \| TEXT Required: No DocumentType The type of document. Type: String Valid Values: Command \| Policy \| Automation \| Session \| Package \| ApplicationConfiguration \| ApplicationConfigurationSchema \| DeploymentStrategy \| ChangeCalendar \| Automation.ChangeTemplate \| ProblemAnalysis \| ProblemAnalysisTemplate \| CloudFormation \| ConformancePackTemplate \| QuickSetup \| ManualApprovalPolicy \| AutoApprovalPolicy Required: No DocumentVersion The document version. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No Hash The Sha256 or Sha1 hash created by the system when the document was created. Note Sha1 hashes have been deprecated. Type: String Contents API Version 2014-11-06 991 AWS Systems Manager API Reference Length Constraints: Maximum length of 256. Required: No HashType The hash type of the document. Valid values include Sha256 or Sha1. Note Sha1 hashes have been deprecated. Type: String Valid Values: Sha256 \| Sha1 Required: No LatestVersion The latest version of the document. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No Name The name of the SSM document. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: No Owner The Amazon Web Services user that created the document. Type: String Required: No Contents API Version 2014-11-06 992 API Reference AWS Systems Manager Parameters A description of the parameters for a document. Type: Array of DocumentParameter objects Required: No PendingReviewVersion The version of the document that is currently under review. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No PlatformTypes The list of operating system (OS) platforms compatible with this SSM document. Type: Array of strings Valid Values: Windows \| Linux \| MacOS Required: No Requires A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document. Type: Array of DocumentRequires objects Array Members: Minimum number of 1 item. Required: No ReviewInformation Details about the review of a document. Type: Array of ReviewInformation objects Contents API Version 2014-11-06 993 AWS Systems Manager API Reference Array Members: Minimum number of 1 item. Required: No ReviewStatus The current status of the review. Type: String Valid Values: APPROVED \| NOT_REVIEWED \| PENDING \| REJECTED Required: No SchemaVersion The schema version. Type: String Pattern: ([0-9]+)\.([0-9]+) Required: No Sha1 The SHA1 hash of the document, which you can use for veriﬁcation. Type: String Required: No Status The status of the SSM document. Type: String Valid Values: Creating \| Active \| Updating \| Deleting \| Failed Required: No StatusInformation 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 speciﬁed S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct." Contents API Version 2014-11-06 994 API Reference AWS Systems Manager Type: String Required: No Tags The tags, or metadata, that have been applied to the document. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No TargetType The target type which deﬁnes the kinds of resources the document can run on. For example, / AWS::EC2::Instance. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide. Type: String Length Constraints: Maximum length of 200. Pattern: ^\/[\w\.\-\:\/]$ Required: No VersionName The version of the artifact associated with the document. Type: String Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2014-11-06 995 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 996 AWS Systems Manager DocumentFilter API Reference This data type is deprecated. Instead, use DocumentKeyValuesFilter. Contents key The name of the ﬁlter. Type: String Valid Values: Name \| Owner \| PlatformTypes \| DocumentType Required: Yes value The value of the ﬁlter. Type: String Length Constraints: Minimum length of 1. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DocumentFilter API Version 2014-11-06 997 API Reference AWS Systems Manager DocumentIdentiﬁer Describes the name of a SSM document. Contents Author The user in your organization who created the document. Type: String Required: No CreatedDate The date the SSM document was created. Type: Timestamp Required: No DisplayName An optional ﬁeld where you can specify a friendly name for the SSM document.
systems-manager-api-186	systems-manager-api.pdf	186	of 1. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DocumentFilter API Version 2014-11-06 997 API Reference AWS Systems Manager DocumentIdentiﬁer Describes the name of a SSM document. Contents Author The user in your organization who created the document. Type: String Required: No CreatedDate The date the SSM document was created. Type: Timestamp Required: No DisplayName An optional ﬁeld where you can specify a friendly name for the SSM document. This value can diﬀer for each version of the document. If you want to update this value, see UpdateDocument. Type: String Length Constraints: Maximum length of 1024. Pattern: ^[\w\.\-\:\/ ]$ Required: No DocumentFormat The document format, either JSON or YAML. Type: String Valid Values: YAML \| JSON \| TEXT Required: No DocumentIdentiﬁer API Version 2014-11-06 998 AWS Systems Manager DocumentType The document type. Type: String API Reference Valid Values: Command \| Policy \| Automation \| Session \| Package \| ApplicationConfiguration \| ApplicationConfigurationSchema \| DeploymentStrategy \| ChangeCalendar \| Automation.ChangeTemplate \| ProblemAnalysis \| ProblemAnalysisTemplate \| CloudFormation \| ConformancePackTemplate \| QuickSetup \| ManualApprovalPolicy \| AutoApprovalPolicy Required: No DocumentVersion The document version. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No Name The name of the SSM document. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: No Owner The Amazon Web Services user that created the document. Type: String Required: No PlatformTypes The operating system platform. Contents API Version 2014-11-06 999 AWS Systems Manager Type: Array of strings Valid Values: Windows \| Linux \| MacOS Required: No Requires API Reference A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document. Type: Array of DocumentRequires objects Array Members: Minimum number of 1 item. Required: No ReviewStatus The current status of a document review. Type: String Valid Values: APPROVED \| NOT_REVIEWED \| PENDING \| REJECTED Required: No SchemaVersion The schema version. Type: String Pattern: ([0-9]+)\.([0-9]+) Required: No Tags The tags, or metadata, that have been applied to the document. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Contents API Version 2014-11-06 1000 AWS Systems Manager Required: No TargetType API Reference The target type which deﬁnes the kinds of resources the document can run on. For example, / AWS::EC2::Instance. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide. Type: String Length Constraints: Maximum length of 200. Pattern: ^\/[\w\.\-\:\/]*$ Required: No VersionName An optional ﬁeld 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 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1001 AWS Systems Manager API Reference DocumentKeyValuesFilter One or more ﬁlters. Use a ﬁlter to return a more speciﬁc list of documents. For keys, you can specify one or more tags that have been applied to a document. You can also use AWS-provided keys, some of which have speciﬁc allowed values. These keys and their associated values are as follows: DocumentType • ApplicationConfiguration • ApplicationConfigurationSchema • Automation • ChangeCalendar • Command • Package • Policy • Session Owner Note that only one Owner can be speciﬁed in a request. For example: Key=Owner,Values=Self. • Amazon • Private • Public • Self • ThirdParty PlatformTypes • Linux • Windows Name is another AWS-provided key. If you use Name as a key, you can use a name preﬁx to return a list of documents. For example, in the AWS CLI, to return a list of all documents that begin with Te, run the following command: DocumentKeyValuesFilter API Version 2014-11-06 1002 AWS Systems Manager API Reference aws ssm list-documents --filters Key=Name,Values=Te You can also use the TargetType AWS-provided key. For a list of valid resource type values that can be used with this key, see AWS resource and property types reference in the AWS CloudFormation User Guide. If you specify more than two keys, only documents that are identiﬁed by all the tags are returned in the results. If you specify more than two values for a key, documents that are identiﬁed by any of the values are returned in the results. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName. For example, if you created a key called region and are using the AWS CLI to call the list- documents command: aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self Contents Key The name of the ﬁlter key. Type: String Length Constraints: Minimum length of 1. Maximum
systems-manager-api-187	systems-manager-api.pdf	187	Guide. If you specify more than two keys, only documents that are identiﬁed by all the tags are returned in the results. If you specify more than two values for a key, documents that are identiﬁed by any of the values are returned in the results. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName. For example, if you created a key called region and are using the AWS CLI to call the list- documents command: aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self Contents Key The name of the ﬁlter key. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Values The value for the ﬁlter key. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Contents API Version 2014-11-06 1003 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1004 AWS Systems Manager API Reference DocumentMetadataResponseInfo Details about the response to a document review request. Contents ReviewerResponse Details about a reviewer's response to a document review request. Type: Array of DocumentReviewerResponseSource objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DocumentMetadataResponseInfo API Version 2014-11-06 1005 AWS Systems Manager API Reference DocumentParameter Parameters speciﬁed in a Systems Manager document that run on the server when the command is run. Contents DefaultValue If speciﬁed, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional. Type: String Required: No Description A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional. Type: String Required: No Name The name of the parameter. Type: String Required: No Type The type of parameter. The type can be either String or StringList. Type: String Valid Values: String \| StringList Required: No DocumentParameter API Version 2014-11-06 1006 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1007 AWS Systems Manager DocumentRequires An SSM document required by the current document. Contents Name API Reference The name of the required SSM document. The name can be an Amazon Resource Name (ARN). Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: Yes RequireType The document type of the required SSM document. Type: String Length Constraints: Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Required: No Version The document version required by the current document. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No VersionName An optional ﬁeld 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 DocumentRequires API Version 2014-11-06 1008 AWS Systems Manager API Reference Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1009 AWS Systems Manager API Reference DocumentReviewCommentSource Information about comments added to a document review request. Contents Content The content of a comment entered by a user who requests a review of a new document version, or who reviews the new version. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^(?!\s$).+ Required: No Type The type of information added to a review request. Currently, only the value Comment is supported. Type: String Valid Values: Comment Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DocumentReviewCommentSource API Version 2014-11-06 1010 AWS Systems Manager API Reference DocumentReviewerResponseSource Information about a reviewer's response to a document review request. Contents Comment The comment entered by a reviewer as part of their document review response. Type: Array of DocumentReviewCommentSource objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No CreateTime The date and time that a reviewer entered a response to a document review request. Type: Timestamp Required: No Reviewer The user in your organization assigned to review a document request. Type: String Length Constraints: Maximum length of 50. Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Required: No ReviewStatus The current review
systems-manager-api-188	systems-manager-api.pdf	188	2014-11-06 1010 AWS Systems Manager API Reference DocumentReviewerResponseSource Information about a reviewer's response to a document review request. Contents Comment The comment entered by a reviewer as part of their document review response. Type: Array of DocumentReviewCommentSource objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No CreateTime The date and time that a reviewer entered a response to a document review request. Type: Timestamp Required: No Reviewer The user in your organization assigned to review a document request. Type: String Length Constraints: Maximum length of 50. Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Required: No ReviewStatus The current review status of a new custom SSM document created by a member of your organization, or of the latest version of an existing SSM document. Only one version of a 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 a document can be in review, or PENDING, at a time. DocumentReviewerResponseSource API Version 2014-11-06 1011 AWS Systems Manager Type: String API Reference Valid Values: APPROVED \| NOT_REVIEWED \| PENDING \| REJECTED Required: No UpdatedTime The date and time that a reviewer last updated a response to a document review request. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1012 AWS Systems Manager DocumentReviews Information about a document approval review. Contents Action API Reference The action to take on a document approval review request. Type: String Valid Values: SendForReview \| UpdateReview \| Approve \| Reject Required: Yes Comment A comment entered by a user in your organization about the document review request. Type: Array of DocumentReviewCommentSource objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DocumentReviews API Version 2014-11-06 1013 AWS Systems Manager API Reference DocumentVersionInfo Version information about the document. Contents CreatedDate The date the document was created. Type: Timestamp Required: No DisplayName The friendly name of the SSM document. This value can diﬀer for each version of the document. If you want to update this value, see UpdateDocument. Type: String Length Constraints: Maximum length of 1024. Pattern: ^[\w\.\-\:\/ ]$ Required: No DocumentFormat The document format, either JSON or YAML. Type: String Valid Values: YAML \| JSON \| TEXT Required: No DocumentVersion The document version. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) DocumentVersionInfo API Version 2014-11-06 1014 AWS Systems Manager Required: No IsDefaultVersion An identiﬁer for the default version of the document. API Reference Type: Boolean Required: No Name The document name. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No ReviewStatus The current status of the approval review for the latest version of the document. Type: String Valid Values: APPROVED \| NOT_REVIEWED \| PENDING \| REJECTED Required: No Status The status of the SSM document, such as Creating, Active, Failed, and Deleting. Type: String Valid Values: Creating \| Active \| Updating \| Deleting \| Failed Required: No StatusInformation 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 speciﬁed S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct." Type: String Contents API Version 2014-11-06 1015 AWS Systems Manager Required: No VersionName API Reference 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 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1016 AWS Systems Manager EﬀectivePatch API Reference The EffectivePatch structure deﬁnes metadata about a patch along with the approval state of the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved. Contents Patch Provides metadata for a patch, including information such as the KB ID, severity, classiﬁcation and a URL for where more information can be obtained about the patch. Type: Patch object Required: No PatchStatus The status of the patch in a patch baseline. This includes information about whether the patch is currently approved, due to be approved by
systems-manager-api-189	systems-manager-api.pdf	189	the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved. Contents Patch Provides metadata for a patch, including information such as the KB ID, severity, classiﬁcation and a URL for where more information can be obtained about the patch. Type: Patch object Required: No PatchStatus The status of the patch in a patch baseline. This includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved. Type: PatchStatus object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 EﬀectivePatch API Version 2014-11-06 1017 AWS Systems Manager ExecutionInputs Information about the inputs for an execution preview. API Reference Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. Automation Information about the optional inputs that can be speciﬁed for an automation execution preview. Type: AutomationExecutionInputs object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExecutionInputs API Version 2014-11-06 1018 AWS Systems Manager ExecutionPreview API Reference Information about the changes that would be made if an execution were run. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. Automation Information about the changes that would be made if an Automation workﬂow were run. Type: AutomationExecutionPreview object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExecutionPreview API Version 2014-11-06 1019 AWS Systems Manager API Reference FailedCreateAssociation Describes a failed association. Contents Entry The association. Type: CreateAssociationBatchRequestEntry object Required: No Fault The source of the failure. Type: String Valid Values: Client \| Server \| Unknown Required: No Message A description of the failure. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FailedCreateAssociation API Version 2014-11-06 1020 AWS Systems Manager FailureDetails Information about an Automation failure. Contents Details API Reference Detailed information about the Automation step failure. 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 FailureStage The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVeriﬁcation, Invocation, PostVeriﬁcation. Type: String Required: No FailureType The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Veriﬁcation, Internal. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: FailureDetails API Version 2014-11-06 1021 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1022 AWS Systems Manager API Reference GetResourcePoliciesResponseEntry A resource policy helps you to deﬁne the IAM entity (for example, an AWS account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems). Contents Policy A resource policy helps you to deﬁne the IAM entity (for example, an AWS account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems). Type: String Pattern: ^(?!\s*$).+ Required: No PolicyHash 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 A policy ID. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: GetResourcePoliciesResponseEntry API Version 2014-11-06
systems-manager-api-190	systems-manager-api.pdf	190	only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems). Type: String Pattern: ^(?!\s$).+ Required: No PolicyHash 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 A policy ID. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: GetResourcePoliciesResponseEntry API Version 2014-11-06 1023 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1024 AWS Systems Manager API Reference InstanceAggregatedAssociationOverview Status information about the aggregated associations. Contents DetailedStatus Detailed status information about the aggregated associations. Type: String Required: No InstanceAssociationStatusAggregatedCount The number of associations for the managed nodes. Type: String to integer map Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InstanceAggregatedAssociationOverview API Version 2014-11-06 1025 AWS Systems Manager InstanceAssociation One or more association documents on the managed node. API Reference Contents AssociationId The association ID. 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 Version information for the association on the managed node. Type: String Pattern: ([$]LATEST)\|([1-9][0-9]) Required: No Content The content of the association document for the managed nodes. Type: String Length Constraints: Minimum length of 1. Required: No InstanceId The managed node ID. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) InstanceAssociation API Version 2014-11-06 1026 AWS Systems Manager Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1027 AWS Systems Manager API Reference InstanceAssociationOutputLocation An S3 bucket where you want to store the results of this request. For the minimal permissions required to enable Amazon S3 output for an association, see Create an association (console) in the Systems Manager User Guide. Contents S3Location An S3 bucket where you want to store the results of this request. Type: S3OutputLocation object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InstanceAssociationOutputLocation API Version 2014-11-06 1028 AWS Systems Manager API Reference InstanceAssociationOutputUrl The URL of S3 bucket where you want to store the results of this request. Contents S3OutputUrl The URL of S3 bucket where you want to store the results of this request. Type: S3OutputUrl object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InstanceAssociationOutputUrl API Version 2014-11-06 1029 AWS Systems Manager API Reference InstanceAssociationStatusInfo Status information about the association. Contents AssociationId The association ID. 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 AssociationName The name of the association applied to the managed node. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No AssociationVersion The version of the association applied to the managed node. Type: String Pattern: ([$]LATEST)\|([1-9][0-9]) Required: No DetailedStatus Detailed status information about the association. Type: String Required: No InstanceAssociationStatusInfo API Version 2014-11-06 1030 API Reference AWS Systems Manager DocumentVersion The association document versions. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No ErrorCode An error code returned by the request to create the association. Type: String Length Constraints: Maximum length of 10. Required: No ExecutionDate The date the association ran. Type: Timestamp Required: No ExecutionSummary Summary information about association execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No InstanceId The managed node ID where the association was created. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) Required: No Contents API Version 2014-11-06 1031 API Reference AWS Systems Manager Name The name of the association. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: No OutputUrl A URL for an S3 bucket where you want to store the results of this request. Type: InstanceAssociationOutputUrl object Required: No Status Status information about the association. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1032 API Reference AWS Systems Manager InstanceInfo Details about a speciﬁc managed node. Contents AgentType The type of agent installed on the
systems-manager-api-191	systems-manager-api.pdf	191	String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: No OutputUrl A URL for an S3 bucket where you want to store the results of this request. Type: InstanceAssociationOutputUrl object Required: No Status Status information about the association. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1032 API Reference AWS Systems Manager InstanceInfo Details about a speciﬁc managed node. Contents AgentType The type of agent installed on the node. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No AgentVersion The version number of the agent installed on the node. Type: String Pattern: ^[0-9]{1,6}(\.[0-9]{1,6}){2,3}$ Required: No ComputerName The fully qualiﬁed host name of the managed node. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No InstanceStatus The current status of the managed node. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No InstanceInfo API Version 2014-11-06 1033 API Reference AWS Systems Manager IpAddress The IP address of the managed node. Type: String Length Constraints: Minimum length of 1. Maximum length of 46. Required: No ManagedStatus Indicates whether the node is managed by Systems Manager. Type: String Valid Values: All \| Managed \| Unmanaged Required: No PlatformName The name of the operating system platform running on your managed node. Type: String Length Constraints: Maximum length of 120. Required: No PlatformType The operating system platform type of the managed node. Type: String Valid Values: Windows \| Linux \| MacOS Required: No PlatformVersion The version of the OS platform running on your managed node. Type: String Length Constraints: Maximum length of 120. Contents API Version 2014-11-06 1034 AWS Systems Manager Required: No ResourceType API Reference The type of instance, either an EC2 instance or another supported machine type in a hybrid ﬂeet. Type: String Valid Values: ManagedInstance \| EC2Instance Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1035 AWS Systems Manager API Reference InstanceInformation Describes a ﬁlter for a speciﬁc list of managed nodes. Contents ActivationId The activation ID created by AWS Systems Manager when the server or virtual machine (VM) was registered. Type: String Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ Required: No AgentVersion The version of SSM Agent running on your Linux managed node. Type: String Pattern: ^[0-9]{1,6}(\.[0-9]{1,6}){2,3}$ Required: No AssociationOverview Information about the association. Type: InstanceAggregatedAssociationOverview object Required: No AssociationStatus The status of the association. Type: String Required: No ComputerName The fully qualiﬁed host name of the managed node. InstanceInformation API Version 2014-11-06 1036 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 255. Required: No IamRole The role assigned to an Amazon EC2 instance conﬁgured with a Systems Manager Quick Setup host management conﬁguration or the role assigned to an on-premises managed node. This call doesn't return the IAM role for unmanaged Amazon EC2 instances (instances not conﬁgured for Systems Manager). To retrieve the role for an unmanaged instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference. Type: String Length Constraints: Maximum length of 64. Required: No InstanceId The managed node ID. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) Required: No IPAddress The IP address of the managed node. Type: String Length Constraints: Minimum length of 1. Maximum length of 46. Required: No IsLatestVersion Indicates whether the latest version of SSM Agent is running on your Linux managed node. This ﬁeld doesn't indicate whether or not the latest version is installed on Windows managed nodes, Contents API Version 2014-11-06 1037 AWS Systems Manager API Reference because some older versions of Windows Server use the EC2Conﬁg service to process Systems Manager requests. Type: Boolean Required: No LastAssociationExecutionDate The date the association was last run. Type: Timestamp Required: No LastPingDateTime The date and time when the agent last pinged the Systems Manager service. Type: Timestamp Required: No LastSuccessfulAssociationExecutionDate The last date the association was successfully run. Type: Timestamp Required: No Name The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is speciﬁed as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in How to install SSM Agent on hybrid Linux nodes and How to install SSM Agent on hybrid Windows Server nodes. To retrieve the
systems-manager-api-192	systems-manager-api.pdf	192	Required: No LastSuccessfulAssociationExecutionDate The last date the association was successfully run. Type: Timestamp Required: No Name The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is speciﬁed as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in How to install SSM Agent on hybrid Linux nodes and How to install SSM Agent on hybrid Windows Server nodes. To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference. Type: String Required: No Contents API Version 2014-11-06 1038 API Reference AWS Systems Manager PingStatus Connection status of SSM Agent. Note The status Inactive has been deprecated and is no longer in use. Type: String Valid Values: Online \| ConnectionLost \| Inactive Required: No PlatformName The name of the operating system platform running on your managed node. Type: String Required: No PlatformType The operating system platform type. Type: String Valid Values: Windows \| Linux \| MacOS Required: No PlatformVersion The version of the OS platform running on your managed node. Type: String Required: No RegistrationDate The date the server or VM was registered with AWS as a managed node. Type: Timestamp Contents API Version 2014-11-06 1039 AWS Systems Manager Required: No ResourceType API Reference The type of instance. Instances are either EC2 instances or managed instances. Type: String Valid Values: ManagedInstance \| EC2Instance Required: No SourceId The ID of the source resource. For AWS IoT Greengrass devices, SourceId is the Thing name. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: ^[a-zA-Z0-9:_-]*$ Required: No SourceType The type of the source resource. For AWS IoT Greengrass devices, SourceType is AWS::IoT::Thing. Type: String Valid Values: AWS::EC2::Instance \| AWS::IoT::Thing \| AWS::SSM::ManagedInstance Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2014-11-06 1040 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1041 AWS Systems Manager API Reference InstanceInformationFilter Describes a ﬁlter for a speciﬁc list of managed nodes. You can ﬁlter node information by using tags. You specify tags by using a key-value mapping. Use this operation instead of the DescribeInstanceInformation:InstanceInformationFilterList method. The InstanceInformationFilterList method is a legacy method and doesn't support tags. Contents key The name of the ﬁlter. Type: String Valid Values: InstanceIds \| AgentVersion \| PingStatus \| PlatformTypes \| ActivationIds \| IamRole \| ResourceType \| AssociationStatus Required: Yes valueSet The ﬁlter values. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Length Constraints: Minimum length of 1. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 InstanceInformationFilter API Version 2014-11-06 1042 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1043 AWS Systems Manager API Reference InstanceInformationStringFilter The ﬁlters to describe or get information about your managed nodes. Contents Key The ﬁlter key name to describe your managed nodes. Valid ﬁlter key values: ActivationIds \| AgentVersion \| AssociationStatus \| IamRole \| InstanceIds \| PingStatus \| PlatformTypes \| ResourceType \| SourceIds \| SourceTypes \| "tag-key" \| "tag:{keyname} • Valid values for the AssociationStatus ﬁlter key: Success \| Pending \| Failed • Valid values for the PingStatus ﬁlter key: Online \| ConnectionLost \| Inactive (deprecated) • Valid values for the PlatformType ﬁlter key: Windows \| Linux \| MacOS • Valid values for the ResourceType ﬁlter key: EC2Instance \| ManagedInstance • Valid values for the SourceType ﬁlter key: AWS::EC2::Instance \| AWS::SSM::ManagedInstance \| AWS::IoT::Thing • Valid tag examples: Key=tag-key,Values=Purpose \| Key=tag:Purpose,Values=Test. Type: String Length Constraints: Minimum length of 1. Required: Yes Values The ﬁlter values. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Length Constraints: Minimum length of 1. Required: Yes InstanceInformationStringFilter API Version 2014-11-06 1044 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1045 AWS Systems Manager InstancePatchState API Reference Deﬁnes the high-level patch compliance state for a managed node, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information
systems-manager-api-193	systems-manager-api.pdf	193	100 items. Length Constraints: Minimum length of 1. Required: Yes InstanceInformationStringFilter API Version 2014-11-06 1044 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1045 AWS Systems Manager InstancePatchState API Reference Deﬁnes the high-level patch compliance state for a managed node, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the managed node. Contents BaselineId The ID of the patch baseline used to patch the managed node. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Required: Yes InstanceId The ID of the managed node the high-level patch compliance information was collected for. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) Required: Yes Operation The type of patching operation that was performed: or • SCAN assesses the patch compliance state. • INSTALL installs missing patches. Type: String Valid Values: Scan \| Install Required: Yes OperationEndTime The time the most recent patching operation completed on the managed node. InstancePatchState API Version 2014-11-06 1046 AWS Systems Manager Type: Timestamp Required: Yes OperationStartTime API Reference The time the most recent patching operation was started on the managed node. Type: Timestamp Required: Yes PatchGroup The name of the patch group the managed node belongs to. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Required: Yes AvailableSecurityUpdateCount The number of security-related patches that are available but not approved because they didn't meet the patch baseline requirements. For example, an updated version of a patch might have been released before the speciﬁed auto-approval period was over. Applies to Windows Server managed nodes only. Type: Integer Required: No CriticalNonCompliantCount The number of patches per node that are speciﬁed 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 Required: No Contents API Version 2014-11-06 1047 AWS Systems Manager FailedCount API Reference The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install. Type: Integer Required: No InstalledCount The number of patches from the patch baseline that are installed on the managed node. Type: Integer Required: No InstalledOtherCount The number of patches not speciﬁed in the patch baseline that are installed on the managed node. Type: Integer Required: No InstalledPendingRebootCount The number of patches installed by Patch Manager since the last time the managed node was rebooted. Type: Integer Required: No InstalledRejectedCount The number of patches installed on a managed node that are speciﬁed in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list. Note If ALLOW_AS_DEPENDENCY is the speciﬁed option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero). Contents API Version 2014-11-06 1048 AWS Systems Manager Type: Integer Required: No InstallOverrideList API Reference An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches speciﬁed by the default patch baseline. For more information about the InstallOverrideList parameter, see SSM Command document for patching: AWS-RunPatchBaseline in the AWS Systems Manager User Guide. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^https://.+$\|^s3://([^/]+)/(.?([^/]+))$ Required: No LastNoRebootInstallOperationTime The time of the last attempt to patch the managed node with NoReboot speciﬁed as the reboot option. Type: Timestamp Required: No MissingCount The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed. Type: Integer Required: No NotApplicableCount The number of patches from the patch baseline that aren't applicable for the managed node and therefore aren't installed on the node. This number may be truncated if the list Contents API Version 2014-11-06 1049 AWS Systems Manager API Reference of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount. Type: Integer Required: No OtherNonCompliantCount The number of patches per node that are speciﬁed 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 Required: No OwnerInformation Placeholder information. This ﬁeld will always be empty in the current release of the service. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No RebootOption Indicates the reboot option
systems-manager-api-194	systems-manager-api.pdf	194	API Version 2014-11-06 1049 AWS Systems Manager API Reference of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount. Type: Integer Required: No OtherNonCompliantCount The number of patches per node that are speciﬁed 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 Required: No OwnerInformation Placeholder information. This ﬁeld will always be empty in the current release of the service. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No RebootOption Indicates the reboot option speciﬁed in the patch baseline. Note Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations. • RebootIfNeeded: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot. • NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in eﬀect until a reboot is performed. Contents API Version 2014-11-06 1050 AWS Systems Manager Type: String Valid Values: RebootIfNeeded \| NoReboot Required: No SecurityNonCompliantCount API Reference The number of patches per node that are speciﬁed 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 Required: No SnapshotId The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected. 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: No UnreportedNotApplicableCount The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a tool in AWS Systems Manager. Type: Integer Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2014-11-06 1051 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1052 AWS Systems Manager API Reference InstancePatchStateFilter Deﬁnes a ﬁlter used in DescribeInstancePatchStatesForPatchGroup to scope down the information returned by the API. Example: To ﬁlter for all managed nodes in a patch group having more than three patches with a FailedCount status, use the following for the ﬁlter: • Value for Key: FailedCount • Value for Type: GreaterThan • Value for Values: 3 Contents Key The key for the ﬁlter. Supported values include the following: • InstalledCount • InstalledOtherCount • InstalledPendingRebootCount • InstalledRejectedCount • MissingCount • FailedCount • UnreportedNotApplicableCount • NotApplicableCount Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: Yes Type The type of comparison that should be performed for the value. Type: String InstancePatchStateFilter API Version 2014-11-06 1053 AWS Systems Manager API Reference Valid Values: Equal \| NotEqual \| LessThan \| GreaterThan Required: Yes Values The value for the ﬁlter. Must be an integer greater than or equal to 0. Type: Array of strings Array Members: Fixed number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1054 AWS Systems Manager InstanceProperty An object containing various properties of a managed node. API Reference Contents ActivationId The activation ID created by Systems Manager when the server or virtual machine (VM) was registered Type: String Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ Required: No AgentVersion The version of SSM Agent running on your managed node. Type: String Pattern: ^[0-9]{1,6}(\.[0-9]{1,6}){2,3}$ Required: No Architecture The CPU architecture of the node. For example, x86_64. Type: String Length Constraints: Maximum length of 120. Required: No AssociationOverview Status information about the aggregated associations. Type: InstanceAggregatedAssociationOverview object Required: No InstanceProperty API Version 2014-11-06 1055 AWS Systems Manager AssociationStatus API Reference The status of the State Manager association applied to the managed node. Type: String Required: No ComputerName The fully qualiﬁed host name of the managed node. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No IamRole The IAM role used in the hybrid activation to register the node with Systems Manager. Type: String Length Constraints: Maximum length of 64. Required: No InstanceId The ID of the managed node. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) Required: No InstanceRole The instance proﬁle attached to the node. If an instance proﬁle isn't attached to the node, this value is blank. Type: String Length Constraints: Maximum length of 120. Contents API Version 2014-11-06 1056 API Reference AWS Systems Manager Required: No InstanceState The
systems-manager-api-195	systems-manager-api.pdf	195	of the managed node. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No IamRole The IAM role used in the hybrid activation to register the node with Systems Manager. Type: String Length Constraints: Maximum length of 64. Required: No InstanceId The ID of the managed node. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) Required: No InstanceRole The instance proﬁle attached to the node. If an instance proﬁle isn't attached to the node, this value is blank. Type: String Length Constraints: Maximum length of 120. Contents API Version 2014-11-06 1056 API Reference AWS Systems Manager Required: No InstanceState The current state of the node. Type: String Length Constraints: Maximum length of 120. Required: No InstanceType The instance type of the managed node. For example, t3.large. Type: String Length Constraints: Maximum length of 120. Required: No IPAddress The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank. Type: String Length Constraints: Minimum length of 1. Maximum length of 46. Required: No KeyName The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank. Type: String Length Constraints: Maximum length of 255. Required: No LastAssociationExecutionDate The date the association was last run. Contents API Version 2014-11-06 1057 AWS Systems Manager Type: Timestamp Required: No LastPingDateTime API Reference The date and time when the SSM Agent last pinged the Systems Manager service. Type: Timestamp Required: No LastSuccessfulAssociationExecutionDate The last date the association was successfully run. Type: Timestamp Required: No LaunchTime The timestamp for when the node was launched. Type: Timestamp Required: No Name The value of the EC2 Name tag associated with the node. If a Name tag hasn't been applied to the node, this value is blank. Type: String Length Constraints: Maximum length of 255. Required: No PingStatus Connection status of the SSM Agent on the managed node. Type: String Valid Values: Online \| ConnectionLost \| Inactive Contents API Version 2014-11-06 1058 AWS Systems Manager Required: No PlatformName API Reference The name of the operating system platform running on your managed node. Type: String Length Constraints: Maximum length of 120. Required: No PlatformType The operating system platform type of the managed node. For example, Windows Server or Amazon Linux 2. Type: String Valid Values: Windows \| Linux \| MacOS Required: No PlatformVersion The version of the OS platform running on your managed node. Type: String Length Constraints: Maximum length of 120. Required: No RegistrationDate The date the node was registered with Systems Manager. Type: Timestamp Required: No ResourceType The type of managed node. Type: String Contents API Version 2014-11-06 1059 AWS Systems Manager Required: No SourceId The ID of the source resource. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. API Reference Pattern: ^[a-zA-Z0-9:_-]*$ Required: No SourceType The type of the source resource. Type: String Valid Values: AWS::EC2::Instance \| AWS::IoT::Thing \| AWS::SSM::ManagedInstance Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1060 AWS Systems Manager API Reference InstancePropertyFilter Describes a ﬁlter for a speciﬁc list of managed nodes. You can ﬁlter node information by using tags. You specify tags by using a key-value mapping. Contents key The name of the ﬁlter. Type: String Valid Values: InstanceIds \| AgentVersion \| PingStatus \| PlatformTypes \| DocumentName \| ActivationIds \| IamRole \| ResourceType \| AssociationStatus Required: Yes valueSet The ﬁlter values. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 40 items. Length Constraints: Minimum length of 1. Maximum length of 100000. Pattern: ^.{1,100000}$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InstancePropertyFilter API Version 2014-11-06 1061 AWS Systems Manager API Reference See Also API Version 2014-11-06 1062 AWS Systems Manager API Reference InstancePropertyStringFilter The ﬁlters to describe or get information about your managed nodes. Contents Key The ﬁlter key name to describe your managed nodes. Type: String Length Constraints: Minimum length of 1. Maximum length of 100000. Pattern: ^.{1,100000}$ Required: Yes Values The ﬁlter key name to describe your managed nodes. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 40 items. Length Constraints: Minimum length of 1. Maximum length of 100000. Pattern: ^.{1,100000}$ Required: Yes Operator The operator used by the ﬁlter call. Type: String Valid Values: Equal \| NotEqual \| BeginWith \| LessThan \| GreaterThan Required: No InstancePropertyStringFilter API Version 2014-11-06 1063 AWS Systems Manager See Also API Reference
systems-manager-api-196	systems-manager-api.pdf	196	The ﬁlter key name to describe your managed nodes. Type: String Length Constraints: Minimum length of 1. Maximum length of 100000. Pattern: ^.{1,100000}$ Required: Yes Values The ﬁlter key name to describe your managed nodes. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 40 items. Length Constraints: Minimum length of 1. Maximum length of 100000. Pattern: ^.{1,100000}$ Required: Yes Operator The operator used by the ﬁlter call. Type: String Valid Values: Equal \| NotEqual \| BeginWith \| LessThan \| GreaterThan Required: No InstancePropertyStringFilter API Version 2014-11-06 1063 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1064 AWS Systems Manager API Reference InventoryAggregator Speciﬁes the inventory type and attribute for the aggregation execution. Contents Aggregators Nested aggregators to further reﬁne aggregation for an inventory type. Type: Array of InventoryAggregator objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: No Expression The inventory type and attribute name for aggregation. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No Groups A user-deﬁned set of one or more ﬁlters on which to aggregate inventory data. Groups return a count of resources that match and don't match the speciﬁed criteria. Type: Array of InventoryGroup objects Array Members: Minimum number of 1 item. Maximum number of 15 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ InventoryAggregator API Version 2014-11-06 1065 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1066 AWS Systems Manager API Reference InventoryDeletionStatusItem Status information returned by the DeleteInventory operation. Contents DeletionId The deletion ID 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 DeletionStartTime The UTC timestamp when the delete operation started. Type: Timestamp Required: No DeletionSummary Information about the delete operation. For more information about this summary, see Understanding the delete inventory summary in the AWS Systems Manager User Guide. Type: InventoryDeletionSummary object Required: No LastStatus The status of the operation. Possible values are InProgress and Complete. Type: String Valid Values: InProgress \| Complete Required: No LastStatusMessage Information about the status. InventoryDeletionStatusItem API Version 2014-11-06 1067 API Reference AWS Systems Manager Type: String Required: No LastStatusUpdateTime The UTC timestamp of when the last status report. Type: Timestamp Required: No TypeName The name of the inventory data type. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS\|Custom):.*$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1068 AWS Systems Manager API Reference InventoryDeletionSummary Information about the delete operation. Contents RemainingCount Remaining number of items to delete. Type: Integer Required: No SummaryItems A list of counts and versions for deleted items. Type: Array of InventoryDeletionSummaryItem objects Required: No TotalCount The total number of items to delete. This count doesn't change during the delete operation. Type: Integer Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InventoryDeletionSummary API Version 2014-11-06 1069 AWS Systems Manager API Reference InventoryDeletionSummaryItem Either a count, remaining count, or a version number in a delete inventory summary. Contents Count A count of the number of deleted items. Type: Integer Required: No RemainingCount The remaining number of items to delete. Type: Integer Required: No Version The inventory type version. Type: String Pattern: ^([0-9]{1,6})(\.[0-9]{1,6})$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InventoryDeletionSummaryItem API Version 2014-11-06 1070 AWS Systems Manager InventoryFilter API Reference One or more ﬁlters. Use a ﬁlter to return a more speciﬁc list of results. Contents Key The name of the ﬁlter key. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: Yes Values Inventory ﬁlter values. Example: inventory ﬁlter where managed node IDs are speciﬁed as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 40 items. Required: Yes Type The type of ﬁlter. Note The Exists ﬁlter must be used with aggregators. For more information, see Aggregating inventory
systems-manager-api-197	systems-manager-api.pdf	197	1070 AWS Systems Manager InventoryFilter API Reference One or more ﬁlters. Use a ﬁlter to return a more speciﬁc list of results. Contents Key The name of the ﬁlter key. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: Yes Values Inventory ﬁlter values. Example: inventory ﬁlter where managed node IDs are speciﬁed as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 40 items. Required: Yes Type The type of ﬁlter. Note The Exists ﬁlter must be used with aggregators. For more information, see Aggregating inventory data in the AWS Systems Manager User Guide. Type: String Valid Values: Equal \| NotEqual \| BeginWith \| LessThan \| GreaterThan \| Exists Required: No InventoryFilter API Version 2014-11-06 1071 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1072 AWS Systems Manager InventoryGroup API Reference A user-deﬁned set of one or more ﬁlters on which to aggregate inventory data. Groups return a count of resources that match and don't match the speciﬁed criteria. Contents Filters Filters deﬁne the criteria for the group. The matchingCount ﬁeld displays the number of resources that match the criteria. The notMatchingCount ﬁeld displays the number of resources that don't match the criteria. Type: Array of InventoryFilter objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: Yes Name The name of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InventoryGroup API Version 2014-11-06 1073 AWS Systems Manager InventoryItem API Reference Information collected from managed nodes based on your inventory policy document Contents CaptureTime The time the inventory information was collected. 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)$ Required: Yes SchemaVersion The schema version for the inventory item. Type: String Pattern: ^([0-9]{1,6})(\.[0-9]{1,6})$ Required: Yes TypeName The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS\|Custom):.*$ Required: Yes Content The inventory data of the inventory type. InventoryItem API Version 2014-11-06 1074 AWS Systems Manager API Reference 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. Required: No ContentHash MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update. Type: String Length Constraints: Maximum length of 256. Required: No Context A map of associated properties for a speciﬁed inventory type. For example, with this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType properties of the AWS:ComplianceItem type. Type: String to string map 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. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2014-11-06 1075 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1076 AWS Systems Manager API Reference InventoryItemAttribute Attributes are the entries within the inventory item content. It contains name and value. Contents DataType The data type of the inventory item attribute. Type: String Valid Values: string \| number Required: Yes Name Name of the inventory item attribute. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InventoryItemAttribute API Version 2014-11-06 1077 AWS Systems Manager API Reference InventoryItemSchema The inventory item schema deﬁnition. Users can use this to compose inventory query ﬁlters. Contents Attributes The schema attributes for inventory. This contains data type and attribute name. Type: Array of InventoryItemAttribute objects Array
systems-manager-api-198	systems-manager-api.pdf	198	String Valid Values: string \| number Required: Yes Name Name of the inventory item attribute. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InventoryItemAttribute API Version 2014-11-06 1077 AWS Systems Manager API Reference InventoryItemSchema The inventory item schema deﬁnition. Users can use this to compose inventory query ﬁlters. Contents Attributes The schema attributes for inventory. This contains data type and attribute name. Type: Array of InventoryItemAttribute objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: Yes TypeName The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS\|Custom):.$ Required: Yes DisplayName The alias name of the inventory type. The alias name is used for display purposes. Type: String Required: No Version The schema version for the inventory item. Type: String InventoryItemSchema API Version 2014-11-06 1078 AWS Systems Manager API Reference Pattern: ^([0-9]{1,6})(\.[0-9]{1,6})$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1079 AWS Systems Manager API Reference InventoryResultEntity Inventory query results. Contents Data The data section in the inventory result entity JSON. Type: String to InventoryResultItem object map Required: No Id ID of the inventory result entity. For example, for managed node inventory the result will be the managed node ID. For EC2 instance inventory, the result will be the instance ID. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InventoryResultEntity API Version 2014-11-06 1080 AWS Systems Manager API Reference InventoryResultItem The inventory result item. Contents Content Contains all the inventory data of the item type. Results include attribute names and values. 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. Required: Yes SchemaVersion The schema version for the inventory result item/ Type: String Pattern: ^([0-9]{1,6})(\.[0-9]{1,6})$ Required: Yes TypeName The name of the inventory result item type. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS\|Custom):.$ Required: Yes InventoryResultItem API Version 2014-11-06 1081 AWS Systems Manager CaptureTime The time inventory item data was captured. Type: String API Reference 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)$ Required: No ContentHash MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update. Type: String Length Constraints: Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1082 AWS Systems Manager LoggingInfo API Reference Information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node- level logs to. Note 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. Contents S3BucketName The name of an S3 bucket where execution logs are stored. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Required: Yes S3Region The AWS Region where the S3 bucket is located. Type: String Length Constraints: Minimum length of 3. Maximum length of 20. Required: Yes S3KeyPreﬁx (Optional) The S3 bucket subfolder. Type: String Length Constraints: Maximum length of 500. LoggingInfo API Version 2014-11-06 1083 AWS Systems Manager Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1084 AWS Systems Manager API Reference MaintenanceWindowAutomationParameters The parameters for an AUTOMATION task type. Contents DocumentVersion
systems-manager-api-199	systems-manager-api.pdf	199	bucket is located. Type: String Length Constraints: Minimum length of 3. Maximum length of 20. Required: Yes S3KeyPreﬁx (Optional) The S3 bucket subfolder. Type: String Length Constraints: Maximum length of 500. LoggingInfo API Version 2014-11-06 1083 AWS Systems Manager Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1084 AWS Systems Manager API Reference MaintenanceWindowAutomationParameters The parameters for an AUTOMATION task type. Contents DocumentVersion The version of an Automation runbook to use during task execution. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]*$) Required: No Parameters The parameters for the AUTOMATION task. For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask. Note 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. 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. For AUTOMATION task types, AWS Systems Manager ignores any values speciﬁed for these parameters. Type: String to array of strings map MaintenanceWindowAutomationParameters API Version 2014-11-06 1085 AWS Systems Manager API Reference 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 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1086 AWS Systems Manager API Reference MaintenanceWindowExecution Describes the information about an execution of a maintenance window. Contents EndTime The time the execution ﬁnished. Type: Timestamp Required: No StartTime The time the execution started. Type: Timestamp Required: No Status The status of the execution. Type: String Valid Values: PENDING \| IN_PROGRESS \| SUCCESS \| FAILED \| TIMED_OUT \| CANCELLING \| CANCELLED \| SKIPPED_OVERLAPPING Required: No StatusDetails The details explaining the status. Not available for all status values. Type: String Length Constraints: Minimum length of 0. Maximum length of 250. Required: No WindowExecutionId The ID of the maintenance window execution. MaintenanceWindowExecution API Version 2014-11-06 1087 AWS Systems Manager Type: String Length Constraints: Fixed length of 36. API Reference 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 WindowId The ID of the maintenance window. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1088 AWS Systems Manager API Reference MaintenanceWindowExecutionTaskIdentity Information about a task execution performed as part of a maintenance window execution. Contents AlarmConﬁguration The details for the CloudWatch alarm applied to your maintenance window task. Type: AlarmConﬁguration object Required: No EndTime The time the task execution ﬁnished. Type: Timestamp Required: No StartTime The time the task execution started. Type: Timestamp Required: No Status The status of the task execution. Type: String Valid Values: PENDING \| IN_PROGRESS \| SUCCESS \| FAILED \| TIMED_OUT \| CANCELLING \| CANCELLED \| SKIPPED_OVERLAPPING Required: No StatusDetails The details explaining the status of the task execution. Not available for all status values. Type: String MaintenanceWindowExecutionTaskIdentity API Version 2014-11-06 1089 AWS Systems Manager API Reference Length Constraints: Minimum length of 0. Maximum length of 250. Required: No TaskArn The Amazon Resource Name (ARN) of the task that ran. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Required: No TaskExecutionId The ID of the speciﬁc task execution in 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}$ Required: No TaskType The type of task that ran. Type: String Valid Values: RUN_COMMAND \| AUTOMATION \| STEP_FUNCTIONS \| LAMBDA Required: No TriggeredAlarms The CloudWatch alarm that was invoked by the maintenance window task. Type: Array of AlarmStateInformation objects Array Members: Fixed number of 1 item. Required: No Contents API Version 2014-11-06 1090 AWS Systems Manager WindowExecutionId API Reference The ID of the maintenance window execution that ran 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: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see
systems-manager-api-200	systems-manager-api.pdf	200	Required: No TaskType The type of task that ran. Type: String Valid Values: RUN_COMMAND \| AUTOMATION \| STEP_FUNCTIONS \| LAMBDA Required: No TriggeredAlarms The CloudWatch alarm that was invoked by the maintenance window task. Type: Array of AlarmStateInformation objects Array Members: Fixed number of 1 item. Required: No Contents API Version 2014-11-06 1090 AWS Systems Manager WindowExecutionId API Reference The ID of the maintenance window execution that ran 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: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1091 AWS Systems Manager API Reference MaintenanceWindowExecutionTaskInvocationIdentity Describes the information about a task invocation for a particular target as part of a task execution performed as part of a maintenance window execution. Contents EndTime The time the invocation ﬁnished. Type: Timestamp Required: No ExecutionId The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID. Type: String Required: No InvocationId The ID of the task invocation. 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: No OwnerInformation User-provided value that was speciﬁed when the target was registered with the maintenance window. This was also included in any Amazon CloudWatch Events events raised during the task invocation. Type: String MaintenanceWindowExecutionTaskInvocationIdentity API Version 2014-11-06 1092 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Parameters The parameters that were provided for the invocation when it was run. Type: String Required: No StartTime The time the invocation started. Type: Timestamp Required: No Status The status of the task invocation. Type: String Valid Values: PENDING \| IN_PROGRESS \| SUCCESS \| FAILED \| TIMED_OUT \| CANCELLING \| CANCELLED \| SKIPPED_OVERLAPPING Required: No StatusDetails The details explaining the status of the task invocation. Not available for all status values. Type: String Length Constraints: Minimum length of 0. Maximum length of 250. Required: No TaskExecutionId The ID of the speciﬁc task execution in the maintenance window execution. Type: String Contents API Version 2014-11-06 1093 AWS Systems Manager API Reference 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: No TaskType The task type. Type: String Valid Values: RUN_COMMAND \| AUTOMATION \| STEP_FUNCTIONS \| LAMBDA Required: No WindowExecutionId The ID of the maintenance window execution that ran 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: No WindowTargetId The ID of the target deﬁnition in this maintenance window the invocation was performed for. Type: String Length Constraints: Maximum length of 36. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2014-11-06 1094 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1095 AWS Systems Manager API Reference MaintenanceWindowFilter Filter used in the request. Supported ﬁlter keys depend on the API operation that includes the ﬁlter. API operations that use MaintenanceWindowFilter> include the following: • DescribeMaintenanceWindowExecutions • DescribeMaintenanceWindowExecutionTaskInvocations • DescribeMaintenanceWindowExecutionTasks • DescribeMaintenanceWindows • DescribeMaintenanceWindowTargets • DescribeMaintenanceWindowTasks Contents Key The name of the ﬁlter. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Values The ﬁlter values. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: MaintenanceWindowFilter API Version 2014-11-06 1096 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1097 AWS Systems Manager API Reference MaintenanceWindowIdentity Information about the maintenance window. Contents Cutoﬀ 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 A description of the maintenance window. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Duration The duration of the maintenance window in hours. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Required: No Enabled Indicates whether the maintenance window is enabled. Type: Boolean Required: No MaintenanceWindowIdentity API Version 2014-11-06 1098 AWS Systems Manager EndDate API Reference The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. Type: String Required: No Name The name of the maintenance window. Type: String Length Constraints: Minimum
systems-manager-api-201	systems-manager-api.pdf	201	A description of the maintenance window. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Duration The duration of the maintenance window in hours. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Required: No Enabled Indicates whether the maintenance window is enabled. Type: Boolean Required: No MaintenanceWindowIdentity API Version 2014-11-06 1098 AWS Systems Manager EndDate API Reference The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. Type: String Required: No Name 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 NextExecutionTime The next time the maintenance window will actually run, taking into account any speciﬁed times for the maintenance window to become active or inactive. Type: String Required: No Schedule 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 ScheduleOﬀset The number of days to wait to run a maintenance window after the scheduled cron expression date and time. Type: Integer Contents API Version 2014-11-06 1099 AWS Systems Manager API Reference Valid Range: Minimum value of 1. Maximum value of 6. Required: No ScheduleTimezone The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. Type: String Required: No StartDate The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. Type: String Required: No WindowId The ID of the maintenance window. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1100 AWS Systems Manager API Reference MaintenanceWindowIdentityForTarget The maintenance window to which the speciﬁed target belongs. Contents Name 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 WindowId The ID of the maintenance window. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MaintenanceWindowIdentityForTarget API Version 2014-11-06 1101 AWS Systems Manager API Reference MaintenanceWindowLambdaParameters The parameters for a LAMBDA task type. For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask. Note 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. 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. For Lambda tasks, Systems Manager ignores any values speciﬁed for TaskParameters and LoggingInfo. Contents ClientContext Pass client-speciﬁc information to the AWS Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. Type: String Length Constraints: Minimum length of 1. Maximum length of 8000. Required: No Payload JSON to provide to your Lambda function as input. Type: Base64-encoded binary data object MaintenanceWindowLambdaParameters API Version 2014-11-06 1102 AWS Systems Manager API Reference Length Constraints: Maximum length of 4096. Required: No Qualiﬁer (Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation uses the qualiﬁed function Amazon Resource Name (ARN) to invoke a speciﬁc Lambda function. If you specify an alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1103 AWS Systems Manager API Reference MaintenanceWindowRunCommandParameters The parameters for a RUN_COMMAND task type. For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask. Note 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
systems-manager-api-202	systems-manager-api.pdf	202	more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1103 AWS Systems Manager API Reference MaintenanceWindowRunCommandParameters The parameters for a RUN_COMMAND task type. For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask. Note 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. 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. For RUN_COMMAND tasks, Systems Manager uses speciﬁed values for TaskParameters and LoggingInfo only if no values are speciﬁed for TaskInvocationParameters. Contents CloudWatchOutputConﬁg Conﬁguration options for sending command output to Amazon CloudWatch Logs. Type: CloudWatchOutputConﬁg object Required: No Comment Information about the commands to run. Type: String Length Constraints: Maximum length of 100. Required: No MaintenanceWindowRunCommandParameters API Version 2014-11-06 1104 AWS Systems Manager DocumentHash API Reference The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated. Type: String Length Constraints: Maximum length of 256. Required: No DocumentHashType SHA-256 or SHA-1. SHA-1 hashes have been deprecated. Type: String Valid Values: Sha256 \| Sha1 Required: No DocumentVersion The AWS Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT, $LATEST, or a speciﬁc version number. If you run commands by using the AWS CLI, then you must escape the ﬁrst 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 "\$DEFAULT" --document-version "\$LATEST" --document-version "3" Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]*$) Required: No NotiﬁcationConﬁg Conﬁgurations for sending notiﬁcations about command status changes on a per-managed node basis. Contents API Version 2014-11-06 1105 AWS Systems Manager API Reference Type: NotiﬁcationConﬁg object Required: No OutputS3BucketName The name of the Amazon Simple Storage Service (Amazon S3) bucket. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Required: No OutputS3KeyPreﬁx The S3 bucket subfolder. Type: String Length Constraints: Maximum length of 500. Required: No Parameters The parameters for the RUN_COMMAND task execution. Type: String to array of strings map Required: No ServiceRoleArn 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 in the in the AWS Systems Manager User Guide. Contents API Version 2014-11-06 1106 AWS Systems Manager Type: String Required: No TimeoutSeconds API Reference If this time is reached and the command hasn't already started running, it doesn't run. Type: Integer Valid Range: Minimum value of 30. Maximum value of 2592000. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1107 AWS Systems Manager API Reference MaintenanceWindowStepFunctionsParameters The parameters for a STEP_FUNCTIONS task. For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask. Note 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. 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. For Step Functions tasks, Systems Manager ignores any values speciﬁed for TaskParameters and LoggingInfo. Contents Input The inputs for the STEP_FUNCTIONS task. Type: String Length Constraints: Maximum length of 4096. Required: No Name The name of the STEP_FUNCTIONS task. Type: String Length Constraints: Minimum length of 1. Maximum length of 80. MaintenanceWindowStepFunctionsParameters API Version 2014-11-06 1108 AWS
systems-manager-api-203	systems-manager-api.pdf	203	MaintenanceWindowTaskInvocationParameters. 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. For Step Functions tasks, Systems Manager ignores any values speciﬁed for TaskParameters and LoggingInfo. Contents Input The inputs for the STEP_FUNCTIONS task. Type: String Length Constraints: Maximum length of 4096. Required: No Name The name of the STEP_FUNCTIONS task. Type: String Length Constraints: Minimum length of 1. Maximum length of 80. MaintenanceWindowStepFunctionsParameters API Version 2014-11-06 1108 AWS Systems Manager Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1109 AWS Systems Manager API Reference MaintenanceWindowTarget The target registered with the maintenance window. Contents Description A description for the target. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Name The name for the maintenance window target. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No OwnerInformation A user-provided value that will be included in any Amazon CloudWatch Events events that are 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 The type of target that is being registered with the maintenance window. Type: String MaintenanceWindowTarget API Version 2014-11-06 1110 AWS Systems Manager API Reference Valid Values: INSTANCE \| RESOURCE_GROUP Required: No Targets The targets, either managed nodes or tags. Specify managed nodes using the following format: Key=instanceids,Values=<instanceid1>,<instanceid2> Tags are speciﬁed using the following format: Key=<tag name>,Values=<tag value>. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No WindowId The ID of the maintenance window to register the target with. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: No WindowTargetId The ID of the target. 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: No Contents API Version 2014-11-06 1111 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1112 AWS Systems Manager API Reference MaintenanceWindowTask Information about a task deﬁned for a maintenance window. Contents AlarmConﬁguration The details for the CloudWatch alarm applied to your maintenance window task. Type: AlarmConﬁguration object Required: No CutoﬀBehavior The speciﬁcation for whether tasks should continue to run after the cutoﬀ time speciﬁed in the maintenance windows is reached. Type: String Valid Values: CONTINUE_TASK \| CANCEL_TASK Required: No Description A description of the task. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LoggingInfo Information about an S3 bucket to write task-level logs to. Note 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 MaintenanceWindowTask API Version 2014-11-06 1113 AWS Systems Manager API Reference information about how AWS Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. Type: LoggingInfo object Required: No MaxConcurrency The maximum number of targets this task can be run for, in parallel. Note Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases. For maintenance window tasks without a target speciﬁed, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't aﬀect 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 The maximum number of errors allowed before this task stops being scheduled. Note Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases. For maintenance window tasks without a target speciﬁed, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't aﬀect the running of your task. Contents API Version 2014-11-06 1114 AWS Systems Manager Type: String API Reference 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 The task name. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No
systems-manager-api-204	systems-manager-api.pdf	204	omitted only when you are registering or updating a targetless task You must provide a value in all other cases. For maintenance window tasks without a target speciﬁed, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't aﬀect the running of your task. Contents API Version 2014-11-06 1114 AWS Systems Manager Type: String API Reference 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 The task name. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No Priority The priority of the task in the maintenance window. 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 ServiceRoleArn 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 in the in the AWS Systems Manager User Guide. Contents API Version 2014-11-06 1115 AWS Systems Manager Type: String Required: No Targets API Reference The targets (either managed nodes or tags). Managed nodes are speciﬁed using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are speciﬁed using Key=<tag name>,Values=<tag value>. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No TaskArn The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the AWS Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Required: No TaskParameters The parameters that should be passed to the task when it is run. Note 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. Type: String to MaintenanceWindowTaskParameterValueExpression object map Key Length Constraints: Minimum length of 1. Maximum length of 255. Contents API Version 2014-11-06 1116 AWS Systems Manager Required: No Type The type of task. Type: String API Reference Valid Values: RUN_COMMAND \| AUTOMATION \| STEP_FUNCTIONS \| LAMBDA Required: No WindowId The ID of the maintenance window where the task is registered. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: No WindowTaskId The 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}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2014-11-06 1117 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1118 AWS Systems Manager API Reference MaintenanceWindowTaskInvocationParameters The parameters for task execution. Contents Automation The parameters for an AUTOMATION task type. Type: MaintenanceWindowAutomationParameters object Required: No Lambda The parameters for a LAMBDA task type. Type: MaintenanceWindowLambdaParameters object Required: No RunCommand The parameters for a RUN_COMMAND task type. Type: MaintenanceWindowRunCommandParameters object Required: No StepFunctions The parameters for a STEP_FUNCTIONS task type. Type: MaintenanceWindowStepFunctionsParameters object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ MaintenanceWindowTaskInvocationParameters API Version 2014-11-06 1119 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1120 AWS Systems Manager API Reference MaintenanceWindowTaskParameterValueExpression Deﬁnes the values for a task parameter. Contents Values This ﬁeld contains an array of 0 or more strings, each 1 to 255 characters in length. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MaintenanceWindowTaskParameterValueExpression API Version 2014-11-06 1121 AWS Systems Manager MetadataValue Metadata to assign to an Application Manager application. API Reference Contents Value Metadata value to assign to an Application Manager application. Type: String Length Constraints: Minimum length
systems-manager-api-205	systems-manager-api.pdf	205	of 0 or more strings, each 1 to 255 characters in length. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MaintenanceWindowTaskParameterValueExpression API Version 2014-11-06 1121 AWS Systems Manager MetadataValue Metadata to assign to an Application Manager application. API Reference Contents Value Metadata value to assign to an Application Manager application. Type: String Length Constraints: Minimum length of 1. Maximum length of 4096. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MetadataValue API Version 2014-11-06 1122 AWS Systems Manager Node Details about an individual managed node. Contents CaptureTime The UTC timestamp for when the managed node data was last captured. API Reference Type: Timestamp Required: No Id The ID of the managed node. Type: String Pattern: (^i-(\w{8}\|\w{17})$)\|(^mi-\w{17}$) Required: No NodeType Information about the type of node. Type: NodeType object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No Owner Information about the ownership of the managed node. Type: NodeOwnerInfo object Required: No Region The AWS Region that a managed node was created in or assigned to. Node API Version 2014-11-06 1123 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1124 AWS Systems Manager NodeAggregator API Reference One or more aggregators for viewing counts of nodes using diﬀerent dimensions. Contents AggregatorType The aggregator type for limiting a node summary. Currently, only Count is supported. Type: String Valid Values: Count Required: Yes AttributeName The name of a node attribute on which to limit the count of nodes. Type: String Valid Values: AgentVersion \| PlatformName \| PlatformType \| PlatformVersion \| Region \| ResourceType Required: Yes TypeName The data type name to use for viewing counts of nodes. Currently, only Instance is supported. Type: String Valid Values: Instance Required: Yes Aggregators Information about aggregators used to reﬁne a node summary. Type: Array of NodeAggregator objects Array Members: Minimum number of 1 item. Maximum number of 2 items. NodeAggregator API Version 2014-11-06 1125 AWS Systems Manager Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1126 API Reference AWS Systems Manager NodeFilter The ﬁlters for the operation. Contents Key The name of the ﬁlter. Type: String Valid Values: AgentType \| AgentVersion \| ComputerName \| InstanceId \| InstanceStatus \| IpAddress \| ManagedStatus \| PlatformName \| PlatformType \| PlatformVersion \| ResourceType \| OrganizationalUnitId \| OrganizationalUnitPath \| Region \| AccountId Required: Yes Values A ﬁlter value supported by the speciﬁed key. For example, for the key PlatformType, supported values include Linux and Windows. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 512. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes Type The type of ﬁlter operator. Type: String Valid Values: Equal \| NotEqual \| BeginWith Required: No NodeFilter API Version 2014-11-06 1127 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1128 API Reference AWS Systems Manager NodeOwnerInfo Information about ownership of a managed node. Contents AccountId The ID of the AWS account that owns the managed node. Type: String Pattern: [0-9]{12} Required: No OrganizationalUnitId The ID of the organization unit (OU) that the account is part of. Type: String Length Constraints: Minimum length of 1. Maximum length of 68. Pattern: ^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$ Required: No OrganizationalUnitPath The path for the organizational unit (OU) that owns the managed node. The path for the OU is built using the IDs of the organization, root, and all OUs in the path down to and including the OU. For example: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/ Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No NodeOwnerInfo API Version 2014-11-06 1129 AWS Systems Manager See Also API Reference For more information about using
systems-manager-api-206	systems-manager-api.pdf	206	of the organization unit (OU) that the account is part of. Type: String Length Constraints: Minimum length of 1. Maximum length of 68. Pattern: ^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$ Required: No OrganizationalUnitPath The path for the organizational unit (OU) that owns the managed node. The path for the OU is built using the IDs of the organization, root, and all OUs in the path down to and including the OU. For example: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/ Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No NodeOwnerInfo API Version 2014-11-06 1129 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1130 AWS Systems Manager NodeType Information about a managed node's type. Contents Important API Reference This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. Instance Information about a speciﬁc managed node. Type: InstanceInfo object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NodeType API Version 2014-11-06 1131 AWS Systems Manager API Reference NonCompliantSummary A summary of resources that aren't compliant. The summary is organized according to resource type. Contents NonCompliantCount The total number of compliance items that aren't compliant. Type: Integer Required: No SeveritySummary A summary of the non-compliance severity by compliance type Type: SeveritySummary object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NonCompliantSummary API Version 2014-11-06 1132 AWS Systems Manager NotiﬁcationConﬁg Conﬁgurations for sending notiﬁcations. Contents NotiﬁcationArn API Reference An Amazon Resource Name (ARN) for an Amazon Simple Notiﬁcation Service (Amazon SNS) topic. Run Command pushes notiﬁcations about command status changes to this topic. Type: String Required: No NotiﬁcationEvents The diﬀerent events for which you can receive notiﬁcations. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notiﬁcations in the AWS Systems Manager User Guide. Type: Array of strings Valid Values: All \| InProgress \| Success \| TimedOut \| Cancelled \| Failed Required: No NotiﬁcationType The type of notiﬁcation. • Command: Receive notiﬁcation when the status of a command changes. • Invocation: For commands sent to multiple managed nodes, receive notiﬁcation on a per- node basis when the status of a command changes. Type: String Valid Values: Command \| Invocation Required: No NotiﬁcationConﬁg API Version 2014-11-06 1133 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1134 AWS Systems Manager OpsAggregator API Reference One or more aggregators for viewing counts of OpsData using diﬀerent dimensions such as Source, CreatedTime, or Source and CreatedTime, to name a few. Contents Aggregators A nested aggregator for viewing counts of OpsData. Type: Array of OpsAggregator objects Array Members: Minimum number of 1 item. Maximum number of 12 items. Required: No AggregatorType Either a Range or Count aggregator for limiting an OpsData summary. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: ^(range\|count\|sum) Required: No AttributeName The name of an OpsData attribute on which to limit the count of OpsData. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Filters The aggregator ﬁlters. Type: Array of OpsFilter objects OpsAggregator API Version 2014-11-06 1135 AWS Systems Manager API Reference Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No TypeName The data type name to use for viewing counts of OpsData. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS\|Custom):.*$ Required: No Values The aggregator value. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 5 items. Key Length Constraints: Minimum length of 1. Maximum length of 32. Value Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1136 API Reference AWS Systems Manager OpsEntity The result of the query. Contents Data The data returned by the query. Type: String to OpsEntityItem object map Required: No Id The
systems-manager-api-207	systems-manager-api.pdf	207	Maximum number of 5 items. Key Length Constraints: Minimum length of 1. Maximum length of 32. Value Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1136 API Reference AWS Systems Manager OpsEntity The result of the query. Contents Data The data returned by the query. Type: String to OpsEntityItem object map Required: No Id The query ID. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OpsEntity API Version 2014-11-06 1137 API Reference AWS Systems Manager OpsEntityItem The OpsData summary. Contents CaptureTime The time the OpsData was captured. 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)$ Required: No Content The details of an OpsData summary. 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. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OpsEntityItem API Version 2014-11-06 1138 AWS Systems Manager API Reference See Also API Version 2014-11-06 1139 API Reference AWS Systems Manager OpsFilter A ﬁlter for viewing OpsData summaries. Contents Key The name of the ﬁlter. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: Yes Values The ﬁlter value. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 40 items. Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes Type The type of ﬁlter. Type: String Valid Values: Equal \| NotEqual \| BeginWith \| LessThan \| GreaterThan \| Exists Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: OpsFilter API Version 2014-11-06 1140 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1141 AWS Systems Manager OpsItem API Reference Operations engineers and IT professionals use AWS Systems Manager OpsCenter to view, investigate, and remediate operational work items (OpsItems) impacting the performance and health of their AWS resources. OpsCenter is integrated with Amazon EventBridge and Amazon CloudWatch. This means you can conﬁgure these services to automatically create an OpsItem in OpsCenter when a CloudWatch alarm enters the ALARM state or when EventBridge processes an event from any AWS service that publishes events. Conﬁguring Amazon CloudWatch alarms and EventBridge events to automatically create OpsItems allows you to quickly diagnose and remediate issues with AWS resources from a single console. To help you diagnose issues, each OpsItem includes contextually relevant information such as the name and ID of the AWS resource that generated the OpsItem, alarm or event details, alarm history, and an alarm timeline graph. For the AWS resource, OpsCenter aggregates information from AWS Conﬁg, AWS CloudTrail logs, and EventBridge, so you don't have to navigate across multiple console pages during your investigation. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide. Contents ActualEndTime The time a runbook workﬂow ended. Currently reported only for the OpsItem type /aws/ changerequest. Type: Timestamp Required: No ActualStartTime The time a runbook workﬂow started. Currently reported only for the OpsItem type /aws/ changerequest. Type: Timestamp Required: No Category An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security. OpsItem API Version 2014-11-06 1142 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^(?!\s$).+ Required: No CreatedBy The ARN of the AWS account that created the OpsItem. Type: String Required: No CreatedTime The date and time the OpsItem was created. Type: Timestamp Required: No Description The OpsItem description. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\s\S]\S[\s\S]* Required: No LastModiﬁedBy The ARN of the AWS account that last updated the OpsItem. Type: String Required: No LastModiﬁedTime The date and time the OpsItem was last updated. Contents API Version 2014-11-06 1143 AWS Systems Manager Type: Timestamp Required: No Notiﬁcations API Reference The Amazon Resource Name (ARN) of an Amazon Simple Notiﬁcation Service (Amazon SNS) topic where notiﬁcations are sent when this OpsItem is edited or changed.
systems-manager-api-208	systems-manager-api.pdf	208	No CreatedTime The date and time the OpsItem was created. Type: Timestamp Required: No Description The OpsItem description. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\s\S]\S[\s\S] Required: No LastModiﬁedBy The ARN of the AWS account that last updated the OpsItem. Type: String Required: No LastModiﬁedTime The date and time the OpsItem was last updated. Contents API Version 2014-11-06 1143 AWS Systems Manager Type: Timestamp Required: No Notiﬁcations API Reference The Amazon Resource Name (ARN) of an Amazon Simple Notiﬁcation Service (Amazon SNS) topic where notiﬁcations are sent when this OpsItem is edited or changed. Type: Array of OpsItemNotiﬁcation objects Required: No OperationalData Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log ﬁles, 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. Important 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 operation) can view and search on the speciﬁed data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem 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 in the AWS Systems Manager User Guide. Type: String to OpsItemDataValue object map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!\s$).+ Contents API Version 2014-11-06 1144 AWS Systems Manager Required: No OpsItemArn The OpsItem Amazon Resource Name (ARN). Type: String API Reference 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 The ID of the OpsItem. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Required: No OpsItemType The type of OpsItem. Systems Manager supports the following types of OpsItems: • /aws/issue This type of OpsItem is used for default OpsItems created by OpsCenter. • /aws/changerequest This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests. • /aws/insight This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems. Type: String Required: No Contents API Version 2014-11-06 1145 AWS Systems Manager PlannedEndTime API Reference The time speciﬁed in a change request for a runbook workﬂow to end. Currently supported only for the OpsItem type /aws/changerequest. Type: Timestamp Required: No PlannedStartTime The time speciﬁed in a change request for a runbook workﬂow to start. Currently supported only for the OpsItem type /aws/changerequest. Type: Timestamp Required: No Priority 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 One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource. Type: Array of RelatedOpsItem objects Required: No Severity The severity of the OpsItem. Severity options range from 1 to 4. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Contents API Version 2014-11-06 1146 AWS Systems Manager Pattern: ^(?!\s$).+ Required: No Source API Reference The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^(?!\s$).+ Required: No Status The OpsItem status. For more information, see Editing OpsItem details 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 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 Contents API Version 2014-11-06 1147 AWS Systems Manager Version API Reference The version of this OpsItem. Each time the OpsItem is edited the version number increments by one. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK
systems-manager-api-209	systems-manager-api.pdf	209	\| Closed Required: No Title 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 Contents API Version 2014-11-06 1147 AWS Systems Manager Version API Reference The version of this OpsItem. Each time the OpsItem is edited the version number increments by one. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1148 AWS Systems Manager OpsItemDataValue API Reference An object that deﬁnes the value of the key and its type in the OperationalData map. Contents Type The type of key-value pair. Valid types include SearchableString and String. Type: String Valid Values: SearchableString \| String Required: No Value The value of the OperationalData key. Type: String Pattern: [\s\S]\S[\s\S]* Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OpsItemDataValue API Version 2014-11-06 1149 AWS Systems Manager OpsItemEventFilter API Reference Describes a ﬁlter for a speciﬁc list of OpsItem events. You can ﬁlter event information by using tags. You specify tags by using a key-value pair mapping. Contents Key The name of the ﬁlter key. Currently, the only supported value is OpsItemId. Type: String Valid Values: OpsItemId Required: Yes Operator The operator used by the ﬁlter call. Currently, the only supported value is Equal. Type: String Valid Values: Equal Required: Yes Values The values for the ﬁlter, consisting of one or more OpsItem IDs. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 15. Pattern: ^(oi)-[0-9a-f]{12}$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: OpsItemEventFilter API Version 2014-11-06 1150 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1151 AWS Systems Manager API Reference OpsItemEventSummary Summary information about an OpsItem event or that associated an OpsItem with a related item. Contents CreatedBy Information about the user or resource that created the OpsItem event. Type: OpsItemIdentity object Required: No CreatedTime The date and time the OpsItem event was created. Type: Timestamp Required: No Detail Speciﬁc information about the OpsItem event. Type: String Required: No DetailType The type of information provided as a detail. Type: String Required: No EventId The ID of the OpsItem event. Type: String Required: No OpsItemEventSummary API Version 2014-11-06 1152 API Reference AWS Systems Manager OpsItemId The ID of the OpsItem. Type: String Required: No Source The source of the OpsItem event. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1153 API Reference AWS Systems Manager OpsItemFilter Describes an OpsItem ﬁlter. Contents Key The name of the ﬁlter. Type: String Valid Values: Status \| CreatedBy \| Source \| Priority \| Title \| OpsItemId \| CreatedTime \| LastModifiedTime \| ActualStartTime \| ActualEndTime \| PlannedStartTime \| PlannedEndTime \| OperationalData \| OperationalDataKey \| OperationalDataValue \| ResourceId \| AutomationId \| Category \| Severity \| OpsItemType \| AccessRequestByRequesterArn \| AccessRequestByRequesterId \| AccessRequestByApproverArn \| AccessRequestByApproverId \| AccessRequestBySourceAccountId \| AccessRequestBySourceOpsItemId \| AccessRequestBySourceRegion \| AccessRequestByIsReplica \| AccessRequestByTargetResourceId \| ChangeRequestByRequesterArn \| ChangeRequestByRequesterName \| ChangeRequestByApproverArn \| ChangeRequestByApproverName \| ChangeRequestByTemplate \| ChangeRequestByTargetsResourceGroup \| InsightByType \| AccountId Required: Yes Operator The operator used by the ﬁlter call. Type: String Valid Values: Equal \| Contains \| GreaterThan \| LessThan Required: Yes Values The ﬁlter value. OpsItemFilter API Version 2014-11-06 1154 AWS Systems Manager Type: Array of strings Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1155 AWS Systems Manager OpsItemIdentity API Reference Information about the user or resource that created an OpsItem event. Contents Arn The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OpsItemIdentity API Version 2014-11-06 1156 AWS Systems Manager API Reference OpsItemNotiﬁcation A notiﬁcation about the OpsItem. Contents Arn The Amazon
systems-manager-api-210	systems-manager-api.pdf	210	V3 See Also API Version 2014-11-06 1155 AWS Systems Manager OpsItemIdentity API Reference Information about the user or resource that created an OpsItem event. Contents Arn The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OpsItemIdentity API Version 2014-11-06 1156 AWS Systems Manager API Reference OpsItemNotiﬁcation A notiﬁcation about the OpsItem. Contents Arn The Amazon Resource Name (ARN) of an Amazon Simple Notiﬁcation Service (Amazon SNS) topic where notiﬁcations are sent when this OpsItem is edited or changed. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OpsItemNotiﬁcation API Version 2014-11-06 1157 AWS Systems Manager API Reference OpsItemRelatedItemsFilter Describes a ﬁlter for a speciﬁc list of related-item resources. Contents Key The name of the ﬁlter key. Supported values include ResourceUri, ResourceType, or AssociationId. Type: String Valid Values: ResourceType \| AssociationId \| ResourceUri Required: Yes Operator The operator used by the ﬁlter call. The only supported operator is EQUAL. Type: String Valid Values: Equal Required: Yes Values The values for the ﬁlter. Type: Array of strings Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 OpsItemRelatedItemsFilter API Version 2014-11-06 1158 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1159 AWS Systems Manager API Reference OpsItemRelatedItemSummary Summary information about related-item resources for an OpsItem. Contents AssociationId The association ID. Type: String Required: No AssociationType The association type. Type: String Required: No CreatedBy Information about the user or resource that created an OpsItem event. Type: OpsItemIdentity object Required: No CreatedTime The time the related-item association was created. Type: Timestamp Required: No LastModiﬁedBy Information about the user or resource that created an OpsItem event. Type: OpsItemIdentity object Required: No OpsItemRelatedItemSummary API Version 2014-11-06 1160 AWS Systems Manager LastModiﬁedTime The time the related-item association was last updated. API Reference Type: Timestamp Required: No OpsItemId The OpsItem ID. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Required: No ResourceType The resource type. Type: String Required: No ResourceUri The Amazon Resource Name (ARN) of the related-item resource. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1161 AWS Systems Manager OpsItemSummary A count of OpsItems. Contents ActualEndTime API Reference The time a runbook workﬂow ended. Currently reported only for the OpsItem type /aws/ changerequest. Type: Timestamp Required: No ActualStartTime The time a runbook workﬂow started. Currently reported only for the OpsItem type /aws/ changerequest. Type: Timestamp Required: No Category A list of OpsItems by category. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^(?!\s$).+ Required: No CreatedBy The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem. Type: String Required: No OpsItemSummary API Version 2014-11-06 1162 API Reference AWS Systems Manager CreatedTime The date and time the OpsItem was created. Type: Timestamp Required: No LastModiﬁedBy The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem. Type: String Required: No LastModiﬁedTime The date and time the OpsItem was last updated. Type: Timestamp Required: No OperationalData Operational data is custom data that provides useful reference details about the OpsItem. Type: String to OpsItemDataValue object map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!\s$).+ Required: No OpsItemId The ID of the OpsItem. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Required: No Contents API Version 2014-11-06 1163 AWS Systems Manager OpsItemType API Reference The type of OpsItem. Systems Manager supports the following types of OpsItems: • /aws/issue This type of OpsItem is used for default OpsItems created by OpsCenter. • /aws/changerequest This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests. • /aws/insight This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems. Type: String Required: No PlannedEndTime The time speciﬁed in a change request for a runbook workﬂow to end. Currently supported only for the OpsItem type /aws/changerequest. Type: Timestamp Required: No PlannedStartTime The time speciﬁed in a change request for a runbook workﬂow to start. Currently supported only for the OpsItem type /aws/changerequest. Type: Timestamp Required: No Priority The importance of this OpsItem in
systems-manager-api-211	systems-manager-api.pdf	211	OpsCenter. • /aws/changerequest This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests. • /aws/insight This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems. Type: String Required: No PlannedEndTime The time speciﬁed in a change request for a runbook workﬂow to end. Currently supported only for the OpsItem type /aws/changerequest. Type: Timestamp Required: No PlannedStartTime The time speciﬁed in a change request for a runbook workﬂow to start. Currently supported only for the OpsItem type /aws/changerequest. Type: Timestamp Required: No Priority 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. Contents API Version 2014-11-06 1164 AWS Systems Manager Required: No Severity A list of OpsItems by severity. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. API Reference Pattern: ^(?!\s$).+ Required: No Source The impacted AWS resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^(?!\s$).+ Required: No Status The OpsItem status. 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 A short heading that describes the nature of the OpsItem and the impacted resource. Type: String Contents API Version 2014-11-06 1165 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^(?!\s$).+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1166 API Reference AWS Systems Manager OpsMetadata Operational metadata for an application in Application Manager. Contents CreationDate The date the OpsMetadata objects was created. Type: Timestamp Required: No LastModiﬁedDate The date the OpsMetadata object was last updated. Type: Timestamp Required: No LastModiﬁedUser The user name who last updated the OpsMetadata object. Type: String Required: No OpsMetadataArn The Amazon Resource Name (ARN) of the OpsMetadata Object or blob. 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: No ResourceId The ID of the Application Manager application. OpsMetadata API Version 2014-11-06 1167 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^(?!\s$).+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1168 AWS Systems Manager OpsMetadataFilter A ﬁlter to limit the number of OpsMetadata objects displayed. API Reference Contents Key A ﬁlter key. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^(?!\s$).+ Required: Yes Values A ﬁlter value. 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 1024. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OpsMetadataFilter API Version 2014-11-06 1169 AWS Systems Manager OpsResultAttribute The OpsItem data type to return. Contents TypeName API Reference Name of the data type. Valid value: AWS:OpsItem, AWS:EC2InstanceInformation, AWS:OpsItemTrendline, or AWS:ComplianceSummary. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS\|Custom):.$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OpsResultAttribute API Version 2014-11-06 1170 AWS Systems Manager OutputSource API Reference Information about the source where the association execution details are stored. Contents OutputSourceId The ID of the output source, for example the URL of an S3 bucket. Type: String Length Constraints: Fixed length of 36. Required: No OutputSourceType The type of source where the association execution details are stored, for example, Amazon S3. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OutputSource API Version 2014-11-06 1171 AWS Systems Manager Parameter An AWS Systems Manager parameter in Parameter Store. API Reference Contents ARN The Amazon Resource Name (ARN) of the parameter. Type: String Required: No DataType The data type of the parameter, such as
systems-manager-api-212	systems-manager-api.pdf	212	Required: No OutputSourceType The type of source where the association execution details are stored, for example, Amazon S3. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OutputSource API Version 2014-11-06 1171 AWS Systems Manager Parameter An AWS Systems Manager parameter in Parameter Store. API Reference Contents ARN The Amazon Resource Name (ARN) of the parameter. Type: String Required: No DataType The data type of the parameter, such as text or aws:ec2:image. The default is text. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Required: No LastModiﬁedDate Date the parameter was last changed or updated and the parameter version was created. Type: Timestamp Required: No Name The name of the parameter. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Selector Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats: Parameter API Version 2014-11-06 1172 AWS Systems Manager API Reference parameter_name:version parameter_name:label Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Required: No SourceResult Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source. Type: String Required: No Type The type of parameter. Valid values include the following: String, StringList, and SecureString. Note If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value ﬁeld. Type: String Valid Values: String \| StringList \| SecureString Required: No Value The parameter value. Note If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value ﬁeld. Contents API Version 2014-11-06 1173 API Reference AWS Systems Manager Type: String Required: No Version The parameter version. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1174 AWS Systems Manager ParameterHistory Information about parameter usage. Contents AllowedPattern API Reference Parameter names can include the following letters and symbols. a-zA-Z0-9_.- Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No DataType The data type of the parameter, such as text or aws:ec2:image. The default is text. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Required: No Description Information about the parameter. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No KeyId The alias of the AWS Key Management Service (AWS KMS) key used to encrypt the parameter. Applies to SecureString parameters only Type: String ParameterHistory API Version 2014-11-06 1175 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([a-zA-Z0-9:/_-]+)$ Required: No Labels Labels assigned to the 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: No LastModiﬁedDate Date the parameter was last changed or updated. Type: Timestamp Required: No LastModiﬁedUser Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter. Type: String Required: No Name The name of the parameter. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Policies Information about the policies assigned to a parameter. Contents API Version 2014-11-06 1176 AWS Systems Manager API Reference Assigning parameter policies in the AWS Systems Manager User Guide. Type: Array of ParameterInlinePolicy objects Required: No Tier The parameter tier. Type: String Valid Values: Standard \| Advanced \| Intelligent-Tiering Required: No Type The type of parameter used. Type: String Valid Values: String \| StringList \| SecureString Required: No Value The parameter value. Type: String Required: No Version The parameter version. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2014-11-06 1177 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1178 AWS Systems Manager API Reference ParameterInlinePolicy One or more policies assigned to a parameter. Contents PolicyStatus The status of the policy. Policies report the following statuses: Pending (the policy hasn't been enforced or applied yet), Finished (the policy was applied), Failed (the policy wasn't applied), or InProgress (the policy is being applied now). Type: String Required: No PolicyText The JSON text of the policy. Type: String Required: No PolicyType The type of policy. Parameter Store,
systems-manager-api-213	systems-manager-api.pdf	213	• AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1178 AWS Systems Manager API Reference ParameterInlinePolicy One or more policies assigned to a parameter. Contents PolicyStatus The status of the policy. Policies report the following statuses: Pending (the policy hasn't been enforced or applied yet), Finished (the policy was applied), Failed (the policy wasn't applied), or InProgress (the policy is being applied now). Type: String Required: No PolicyText The JSON text of the policy. Type: String Required: No PolicyType The type of policy. Parameter Store, a tool in AWS Systems Manager, supports the following policy types: Expiration, ExpirationNotiﬁcation, and NoChangeNotiﬁcation. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ParameterInlinePolicy API Version 2014-11-06 1179 AWS Systems Manager API Reference See Also API Version 2014-11-06 1180 AWS Systems Manager ParameterMetadata API Reference Metadata includes information like the Amazon Resource Name (ARN) of the last user to update the parameter and the date and time the parameter was last used. Contents AllowedPattern A parameter name can include only the following letters and symbols. a-zA-Z0-9_.- Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ARN The Amazon Resource Name (ARN) of the parameter. Type: String Required: No DataType The data type of the parameter, such as text or aws:ec2:image. The default is text. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Required: No Description Description of the parameter actions. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ParameterMetadata API Version 2014-11-06 1181 AWS Systems Manager Required: No KeyId API Reference The alias of the AWS Key Management Service (AWS KMS) key used to encrypt the parameter. Applies to SecureString parameters only. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([a-zA-Z0-9:/_-]+)$ Required: No LastModiﬁedDate Date the parameter was last changed or updated. Type: Timestamp Required: No LastModiﬁedUser Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter. Type: String Required: No Name The parameter name. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Policies A list of policies associated with a parameter. Type: Array of ParameterInlinePolicy objects Contents API Version 2014-11-06 1182 AWS Systems Manager Required: No Tier The parameter tier. Type: String API Reference Valid Values: Standard \| Advanced \| Intelligent-Tiering Required: No Type The type of parameter. Valid parameter types include the following: String, StringList, and SecureString. Type: String Valid Values: String \| StringList \| SecureString Required: No Version The parameter version. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1183 AWS Systems Manager ParametersFilter This data type is deprecated. Instead, use ParameterStringFilter. API Reference Contents Key The name of the ﬁlter. Type: String Valid Values: Name \| Type \| KeyId Required: Yes Values The ﬁlter values. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ParametersFilter API Version 2014-11-06 1184 AWS Systems Manager API Reference ParameterStringFilter One or more ﬁlters. Use a ﬁlter to return a more speciﬁc list of results. Contents Key The name of the ﬁlter. The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed for Key can be used with both operations. For DescribeParameters, all of the listed patterns are valid except Label. For GetParametersByPath, the following patterns listed for Key aren't valid: tag, DataType, Name, Path, and Tier. For examples of AWS CLI commands demonstrating valid parameter ﬁlter constructions, see Searching for Systems Manager parameters in the AWS Systems Manager User Guide. Type: String Length Constraints: Minimum length of 1. Maximum length of 132. Pattern: tag:.+\|Name\|Type\|KeyId\|Path\|Label\|Tier\|DataType Required: Yes Option For all ﬁlters used with DescribeParameters, valid options include Equals and BeginsWith. The Name ﬁlter additionally supports the Contains option. (Exception: For ﬁlters using the key Path, valid options include Recursive and OneLevel.) For ﬁlters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For ﬁlters using Label as the Key name, the only valid option is Equals.) Type:
systems-manager-api-214	systems-manager-api.pdf	214	examples of AWS CLI commands demonstrating valid parameter ﬁlter constructions, see Searching for Systems Manager parameters in the AWS Systems Manager User Guide. Type: String Length Constraints: Minimum length of 1. Maximum length of 132. Pattern: tag:.+\|Name\|Type\|KeyId\|Path\|Label\|Tier\|DataType Required: Yes Option For all ﬁlters used with DescribeParameters, valid options include Equals and BeginsWith. The Name ﬁlter additionally supports the Contains option. (Exception: For ﬁlters using the key Path, valid options include Recursive and OneLevel.) For ﬁlters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For ﬁlters using Label as the Key name, the only valid option is Equals.) Type: String Length Constraints: Minimum length of 1. Maximum length of 10. ParameterStringFilter API Version 2014-11-06 1185 AWS Systems Manager Required: No Values The value you want to search for. Type: Array of strings API Reference Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1186 AWS Systems Manager ParentStepDetails A detailed status of the parent step. Contents Action The name of the automation action. Type: String Pattern: ^aws:[a-zA-Z]{3,25}$ Required: No Iteration The current repetition of the loop represented by an integer. Type: Integer Required: No IteratorValue The current value of the speciﬁed iterator in the loop. Type: String Required: No StepExecutionId The unique ID of a step execution. Type: String Required: No StepName The name of the step. Type: String ParentStepDetails API Reference API Version 2014-11-06 1187 AWS Systems Manager Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1188 AWS Systems Manager Patch Represents metadata about a patch. Contents AdvisoryIds API Reference The Advisory ID of the patch. For example, RHSA-2020:3779. Applies to Linux-based managed nodes only. Type: Array of strings Required: No Arch The architecture of the patch. For example, in example-pkg-0.710.10-2.7.abcd.x86_64, the architecture is indicated by x86_64. Applies to Linux-based managed nodes only. Type: String Required: No BugzillaIds The Bugzilla ID of the patch. For example, 1600646. Applies to Linux-based managed nodes only. Type: Array of strings Required: No Classiﬁcation The classiﬁcation of the patch. For example, SecurityUpdates, Updates, or CriticalUpdates. Type: String Required: No ContentUrl The URL where more information can be obtained about the patch. Patch API Version 2014-11-06 1189 AWS Systems Manager Type: String Required: No CVEIds API Reference The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example, CVE-2011-3192. Applies to Linux-based managed nodes only. Type: Array of strings Required: No Description The description of the patch. Type: String Required: No Epoch The epoch of the patch. For example in pkg-example-EE-20180914-2.2.amzn1.noarch, the epoch value is 20180914-2. Applies to Linux-based managed nodes only. Type: Integer Required: No Id The ID of the patch. Applies to Windows patches only. Note This ID isn't the same as the Microsoft Knowledge Base ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No Contents API Version 2014-11-06 1190 AWS Systems Manager KbNumber API Reference The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only. Type: String Required: No Language The language of the patch if it's language-speciﬁc. Type: String Required: No MsrcNumber The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to. For example, MS14-045. Applies to Windows patches only. Type: String Required: No MsrcSeverity The severity of the patch, such as Critical, Important, or Moderate. Applies to Windows patches only. Type: String Required: No Name The name of the patch. Applies to Linux-based managed nodes only. Type: String Required: No Product The speciﬁc product the patch is applicable for. For example, WindowsServer2016 or AmazonLinux2018.03. Contents API Version 2014-11-06 1191 AWS Systems Manager Type: String Required: No ProductFamily API Reference The product family the patch is applicable for. For example, Windows or Amazon Linux 2. Type: String Required: No Release The particular release of a patch. For example, in pkg-example- EE-20180914-2.2.amzn1.noarch, the release is 2.amaz1. Applies to Linux-based managed nodes only. Type: String Required: No ReleaseDate The date the patch was released. Type: Timestamp Required: No Repository The source patch repository for the operating system and version, such as trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu Server 20.04 LTE. Applies to Linux-based managed nodes only. Type: String Required: No Severity The severity level of the patch. For example, CRITICAL or MODERATE. Type: String Contents API Version 2014-11-06 1192
systems-manager-api-215	systems-manager-api.pdf	215	or Amazon Linux 2. Type: String Required: No Release The particular release of a patch. For example, in pkg-example- EE-20180914-2.2.amzn1.noarch, the release is 2.amaz1. Applies to Linux-based managed nodes only. Type: String Required: No ReleaseDate The date the patch was released. Type: Timestamp Required: No Repository The source patch repository for the operating system and version, such as trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu Server 20.04 LTE. Applies to Linux-based managed nodes only. Type: String Required: No Severity The severity level of the patch. For example, CRITICAL or MODERATE. Type: String Contents API Version 2014-11-06 1192 API Reference AWS Systems Manager Required: No Title The title of the patch. Type: String Required: No Vendor The name of the vendor providing the patch. Type: String Required: No Version The version number of the patch. For example, in example- pkg-1.710.10-2.7.abcd.x86_64, the version number is indicated by -1. Applies to Linux- based managed nodes only. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1193 AWS Systems Manager API Reference PatchBaselineIdentity Deﬁnes the basic information about a patch baseline. Contents BaselineDescription The description of the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No BaselineId The ID of the patch baseline. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Required: No BaselineName 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 DefaultBaseline Indicates whether this is the default baseline. AWS Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. PatchBaselineIdentity API Version 2014-11-06 1194 AWS Systems Manager Type: Boolean Required: No OperatingSystem API Reference Deﬁnes 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 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1195 AWS Systems Manager API Reference PatchComplianceData Information about the state of a patch on a particular managed node as it relates to the patch baseline used to patch the node. Contents Classiﬁcation The classiﬁcation of the patch, such as SecurityUpdates, Updates, and CriticalUpdates. Type: String Required: Yes InstalledTime The date/time the patch was installed on the managed node. Not all operating systems provide this level of information. Type: Timestamp Required: Yes KBId The operating system-speciﬁc ID of the patch. Type: String Required: Yes Severity The severity of the patch such as Critical, Important, and Moderate. Type: String Required: Yes State The state of the patch on the managed node, such as INSTALLED or FAILED. For descriptions of each patch state, see About patch compliance in the AWS Systems Manager User Guide. PatchComplianceData API Version 2014-11-06 1196 AWS Systems Manager Type: String API Reference Valid Values: INSTALLED \| INSTALLED_OTHER \| INSTALLED_PENDING_REBOOT \| INSTALLED_REJECTED \| MISSING \| NOT_APPLICABLE \| FAILED \| AVAILABLE_SECURITY_UPDATE Required: Yes Title The title of the patch. Type: String Required: Yes CVEIds The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch. Note Currently, CVE ID values are reported only for patches with a status of Missing or Failed. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1197 AWS Systems Manager PatchFilter API Reference Deﬁnes which patches should be included in a patch baseline. A patch ﬁlter consists of a key and a set of values. The ﬁlter key is a patch property. For example, the available ﬁlter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY. The ﬁlter values deﬁne a matching criterion for the patch property indicated by the key. For example, if the ﬁlter key is PRODUCT and the ﬁlter values are ["Office 2013", "Office 2016"], then the ﬁlter accepts all patches where product name is either "Oﬃce 2013" or "Oﬃce 2016". The ﬁlter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values. You can view lists of
systems-manager-api-216	systems-manager-api.pdf	216	of values. The ﬁlter key is a patch property. For example, the available ﬁlter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY. The ﬁlter values deﬁne a matching criterion for the patch property indicated by the key. For example, if the ﬁlter key is PRODUCT and the ﬁlter values are ["Office 2013", "Office 2016"], then the ﬁlter accepts all patches where product name is either "Oﬃce 2013" or "Oﬃce 2016". The ﬁlter values can be exact values for the patch property given as a key, or a wildcard (), which matches all values. You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties. Contents Key The key for the ﬁlter. Run the DescribePatchProperties command to view lists of valid keys for each operating system type. Type: String Valid Values: ARCH \| ADVISORY_ID \| BUGZILLA_ID \| PATCH_SET \| PRODUCT \| PRODUCT_FAMILY \| CLASSIFICATION \| CVE_ID \| EPOCH \| MSRC_SEVERITY \| NAME \| PATCH_ID \| SECTION \| PRIORITY \| REPOSITORY \| RELEASE \| SEVERITY \| SECURITY \| VERSION Required: Yes Values The value for the ﬁlter key. Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type. PatchFilter API Version 2014-11-06 1198 AWS Systems Manager Type: Array of strings API Reference Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1199 API Reference AWS Systems Manager PatchFilterGroup A set of patch ﬁlters, typically used for approval rules. Contents PatchFilters The set of patch ﬁlters that make up the group. Type: Array of PatchFilter objects Array Members: Minimum number of 0 items. Maximum number of 4 items. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PatchFilterGroup API Version 2014-11-06 1200 AWS Systems Manager API Reference PatchGroupPatchBaselineMapping The mapping between a patch group and the patch baseline the patch group is registered with. Contents BaselineIdentity The patch baseline the patch group is registered with. Type: PatchBaselineIdentity object Required: No PatchGroup 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}_.:/=+\-@])$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PatchGroupPatchBaselineMapping API Version 2014-11-06 1201 AWS Systems Manager API Reference PatchOrchestratorFilter Deﬁnes a ﬁlter used in Patch Manager APIs. Supported ﬁlter keys depend on the API operation that includes the ﬁlter. Patch Manager API operations that use PatchOrchestratorFilter include the following: • DescribeAvailablePatches • DescribeInstancePatches • DescribePatchBaselines • DescribePatchGroups Contents Key The key for the ﬁlter. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Values The value for the ﬁlter. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ PatchOrchestratorFilter API Version 2014-11-06 1202 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1203 API Reference AWS Systems Manager PatchRule Deﬁnes an approval rule for a patch baseline. Contents PatchFilterGroup The patch ﬁlter group that deﬁnes the criteria for the rule. Type: PatchFilterGroup object Required: Yes ApproveAfterDays The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released. This parameter is marked as Required: No, but your request must include a value for either ApproveAfterDays or ApproveUntilDate. Not supported for Debian Server or Ubuntu Server. Important Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the AWS Systems Manager User Guide. Type: Integer Valid Range:
systems-manager-api-217	systems-manager-api.pdf	217	approved seven days after they are released. This parameter is marked as Required: No, but your request must include a value for either ApproveAfterDays or ApproveUntilDate. Not supported for Debian Server or Ubuntu Server. Important Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the AWS Systems Manager User Guide. Type: Integer Valid Range: Minimum value of 0. Maximum value of 360. Required: No PatchRule API Version 2014-11-06 1204 AWS Systems Manager ApproveUntilDate API Reference The cutoﬀ date for auto approval of released patches. Any patches released on or before this date are installed automatically. Enter dates in the format YYYY-MM-DD. For example, 2024-12-31. This parameter is marked as Required: No, but your request must include a value for either ApproveUntilDate or ApproveAfterDays. Not supported for Debian Server or Ubuntu Server. Important Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the AWS Systems Manager User Guide. Type: String Length Constraints: Minimum length of 1. Maximum length of 10. Required: No ComplianceLevel A compliance severity level for all approved patches in a patch baseline. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| INFORMATIONAL \| UNSPECIFIED Required: No EnableNonSecurity For managed nodes identiﬁed by the approval rule ﬁlters, enables a patch baseline to apply non-security updates available in the speciﬁed repository. The default value is false. Applies to Linux managed nodes only. Contents API Version 2014-11-06 1205 AWS Systems Manager Type: Boolean Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1206 AWS Systems Manager PatchRuleGroup A set of rules deﬁning the approval rules for a patch baseline. API Reference Contents PatchRules The rules that make up the rule group. Type: Array of PatchRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PatchRuleGroup API Version 2014-11-06 1207 AWS Systems Manager PatchSource API Reference Information about the patches to use to update the managed nodes, including target operating systems and source repository. Applies to Linux managed nodes only. Contents Conﬁguration The value of the yum repo conﬁguration. For example: [main] name=MyCustomRepository baseurl=https://my-custom-repository enabled=1 Note For information about other options available for your yum repository conﬁguration, see dnf.conf(5). Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes Name The name speciﬁed to identify the patch source. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,50}$ Required: Yes PatchSource API Version 2014-11-06 1208 AWS Systems Manager Products API Reference The speciﬁc operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see PatchFilter. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1209 AWS Systems Manager PatchStatus Information about the approval status of a patch. Contents ApprovalDate API Reference The date the patch was approved (or will be approved if the status is PENDING_APPROVAL). Type: Timestamp Required: No ComplianceLevel The compliance severity level for a patch. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| INFORMATIONAL \| UNSPECIFIED Required: No DeploymentStatus The approval status of a patch. Type: String Valid Values: APPROVED \| PENDING_APPROVAL \| EXPLICIT_APPROVED \| EXPLICIT_REJECTED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 PatchStatus API Version 2014-11-06 1210 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1211 AWS Systems Manager ProgressCounters API Reference An aggregate of step execution statuses displayed
systems-manager-api-218	systems-manager-api.pdf	218	Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| INFORMATIONAL \| UNSPECIFIED Required: No DeploymentStatus The approval status of a patch. Type: String Valid Values: APPROVED \| PENDING_APPROVAL \| EXPLICIT_APPROVED \| EXPLICIT_REJECTED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 PatchStatus API Version 2014-11-06 1210 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1211 AWS Systems Manager ProgressCounters API Reference An aggregate of step execution statuses displayed in the AWS Systems Manager console for a multi-Region and multi-account Automation execution. Contents CancelledSteps The total number of steps that the system cancelled in all speciﬁed AWS Regions and AWS accounts for the current Automation execution. Type: Integer Required: No FailedSteps The total number of steps that failed to run in all speciﬁed AWS Regions and AWS accounts for the current Automation execution. Type: Integer Required: No SuccessSteps The total number of steps that successfully completed in all speciﬁed AWS Regions and AWS accounts for the current Automation execution. Type: Integer Required: No TimedOutSteps The total number of steps that timed out in all speciﬁed AWS Regions and AWS accounts for the current Automation execution. Type: Integer Required: No ProgressCounters API Version 2014-11-06 1212 AWS Systems Manager TotalSteps API Reference The total number of steps run in all speciﬁed AWS Regions and AWS accounts for the current Automation execution. Type: Integer Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1213 AWS Systems Manager API Reference RegistrationMetadataItem Reserved for internal use. Contents Key Reserved for internal use. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^(?!\s$).+ Required: Yes Value Reserved for internal use. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^(?!\s$).+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegistrationMetadataItem API Version 2014-11-06 1214 AWS Systems Manager RelatedOpsItem API Reference An OpsItems that shares something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource. Contents OpsItemId The ID of an OpsItem related to the current OpsItem. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RelatedOpsItem API Version 2014-11-06 1215 AWS Systems Manager ResolvedTargets API Reference Information about targets that resolved during the Automation execution. Contents ParameterValues A list of parameter values sent to targets that resolved during the Automation execution. Type: Array of strings Required: No Truncated A boolean value indicating whether the resolved target list is truncated. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResolvedTargets API Version 2014-11-06 1216 AWS Systems Manager API Reference ResourceComplianceSummaryItem Compliance summary information for a speciﬁc resource. Contents ComplianceType The compliance type. 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: No CompliantSummary A list of items that are compliant for the resource. Type: CompliantSummary object Required: No ExecutionSummary Information about the execution. Type: ComplianceExecutionSummary object Required: No NonCompliantSummary A list of items that aren't compliant for the resource. Type: NonCompliantSummary object Required: No OverallSeverity The highest severity item found for the resource. The resource is compliant for this item. ResourceComplianceSummaryItem API Version 2014-11-06 1217 AWS Systems Manager Type: String API Reference Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| INFORMATIONAL \| UNSPECIFIED Required: No ResourceId The resource ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No ResourceType The resource type. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Required: No Status The compliance status for the resource. Type: String Valid Values: COMPLIANT \| NON_COMPLIANT Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1218 AWS Systems Manager API Reference See Also API Version 2014-11-06
systems-manager-api-219	systems-manager-api.pdf	219	Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No ResourceType The resource type. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Required: No Status The compliance status for the resource. Type: String Valid Values: COMPLIANT \| NON_COMPLIANT Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1218 AWS Systems Manager API Reference See Also API Version 2014-11-06 1219 AWS Systems Manager API Reference ResourceDataSyncAwsOrganizationsSource Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations or, if an AWS organization isn't present, from multiple AWS Regions. Contents OrganizationSourceType If an AWS organization is present, this is either OrganizationalUnits or EntireOrganization. For OrganizationalUnits, the data is aggregated from a set of organization units. For EntireOrganization, the data is aggregated from the entire AWS organization. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes OrganizationalUnits The AWS Organizations organization units included in the sync. Type: Array of ResourceDataSyncOrganizationalUnit objects Array Members: Minimum number of 1 item. Maximum number of 1000 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourceDataSyncAwsOrganizationsSource API Version 2014-11-06 1220 AWS Systems Manager API Reference ResourceDataSyncDestinationDataSharing Synchronize AWS Systems Manager Inventory data from multiple AWS accounts deﬁned in AWS Organizations to a centralized Amazon S3 bucket. Data is synchronized to individual key preﬁxes in the central bucket. Each key preﬁx represents a diﬀerent AWS account ID. Contents DestinationDataSharingType The sharing data type. Only Organization is supported. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourceDataSyncDestinationDataSharing API Version 2014-11-06 1221 AWS Systems Manager API Reference ResourceDataSyncItem Information about a resource data sync conﬁguration, including its current status and last successful sync. Contents LastStatus The status reported by the last sync. Type: String Valid Values: Successful \| Failed \| InProgress Required: No LastSuccessfulSyncTime The last time the sync operations returned a status of SUCCESSFUL (UTC). Type: Timestamp Required: No LastSyncStatusMessage The status message details reported by the last sync. Type: String Required: No LastSyncTime The last time the conﬁguration attempted to sync (UTC). Type: Timestamp Required: No S3Destination Conﬁguration information for the target S3 bucket. Type: ResourceDataSyncS3Destination object ResourceDataSyncItem API Version 2014-11-06 1222 API Reference AWS Systems Manager Required: No SyncCreatedTime The date and time the conﬁguration was created (UTC). Type: Timestamp Required: No SyncLastModiﬁedTime The date and time the resource data sync was changed. Type: Timestamp Required: No SyncName The name of the resource data sync. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No SyncSource Information about the source where the data was synchronized. Type: ResourceDataSyncSourceWithState object Required: No SyncType The type of resource data sync. If SyncType is SyncToDestination, then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Contents API Version 2014-11-06 1223 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1224 AWS Systems Manager API Reference ResourceDataSyncOrganizationalUnit The AWS Organizations organizational unit data source for the sync. Contents OrganizationalUnitId The AWS Organizations unit ID data source for the sync. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourceDataSyncOrganizationalUnit API Version 2014-11-06 1225 AWS Systems Manager API Reference ResourceDataSyncS3Destination Information about the target S3 bucket for the resource data sync. Contents BucketName The name of the S3 bucket where the aggregated data is stored. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Region The AWS Region with the S3 bucket targeted by the resource data sync. Type: String Length
systems-manager-api-220	systems-manager-api.pdf	220	more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourceDataSyncOrganizationalUnit API Version 2014-11-06 1225 AWS Systems Manager API Reference ResourceDataSyncS3Destination Information about the target S3 bucket for the resource data sync. Contents BucketName The name of the S3 bucket where the aggregated data is stored. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Region The AWS Region with the S3 bucket targeted by the resource data sync. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes SyncFormat A supported sync format. The following format is currently supported: JsonSerDe Type: String Valid Values: JsonSerDe Required: Yes AWSKMSKeyARN The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. ResourceDataSyncS3Destination API Version 2014-11-06 1226 API Reference AWS Systems Manager Pattern: arn:.* Required: No DestinationDataSharing Enables destination data sharing. By default, this ﬁeld is null. Type: ResourceDataSyncDestinationDataSharing object Required: No Preﬁx An Amazon S3 preﬁx for the bucket. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1227 AWS Systems Manager API Reference ResourceDataSyncSource Information about the source of the data included in the resource data sync. Contents SourceRegions The SyncSource AWS Regions included in the resource data sync. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes SourceType The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations) or SingleAccountMultiRegions. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes AwsOrganizationsSource Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations. Type: ResourceDataSyncAwsOrganizationsSource object Required: No EnableAllOpsDataSources When you create a resource data sync, if you choose one of the AWS Organizations options, then Systems Manager automatically enables all OpsData sources in the selected AWS Regions for all AWS accounts in your organization (or in the selected organization units). For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager User Guide. ResourceDataSyncSource API Version 2014-11-06 1228 AWS Systems Manager Type: Boolean Required: No IncludeFutureRegions API Reference Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1229 AWS Systems Manager API Reference ResourceDataSyncSourceWithState The data type name for including resource data sync state. There are four sync states: OrganizationNotExists (Your organization doesn't exist) NoPermissions (The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in AWS Systems Manager Explorer.) InvalidOrganizationalUnit (You speciﬁed or selected an invalid unit in the resource data sync conﬁguration.) TrustedAccessDisabled (You disabled Systems Manager access in the organization in AWS Organizations.) Contents AwsOrganizationsSource The ﬁeld name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type. Type: ResourceDataSyncAwsOrganizationsSource object Required: No EnableAllOpsDataSources When you create a resource data sync, if you choose one of the AWS Organizations options, then Systems Manager automatically enables all OpsData sources in the selected AWS Regions for all AWS accounts in your organization (or in the selected organization units). For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager User Guide. Type: Boolean Required: No IncludeFutureRegions Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online. Type: Boolean ResourceDataSyncSourceWithState API Version 2014-11-06 1230 API Reference AWS Systems Manager Required: No SourceRegions The SyncSource AWS Regions included in the resource data sync. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No SourceType The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations) or singleAccountMultiRegions. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No State The data type name for including resource data sync state. There are four sync states: OrganizationNotExists: Your organization doesn't exist. NoPermissions:
systems-manager-api-221	systems-manager-api.pdf	221	ResourceDataSyncSourceWithState API Version 2014-11-06 1230 API Reference AWS Systems Manager Required: No SourceRegions The SyncSource AWS Regions included in the resource data sync. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No SourceType The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations) or singleAccountMultiRegions. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No State The data type name for including resource data sync state. There are four sync states: OrganizationNotExists: Your organization doesn't exist. NoPermissions: The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer. InvalidOrganizationalUnit: You speciﬁed or selected an invalid unit in the resource data sync conﬁguration. TrustedAccessDisabled: You disabled Systems Manager access in the organization in AWS Organizations. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Contents API Version 2014-11-06 1231 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1232 AWS Systems Manager ResultAttribute The inventory item result attribute. Contents TypeName API Reference Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS\|Custom):.$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResultAttribute API Version 2014-11-06 1233 AWS Systems Manager ReviewInformation Information about the result of a document review request. API Reference Contents ReviewedTime The time that the reviewer took action on the document review request. Type: Timestamp Required: No Reviewer The reviewer assigned to take action on the document review request. Type: String Length Constraints: Maximum length of 50. Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Required: No Status The current status of the document review request. Type: String Valid Values: APPROVED \| NOT_REVIEWED \| PENDING \| REJECTED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 ReviewInformation API Version 2014-11-06 1234 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1235 AWS Systems Manager Runbook API Reference Information about an Automation runbook used in a runbook workﬂow in Change Manager. Note The Automation runbooks speciﬁed for the runbook workﬂow can't run until all required approvals for the change request have been received. Contents DocumentName The name of the Automation runbook used in a runbook workﬂow. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: Yes DocumentVersion The version of the Automation runbook used in a runbook workﬂow. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No MaxConcurrency The MaxConcurrency value speciﬁed by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time. 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 Runbook API Version 2014-11-06 1236 AWS Systems Manager MaxErrors API Reference The MaxErrors value speciﬁed by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back. 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 Parameters The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution. 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 TargetLocations Information about the AWS Regions and AWS accounts targeted by the current Runbook operation. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetMaps A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be speciﬁed together. Contents API Version 2014-11-06 1237 AWS Systems Manager API Reference 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 The name of the
systems-manager-api-222	systems-manager-api.pdf	222	100 items. Required: No TargetMaps A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be speciﬁed together. Contents API Version 2014-11-06 1237 AWS Systems Manager API Reference 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 The name of the parameter used as the target resource for the rate-controlled runbook workﬂow. Required if you specify Targets. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Required: No Targets A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2014-11-06 1238 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1239 AWS Systems Manager S3OutputLocation An S3 bucket where you want to store the results of this request. API Reference Contents OutputS3BucketName The name of the S3 bucket. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Required: No OutputS3KeyPreﬁx The S3 bucket subfolder. Type: String Length Constraints: Maximum length of 500. Required: No OutputS3Region The AWS Region of the S3 bucket. Type: String Length Constraints: Minimum length of 3. Maximum length of 20. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 S3OutputLocation API Version 2014-11-06 1240 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1241 AWS Systems Manager S3OutputUrl API Reference A URL for the AWS Systems Manager (Systems Manager) bucket where you want to store the results of this request. Contents OutputUrl A URL for an S3 bucket where you want to store the results of this request. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3OutputUrl API Version 2014-11-06 1242 AWS Systems Manager API Reference ScheduledWindowExecution Information about a scheduled execution for a maintenance window. Contents ExecutionTime The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run. Type: String Required: No Name The name of the maintenance window to be run. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No WindowId The ID of the maintenance window to be run. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: ScheduledWindowExecution API Version 2014-11-06 1243 AWS Systems Manager • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 1244 AWS Systems Manager ServiceSetting The service setting data structure. API Reference ServiceSetting is an account-level setting for an AWS service. This setting deﬁnes 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 deﬁne 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 operation to change the default setting. Or, use the ResetServiceSetting to change the value back to the original value deﬁned by the AWS service team. Contents ARN The ARN of the service setting. Type: String Required: No LastModiﬁedDate The last time the service setting was modiﬁed. Type: Timestamp Required: No LastModiﬁedUser The ARN of the last modiﬁed user. This ﬁeld is populated only if the setting value was overwritten. Type: String Required: No ServiceSetting API Version 2014-11-06 1245 AWS Systems Manager SettingId The ID of the service setting. Type:
systems-manager-api-223	systems-manager-api.pdf	223	have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or, use the ResetServiceSetting to change the value back to the original value deﬁned by the AWS service team. Contents ARN The ARN of the service setting. Type: String Required: No LastModiﬁedDate The last time the service setting was modiﬁed. Type: Timestamp Required: No LastModiﬁedUser The ARN of the last modiﬁed user. This ﬁeld is populated only if the setting value was overwritten. Type: String Required: No ServiceSetting API Version 2014-11-06 1245 AWS Systems Manager SettingId The ID of the service setting. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No SettingValue The value of the service setting. Type: String Length Constraints: Minimum length of 1. Maximum length of 4096. Required: No Status The status of the service setting. The value can be Default, Customized or PendingUpdate. • Default: The current setting uses a default value provisioned by the AWS service team. • Customized: The current setting use a custom value speciﬁed by the customer. • PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1246 AWS Systems Manager Session API Reference Information about a Session Manager connection to a managed node. Contents Details Reserved for future use. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No DocumentName The name of the Session Manager SSM document used to deﬁne the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No EndDate The date and time, in ISO-8601 Extended format, when the session was terminated. Type: Timestamp Required: No MaxSessionDuration The maximum duration of a session before it terminates. Type: String Length Constraints: Minimum length of 1. Maximum length of 4. Pattern: ^([1-9]\|[1-9][0-9]\|[1-9][0-9][0-9]\|1[0-4][0-3][0-9]\|1440)$ Session API Version 2014-11-06 1247 API Reference AWS Systems Manager Required: No OutputUrl Reserved for future use. Type: SessionManagerOutputUrl object Required: No Owner The ID of the Amazon Web Services user that started the session. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No Reason The reason for connecting to the instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^.{1,256}$ Required: No SessionId The ID of the session. Type: String Length Constraints: Minimum length of 1. Maximum length of 96. Required: No StartDate The date and time, in ISO-8601 Extended format, when the session began. Type: Timestamp Contents API Version 2014-11-06 1248 AWS Systems Manager Required: No Status API Reference The status of the session. For example, "Connected" or "Terminated". Type: String Valid Values: Connected \| Connecting \| Disconnected \| Terminated \| Terminating \| Failed Required: No Target The managed node that the Session Manager session connected to. Type: String Length Constraints: Minimum length of 1. Maximum length of 400. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1249 AWS Systems Manager SessionFilter Describes a ﬁlter for Session Manager information. API Reference Contents key The name of the ﬁlter. Type: String Valid Values: InvokedAfter \| InvokedBefore \| Target \| Owner \| Status \| SessionId Required: Yes value The ﬁlter value. Valid values for each ﬁlter key are as follows: • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2024-08-29T00:00:00Z to see sessions that started August 29, 2024, and later. • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2024-08-29T00:00:00Z to see sessions that started before August 29, 2024. • Target: Specify a managed node to which session connections have been made. • Owner: Specify an Amazon Web Services user to see a list of sessions started by that user. • Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include: • Connected • Connecting • Disconnected • Terminated • Terminating • Failed • SessionId: Specify a session ID to return details about the session. Type: String SessionFilter API Version 2014-11-06 1250 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 400. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See
systems-manager-api-224	systems-manager-api.pdf	224	see a list of all sessions with that status. Status values you can specify include: • Connected • Connecting • Disconnected • Terminated • Terminating • Failed • SessionId: Specify a session ID to return details about the session. Type: String SessionFilter API Version 2014-11-06 1250 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 400. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1251 AWS Systems Manager API Reference SessionManagerOutputUrl Reserved for future use. Contents CloudWatchOutputUrl Reserved for future use. Type: String Length Constraints: Minimum length of 1. Maximum length of 2083. Required: No S3OutputUrl Reserved for future use. Type: String Length Constraints: Minimum length of 1. Maximum length of 2083. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SessionManagerOutputUrl API Version 2014-11-06 1252 AWS Systems Manager SeveritySummary API Reference The number of managed nodes found for each patch severity level deﬁned in the request ﬁlter. Contents CriticalCount The total number of resources or compliance items that have a severity level of Critical. Critical severity is determined by the organization that published the compliance items. Type: Integer Required: No HighCount The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items. Type: Integer Required: No InformationalCount The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items. Type: Integer Required: No LowCount The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items. Type: Integer Required: No MediumCount The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items. SeveritySummary API Version 2014-11-06 1253 AWS Systems Manager Type: Integer Required: No UnspeciﬁedCount API Reference The total number of resources or compliance items that have a severity level of unspeciﬁed. Unspeciﬁed severity is determined by the organization that published the compliance items. Type: Integer Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1254 AWS Systems Manager StepExecution API Reference Detailed information about an the execution state of an Automation step. Contents Action The action this step performs. The action determines the behavior of the step. Type: String Pattern: ^aws:[a-zA-Z]{3,25}$ Required: No ExecutionEndTime If a step has ﬁnished execution, this contains the time the execution ended. If the step hasn't yet concluded, this ﬁeld isn't populated. Type: Timestamp Required: No ExecutionStartTime If a step has begun execution, this contains the time the step started. If the step is in Pending status, this ﬁeld isn't populated. Type: Timestamp Required: No FailureDetails Information about the Automation failure. Type: FailureDetails object Required: No FailureMessage If a step failed, this message explains why the execution failed. StepExecution API Version 2014-11-06 1255 AWS Systems Manager Type: String Required: No Inputs API Reference Fully-resolved values passed into the step before execution. Type: String to string map Required: No IsCritical The ﬂag which can be used to help decide whether the failure of current step leads to the Automation failure. Type: Boolean Required: No IsEnd The ﬂag which can be used to end automation no matter whether the step succeeds or fails. Type: Boolean Required: No MaxAttempts The maximum number of tries to run the action of the step. The default value is 1. Type: Integer Required: No NextStep The next step after the step succeeds. Type: String Required: No OnFailure The action to take if the step fails. The default value is Abort. Contents API Version 2014-11-06 1256 API Reference AWS Systems Manager Type: String Required: No Outputs Returned values from the execution of the step. 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 OverriddenParameters A user-speciﬁed list of parameters to override when running a step. Type: String to array of strings map Map Entries: Maximum number
systems-manager-api-225	systems-manager-api.pdf	225	The default value is Abort. Contents API Version 2014-11-06 1256 API Reference AWS Systems Manager Type: String Required: No Outputs Returned values from the execution of the step. 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 OverriddenParameters A user-speciﬁed list of parameters to override when running a step. 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 ParentStepDetails Information about the parent step. Type: ParentStepDetails object Required: No Response A message associated with the response code for an execution. Contents API Version 2014-11-06 1257 AWS Systems Manager Type: String Required: No ResponseCode The response code returned by the execution of the step. API Reference Type: String Required: No StepExecutionId The unique ID of a step execution. Type: String Required: No StepName The name of this execution step. Type: String Required: No StepStatus The execution status for this step. Type: String Valid Values: Pending \| InProgress \| Waiting \| Success \| TimedOut \| Cancelling \| Cancelled \| Failed \| PendingApproval \| Approved \| Rejected \| Scheduled \| RunbookInProgress \| PendingChangeCalendarOverride \| ChangeCalendarOverrideApproved \| ChangeCalendarOverrideRejected \| CompletedWithSuccess \| CompletedWithFailure \| Exited Required: No TargetLocation The combination of AWS Regions and AWS accounts targeted by the current Automation execution. Contents API Version 2014-11-06 1258 API Reference AWS Systems Manager Type: TargetLocation object Required: No Targets The targets for the step execution. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No TimeoutSeconds The timeout seconds of the step. Type: Long Required: No TriggeredAlarms The CloudWatch alarms that were invoked by the automation. Type: Array of AlarmStateInformation objects Array Members: Fixed number of 1 item. Required: No ValidNextSteps Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another speciﬁc step. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 65535. Required: No Contents API Version 2014-11-06 1259 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2014-11-06 1260 AWS Systems Manager StepExecutionFilter API Reference A ﬁlter to limit the amount of step execution information returned by the call. Contents Key One or more keys to limit the results. Type: String Valid Values: StartTimeBefore \| StartTimeAfter \| StepExecutionStatus \| StepExecutionId \| StepName \| Action \| ParentStepExecutionId \| ParentStepIteration \| ParentStepIteratorValue Required: Yes Values The values of the ﬁlter key. 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 150. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 StepExecutionFilter API Version 2014-11-06 1261 AWS Systems Manager Tag API Reference Metadata that you assign to your AWS resources. Tags enable you to categorize your resources in diﬀerent ways, for example, by purpose, owner, or environment. In AWS Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata. Contents Key The name of the tag. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Required: Yes Value The value of the tag. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Tag API Version 2014-11-06 1262 AWS Systems Manager API Reference See Also API Version 2014-11-06 1263 AWS Systems Manager Target API Reference An array of search criteria that targets managed nodes using a key-value pair that you specify. Note One or more targets must be speciﬁed for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.