String activationId
The ID created by Systems Manager when you submitted the activation.
String description
A user defined description of the activation.
String defaultInstanceName
A name for the managed instance when it is created.
String iamRole
The Amazon Identity and Access Management (IAM) role to assign to the managed instance.
Integer registrationLimit
The maximum number of managed instances that can be registered using this activation.
Integer registrationsCount
The number of managed instances already registered with this activation.
Date expirationDate
The date when this activation can no longer be used to register managed instances.
Boolean expired
Whether or not the activation is expired.
Date createdDate
The date the activation was created.
String resourceType
Specifies the type of resource you are tagging.
String resourceId
The resource ID you want to tag.
com.amazonaws.internal.SdkInternalList<T> tags
One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
String name
The name of the SSM document.
String instanceId
The ID of the instance.
String 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.
String documentVersion
The version of the document used in the association.
com.amazonaws.internal.SdkInternalList<T> targets
The instances targeted by the request to create an association.
Date lastExecutionDate
The date on which the association was last run.
AssociationOverview overview
Information about the association.
String scheduleExpression
A cron expression that specifies a schedule when the association runs.
String name
The name of the SSM document.
String instanceId
The ID of the instance.
Date dateValue
The date when the association was made.
Date lastUpdateAssociationDate
The date when the association was last updated.
AssociationStatus status
The association status.
AssociationOverview overview
Information about the association.
String documentVersion
The document version.
Map<K,V> parameters
A description of the parameters for a document.
String associationId
The association ID.
com.amazonaws.internal.SdkInternalList<T> targets
The instances targeted by the request.
String scheduleExpression
A cron expression that specifies a schedule when the association runs.
InstanceAssociationOutputLocation outputLocation
An Amazon S3 bucket where you want to store the output details of the request.
Date lastExecutionDate
The date on which the association was last run.
Date lastSuccessfulExecutionDate
The last date on which the association was successfully run.
String status
The status of the association. Status can be: Pending
, Success
, or Failed
.
String detailedStatus
A detailed status of the association.
Map<K,V> associationStatusAggregatedCount
Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.
String automationExecutionId
The execution ID.
String documentName
The name of the Automation document used during the execution.
String documentVersion
The version of the document to use during execution.
Date executionStartTime
The time the execution started.
Date executionEndTime
The time the execution finished.
String automationExecutionStatus
The execution status of the Automation.
com.amazonaws.internal.SdkInternalList<T> stepExecutions
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.
Map<K,V> parameters
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution
.
Map<K,V> outputs
The list of execution outputs as defined in the automation document.
String failureMessage
A message describing why an execution has failed, if the status is set to Failed.
String key
The aspect of the Automation execution information that should be limited.
com.amazonaws.internal.SdkInternalList<T> values
The values used to limit the execution information associated with the filter's key.
String automationExecutionId
The execution ID.
String documentName
The name of the Automation document used during execution.
String documentVersion
The document version used during the execution.
String automationExecutionStatus
The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
Date executionStartTime
The time the execution started.>
Date executionEndTime
The time the execution finished. This is not populated if the execution is still in progress.
String executedBy
The IAM role ARN of the user who executed the Automation.
String logFile
An Amazon S3 bucket where execution information is stored.
Map<K,V> outputs
The list of execution outputs as defined in the Automation document.
String commandId
The ID of the command you want to cancel.
com.amazonaws.internal.SdkInternalList<T> instanceIds
(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.
String commandId
A unique identifier for this command.
String documentName
The name of the SSM document requested for execution.
String comment
User-specified information about the command, such as a brief description of what the command should do.
Date expiresAfter
If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
Map<K,V> parameters
The parameter values to be inserted in the SSM document when executing the command.
com.amazonaws.internal.SdkInternalList<T> instanceIds
The instance IDs against which this command was requested.
com.amazonaws.internal.SdkInternalList<T> targets
An array of search criteria that targets instances using a Key
;Value
combination that
you specify. Targets
is required if you don't provide one or more instance IDs in the call.
Date requestedDateTime
The date and time the command was requested.
String status
The status of the command.
String 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 different results than Status
. For more information about these
statuses, see Monitor
Commands (Linux) or Monitor Commands
(Windows). StatusDetails
can be one of the following values:
Pending – The command has not been sent to any instances.
In Progress – The command has been sent to at least one instance but has not reached a final state on all instances.
Success – The command successfully executed 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 instances and one or more invocations does not have a value of
Success
but not enough invocations failed for the status to be Failed
. This is a
terminal state.
Canceled – The command was terminated before it was completed. This is a terminal state.
Rate Exceeded – The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.
String outputS3Region
The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.
String outputS3BucketName
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
String outputS3KeyPrefix
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
String maxConcurrency
The maximum number of instances that are allowed to execute the command at the same time. You can specify a
number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more
information about how to use MaxConcurrency
, see Executing a Command Using Amazon EC2
Run Command (Linux) or Executing a Command Using Amazon
EC2 Run Command (Windows).
String 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 50. For more
information about how to use MaxErrors
, see Executing a Command Using Amazon EC2
Run Command (Linux) or Executing a Command Using Amazon
EC2 Run Command (Windows).
Integer targetCount
The number of targets for the command.
Integer completedCount
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
, Canceled
, Terminated
, or Undeliverable
.
Integer errorCount
The number of targets for which the status is Failed
or Execution Timed Out
.
String serviceRole
The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
NotificationConfig notificationConfig
Configurations for sending notifications about command status changes.
String commandId
The command against which this invocation was requested.
String instanceId
The instance ID in which this invocation was requested.
String instanceName
The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name
tag.
For on-premises instances, this is the name of the instance.
String comment
User-specified information about the command, such as a brief description of what the command should do.
String documentName
The document name that was requested for execution.
Date requestedDateTime
The time and date the request was sent to this instance.
String status
Whether or not the invocation succeeded, failed, or is pending.
String statusDetails
A detailed status of the command execution for each invocation (each instance targeted by the command).
StatusDetails
includes more information than Status
because it includes states
resulting from error and concurrency control parameters. StatusDetails
can show different results
than Status
. For more information about these statuses, see Monitor Commands (Linux) or
Monitor Commands
(Windows). StatusDetails
can be one of the following values:
Pending – The command has not been sent to the instance.
In Progress – The command has been sent to the instance but has not 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 was not delivered to the instance before the delivery timeout expired. Delivery
timeouts do not 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 instance, but the execution was not 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 was not successful on the instance. For a plugin, this indicates that the result code was
not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero.
Invocation failures count against the MaxErrors
limit of the parent command. This is a terminal
state.
Canceled – The command was terminated before it was completed. This is a terminal state.
Undeliverable – The command can't be delivered to the instance. The instance might not exist or might not be
responding. Undeliverable invocations don't count against the parent command’s MaxErrors
limit and
don't contribute to whether the parent command status is Success
or Incomplete
. This is
a terminal state.
Terminated – The parent command exceeded its MaxErrors
limit and subsequent command invocations were
canceled by the system. This is a terminal state.
String traceOutput
Gets the trace output sent by the agent.
String standardOutputUrl
The URL to the plugin’s StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For
an invocation, StandardOutputUrl
is populated if there is just one plugin defined for the command,
and the Amazon S3 bucket was defined for the command.
String standardErrorUrl
The URL to the plugin’s StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For
an invocation, StandardErrorUrl
is populated if there is just one plugin defined for the command,
and the Amazon S3 bucket was defined for the command.
com.amazonaws.internal.SdkInternalList<T> commandPlugins
String serviceRole
The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.
NotificationConfig notificationConfig
Configurations for sending notifications about command status changes on a per instance basis.
String name
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.
String status
The status of this plugin. You can execute a document with multiple plugins.
String statusDetails
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 different results than Status
. For more information about these
statuses, see Monitor
Commands (Linux) or Monitor Commands
(Windows). StatusDetails
can be one of the following values:
Pending – The command has not been sent to the instance.
In Progress – The command has been sent to the instance but has not 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 was not delivered to the instance before the delivery timeout expired. Delivery
timeouts do not 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 instance, but the execution was not 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 was not successful on the instance. For a plugin, this indicates that the result code was
not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero.
Invocation failures count against the MaxErrors
limit of the parent command. This is a terminal
state.
Canceled – The command was terminated before it was completed. This is a terminal state.
Undeliverable – The command can't be delivered to the instance. The instance 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.
Integer responseCode
A numeric response code generated after executing the plugin.
Date responseStartDateTime
The time the plugin started executing.
Date responseFinishDateTime
The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
String output
Output of the plugin execution.
String standardOutputUrl
The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty.
String standardErrorUrl
The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.
String outputS3Region
The name of the region where the output is stored in Amazon S3.
String 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:
test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript
test_folder
is the name of the Amazon S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix;
i-1234567876543
is the instance ID;
awsrunShellScript
is the name of the plugin.
String outputS3KeyPrefix
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:
test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript
test_folder
is the name of the Amazon S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix;
i-1234567876543
is the instance ID;
awsrunShellScript
is the name of the plugin.
String description
A user-defined description of the resource that you want to register with Amazon EC2.
String defaultInstanceName
The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources.
String iamRole
The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.
Integer registrationLimit
Specify the maximum number of managed instances you want to register. The default value is 1 instance.
Date expirationDate
The date by which this activation request should expire. The default value is 24 hours.
String activationId
The ID number generated by the system when it processed the activation. The activation ID functions like a user name.
String activationCode
The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.
com.amazonaws.internal.SdkInternalList<T> entries
One or more associations.
String name
The name of the configuration document.
String instanceId
The ID of the instance.
Map<K,V> parameters
A description of the parameters for a document.
String documentVersion
The document version.
com.amazonaws.internal.SdkInternalList<T> targets
The instances targeted by the request.
String scheduleExpression
A cron expression that specifies a schedule when the association runs.
InstanceAssociationOutputLocation outputLocation
An Amazon S3 bucket where you want to store the results of this request.
com.amazonaws.internal.SdkInternalList<T> successful
Information about the associations that succeeded.
com.amazonaws.internal.SdkInternalList<T> failed
Information about the associations that failed.
String name
The name of the SSM document.
String documentVersion
The document version you want to associate with the target(s). Can be a specific version or the default version.
String instanceId
The instance ID.
Map<K,V> parameters
The parameters for the documents runtime configuration.
com.amazonaws.internal.SdkInternalList<T> targets
The targets (either instances or tags) for the association. Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
String scheduleExpression
A cron expression when the association will be applied to the target(s). Supported expressions are every half, 1, 2, 4, 8 or 12 hour(s); every specified day and time of the week. For example: cron(0 0/30 * 1/1 * ? *) to run every thirty minutes; cron(0 0 0/4 1/1 * ? *) to run every four hours; and cron(0 0 10 ? * SUN *) to run every Sunday at 10 a.m.
InstanceAssociationOutputLocation outputLocation
An Amazon S3 bucket where you want to store the output details of the request. For example:
"{ \"S3Location\": { \"OutputS3Region\": \"<region>\", \"OutputS3BucketName\": \"bucket name\", \"OutputS3KeyPrefix\": \"folder name\" } }"
AssociationDescription associationDescription
Information about the association.
DocumentDescription documentDescription
Information about the SSM document.
String name
The name of the Maintenance Window.
String schedule
The schedule of the Maintenance Window in the form of a cron or rate expression.
Integer duration
The duration of the Maintenance Window in hours.
Integer cutoff
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Boolean allowUnassociatedTargets
Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
String clientToken
User-provided idempotency token.
String windowId
The ID of the created Maintenance Window.
String name
The name of the patch baseline.
PatchFilterGroup globalFilters
A set of global filters used to exclude patches from the baseline.
PatchRuleGroup approvalRules
A set of rules used to include patches in the baseline.
com.amazonaws.internal.SdkInternalList<T> approvedPatches
A list of explicitly approved patches for the baseline.
com.amazonaws.internal.SdkInternalList<T> rejectedPatches
A list of explicitly rejected patches for the baseline.
String description
A description of the patch baseline.
String clientToken
Caller-provided idempotency token.
String baselineId
The ID of the created patch baseline.
String activationId
The ID of the activation that you want to delete.
String name
The name of the SSM document.
String windowId
The ID of the Maintenance Window to delete.
String windowId
The ID of the deleted Maintenance Window.
String name
The name of the parameter to delete.
String baselineId
The ID of the patch baseline to delete.
String baselineId
The ID of the deleted patch baseline.
String instanceId
The ID assigned to the managed instance when you registered it using the activation process.
String filterKey
The name of the filter.
com.amazonaws.internal.SdkInternalList<T> filterValues
The filter values.
com.amazonaws.internal.SdkInternalList<T> filters
A filter to view information about your activations.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
A token to start the list. Use this token to get the next set of results.
com.amazonaws.internal.SdkInternalList<T> activationList
A list of activations for your AWS account.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
AssociationDescription associationDescription
Information about the association.
com.amazonaws.internal.SdkInternalList<T> filters
Filters used to limit the scope of executions that are requested.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> automationExecutionMetadataList
The list of details about each automation execution which has occurred which matches the filter specification, if any.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> filters
Filters used to scope down the returned patches.
Integer maxResults
The maximum number of patches to return (per page).
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> patches
An array of patches. Each entry in the array is a patch structure.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> accountIds
The account IDs that have permission to use this document. The ID can be either an AWS account or All.
DocumentDescription document
Information about the SSM document.
String instanceId
The instance ID for which you want to view all associations.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> associations
The associations for the requested instance.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String baselineId
The ID of the patch baseline to retrieve the effective patches for.
Integer maxResults
The maximum number of patches to return (per page).
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> effectivePatches
An array of patches and patch status.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String instanceId
The instance IDs for which you want association status information.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> instanceAssociationStatusInfos
Status information about the association.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> instanceInformationFilterList
One or more filters. Use a filter to return a more specific list of instances.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters. Use a filter to return a more specific list of instances.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> instanceInformationList
The instance information list.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String instanceId
The ID of the instance whose patch state information should be retrieved.
com.amazonaws.internal.SdkInternalList<T> filters
Each entry in the array is a structure containing:
Key (string, 1 ≤ length ≤ 128)
Values (array of strings 1 ≤ length ≤ 256)
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxResults
The maximum number of patches to return (per page).
com.amazonaws.internal.SdkInternalList<T> patches
Each entry in the array is a structure containing:
Title (string)
KBId (string)
Classification (string)
Severity (string)
State (string – “INSTALLED”, “INSTALLED_OTHER”, “MISSING”, “NOT_APPLICABLE”, “FAILED”)
InstalledTime (DateTime)
InstalledBy (string)
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String patchGroup
The name of the patch group for which the patch state information should be retrieved.
com.amazonaws.internal.SdkInternalList<T> filters
Each entry in the array is a structure containing:
Key (string 1 ≤ length ≤ 200)
Values (array containing a single string)
Type (string “Equal”, “NotEqual”, “LessThan”, “GreaterThan”)
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxResults
The maximum number of patches to return (per page).
com.amazonaws.internal.SdkInternalList<T> instancePatchStates
The high-level patch state for the requested instances.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> instanceIds
The ID of the instance whose patch state information should be retrieved.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxResults
The maximum number of instances to return (per page).
com.amazonaws.internal.SdkInternalList<T> instancePatchStates
The high-level patch state for the requested instances.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String windowId
The ID of the Maintenance Window whose executions should be retrieved.
com.amazonaws.internal.SdkInternalList<T> filters
Each entry in the array is a structure containing:
Key (string, 1 ≤ length ≤ 128)
Values (array of strings 1 ≤ length ≤ 256)
The supported Keys are ExecutedBefore
and ExecutedAfter
with the value being a
date/time string such as 2016-11-04T05:00:00Z.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> windowExecutions
Information about the Maintenance Windows execution.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String windowExecutionId
The ID of the Maintenance Window execution the task is part of.
String taskId
The ID of the specific task in the Maintenance Window task that should be retrieved.
com.amazonaws.internal.SdkInternalList<T> filters
Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> windowExecutionTaskInvocationIdentities
Information about the task invocation results per invocation.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String windowExecutionId
The ID of the Maintenance Window execution whose task executions should be retrieved.
com.amazonaws.internal.SdkInternalList<T> filters
Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> windowExecutionTaskIdentities
Information about the task executions.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> filters
Optional filters used to narrow down the scope of the returned Maintenance Windows. Supported filter keys are
Name
and Enabled
.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> windowIdentities
Information about the Maintenance Windows.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String windowId
The ID of the Maintenance Window whose targets should be retrieved.
com.amazonaws.internal.SdkInternalList<T> filters
Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter
keys are Type
, WindowTargetId
and OwnerInformation
.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> targets
Information about the targets in the Maintenance Window.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String windowId
The ID of the Maintenance Window whose tasks should be retrieved.
com.amazonaws.internal.SdkInternalList<T> filters
Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are
WindowTaskId
, TaskArn
, Priority
, and TaskType
.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> tasks
Information about the tasks in the Maintenance Window.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters. Use a filter to return a more specific list of results.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> parameters
Parameters returned by the request.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> filters
Each element in the array is a structure containing:
Key: (string, “NAME_PREFIX” or “OWNER”)
Value: (array of strings, exactly 1 entry, 1 ≤ length ≤ 255)
Integer maxResults
The maximum number of patch baselines to return (per page).
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> baselineIdentities
An array of PatchBaselineIdentity elements.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> mappings
Each entry in the array contains:
PatchGroup: string (1 ≤ length ≤ 256, Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$)
PatchBaselineIdentity: A PatchBaselineIdentity element.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String patchGroup
The name of the patch group whose patch snapshot should be retrieved.
Integer instances
The number of instances in the patch group.
Integer instancesWithInstalledPatches
The number of instances with installed patches.
Integer instancesWithInstalledOtherPatches
The number of instances with patches installed that aren’t defined in the patch baseline.
Integer instancesWithMissingPatches
The number of instances with missing patches from the patch baseline.
Integer instancesWithFailedPatches
The number of instances with patches from the patch baseline that failed to install.
Integer instancesWithNotApplicablePatches
The number of instances with patches that aren’t applicable.
String sha1
The SHA1 hash of the document, which you can use for verification purposes.
String hash
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
String hashType
Sha256 or Sha1.
Sha1 hashes have been deprecated.
String name
The name of the SSM document.
String owner
The AWS user account of the person who created the document.
Date createdDate
The date when the SSM document was created.
String status
The status of the SSM document.
String documentVersion
The document version.
String description
A description of the document.
com.amazonaws.internal.SdkInternalList<T> parameters
A description of the parameters for a document.
com.amazonaws.internal.SdkInternalList<T> platformTypes
The list of OS platforms compatible with this SSM document.
String documentType
The type of document.
String schemaVersion
The schema version.
String latestVersion
The latest version of the document.
String defaultVersion
The default version.
String name
The name of the SSM document.
String owner
The AWS user account of the person who created the document.
com.amazonaws.internal.SdkInternalList<T> platformTypes
The operating system platform.
String documentVersion
The document version.
String documentType
The document type.
String schemaVersion
The schema version.
String name
The name of the parameter.
String type
The type of parameter. The type can be either “String” or “StringList”.
String description
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
String defaultValue
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
Patch patch
Provides metadata for a patch, including information such as the KB ID, severity, classification and a URL for where more information can be obtained about the patch.
PatchStatus 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.
CreateAssociationBatchRequestEntry entry
The association.
String message
A description of the failure.
String fault
The source of the failure.
String automationExecutionId
The unique identifier for an existing automation execution to examine. The execution ID is returned by
StartAutomationExecution
when the execution of an Automation document is initiated.
AutomationExecution automationExecution
Detailed information about the current state of an automation execution.
String commandId
(Required) The parent command ID of the invocation plugin.
String instanceId
(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
String pluginName
(Optional) The name of the plugin for which you want detailed results. If the SSM document contains only one plugin, the name can be omitted and the details will be returned.
String commandId
The parent command ID of the invocation plugin.
String instanceId
The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
String comment
The comment text for the command.
String documentName
The name of the SSM document that was executed. For example, AWS-RunShellScript is an SSM document.
String pluginName
The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.
Integer responseCode
The error level response code for the plugin script. If the response code is -1
, then the command
has not started executing on the instance, or it was not received by the instance.
String executionStartDateTime
The date and time the plugin started executing. Date and time are written in ISO 8601 format. For example, August 28, 2016 is represented as 2016-08-28. If the plugin has not started to execute, the string is empty.
String executionElapsedTime
Duration since ExecutionStartDateTime
.
String executionEndDateTime
The date and time the plugin was finished executing. Date and time are written in ISO 8601 format. For example, August 28, 2016 is represented as 2016-08-28. If the plugin has not started to execute, the string is empty.
String status
The status of the parent command for this invocation. This status can be different than
StatusDetails
.
String statusDetails
A detailed status of the command execution for an invocation. StatusDetails
includes more
information than Status
because it includes states resulting from error and concurrency control
parameters. StatusDetails
can show different results than Status
. For more information
about these statuses, see Monitor Commands (Linux) or
Monitor Commands
(Windows). StatusDetails
can be one of the following values:
Pending – The command has not been sent to the instance.
In Progress – The command has been sent to the instance but has not reached a terminal state.
Delayed – The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again.
Success – The command or plugin was executed successfully. This is a terminal state.
Delivery Timed Out – The command was not delivered to the instance before the delivery timeout expired. Delivery
timeouts do not count against the parent command’s MaxErrors
limit, but they do contribute to
whether the parent command status is Success
or Incomplete
. This is a terminal state.
Execution Timed Out – The command started to execute on the instance, but the execution was not complete before
the timeout expired. Execution timeouts count against the MaxErrors
limit of the parent command.
This is a terminal state.
Failed – The command wasn't executed successfully on the instance. For a plugin, this indicates that the result
code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not
zero. Invocation failures count against the MaxErrors
limit of the parent command. This is a
terminal state.
Canceled – The command was terminated before it was completed. This is a terminal state.
Undeliverable – The command can't be delivered to the instance. The instance might not exist or might not be
responding. Undeliverable invocations don't count against the parent command’s MaxErrors
limit and
don't contribute to whether the parent command status is Success
or Incomplete
. This is
a terminal state.
Terminated – The parent command exceeded its MaxErrors
limit and subsequent command invocations were
canceled by the system. This is a terminal state.
String standardOutputContent
The first 24,000 characters written by the plugin to stdout. If the command has not finished executing, if
ExecutionStatus
is neither Succeeded
nor Failed
, then this string is
empty.
String standardOutputUrl
The URL for the complete text written by the plugin to stdout in Amazon S3. If an Amazon S3 bucket was not specified, then this string is empty.
String standardErrorContent
The first 8,000 characters written by the plugin to stderr. If the command has not finished executing, then this string is empty.
String standardErrorUrl
The URL for the complete text written by the plugin to stderr. If the command has not finished executing, then this string is empty.
String baselineId
The ID of the default patch baseline.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters. Use a filter to return a more specific list of results.
com.amazonaws.internal.SdkInternalList<T> resultAttributes
The list of inventory item types to return.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
com.amazonaws.internal.SdkInternalList<T> entities
Collection of inventory entities such as a collection of instance inventory.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String typeName
The type of inventory item to return.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
com.amazonaws.internal.SdkInternalList<T> schemas
Inventory schemas returned by the request.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String windowExecutionId
The ID of the Maintenance Window execution that includes the task.
String windowExecutionId
The ID of the Maintenance Window execution.
com.amazonaws.internal.SdkInternalList<T> taskIds
The ID of the task executions from the Maintenance Window execution.
String status
The status of the Maintenance Window execution.
String statusDetails
The details explaining the Status. Only available for certain status values.
Date startTime
The time the Maintenance Window started executing.
Date endTime
The time the Maintenance Window finished executing.
String windowExecutionId
The ID of the Maintenance Window execution that includes the task.
String taskExecutionId
The ID of the specific task execution in the Maintenance Window task that was retrieved.
String taskArn
The ARN of the executed task.
String serviceRole
The role that was assumed when executing the task.
String type
The type of task executed.
com.amazonaws.internal.SdkInternalList<T> taskParameters
The parameters passed to the task when it was executed. The map has the following format:
Key: string, 1 ≤ length ≤ 255
Value: an array of strings where each string 1 ≤ length ≤ 255
Integer priority
The priority of the task.
String maxConcurrency
The defined maximum number of task executions that could be run in parallel.
String maxErrors
The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
String status
The status of the task.
String statusDetails
The details explaining the Status. Only available for certain status values.
Date startTime
The time the task execution started.
Date endTime
The time the task execution completed.
String windowId
The ID of the desired Maintenance Window.
String windowId
The ID of the created Maintenance Window.
String name
The name of the Maintenance Window.
String schedule
The schedule of the Maintenance Window in the form of a cron or rate expression.
Integer duration
The duration of the Maintenance Window in hours.
Integer cutoff
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Boolean allowUnassociatedTargets
Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
Boolean enabled
Whether the Maintenance Windows is enabled.
Date createdDate
The date the Maintenance Window was created.
Date modifiedDate
The date the Maintenance Window was last modified.
String name
The name of a parameter you want to query.
Boolean withDecryption
Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> parameters
A list of parameters returned by the request.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> names
Names of the parameters for which you want to query information.
Boolean withDecryption
Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of parameters used by the AWS account.
com.amazonaws.internal.SdkInternalList<T> invalidParameters
A list of parameters that are not formatted correctly or do not run when executed.
String patchGroup
The name of the patch group whose patch baseline should be retrieved.
String baselineId
The ID of the patch baseline to retrieve.
String baselineId
The ID of the retrieved patch baseline.
String name
The name of the patch baseline.
PatchFilterGroup globalFilters
A set of global filters used to exclude patches from the baseline.
PatchRuleGroup approvalRules
A set of rules used to include patches in the baseline.
com.amazonaws.internal.SdkInternalList<T> approvedPatches
A list of explicitly approved patches for the baseline.
com.amazonaws.internal.SdkInternalList<T> rejectedPatches
A list of explicitly rejected patches for the baseline.
com.amazonaws.internal.SdkInternalList<T> patchGroups
Patch groups included in the patch baseline.
Date createdDate
The date the patch baseline was created.
Date modifiedDate
The date the patch baseline was last modified.
String description
A description of the patch baseline.
S3OutputLocation s3Location
An Amazon S3 bucket where you want to store the results of this request.
S3OutputUrl s3OutputUrl
The URL of Amazon S3 bucket where you want to store the results of this request.
String associationId
The association ID.
String name
The name of the association.
String documentVersion
The association document verions.
String instanceId
The instance ID where the association was created.
Date executionDate
The date the instance association executed.
String status
Status information about the instance association.
String detailedStatus
Detailed status information about the instance association.
String executionSummary
Summary information about association execution.
String errorCode
An error code returned by the request to create the association.
InstanceAssociationOutputUrl outputUrl
A URL for an Amazon S3 bucket where you want to store the results of this request.
String instanceId
The instance ID.
String pingStatus
Connection status of the SSM agent.
Date lastPingDateTime
The date and time when agent last pinged Systems Manager service.
String agentVersion
The version of the SSM agent running on your Linux instance.
Boolean isLatestVersion
Indicates whether latest version of the SSM agent is running on your instance.
String platformType
The operating system platform type.
String platformName
The name of the operating system platform running on your instance.
String platformVersion
The version of the OS platform running on your instance.
String activationId
The activation ID created by Systems Manager when the server or VM was registered.
String iamRole
The Amazon Identity and Access Management (IAM) role assigned to EC2 instances or managed instances.
Date registrationDate
The date the server or VM was registered with AWS as a managed instance.
String resourceType
The type of instance. Instances are either EC2 instances or managed instances.
String name
The name of the managed instance.
String iPAddress
The IP address of the managed instance.
String computerName
The fully qualified host name of the managed instance.
String associationStatus
The status of the association.
Date lastAssociationExecutionDate
The date the association was last executed.
Date lastSuccessfulAssociationExecutionDate
The last date the association was successfully run.
InstanceAggregatedAssociationOverview associationOverview
Information about the association.
String key
The name of the filter.
com.amazonaws.internal.SdkInternalList<T> valueSet
The filter values.
String key
The filter key name to describe your instances. For example:
"InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|” AssociationStatus”|”Tag Key”
com.amazonaws.internal.SdkInternalList<T> values
The filter values.
String instanceId
The ID of the managed instance the high-level patch compliance information was collected for.
String patchGroup
The name of the patch group the managed instance belongs to.
String baselineId
The ID of the patch baseline used to patch the instance.
String snapshotId
The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
String ownerInformation
Placeholder information, this field will always be empty in the current release of the service.
Integer installedCount
The number of patches from the patch baseline that are installed on the instance.
Integer installedOtherCount
The number of patches not specified in the patch baseline that are installed on the instance.
Integer missingCount
The number of patches from the patch baseline that are applicable for the instance but aren’t currently installed.
Integer failedCount
The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
Integer notApplicableCount
The number of patches from the patch baseline that aren’t applicable for the instance and hence aren’t installed on the instance.
Date operationStartTime
The time the most recent patching operation was started on the instance.
Date operationEndTime
The time the most recent patching operation completed on the instance.
String operation
The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
String key
The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.
com.amazonaws.internal.SdkInternalList<T> values
The value for the filter, must be an integer greater than or equal to 0.
String type
The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.
String typeName
String key
The name of the filter key.
com.amazonaws.internal.SdkInternalList<T> values
Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal
String type
The type of filter. Valid values include the following: "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"
String 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
.
String schemaVersion
The schema version for the inventory item.
String captureTime
The time the inventory information was collected.
String contentHash
MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory
information. The PutInventory
API does not update the inventory item type contents if the MD5 hash
has not changed since last update.
com.amazonaws.internal.SdkInternalList<T> content
The inventory data of the inventory type.
String 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
.
String version
The schema version for the inventory item.
com.amazonaws.internal.SdkInternalList<T> attributes
The schema attributes for inventory. This contains data type and attribute name.
String typeName
The name of the inventory result item type.
String schemaVersion
The schema version for the inventory result item/
String captureTime
The time inventory item data was captured.
String contentHash
MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory
information. The PutInventory
API does not update the inventory item type contents if the MD5 hash
has not changed since last update.
com.amazonaws.internal.SdkInternalList<T> content
Contains all the inventory data of the item type. Results include attribute names and values.
String typeName
String typeName
com.amazonaws.internal.SdkInternalList<T> associationFilterList
One or more filters. Use a filter to return a more specific list of results.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> associations
The associations.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String commandId
(Optional) The invocations for a specific command ID.
String instanceId
(Optional) The command execution details for a specific instance ID.
Integer maxResults
(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> filters
(Optional) One or more filters. Use a filter to return a more specific list of results.
Boolean details
(Optional) If set this returns the response of the command executions and any command output. By default this is set to False.
com.amazonaws.internal.SdkInternalList<T> commandInvocations
(Optional) A list of all invocations.
String nextToken
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
String commandId
(Optional) If provided, lists only the specified command.
String instanceId
(Optional) Lists commands issued against this instance ID.
Integer maxResults
(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> filters
(Optional) One or more filters. Use a filter to return a more specific list of results.
com.amazonaws.internal.SdkInternalList<T> commands
(Optional) The list of commands requested by the user.
String nextToken
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> documentFilterList
One or more filters. Use a filter to return a more specific list of results.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> documentIdentifiers
The names of the SSM documents.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String name
The name of the document about which you want version information.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> documentVersions
The document versions.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String instanceId
The instance ID for which you want inventory information.
String typeName
The type of inventory item for which you want information.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters. Use a filter to return a more specific list of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String typeName
The type of inventory item returned by the request.
String instanceId
The instance ID targeted by the request to query inventory information.
String schemaVersion
The inventory schema version used by the instance(s).
String captureTime
The time that inventory information was collected for the instance(s).
com.amazonaws.internal.SdkInternalList<T> entries
A list of inventory items on the instance(s).
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> tagList
A list of tags.
String windowId
The ID of the Maintenance Window.
String windowExecutionId
The ID of the Maintenance Window execution.
String status
The status of the execution.
String statusDetails
The details explaining the Status. Only available for certain status values.
Date startTime
The time the execution started.
Date endTime
The time the execution finished.
String windowExecutionId
The ID of the Maintenance Window execution that ran the task.
String taskExecutionId
The ID of the specific task execution in the Maintenance Window execution.
String status
The status of the task execution.
String statusDetails
The details explaining the status of the task execution. Only available for certain status values.
Date startTime
The time the task execution started.
Date endTime
The time the task execution finished.
String taskArn
The ARN of the executed task.
String taskType
The type of executed task.
String windowExecutionId
The ID of the Maintenance Window execution that ran the task.
String taskExecutionId
The ID of the specific task execution in the Maintenance Window execution.
String invocationId
The ID of the task invocation.
String 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.
String parameters
The parameters that were provided for the invocation when it was executed.
String status
The status of the task invocation.
String statusDetails
The details explaining the status of the task invocation. Only available for certain Status values.
Date startTime
The time the invocation started.
Date endTime
The time the invocation finished.
String ownerInformation
User-provided value that was specified when the target was registered with the Maintenance Window. This was also included in any CloudWatch events raised during the task invocation.
String windowTargetId
The ID of the target definition in this Maintenance Window the invocation was performed for.
String key
The name of the filter.
com.amazonaws.internal.SdkInternalList<T> values
The filter values.
String windowId
The ID of the Maintenance Window.
String name
The name of the Maintenance Window.
Boolean enabled
Whether the Maintenance Window is enabled.
Integer duration
The duration of the Maintenance Window in hours.
Integer cutoff
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
String windowId
The Maintenance Window ID where the target is registered.
String windowTargetId
The ID of the target.
String resourceType
The type of target.
com.amazonaws.internal.SdkInternalList<T> targets
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
String ownerInformation
User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
String windowId
The Maintenance Window ID where the task is registered.
String windowTaskId
The task ID.
String taskArn
The ARN of the task to execute.
String type
The type of task.
com.amazonaws.internal.SdkInternalList<T> targets
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
Map<K,V> taskParameters
The parameters that should be passed to the task when it is executed.
Integer 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.
LoggingInfo loggingInfo
Information about an Amazon S3 bucket to write task-level logs to.
String serviceRoleArn
The role that should be assumed when executing the task
String maxConcurrency
The maximum number of targets this task can be run for in parallel.
String maxErrors
The maximum number of errors allowed before this task stops being scheduled.
com.amazonaws.internal.SdkInternalList<T> values
This field contains an array of 0 or more strings, each 1 to 255 characters in length.
String name
The name of the document that you want to share.
String permissionType
The permission type for the document. The permission type can be Share.
com.amazonaws.internal.SdkInternalList<T> accountIdsToAdd
The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
com.amazonaws.internal.SdkInternalList<T> accountIdsToRemove
The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
String notificationArn
An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
com.amazonaws.internal.SdkInternalList<T> notificationEvents
The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Monitoring Commands in the Amazon Elastic Compute Cloud User Guide .
String notificationType
Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
String name
The name of the parameter.
String type
The type of parameter used.
String keyId
The ID of the query key used for this parameter.
Date lastModifiedDate
Date the parameter was last changed or updated.
String lastModifiedUser
Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
String description
Information about the parameter.
String value
The parameter value.
String name
The parameter name.
String type
The type of parameter. Valid parameter types include the following: String, String list, Secure string.
String keyId
The ID of the query key used for this parameter.
Date lastModifiedDate
Date the parameter was last changed or updated.
String lastModifiedUser
Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
String description
Description of the parameter actions.
String key
The name of the filter.
com.amazonaws.internal.SdkInternalList<T> values
The filter values.
String id
The ID of the patch (this is different than the Microsoft Knowledge Base ID).
Date releaseDate
The date the patch was released.
String title
The title of the patch.
String description
The description of the patch.
String contentUrl
The URL where more information can be obtained about the patch.
String vendor
The name of the vendor providing the patch.
String productFamily
The product family the patch is applicable for (for example, Windows).
String product
The specific product the patch is applicable for (for example, WindowsServer2016).
String classification
The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).
String msrcSeverity
The severity of the patch (for example Critical, Important, Moderate).
String kbNumber
The Microsoft Knowledge Base ID of the patch.
String msrcNumber
The ID of the MSRC bulletin the patch is related to.
String language
The language of the patch if it’s language-specific.
String title
The title of the patch.
String kBId
The Microsoft Knowledge Base ID of the patch.
String classification
The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).
String severity
The severity of the patch (for example, Critical, Important, Moderate).
String state
The state of the patch on the instance (INSTALLED, INSTALLED_OTHER, MISSING, NOT_APPLICABLE or FAILED).
Date installedTime
The date/time the patch was installed on the instance.
String key
The key for the filter (PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID)
com.amazonaws.internal.SdkInternalList<T> values
The value for the filter key.
com.amazonaws.internal.SdkInternalList<T> patchFilters
The set of patch filters that make up the group.
String patchGroup
The name of the patch group registered with the patch baseline.
PatchBaselineIdentity baselineIdentity
The patch baseline the patch group is registered with.
String key
The key for the filter.
com.amazonaws.internal.SdkInternalList<T> values
The value for the filter.
PatchFilterGroup patchFilterGroup
The patch filter group that defines the criteria for the rule.
Integer approveAfterDays
The number of days after the release date of each patch matched by the rule the patch is marked as approved in the patch baseline.
com.amazonaws.internal.SdkInternalList<T> patchRules
The rules that make up the rule group.
String instanceId
One or more instance IDs where you want to add or update inventory items.
com.amazonaws.internal.SdkInternalList<T> items
The inventory items that you want to add or update on instances.
String name
The name of the parameter that you want to add to the system.
String description
Information about the parameter that you want to add to the system
String value
The parameter value that you want to add to the system.
String type
The type of parameter that you want to add to the system.
String keyId
The parameter key ID that you want to add to the system.
Boolean overwrite
Overwrite an existing parameter.
String baselineId
The ID of the patch baseline that should be the default patch baseline.
String baselineId
The ID of the default patch baseline.
String windowId
The ID of the Maintenance Window the target should be registered with.
String resourceType
The type of target being registered with the Maintenance Window.
com.amazonaws.internal.SdkInternalList<T> targets
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
String ownerInformation
User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
String clientToken
User-provided idempotency token.
String windowTargetId
The ID of the target definition in this Maintenance Window.
String windowId
The id of the Maintenance Window the task should be added to.
com.amazonaws.internal.SdkInternalList<T> targets
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
String taskArn
The ARN of the task to execute
String serviceRoleArn
The role that should be assumed when executing the task.
String taskType
The type of task being registered.
Map<K,V> taskParameters
The parameters that should be passed to the task when it is executed.
Integer 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.
String maxConcurrency
The maximum number of targets this task can be run for in parallel.
String maxErrors
The maximum number of errors allowed before this task stops being scheduled.
LoggingInfo loggingInfo
A structure containing information about an Amazon S3 bucket to write instance-level logs to.
String clientToken
User-provided idempotency token.
String windowTaskId
The id of the task in the Maintenance Window.
String resourceType
The type of resource of which you want to remove a tag.
String resourceId
The resource ID for which you want to remove tags.
com.amazonaws.internal.SdkInternalList<T> tagKeys
Tag keys that you want to remove from the specified resource.
String typeName
Name of the inventory item type. Valid value: “AWS:InstanceInformation”. Default Value: “AWS:InstanceInformation”.
String outputUrl
A URL for an Amazon S3 bucket where you want to store the results of this request.
com.amazonaws.internal.SdkInternalList<T> instanceIds
Required. The instance IDs where the command should execute. You can specify a maximum of 50 IDs.
com.amazonaws.internal.SdkInternalList<T> targets
(Optional) An array of search criteria that targets instances using a Key
;Value
combination that you specify. Targets
is required if you don't provide one or more instance IDs in
the call. For more information about how to use Targets
, see Executing a Command Using Amazon EC2
Run Command (Linux) or Executing a Command Using Amazon
EC2 Run Command (Windows).
String documentName
Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
String documentHash
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
String documentHashType
Sha256 or Sha1.
Sha1 hashes have been deprecated.
Integer timeoutSeconds
If this time is reached and the command has not already started executing, it will not execute.
String comment
User-specified information about the command, such as a brief description of what the command should do.
Map<K,V> parameters
The required and optional parameters specified in the SSM document being executed.
String outputS3Region
(Optional) The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.
String outputS3BucketName
The name of the S3 bucket where command execution responses should be stored.
String outputS3KeyPrefix
The directory structure within the S3 bucket where the responses should be stored.
String maxConcurrency
(Optional) The maximum number of instances that are allowed to execute 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 Executing a Command Using Amazon EC2
Run Command (Linux) or Executing a Command Using Amazon
EC2 Run Command (Windows).
String 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 50. For more information about how to use
MaxErrors
, see Executing a Command Using Amazon EC2
Run Command (Linux) or Executing a Command Using Amazon
EC2 Run Command (Windows).
String serviceRoleArn
The IAM role that Systems Manager uses to send notifications.
NotificationConfig notificationConfig
Configurations for sending notifications.
Command command
The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.
String documentName
The name of the Automation document to use for this execution.
String documentVersion
The version of the Automation document to use for this execution.
Map<K,V> parameters
A key-value map of execution parameters, which match the declared parameters in the Automation document.
String automationExecutionId
The unique ID of a newly scheduled automation execution.
String stepName
The name of this execution step.
String action
The action this step performs. The action determines the behavior of the step.
Date executionStartTime
If a step has begun execution, this contains the time the step started. If the step is in Pending
status, this field is not populated.
Date executionEndTime
If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
String stepStatus
The execution status for this step. Valid values include: Pending
, InProgress
,
Success
, Cancelled
, Failed
, and TimedOut
.
String responseCode
The response code returned by the execution of the step.
Map<K,V> inputs
Fully-resolved values passed into the step before execution.
Map<K,V> outputs
Returned values from the execution of the step.
String response
A message associated with the response code for an execution.
String failureMessage
If a step failed, this message explains why the execution failed.
String automationExecutionId
The execution ID of the Automation to stop.
String key
User-defined criteria for sending commands that target instances that meet the criteria. Key
can be
tag:<Amazon EC2 tag>
or name:<Amazon EC2 instance ID>
. For example,
tag:ServerRole
or name:0123456789012345
. For more information about how to send
commands that target instances using Key
;Value
parameters, see Executing a Command Using Amazon EC2
Run Command (Linux) or Executing a Command Using Amazon
EC2 Run Command (Windows).
com.amazonaws.internal.SdkInternalList<T> values
User-defined criteria that maps to Key
. For example, if you specified tag:ServerRole
,
you could specify value:WebServer
to execute a command on instances that include Amazon EC2 tags of
ServerRole;WebServer. For more information about how to send commands that target instances using
Key
;Value
parameters, see Executing a Command Using Amazon EC2
Run Command (Linux) or Executing a Command Using Amazon
EC2 Run Command (Windows).
String associationId
The ID of the association you want to update.
Map<K,V> parameters
The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
String documentVersion
The document version you want update for the association.
String scheduleExpression
The cron expression used to schedule the association that you want to update. Supported expressions are every half, 1, 2, 4, 8 or 12 hour(s); every specified day and time of the week. For example: cron(0 0/30 * 1/1 * ? *) to run every thirty minutes; cron(0 0 0/4 1/1 * ? *) to run every four hours; and cron(0 0 10 ? * SUN *) to run every Sunday at 10 a.m.
InstanceAssociationOutputLocation outputLocation
An Amazon S3 bucket where you want to store the results of this request.
"{ \"S3Location\": { \"OutputS3Region\": \"<region>\", \"OutputS3BucketName\": \"bucket name\", \"OutputS3KeyPrefix\": \"folder name\" } }"
AssociationDescription associationDescription
The description of the association that was updated.
String name
The name of the SSM document.
String instanceId
The ID of the instance.
AssociationStatus associationStatus
The association status.
AssociationDescription associationDescription
Information about the association.
DocumentDefaultVersionDescription description
The description of a custom document that you want to set as the default version.
DocumentDescription documentDescription
A description of the document that was updated.
String windowId
The ID of the Maintenance Window to update.
String name
The name of the Maintenance Window.
String schedule
The schedule of the Maintenance Window in the form of a cron or rate expression.
Integer duration
The duration of the Maintenance Window in hours.
Integer cutoff
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Boolean allowUnassociatedTargets
Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
Boolean enabled
Whether the Maintenance Window is enabled.
String windowId
The ID of the created Maintenance Window.
String name
The name of the Maintenance Window.
String schedule
The schedule of the Maintenance Window in the form of a cron or rate expression.
Integer duration
The duration of the Maintenance Window in hours.
Integer cutoff
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Boolean allowUnassociatedTargets
Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
Boolean enabled
Whether the Maintenance Window is enabled.
String baselineId
The ID of the patch baseline to update.
String name
The name of the patch baseline.
PatchFilterGroup globalFilters
A set of global filters used to exclude patches from the baseline.
PatchRuleGroup approvalRules
A set of rules used to include patches in the baseline.
com.amazonaws.internal.SdkInternalList<T> approvedPatches
A list of explicitly approved patches for the baseline.
com.amazonaws.internal.SdkInternalList<T> rejectedPatches
A list of explicitly rejected patches for the baseline.
String description
A description of the patch baseline.
String baselineId
The ID of the deleted patch baseline.
String name
The name of the patch baseline.
PatchFilterGroup globalFilters
A set of global filters used to exclude patches from the baseline.
PatchRuleGroup approvalRules
A set of rules used to include patches in the baseline.
com.amazonaws.internal.SdkInternalList<T> approvedPatches
A list of explicitly approved patches for the baseline.
com.amazonaws.internal.SdkInternalList<T> rejectedPatches
A list of explicitly rejected patches for the baseline.
Date createdDate
The date when the patch baseline was created.
Date modifiedDate
The date when the patch baseline was last modified.
String description
A description of the Patch Baseline.
Copyright © 2017. All rights reserved.