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 node when it is created.
String iamRole
The Identity and Access Management (IAM) role to assign to the managed node.
Integer registrationLimit
The maximum number of managed nodes that can be registered using this activation.
Integer registrationsCount
The number of managed nodes already registered with this activation.
Date expirationDate
The date when this activation can no longer be used to register managed nodes.
Boolean expired
Whether or not the activation is expired.
Date createdDate
The date the activation was created.
SdkInternalList<T> tags
Tags assigned to the activation.
String resourceType
Specifies the type of resource you are tagging.
The ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify
the name of the managed node in the following format: mi-ID_number
. For example,
mi-1a2b3c4d5e6f
.
String resourceId
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow
: mw-012345abcde
PatchBaseline
: pb-012345abcde
OpsMetadata
object: ResourceID
for tagging is created from the Amazon Resource Name
(ARN) for the object. Specifically, ResourceID
is created from the strings that come after the word
opsmetadata
in the ARN. For example, an OpsMetadata object with an ARN of
arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has a
ResourceID
of either aws/ssm/MyGroup/appmanager
or
/aws/ssm/MyGroup/appmanager
.
For the Document
and Parameter
values, use the name of the resource.
ManagedInstance
: mi-012345abcde
The ManagedInstance
type for this API operation is only for on-premises managed nodes. You must
specify the name of the managed node in the following format: mi-ID_number
. For example,
mi-1a2b3c4d5e6f
.
SdkInternalList<T> tags
One or more tags. The value parameter is required.
Don't enter personally identifiable information in this field.
String opsItemId
The ID of the OpsItem to which you want to associate a resource as a related item.
String associationType
The type of association that you want to create between an OpsItem and a resource. OpsCenter supports
IsParentOf
and RelatesTo
association types.
String resourceType
The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:
AWS::SSMIncidents::IncidentRecord
: an Incident Manager incident.
AWS::SSM::Document
: a Systems Manager (SSM) document.
String resourceUri
The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.
String associationId
The association ID.
String name
The name of the SSM document.
String instanceId
The managed node ID.
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 associationVersion
The association version.
String 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.
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
.
SdkInternalList<T> targets
The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon
Web Services account by specifying the InstanceIds
key with a value of *
.
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. The schedule runs in Coordinated Universal Time (UTC).
String associationName
The association name.
String name
The name of the SSM document.
String instanceId
The managed node ID.
String associationVersion
The association version.
Date date
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.
String automationTargetParameterName
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
Map<K,V> parameters
A description of the parameters for a document.
String associationId
The association ID.
SdkInternalList<T> targets
The managed nodes targeted by the request.
String scheduleExpression
A cron expression that specifies a schedule when the association runs.
InstanceAssociationOutputLocation outputLocation
An 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 associationName
The association name.
String 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 first error is returned. If
you run an association on 50 managed nodes and set MaxError
to 10%, then the system stops sending
the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to
complete, but some of these executions may fail as well. If you need to ensure that there won't be more than
max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at a time.
String 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 specified for
MaxConcurrency
.
String complianceSeverity
The severity level that is assigned to the association.
String 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
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
Boolean 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 specified. 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.
SdkInternalList<T> 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 Amazon Web Services Systems Manager Change Calendar.
SdkInternalList<T> targetLocations
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
String associationId
The association ID.
String associationVersion
The association version.
String executionId
The execution ID for the association.
String status
The status of the association execution.
String detailedStatus
Detailed status information about the execution.
Date createdTime
The time the execution started.
Date lastExecutionDate
The date of the last execution.
String resourceCountByStatus
An aggregate status of the resources in the execution based on the status type.
String associationId
The association ID.
String associationVersion
The association version.
String executionId
The execution ID.
String resourceId
The resource ID, for example, the managed node ID where the association ran.
String resourceType
The resource type, for example, EC2.
String status
The association execution status.
String detailedStatus
Detailed information about the execution status.
Date lastExecutionDate
The date of the last execution.
OutputSource outputSource
The location where the association details are saved.
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 managed nodes, and one of them was successful, this would return the count of managed nodes by status.
String associationId
The ID created by the system when the association was created.
String associationVersion
The association version.
Date createdDate
The date the association version was created.
String name
The name specified when the association was created.
String documentVersion
The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.
Map<K,V> parameters
Parameters specified when the association version was created.
SdkInternalList<T> targets
The targets specified for the association when the association version was created.
String scheduleExpression
The cron or rate schedule specified for the association when the association version was created.
InstanceAssociationOutputLocation outputLocation
The location in Amazon S3 specified for the association when the association version was created.
String associationName
The name specified for the association version when the association version was created.
String 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 first error is returned. If
you run an association on 50 managed nodes and set MaxError
to 10%, then the system stops sending
the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to
complete, but some of these executions may fail as well. If you need to ensure that there won't be more than
max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at a time.
String 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 specified for
MaxConcurrency
.
String complianceSeverity
The severity level that is assigned to the association.
String 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
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
Boolean 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 specified. 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.
SdkInternalList<T> calendarNames
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 Amazon Web Services Systems Manager Change Calendar.
SdkInternalList<T> targetLocations
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.
String name
The name of an attachment.
Long size
The size of an attachment in bytes.
String hash
The cryptographic hash value of the document content.
String hashType
The hash algorithm used to calculate the hash value.
String url
The URL location of the attachment content.
String name
The name of the attachment.
String key
The key of a key-value pair that identifies the location of an attachment to a document.
SdkInternalList<T> values
The value of a key-value pair that identifies 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://doc-example-bucket/my-folder" ]
For the key S3FileUrl, the value is a file in an S3 bucket. For example:
"Values": [ "s3://doc-example-bucket/my-folder/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 file attached to that document version that you want to reuse. For example:
"Values": [ "MyOtherDocument/3/my-other-file.py" ]
However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
"Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
String name
The name of the document attachment file.
String automationExecutionId
The execution ID.
String documentName
The name of the Automation runbook 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.
SdkInternalList<T> 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.
Boolean 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.
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 runbook.
String failureMessage
A message describing why an execution has failed, if the status is set to Failed.
String mode
The automation execution mode.
String parentAutomationExecutionId
The AutomationExecutionId of the parent automation.
String executedBy
The Amazon Resource Name (ARN) of the user who ran the automation.
String currentStepName
The name of the step that is currently running.
String currentAction
The action of the step that is currently running.
String targetParameterName
The parameter name.
SdkInternalList<T> targets
The specified targets.
SdkInternalList<T> targetMaps
The specified key-value mapping of document parameters to target resources.
ResolvedTargets resolvedTargets
A list of resolved targets in the rate control execution.
String maxConcurrency
The MaxConcurrency
value specified by the user when the execution started.
String maxErrors
The MaxErrors value specified by the user when the execution started.
String target
The target of the execution.
SdkInternalList<T> targetLocations
The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
ProgressCounters progressCounters
An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
String automationSubtype
The subtype of the Automation operation. Currently, the only supported value is ChangeRequest
.
Date scheduledTime
The date and time the Automation operation is scheduled to start.
SdkInternalList<T> runbooks
Information about the Automation runbooks that are run as part of a runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
String opsItemId
The ID of an OpsItem that is created to represent a Change Manager change request.
String associationId
The ID of a State Manager association used in the Automation operation.
String changeRequestName
The name of the Change Manager change request.
String key
One or more keys to limit the results.
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 runbook used during execution.
String documentVersion
The document version used during the execution.
String automationExecutionStatus
The status of the execution.
Date executionStartTime
The time the execution started.
Date executionEndTime
The time the execution finished. This isn't populated if the execution is still in progress.
String executedBy
The IAM role ARN of the user who ran the automation.
String logFile
An S3 bucket where execution information is stored.
Map<K,V> outputs
The list of execution outputs as defined in the Automation runbook.
String mode
The Automation execution mode.
String parentAutomationExecutionId
The execution ID of the parent automation.
String currentStepName
The name of the step that is currently running.
String currentAction
The action of the step that is currently running.
String failureMessage
The list of execution outputs as defined in the Automation runbook.
String targetParameterName
The list of execution outputs as defined in the Automation runbook.
SdkInternalList<T> targets
The targets defined by the user when starting the automation.
SdkInternalList<T> targetMaps
The specified key-value mapping of document parameters to target resources.
ResolvedTargets resolvedTargets
A list of targets that resolved during the execution.
String maxConcurrency
The MaxConcurrency
value specified by the user when starting the automation.
String maxErrors
The MaxErrors
value specified by the user when starting the automation.
String target
The list of execution outputs as defined in the Automation runbook.
String automationType
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.
String automationSubtype
The subtype of the Automation operation. Currently, the only supported value is ChangeRequest
.
Date scheduledTime
The date and time the Automation operation is scheduled to start.
SdkInternalList<T> runbooks
Information about the Automation runbooks that are run during a runbook workflow in Change Manager.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
String opsItemId
The ID of an OpsItem that is created to represent a Change Manager change request.
String associationId
The ID of a State Manager association used in the Automation operation.
String changeRequestName
The name of the Change Manager change request.
String operatingSystem
The operating system rule used by the patch baseline override.
PatchFilterGroup globalFilters
PatchRuleGroup approvalRules
SdkInternalList<T> approvedPatches
A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
String approvedPatchesComplianceLevel
Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation.
SdkInternalList<T> rejectedPatches
A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
String 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.
Boolean 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.
SdkInternalList<T> 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.
String commandId
The ID of the command you want to cancel.
SdkInternalList<T> instanceIds
(Optional) A list of managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node on which it was requested.
String windowExecutionId
The ID of the maintenance window execution to stop.
String windowExecutionId
The ID of the maintenance window execution that has been stopped.
String cloudWatchLogGroupName
The name of the CloudWatch Logs log group where you want to send command output. If you don't specify a group name, Amazon Web Services Systems Manager automatically creates a log group for you. The log group uses the following naming format:
aws/ssm/SystemsManagerDocumentName
Boolean cloudWatchOutputEnabled
Enables Systems Manager to send command output to CloudWatch Logs.
String commandId
A unique identifier for this command.
String documentName
The name of the document requested for execution.
String documentVersion
The Systems Manager document (SSM document) version.
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 hasn't already started running, it won't run. Calculated based on the
ExpiresAfter
user input provided as part of the SendCommand
API operation.
Map<K,V> parameters
The parameter values to be inserted in the document when running the command.
SdkInternalList<T> instanceIds
The managed node IDs against which this command was requested.
SdkInternalList<T> 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.
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
Understanding
command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of
the following values:
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 final 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.
String outputS3Region
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
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 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 Running commands using
Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
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
0
. For more information about how to use MaxErrors
, see Running commands using
Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
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, Cancelled, Terminated, or Undeliverable.
Integer errorCount
The number of targets for which the status is Failed or Execution Timed Out.
Integer deliveryTimedOutCount
The number of targets for which the status is Delivery Timed Out.
String serviceRole
The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
NotificationConfig notificationConfig
Configurations for sending notifications about command status changes.
CloudWatchOutputConfig cloudWatchOutputConfig
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
Integer timeoutSeconds
The TimeoutSeconds
value specified for a command.
String key
The name of the filter.
The ExecutionStage
filter can't be used with the ListCommandInvocations
operation, only
with ListCommands
.
String value
The filter value. Valid values for each filter key are as follows:
InvokedAfter: Specify a timestamp to limit your results. For example, specify
2021-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
2021-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.
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 Amazon Web Services Systems Manager document (SSM document) for which
you want to see command execution results. For example, specify AWS-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.
String commandId
The command against which this invocation was requested.
String instanceId
The managed node ID in which this invocation was requested.
String instanceName
The fully qualified host name of the managed node.
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.
String documentVersion
The Systems Manager document (SSM document) version.
Date requestedDateTime
The time and date the request was sent to this managed node.
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 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 different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services 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 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 Simple Storage Service (Amazon S3), if the 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 S3 bucket was defined for the command.
String standardErrorUrl
The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the 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 S3 bucket was defined for the command.
SdkInternalList<T> commandPlugins
Plugins processed by the command.
String serviceRole
The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.
NotificationConfig notificationConfig
Configurations for sending notifications about command status changes on a per managed node basis.
CloudWatchOutputConfig cloudWatchOutputConfig
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
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 run 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 Understanding command
statuses in the Amazon Web Services 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.
Integer responseCode
A numeric response code generated after running the plugin.
Date responseStartDateTime
The time the plugin started running.
Date responseFinishDateTime
The time the plugin stopped running. 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 S3 bucket for the command wasn't specified, then this string is empty.
String standardErrorUrl
The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty.
String outputS3Region
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the S3 bucket region.
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:
doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
doc-example-bucket
is the name of the S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix;
i-02573cafcfEXAMPLE
is the managed node 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:
doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
doc-example-bucket
is the name of the S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix;
i-02573cafcfEXAMPLE
is the managed node ID;
awsrunShellScript
is the name of the plugin.
Date 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'.
String 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.
String executionType
The type of execution. For example, Command
is a valid execution type.
String complianceType
The compliance type. For example, Association (for a State Manager association), Patch, or Custom:
string
are all valid compliance types.
String resourceType
The type of resource. ManagedInstance
is currently the only supported resource type.
String resourceId
An ID for the resource. For a managed node, this is the node ID.
String 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.
String title
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.
String 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).
String severity
The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
ComplianceExecutionSummary executionSummary
A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.
Map<K,V> details
A "Key": "Value" tag combination for the compliance item.
String 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.
String title
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.
String severity
The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
String status
The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
Map<K,V> details
A "Key": "Value" tag combination for the compliance item.
String key
The name of the filter.
SdkInternalList<T> values
The value for which to search.
String type
The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.
String complianceType
The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.
CompliantSummary compliantSummary
A list of COMPLIANT items for the specified compliance type.
NonCompliantSummary nonCompliantSummary
A list of NON_COMPLIANT items for the specified compliance type.
Integer compliantCount
The total number of resources that are compliant.
SeveritySummary severitySummary
A summary of the compliance severity by compliance type.
String description
A user-defined description of the resource that you want to register with Systems Manager.
Don't enter personally identifiable information in this field.
String defaultInstanceName
The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.
Don't enter personally identifiable information in this field.
String iamRole
The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM
role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal
ssm.amazonaws.com
. For more information, see Create an IAM
service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.
Integer registrationLimit
Specify the maximum number of managed nodes you want to register. The default value is 1
.
Date expirationDate
The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.
SdkInternalList<T> tags
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.
You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.
SdkInternalList<T> registrationMetadata
Reserved for internal use.
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.
SdkInternalList<T> entries
One or more associations.
String name
The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
You can specify Amazon Web Services-predefined 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 Amazon Web Services 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 Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to
specify the document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
String instanceId
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the
Targets
parameter. Requests that include the parameter InstanceID
with Systems Manager
documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter
InstanceId
, you can't use the parameters AssociationName
, DocumentVersion
,
MaxErrors
, MaxConcurrency
, OutputLocation
, or
ScheduleExpression
. To use these parameters, you must use the Targets
parameter.
Map<K,V> parameters
A description of the parameters for a document.
String 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 capability of Amazon Web Services Systems Manager.
String documentVersion
The document version.
SdkInternalList<T> targets
The managed nodes targeted by the request.
String scheduleExpression
A cron expression that specifies a schedule when the association runs.
InstanceAssociationOutputLocation outputLocation
An S3 bucket where you want to store the results of this request.
String associationName
Specify a descriptive name for the association.
String 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 first error is returned. If
you run an association on 50 managed nodes and set MaxError
to 10%, then the system stops sending
the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to
complete, but some of these executions may fail as well. If you need to ensure that there won't be more than
max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at a time.
String 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 specified for
MaxConcurrency
.
String complianceSeverity
The severity level to assign to the association.
String 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
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
Boolean 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 specified. 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.
SdkInternalList<T> 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 Amazon Web Services Systems Manager Change Calendar.
SdkInternalList<T> targetLocations
Use this action to create an association in multiple Regions and multiple accounts.
SdkInternalList<T> successful
Information about the associations that succeeded.
SdkInternalList<T> failed
Information about the associations that failed.
String name
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:partition:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to
specify the document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
String documentVersion
The document version you want to associate with the target(s). Can be a specific version or the default version.
State Manager doesn't support running associations that use a new version of a document if that document is
shared from another account. State Manager always runs the default
version of a document if shared
from another account, even though the Systems Manager console shows that a new version was processed. If you want
to run an association using a new version of a document shared form another account, you must set the document
version to default
.
String instanceId
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the
Targets
parameter. Requests that include the parameter InstanceID
with Systems Manager
documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter
InstanceId
, you can't use the parameters AssociationName
, DocumentVersion
,
MaxErrors
, MaxConcurrency
, OutputLocation
, or
ScheduleExpression
. To use these parameters, you must use the Targets
parameter.
Map<K,V> parameters
The parameters for the runtime configuration of the document.
SdkInternalList<T> targets
The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups,
all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed
nodes in an Amazon Web Services account by specifying the InstanceIds
key with a value of
*
. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems
Manager User Guide.
String scheduleExpression
A cron expression when the association will be applied to the target(s).
InstanceAssociationOutputLocation outputLocation
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
String associationName
Specify a descriptive name for the association.
String automationTargetParameterName
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
String 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 first error is returned. If
you run an association on 50 managed nodes and set MaxError
to 10%, then the system stops sending
the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to
complete, but some of these executions may fail as well. If you need to ensure that there won't be more than
max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at a time.
String 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 specified for
MaxConcurrency
.
String complianceSeverity
The severity level to assign to the association.
String 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. It is
managed by your direct call to the PutComplianceItems API operation.
By default, all associations use AUTO
mode.
Boolean applyOnlyAtCronInterval
By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. 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.
SdkInternalList<T> 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 Amazon Web Services Systems Manager Change Calendar.
SdkInternalList<T> targetLocations
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
AssociationDescription associationDescription
Information about the association.
String content
The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.
For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.
SdkInternalList<T> requires
A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user
creates an AppConfig configuration in an SSM document, the user must also specify a required document for
validation purposes. In this case, an ApplicationConfiguration
document requires an
ApplicationConfigurationSchema
document for validation purposes. For more information, see What is AppConfig? in
the AppConfig User Guide.
SdkInternalList<T> attachments
A list of key-value pairs that describe attachments to a version of a document.
String name
A name for the SSM document.
You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:
aws-
amazon
amzn
String displayName
An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.
String versionName
An optional field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
String documentType
The type of document to create.
The DeploymentStrategy
document type is an internal-use-only document type reserved for AppConfig.
String documentFormat
Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
String targetType
Specify a target type to define the kinds of resources the document can run on. For example, to run a document on
EC2 instances, specify the following value: /AWS::EC2::Instance
. If you specify a value of '/' the
document can run on all types of resources. If you don't specify a value, the document can't run on any
resources. For a list of valid resource types, see Amazon
Web Services resource and property types reference in the CloudFormation User Guide.
SdkInternalList<T> tags
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource operation.
DocumentDescription documentDescription
Information about the SSM document.
String name
The name of the maintenance window.
String description
An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
String 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 specified future date.
String endDate
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.
String schedule
The schedule of the maintenance window in the form of a cron or rate expression.
String 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.
Integer scheduleOffset
The number of days to wait after the date and time specified by a cron expression before running the maintenance window.
For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.
cron(30 23 ? * TUE#3 *)
If the schedule offset is 2
, the maintenance window won't run until two days later.
Integer duration
The duration of the maintenance window in hours.
Integer cutoff
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
Boolean allowUnassociatedTargets
Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.
If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.
String clientToken
User-provided idempotency token.
SdkInternalList<T> tags
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:
Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing maintenance window, use the AddTagsToResource operation.
String windowId
The ID of the created maintenance window.
String description
Information about the OpsItem.
String opsItemType
The type of OpsItem to create. Currently, the only valid values are /aws/changerequest
and
/aws/issue
.
Map<K,V> operationalData
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon
, aws
,
amzn
, ssm
, /amazon
, /aws
, /amzn
,
/ssm
.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API 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
Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
SdkInternalList<T> notifications
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
Integer priority
The importance of this OpsItem in relation to other OpsItems in the system.
SdkInternalList<T> 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.
String source
The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
The source name can't contain the following strings: aws
, amazon
, and amzn
.
String title
A short heading that describes the nature of the OpsItem and the impacted resource.
SdkInternalList<T> tags
Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.
Tags use a key-value pair. For example:
Key=Department,Value=Finance
To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems
operation and the ssm:AddTagsToResource
operation. To add tags to an existing OpsItem, use the
AddTagsToResource operation.
String category
Specify a category to assign to an OpsItem.
String severity
Specify a severity to assign to an OpsItem.
Date actualStartTime
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest
.
Date actualEndTime
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest
.
Date plannedStartTime
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem
type /aws/changerequest
.
Date plannedEndTime
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem
type /aws/changerequest
.
String opsItemId
The ID of the OpsItem.
String resourceId
A resource ID for a new Application Manager application.
Map<K,V> metadata
Metadata for a new Application Manager application.
SdkInternalList<T> tags
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:
Key=Environment,Value=Production
Key=Region,Value=us-east-2
String opsMetadataArn
The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.
String operatingSystem
Defines the operating system the patch baseline applies to. The default value is WINDOWS
.
String name
The name of the patch baseline.
PatchFilterGroup globalFilters
A set of global filters used to include patches in the baseline.
PatchRuleGroup approvalRules
A set of rules used to include patches in the baseline.
SdkInternalList<T> approvedPatches
A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
String approvedPatchesComplianceLevel
Defines the compliance level for approved patches. When an approved patch is reported as missing, this value
describes the severity of the compliance violation. The default value is UNSPECIFIED
.
Boolean 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.
SdkInternalList<T> rejectedPatches
A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
String rejectedPatchesAction
The action for Patch Manager to take on patches included in the RejectedPackages
list.
ALLOW_AS_DEPENDENCY
: 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 InstalledOther
. This is the default action if no option is specified.
BLOCK
: Packages in the RejectedPatches
list, and packages that include them as
dependencies, aren't installed under any circumstances. If a package was installed before it was added to the
Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as
InstalledRejected
.
String description
A description of the patch baseline.
SdkInternalList<T> 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.
String clientToken
User-provided idempotency token.
SdkInternalList<T> tags
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key-value pairs:
Key=PatchSeverity,Value=Critical
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource operation.
String baselineId
The ID of the created patch baseline.
String syncName
A name for the configuration.
ResourceDataSyncS3Destination s3Destination
Amazon S3 configuration details for the sync. This parameter is required if the SyncType
value is
SyncToDestination.
String syncType
Specify SyncToDestination
to create a resource data sync that synchronizes data to an S3 bucket for
Inventory. If you specify SyncToDestination
, you must provide a value for S3Destination
. Specify SyncFromSource
to synchronize data from a single account and multiple Regions, or multiple
Amazon Web Services accounts and Amazon Web Services Regions, as listed in Organizations for Explorer. If you
specify SyncFromSource
, you must provide a value for SyncSource
. The default value is
SyncToDestination
.
ResourceDataSyncSource syncSource
Specify information about the data sources to synchronize. This parameter is required if the
SyncType
value is SyncFromSource.
String activationId
The ID of the activation that you want to delete.
String name
The name of the SSM document.
String instanceId
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the
Targets
parameter. Requests that include the parameter InstanceID
with Systems Manager
documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter
InstanceId
, you can't use the parameters AssociationName
, DocumentVersion
,
MaxErrors
, MaxConcurrency
, OutputLocation
, or
ScheduleExpression
. To use these parameters, you must use the Targets
parameter.
String associationId
The association ID that you want to delete.
String name
The name of the document.
String documentVersion
The version of the document that you want to delete. If not provided, all versions of the document are deleted.
String versionName
The version name of the document that you want to delete. If not provided, all versions of the document are deleted.
Boolean force
Some SSM document types require that you specify a Force
flag before you can delete the document.
For example, you must specify a Force
flag to delete a document of type
ApplicationConfigurationSchema
. You can restrict access to the Force
flag in an
Identity and Access Management (IAM) policy.
String typeName
The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.
String schemaDeleteOption
Use the SchemaDeleteOption
to delete a custom inventory type (schema). If you don't choose this
option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of
the following options:
DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and
any earlier versions. To enable this schema again, you must call the PutInventory
operation for a
version greater than the disabled version.
DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.
Boolean dryRun
Use this option to view a summary of the deletion request without deleting any data or the data type. This option
is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is
what you intend to delete, you can run the same command without specifying the DryRun
option.
String clientToken
User-provided idempotency token.
String deletionId
Every DeleteInventory
operation is assigned a unique ID. This option returns a unique ID. You can
use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation
has completed before you begin other operations.
String typeName
The name of the inventory data type specified in the request.
InventoryDeletionSummary deletionSummary
A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the Amazon Web Services Systems Manager User Guide.
String windowId
The ID of the maintenance window to delete.
String windowId
The ID of the deleted maintenance window.
String opsMetadataArn
The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.
String name
The name of the parameter to delete.
SdkInternalList<T> names
The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
SdkInternalList<T> deletedParameters
The names of the deleted parameters.
SdkInternalList<T> invalidParameters
The names of parameters that weren't deleted because the parameters aren't valid.
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 node when you registered it using the activation process.
String windowId
The ID of the maintenance window the target should be removed from.
String windowTargetId
The ID of the target definition to remove.
Boolean safe
The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn't deregister the target from the maintenance window.
String filterKey
The name of the filter.
SdkInternalList<T> filterValues
The filter values.
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.
SdkInternalList<T> activationList
A list of activations for your Amazon Web Services account.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
String associationId
The association ID for which you want to view execution history details.
SdkInternalList<T> filters
Filters for the request. You can specify the following filters and values.
ExecutionId (EQUAL)
Status (EQUAL)
CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)
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.
SdkInternalList<T> associationExecutions
A list of the executions for the specified association ID.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
String associationId
The association ID that includes the execution for which you want to view details.
String executionId
The execution ID for which you want to view details.
SdkInternalList<T> filters
Filters for the request. You can specify the following filters and values.
Status (EQUAL)
ResourceId (EQUAL)
ResourceType (EQUAL)
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.
SdkInternalList<T> associationExecutionTargets
Information about the execution.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
String name
The name of the SSM document.
String instanceId
The managed node ID.
String associationId
The association ID for which you want information.
String associationVersion
Specify the association version to retrieve. To view the latest version, either specify $LATEST
for
this parameter, or omit this parameter. To view a list of all associations for a managed node, use
ListAssociations. To get a list of versions for a specific association, use
ListAssociationVersions.
AssociationDescription associationDescription
Information about the association.
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.)
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.
String automationExecutionId
The Automation execution ID for which you want step execution descriptions.
SdkInternalList<T> filters
One or more filters to limit the number of step executions returned by the request.
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.
Boolean reverseOrder
Indicates whether to list step executions in reverse order by start time. The default value is 'false'.
SdkInternalList<T> stepExecutions
A list of details about the current state of all steps that make up an 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.
SdkInternalList<T> filters
Each element in the array is a structure containing a key-value pair.
Windows Server
Supported keys for Windows Server managed node patches include the following:
PATCH_SET
Sample values: OS
| APPLICATION
PRODUCT
Sample values: WindowsServer2012
| Office 2010
|
MicrosoftDefenderAntivirus
PRODUCT_FAMILY
Sample values: Windows
| Office
MSRC_SEVERITY
Sample values: ServicePacks
| Important
| Moderate
CLASSIFICATION
Sample values: ServicePacks
| SecurityUpdates
| DefinitionUpdates
PATCH_ID
Sample values: KB123456
| KB4516046
Linux
When specifying filters for Linux patches, you must specify a key-pair for PRODUCT
. For example,
using the Command Line Interface (CLI), the following command fails:
aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615
However, the following command succeeds:
aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615
Supported keys for Linux managed node patches include the following:
PRODUCT
Sample values: AmazonLinux2018.03
| AmazonLinux2.0
NAME
Sample values: kernel-headers
| samba-python
| php
SEVERITY
Sample values: Critical
| Important
| Medium
| Low
EPOCH
Sample values: 0
| 1
VERSION
Sample values: 78.6.1
| 4.10.16
RELEASE
Sample values: 9.56.amzn1
| 1.amzn2
ARCH
Sample values: i686
| x86_64
REPOSITORY
Sample values: Core
| Updates
ADVISORY_ID
Sample values: ALAS-2018-1058
| ALAS2-2021-1594
CVE_ID
Sample values: CVE-2018-3615
| CVE-2020-1472
BUGZILLA_ID
Sample values: 1463241
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.)
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.
String name
The name of the document for which you are the owner.
String permissionType
The permission type for the document. The permission type can be Share.
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.)
SdkInternalList<T> accountIds
The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account or All.
SdkInternalList<T> accountSharingInfoList
A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
String name
The name of the SSM document.
String documentVersion
The document version for which you want information. Can be a specific version or the default version.
String versionName
An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
DocumentDescription document
Information about the SSM document.
String instanceId
The managed node 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.)
SdkInternalList<T> associations
The associations for the requested managed node.
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.)
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 managed node 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.)
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.
SdkInternalList<T> instanceInformationFilterList
This is a legacy method. We recommend that you don't use this method. Instead, use the Filters
data
type. Filters
enables you to return node information by filtering based on tags applied to managed
nodes.
Attempting to use InstanceInformationFilterList
and Filters
leads to an exception
error.
SdkInternalList<T> filters
One or more filters. Use a filter to return a more specific list of managed nodes. You can filter based on tags
applied to EC2 instances. Use this Filters
data type instead of
InstanceInformationFilterList
, which is deprecated.
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.)
SdkInternalList<T> instanceInformationList
The managed node 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 managed node whose patch state information should be retrieved.
SdkInternalList<T> filters
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribeInstancePatches
include the following:
Classification
Sample values: Security
| SecurityUpdates
KBId
Sample values: KB4480056
| java-1.7.0-openjdk.x86_64
Severity
Sample values: Important
| Medium
| Low
State
Sample values: Installed
| InstalledOther
| InstalledPendingReboot
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).
SdkInternalList<T> patches
Each entry in the array is a structure containing:
Title (string)
KBId (string)
Classification (string)
Severity (string)
State (string, such as "INSTALLED" or "FAILED")
InstalledTime (DateTime)
InstalledBy (string)
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.
SdkInternalList<T> filters
Each entry in the array is a structure containing:
Key (string between 1 and 200 characters)
Values (array containing a single string)
Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
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).
SdkInternalList<T> instancePatchStates
The high-level patch state for the requested managed nodes.
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.
SdkInternalList<T> instanceIds
The ID of the managed node for which 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 managed nodes to return (per page).
SdkInternalList<T> instancePatchStates
The high-level patch state for the requested managed nodes.
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 deletionId
Specify the delete inventory ID for which you want information. This ID was returned by the
DeleteInventory
operation.
String nextToken
A token to start the list. Use this token to get the next set 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.
SdkInternalList<T> inventoryDeletions
A list of status items for deleted inventory.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
String windowId
The ID of the maintenance window whose executions should be retrieved.
SdkInternalList<T> filters
Each entry in the array is a structure containing:
Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore
and
ExecutedAfter
.
Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid
ISO 8601 date/time format, such as 2021-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.)
SdkInternalList<T> windowExecutions
Information about the maintenance window 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.
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.
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.)
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.
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.)
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.
String windowId
The ID of the maintenance window to retrieve information about.
SdkInternalList<T> targets
The managed node ID or key-value pair to retrieve information about.
String resourceType
The type of resource you want to retrieve information about. For example, INSTANCE
.
SdkInternalList<T> filters
Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.
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.)
SdkInternalList<T> scheduledWindowExecutions
Information about maintenance window executions scheduled for the specified time range.
String nextToken
The token for the next set of items to return. (You use this token in the next call.)
SdkInternalList<T> targets
The managed node ID or key-value pair to retrieve information about.
String resourceType
The type of resource you want to retrieve information about. For example, INSTANCE
.
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.)
SdkInternalList<T> windowIdentities
Information about the maintenance window targets and tasks a managed node is associated with.
String nextToken
The token for the next set of items to return. (You use this token in the next call.)
SdkInternalList<T> filters
Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are
Name
and Enabled
. For example, Name=MyMaintenanceWindow
and
Enabled=True
.
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.)
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.
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.)
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.
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.)
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.
SdkInternalList<T> opsItemFilters
One or more filters to limit the response.
Key: CreatedTime
Operations: GreaterThan, LessThan
Key: LastModifiedBy
Operations: Contains, Equals
Key: LastModifiedTime
Operations: GreaterThan, LessThan
Key: Priority
Operations: Equals
Key: Source
Operations: Contains, Equals
Key: Status
Operations: Equals
Key: Title*
Operations: Equals,Contains
Key: OperationalData**
Operations: Equals
Key: OperationalDataKey
Operations: Equals
Key: OperationalDataValue
Operations: Equals, Contains
Key: OpsItemId
Operations: Equals
Key: ResourceId
Operations: Contains
Key: AutomationId
Operations: Equals
*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.
**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}
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.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
SdkInternalList<T> opsItemSummaries
A list of OpsItems.
SdkInternalList<T> filters
This data type is deprecated. Instead, use ParameterFilters
.
SdkInternalList<T> parameterFilters
Filters to limit the request 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.)
SdkInternalList<T> parameters
Parameters returned by the request.
String nextToken
The token to use when requesting the next set of items.
SdkInternalList<T> filters
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribePatchBaselines
include the following:
NAME_PREFIX
Sample values: AWS-
| My-
OWNER
Sample values: AWS
| Self
OPERATING_SYSTEM
Sample values: AMAZON_LINUX
| SUSE
| WINDOWS
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.)
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.
Integer maxResults
The maximum number of patch groups to return (per page).
SdkInternalList<T> filters
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribePatchGroups
include the following:
NAME_PREFIX
Sample values: AWS-
| My-
.
OPERATING_SYSTEM
Sample values: AMAZON_LINUX
| SUSE
| WINDOWS
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
SdkInternalList<T> mappings
Each entry in the array contains:
PatchGroup
: string (between 1 and 256 characters. 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 managed nodes in the patch group.
Integer instancesWithInstalledPatches
The number of managed nodes with installed patches.
Integer instancesWithInstalledOtherPatches
The number of managed nodes with patches installed that aren't defined in the patch baseline.
Integer instancesWithInstalledPendingRebootPatches
The number of managed nodes with patches installed by Patch Manager that haven't been rebooted after the patch
installation. The status of these managed nodes is NON_COMPLIANT
.
Integer instancesWithInstalledRejectedPatches
The number of managed nodes with patches installed that are specified in a RejectedPatches
list.
Patches with a status of INSTALLED_REJECTED
were typically installed before they were added to a
RejectedPatches
list.
If ALLOW_AS_DEPENDENCY
is the specified option for RejectedPatchesAction
, the value of
InstancesWithInstalledRejectedPatches
will always be 0
(zero).
Integer instancesWithMissingPatches
The number of managed nodes with missing patches from the patch baseline.
Integer instancesWithFailedPatches
The number of managed nodes with patches from the patch baseline that failed to install.
Integer instancesWithNotApplicablePatches
The number of managed nodes with patches that aren't applicable.
Integer instancesWithUnreportedNotApplicablePatches
The number of managed nodes with NotApplicable
patches beyond the supported limit, which aren't
reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.
Integer instancesWithCriticalNonCompliantPatches
The number of managed nodes where patches that are specified as Critical
for compliance reporting in
the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or
were installed but awaiting a required managed node reboot. The status of these managed nodes is
NON_COMPLIANT
.
Integer instancesWithSecurityNonCompliantPatches
The number of managed nodes where patches that are specified as Security
in a patch advisory aren't
installed. These patches might be missing, have failed installation, were rejected, or were installed but
awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT
.
Integer instancesWithOtherNonCompliantPatches
The number of managed nodes with patches installed that are specified as other than Critical
or
Security
but aren't compliant with the patch baseline. The status of these managed nodes is
NON_COMPLIANT
.
String operatingSystem
The operating system type for which to list patches.
String property
The patch property for which you want to view patch details.
String patchSet
Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.
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.)
SdkInternalList<T> properties
A list of the properties for patches matching the filter request parameters.
String nextToken
The token for the next set of items to return. (You use this token in the next call.)
String state
The session status to retrieve a list of sessions for. For example, "Active".
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.)
SdkInternalList<T> filters
One or more filters to limit the type of sessions returned by the request.
SdkInternalList<T> sessions
A list of sessions meeting the request parameters.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
String sha1
The SHA1 hash of the document, which you can use for verification.
String hash
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
String hashType
The hash type of the document. Valid values include Sha256
or Sha1
.
Sha1 hashes have been deprecated.
String name
The name of the SSM document.
String displayName
The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
String versionName
The version of the artifact associated with the document.
String owner
The Amazon Web Services user account that created the document.
Date createdDate
The date when the document was created.
String status
The status of the SSM document.
String statusInformation
A message returned by Amazon Web Services Systems Manager that explains the Status
value. For
example, a Failed
status might be explained by the StatusInformation
message,
"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
String documentVersion
The document version.
String description
A description of the document.
SdkInternalList<T> parameters
A description of the parameters for a document.
SdkInternalList<T> platformTypes
The list of operating system (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 documentFormat
The document format, either JSON or YAML.
String targetType
The target type which defines the kinds of resources the document can run on. For example,
/AWS::EC2::Instance
. For a list of valid resource types, see Amazon
Web Services resource and property types reference in the CloudFormation User Guide.
SdkInternalList<T> tags
The tags, or metadata, that have been applied to the document.
SdkInternalList<T> attachmentsInformation
Details about the document attachments, including names, locations, sizes, and so on.
SdkInternalList<T> requires
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
requires an ApplicationConfigurationSchema
document.
String author
The user in your organization who created the document.
SdkInternalList<T> reviewInformation
Details about the review of a document.
String approvedVersion
The version of the document currently approved for use in the organization.
String pendingReviewVersion
The version of the document that is currently under review.
String reviewStatus
The current status of the review.
SdkInternalList<T> category
The classification of a document to help you identify and categorize its use.
SdkInternalList<T> categoryEnum
The value that identifies a document's category.
String name
The name of the SSM document.
Date createdDate
The date the SSM document was created.
String displayName
An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
String owner
The Amazon Web Services user account that created the document.
String versionName
An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
SdkInternalList<T> platformTypes
The operating system platform.
String documentVersion
The document version.
String documentType
The document type.
String schemaVersion
The schema version.
String documentFormat
The document format, either JSON or YAML.
String targetType
The target type which defines the kinds of resources the document can run on. For example,
/AWS::EC2::Instance
. For a list of valid resource types, see Amazon
Web Services resource and property types reference in the CloudFormation User Guide.
SdkInternalList<T> tags
The tags, or metadata, that have been applied to the document.
SdkInternalList<T> requires
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
requires an ApplicationConfigurationSchema
document.
String reviewStatus
The current status of a document review.
String author
The user in your organization who created the document.
String key
The name of the filter key.
SdkInternalList<T> values
The value for the filter key.
SdkInternalList<T> reviewerResponse
Details about a reviewer's response to a document review request.
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.
Date createTime
The date and time that a reviewer entered a response to a document review request.
Date updatedTime
The date and time that a reviewer last updated a response to a document review request.
String 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.
SdkInternalList<T> comment
The comment entered by a reviewer as part of their document review response.
String reviewer
The user in your organization assigned to review a document request.
String action
The action to take on a document approval review request.
SdkInternalList<T> comment
A comment entered by a user in your organization about the document review request.
String name
The document name.
String displayName
The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
String documentVersion
The document version.
String versionName
The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
Date createdDate
The date the document was created.
Boolean isDefaultVersion
An identifier for the default version of the document.
String documentFormat
The document format, either JSON or YAML.
String status
The status of the SSM document, such as Creating
, Active
, Failed
, and
Deleting
.
String statusInformation
A message returned by Amazon Web Services Systems Manager that explains the Status
value. For
example, a Failed
status might be explained by the StatusInformation
message,
"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
String reviewStatus
The current status of the approval review for the latest version of the document.
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 failureStage
The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.
String failureType
The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.
Map<K,V> details
Detailed information about the Automation step 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 runbook is initiated.
AutomationExecution automationExecution
Detailed information about the current state of an automation execution.
SdkInternalList<T> calendarNames
The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.
String atTime
(Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you don't specify a value or
AtTime
, the current time is used.
String state
The state of the calendar. An OPEN
calendar indicates that actions are allowed to proceed, and a
CLOSED
calendar indicates that actions aren't allowed to proceed.
String atTime
The time, as an ISO 8601 string, that you specified in your
command. If you don't specify a time, GetCalendarState
uses the current time.
String nextTransitionTime
The time, as an ISO 8601 string, that the calendar state
will change. If the current calendar state is OPEN
, NextTransitionTime
indicates when
the calendar state changes to CLOSED
, and vice-versa.
String commandId
(Required) The parent command ID of the invocation plugin.
String instanceId
(Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
String pluginName
The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.
Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example,
aws:RunShellScript
is a plugin.
To find the PluginName
, check the document content and find the name of the plugin. Alternatively,
use ListCommandInvocations with the CommandId
and Details
parameters. The
PluginName
is the Name
attribute of the CommandPlugin
object in the
CommandPlugins
list.
String commandId
The parent command ID of the invocation plugin.
String instanceId
The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
String comment
The comment text for the command.
String documentName
The name of the document that was run. For example, AWS-RunShellScript
.
String documentVersion
The Systems Manager document (SSM document) version used in the request.
String pluginName
The name of the plugin, or step name, for which details are reported. 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
hasn't started running on the managed node, or it wasn't received by the node.
String executionStartDateTime
The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7,
2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the
InvokedBefore
filter.
aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z
If the plugin hasn't started to run, the string is empty.
String executionElapsedTime
Duration since ExecutionStartDateTime
.
String executionEndDateTime
The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7,
2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the
InvokedAfter
filter.
aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z
If the plugin hasn't started to run, the string is empty.
String status
The status of this invocation plugin. 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 Understanding command
statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails
can be one
of the following values:
Pending: The command hasn't been sent to the managed node.
In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.
Success: The command or plugin ran successfully. This is a terminal state.
Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired.
Delivery timeouts don't count against the parent command's MaxErrors
limit, but they do contribute
to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: The command started to run on the managed node, but the execution wasn't complete before the
timeout expired. Execution timeouts count against the MaxErrors
limit of the parent command. This is
a terminal state.
Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates that the result
code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't
zero. Invocation failures count against the MaxErrors
limit of the parent command. This is a
terminal state.
Cancelled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the managed node. The node might not exist or might not be
responding. Undeliverable invocations don't count against the parent command's MaxErrors
limit and
don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors
limit and subsequent command invocations were
canceled by the system. This is a terminal state.
String standardOutputContent
The first 24,000 characters written by the plugin to stdout
. If the command hasn't finished running,
if ExecutionStatus
is neither Succeeded nor Failed, then this string is empty.
String standardOutputUrl
The URL for the complete text written by the plugin to stdout
in Amazon Simple Storage Service
(Amazon S3). If an S3 bucket wasn't specified, then this string is empty.
String standardErrorContent
The first 8,000 characters written by the plugin to stderr
. If the command hasn't finished running,
then this string is empty.
String standardErrorUrl
The URL for the complete text written by the plugin to stderr
. If the command hasn't finished
running, then this string is empty.
CloudWatchOutputConfig cloudWatchOutputConfig
Amazon CloudWatch Logs information where Systems Manager sent the command output.
String target
The managed node ID.
String operatingSystem
Returns the default patch baseline for the specified operating system.
String instanceId
The ID of the managed node for which the appropriate patch snapshot should be retrieved.
String snapshotId
The snapshot ID provided by the user when running AWS-RunPatchBaseline
.
BaselineOverride baselineOverride
Defines the basic information about a patch baseline override.
String instanceId
The managed node ID.
String snapshotId
The user-defined snapshot ID.
String snapshotDownloadUrl
A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.
String product
Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the managed node for the specified patch snapshot.
String name
The name of the SSM document.
String versionName
An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.
String documentVersion
The document version for which you want information.
String documentFormat
Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.
String name
The name of the SSM document.
Date createdDate
The date the SSM document was created.
String displayName
The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
String versionName
The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
String documentVersion
The document version.
String status
The status of the SSM document, such as Creating
, Active
, Updating
,
Failed
, and Deleting
.
String statusInformation
A message returned by Amazon Web Services Systems Manager that explains the Status
value. For
example, a Failed
status might be explained by the StatusInformation
message,
"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
String content
The contents of the SSM document.
String documentType
The document type.
String documentFormat
The document format, either JSON or YAML.
SdkInternalList<T> requires
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
requires an ApplicationConfigurationSchema
document.
SdkInternalList<T> attachmentsContent
A description of the document attachments, including names, locations, sizes, and so on.
String reviewStatus
The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.
Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.
Only one version of an SSM document can be in review, or PENDING, at a time.
SdkInternalList<T> filters
One or more filters. Use a filter to return a more specific list of results.
SdkInternalList<T> aggregators
Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an
expression that uses the AWS:InstanceInformation.PlatformType
type, you can see a count of how many
Windows and Linux managed nodes exist in your inventoried fleet.
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.
SdkInternalList<T> entities
Collection of inventory entities such as a collection of managed node 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.
Boolean aggregator
Returns inventory schemas that support aggregation. For example, this call returns the
AWS:InstanceInformation
type, because it supports aggregation based on the PlatformName
, PlatformType
, and PlatformVersion
attributes.
Boolean subType
Returns the sub-type schema for a specified inventory type.
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.
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. Not available for all status values.
Date startTime
The time the maintenance window started running.
Date endTime
The time the maintenance window finished running.
String windowExecutionId
The maintenance window execution ID.
String taskExecutionId
The task execution ID.
String invocationId
The invocation ID.
String executionId
The execution ID.
String taskType
Retrieves the task type for a maintenance window.
String parameters
The parameters used at the time that the task ran.
String status
The task status for an invocation.
String statusDetails
The details explaining the status. Details are only available for certain status values.
Date startTime
The time that the task started running on the target.
Date endTime
The time that the task finished running on the target.
String ownerInformation
User-provided value to be included in any Amazon CloudWatch Events or Amazon EventBridge events raised while running tasks for these targets in this maintenance window.
String windowTargetId
The maintenance window target ID.
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 Amazon Resource Name (ARN) of the task that ran.
String serviceRole
The role that was assumed when running the task.
String type
The type of task that was run.
SdkInternalList<T> taskParameters
The parameters passed to the task when it was run.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead
use the Parameters
option in the TaskInvocationParameters
structure. For information
about how Systems Manager handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
The map has the following format:
Key
: string, between 1 and 255 characters
Value
: an array of strings, each between 1 and 255 characters
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. Not available for all status values.
Date startTime
The time the task execution started.
Date endTime
The time the task execution completed.
String windowId
The ID of the maintenance window for which you want to retrieve information.
String windowId
The ID of the created maintenance window.
String name
The name of the maintenance window.
String description
The description of the maintenance window.
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 specified time.
String 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 specified time.
String schedule
The schedule of the maintenance window in the form of a cron or rate expression.
String 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.
Integer scheduleOffset
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
String nextExecutionTime
The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
Integer duration
The duration of the maintenance window in hours.
Integer cutoff
The number of hours before the end of the maintenance window that Amazon Web Services 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
Indicates whether the maintenance window is enabled.
Date createdDate
The date the maintenance window was created.
Date modifiedDate
The date the maintenance window was last modified.
String windowId
The retrieved maintenance window ID.
String windowTaskId
The retrieved maintenance window task ID.
SdkInternalList<T> targets
The targets where the task should run.
String taskArn
The resource that the task used during execution. For RUN_COMMAND
and AUTOMATION
task
types, the value of TaskArn
is the SSM document name/ARN. For LAMBDA
tasks, the value
is the function name/ARN. For STEP_FUNCTIONS
tasks, the value is the state machine ARN.
String serviceRoleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
String taskType
The type of task to run.
Map<K,V> taskParameters
The parameters to pass to the task when it runs.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead
use the Parameters
option in the TaskInvocationParameters
structure. For information
about how Systems Manager handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
MaintenanceWindowTaskInvocationParameters taskInvocationParameters
The parameters to pass to the task when it runs.
Integer priority
The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
String maxConcurrency
The maximum number of targets allowed to run this task in parallel.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the
system inserts a placeholder value of 1
, which may be reported in the response to this command. This
value doesn't affect the running of your task and can be ignored.
String maxErrors
The maximum number of errors allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the
system inserts a placeholder value of 1
, which may be reported in the response to this command. This
value doesn't affect the running of your task and can be ignored.
LoggingInfo loggingInfo
The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
contain logs, instead use the OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager
handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
String name
The retrieved task name.
String description
The retrieved task description.
String cutoffBehavior
The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK
means
that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK
means that
currently running task invocations continue, but no new task invocations are started. For Run Command tasks,
CANCEL_TASK
means the system attempts to stop the task by sending a CancelCommand
operation.
String opsItemId
The ID of the OpsItem that you want to get.
OpsItem opsItem
The OpsItem.
String opsMetadataArn
The Amazon Resource Name (ARN) of an OpsMetadata Object to view.
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.
String syncName
Specify the name of a resource data sync to get.
SdkInternalList<T> filters
Optional filters used to scope down the returned OpsData.
SdkInternalList<T> aggregators
Optional aggregators that return counts of OpsData based on one or more expressions.
SdkInternalList<T> resultAttributes
The OpsData data type to return.
String nextToken
A token to start the list. Use this token to get the next set 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.
SdkInternalList<T> entities
The list of aggregated details and filtered OpsData.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
String name
The name of the parameter for which you want to review history.
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.)
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.
String name
The name of the parameter you want to query.
To query by parameter label, use "Name": "name:label"
. To query by parameter version, use
"Name": "name:version"
.
Boolean withDecryption
Return decrypted values for secure string parameters. This flag is ignored for String
and
StringList
parameter types.
Parameter parameter
Information about a parameter.
String path
The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name
except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be
in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy:
/Finance/Prod/IAD/WinServ2016/license33
Boolean recursive
Retrieve all parameters within a hierarchy.
If a user has access to a path, then the user can access all levels of that path. For example, if a user has
permission to access path /a
, then the user can also access /a/b
. Even if a user has
explicitly been denied access in IAM for parameter /a/b
, they can still call the GetParametersByPath
API operation recursively for /a
and view /a/b
.
SdkInternalList<T> parameterFilters
Filters to limit the request results.
The following Key
values are supported for GetParametersByPath
: Type
,
KeyId
, and Label
.
The following Key
values aren't supported for GetParametersByPath
: tag
,
DataType
, Name
, Path
, and Tier
.
Boolean withDecryption
Retrieve all parameters in a hierarchy with their value decrypted.
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.
SdkInternalList<T> parameters
A list of parameters found in the specified hierarchy.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
SdkInternalList<T> names
Names of the parameters for which you want to query information.
To query by parameter label, use "Name": "name:label"
. To query by parameter version, use
"Name": "name:version"
.
Boolean withDecryption
Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored
for String
and StringList
parameter types.
SdkInternalList<T> parameters
A list of details for a parameter.
SdkInternalList<T> invalidParameters
A list of parameters that aren't formatted correctly or don't run during an execution.
String baselineId
The ID of the patch baseline to retrieve.
To retrieve information about an Amazon Web Services managed patch baseline, specify the full Amazon Resource
Name (ARN) of the baseline. For example, for the baseline AWS-AmazonLinuxDefaultPatchBaseline
,
specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7
instead of
pb-0e392de35e7c563b7
.
String baselineId
The ID of the retrieved patch baseline.
String name
The name of the patch baseline.
String operatingSystem
Returns the operating system specified for 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.
SdkInternalList<T> approvedPatches
A list of explicitly approved patches for the baseline.
String approvedPatchesComplianceLevel
Returns the specified compliance severity level for approved patches in the patch baseline.
Boolean 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.
SdkInternalList<T> rejectedPatches
A list of explicitly rejected patches for the baseline.
String rejectedPatchesAction
The action specified to take on patches included in the RejectedPatches
list. A patch can be allowed
only if it is a dependency of another package, or blocked entirely along with packages that include it as a
dependency.
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.
SdkInternalList<T> 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.
String settingId
The ID of the service setting to get. The setting ID can be one of the following.
/ssm/automation/customer-script-log-destination
/ssm/automation/customer-script-log-group-name
/ssm/documents/console/public-sharing-permission
/ssm/parameter-store/default-parameter-tier
/ssm/parameter-store/high-throughput-enabled
/ssm/managed-instance/activation-tier
ServiceSetting serviceSetting
The query result of the current service setting.
S3OutputLocation s3Location
An S3 bucket where you want to store the results of this request.
S3OutputUrl s3OutputUrl
The URL of 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 versions.
String associationVersion
The version of the association applied to the managed node.
String instanceId
The managed node ID where the association was created.
Date executionDate
The date the association ran.
String status
Status information about the association.
String detailedStatus
Detailed status information about the 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 S3 bucket where you want to store the results of this request.
String associationName
The name of the association applied to the managed node.
String instanceId
The managed node ID.
String pingStatus
Connection status of SSM Agent.
The status Inactive
has been deprecated and is no longer in use.
Date lastPingDateTime
The date and time when the agent last pinged the Systems Manager service.
String agentVersion
The version of SSM Agent running on your Linux managed node.
Boolean isLatestVersion
Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.
String platformType
The operating system platform type.
String platformName
The name of the operating system platform running on your managed node.
String platformVersion
The version of the OS platform running on your managed node.
String activationId
The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.
String iamRole
The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call
doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for
an EC2 instance, use the Amazon EC2 DescribeInstances
operation. For information, see DescribeInstances in
the Amazon EC2 API Reference or describe-instances in the Amazon
Web Services CLI Command Reference.
Date registrationDate
The date the server or VM was registered with Amazon Web Services as a managed node.
String resourceType
The type of instance. Instances are either EC2 instances or managed instances.
String 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 specified 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 Install SSM
Agent for a hybrid environment (Linux) and Install SSM
Agent for a hybrid environment (Windows). 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 Amazon
Web Services CLI Command Reference.
String iPAddress
The IP address of the managed node.
String computerName
The fully qualified host name of the managed node.
String associationStatus
The status of the association.
Date lastAssociationExecutionDate
The date the association was last run.
Date lastSuccessfulAssociationExecutionDate
The last date the association was successfully run.
InstanceAggregatedAssociationOverview associationOverview
Information about the association.
String sourceId
The ID of the source resource. For IoT Greengrass devices, SourceId
is the Thing name.
String sourceType
The type of the source resource. For IoT Greengrass devices, SourceType
is
AWS::IoT::Thing
.
String key
The name of the filter.
SdkInternalList<T> valueSet
The filter values.
String key
The filter key name to describe your managed nodes. For example:
"InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"| "AssociationStatus"|"Tag Key"
Tag key
isn't a valid filter. You must specify either tag-key
or
tag:keyname
and a string. Here are some valid examples: tag-key, tag:123, tag:al!, tag:Windows. Here
are some invalid examples: tag-keys, Tag Key, tag:, tagKey, abc:keyname.
SdkInternalList<T> values
The filter values.
String instanceId
The ID of the managed node the high-level patch compliance information was collected for.
String patchGroup
The name of the patch group the managed node belongs to.
String baselineId
The ID of the patch baseline used to patch the managed node.
String snapshotId
The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
String installOverrideList
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 specified by the default patch baseline.
For more information about the InstallOverrideList
parameter, see About the AWS-RunPatchBaseline
SSM document in the Amazon Web Services Systems Manager User
Guide.
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 managed node.
Integer installedOtherCount
The number of patches not specified in the patch baseline that are installed on the managed node.
Integer installedPendingRebootCount
The number of patches installed by Patch Manager since the last time the managed node was rebooted.
Integer installedRejectedCount
The number of patches installed on a managed node that are specified in a RejectedPatches
list.
Patches with a status of InstalledRejected
were typically installed before they were added to a
RejectedPatches
list.
If ALLOW_AS_DEPENDENCY
is the specified option for RejectedPatchesAction
, the value of
InstalledRejectedCount
will always be 0
(zero).
Integer missingCount
The number of patches from the patch baseline that are applicable for the managed node 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 unreportedNotApplicableCount
The number of patches beyond the supported limit of NotApplicableCount
that aren't reported by name
to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.
Integer 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 of patch names is very large. The number of
patches beyond this limit are reported in UnreportedNotApplicableCount
.
Date operationStartTime
The time the most recent patching operation was started on the managed node.
Date operationEndTime
The time the most recent patching operation completed on the managed node.
String operation
The type of patching operation that was performed: or
SCAN
assesses the patch compliance state.
INSTALL
installs missing patches.
Date lastNoRebootInstallOperationTime
The time of the last attempt to patch the managed node with NoReboot
specified as the reboot option.
String rebootOption
Indicates the reboot option specified in the patch baseline.
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 effect until a reboot is performed.
Integer criticalNonCompliantCount
The number of managed nodes where patches that are specified as Critical
for compliance reporting in
the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or
were installed but awaiting a required managed node reboot. The status of these managed nodes is
NON_COMPLIANT
.
Integer securityNonCompliantCount
The number of managed nodes where patches that are specified as Security
in a patch advisory aren't
installed. These patches might be missing, have failed installation, were rejected, or were installed but
awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT
.
Integer otherNonCompliantCount
The number of managed nodes with patches installed that are specified as other than Critical
or
Security
but aren't compliant with the patch baseline. The status of these managed nodes is
NON_COMPLIANT
.
String key
The key for the filter. Supported values include the following:
InstalledCount
InstalledOtherCount
InstalledPendingRebootCount
InstalledRejectedCount
MissingCount
FailedCount
UnreportedNotApplicableCount
NotApplicableCount
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.
String typeName
String expression
The inventory type and attribute name for aggregation.
SdkInternalList<T> aggregators
Nested aggregators to further refine aggregation for an inventory type.
SdkInternalList<T> groups
A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.
String deletionId
The deletion ID returned by the DeleteInventory
operation.
String typeName
The name of the inventory data type.
Date deletionStartTime
The UTC timestamp when the delete operation started.
String lastStatus
The status of the operation. Possible values are InProgress and Complete.
String lastStatusMessage
Information about the status.
InventoryDeletionSummary deletionSummary
Information about the delete operation. For more information about this summary, see Understanding the delete inventory summary in the Amazon Web Services Systems Manager User Guide.
Date lastStatusUpdateTime
The UTC timestamp of when the last status report.
Integer totalCount
The total number of items to delete. This count doesn't change during the delete operation.
Integer remainingCount
Remaining number of items to delete.
SdkInternalList<T> summaryItems
A list of counts and versions for deleted items.
String key
The name of the filter key.
SdkInternalList<T> values
Inventory filter values. Example: inventory filter where managed node IDs are specified as values
Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal
.
String type
The type of filter.
The Exists
filter must be used with aggregators. For more information, see Aggregating
inventory data in the Amazon Web Services Systems Manager User Guide.
String name
The name of the group.
SdkInternalList<T> filters
Filters define the criteria for the group. The matchingCount
field displays the number of resources
that match the criteria. The notMatchingCount
field displays the number of resources that don't
match the criteria.
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 doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update.
SdkInternalList<T> content
The inventory data of the inventory type.
Map<K,V> context
A map of associated properties for a specified inventory type. For example, with this attribute, you can specify
the ExecutionId
, ExecutionType
, ComplianceType
properties of the
AWS:ComplianceItem
type.
String typeName
The name of the inventory type. Default inventory item type names start with Amazon Web Services. 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.
SdkInternalList<T> attributes
The schema attributes for inventory. This contains data type and attribute name.
String displayName
The alias name of the inventory type. The alias name is used for display purposes.
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 doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update.
SdkInternalList<T> content
Contains all the inventory data of the item type. Results include attribute names and values.
String typeName
String typeName
String name
The parameter name on which you want to attach one or more labels.
Long parameterVersion
The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.
SdkInternalList<T> labels
One or more labels to attach to the specified parameter version.
SdkInternalList<T> invalidLabels
The label doesn't meet the requirements. For information about parameter label requirements, see Labeling parameters in the Amazon Web Services Systems Manager User Guide.
Long parameterVersion
The version of the parameter that has been labeled.
SdkInternalList<T> associationFilterList
One or more filters. Use a filter to return a more specific list of results.
Filtering associations using the InstanceID
attribute only returns legacy associations created using
the InstanceID
attribute. Associations targeting the managed node that are part of the Target
Attributes ResourceGroup
or Tags
aren't returned.
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.)
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 associationId
The association ID for which you want to view all versions.
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.
SdkInternalList<T> associationVersions
Information about all versions of the association for the specified association ID.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
String commandId
(Optional) The invocations for a specific command ID.
String instanceId
(Optional) The command execution details for a specific managed node 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.)
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. The default value
is false
.
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 managed node ID.
You can't specify a managed node ID in the same command that you specify Status
=
Pending
. This is because the command hasn't reached the managed node yet.
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.)
SdkInternalList<T> filters
(Optional) One or more filters. Use a filter to return a more specific list of results.
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.)
SdkInternalList<T> filters
One or more compliance filters. Use a filter to return a more specific list of results.
SdkInternalList<T> resourceIds
The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.
SdkInternalList<T> resourceTypes
The type of resource from which to get compliance information. Currently, the only supported resource type is
ManagedInstance
.
String nextToken
A token to start the list. Use this token to get the next set 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.
SdkInternalList<T> complianceItems
A list of compliance information for the specified resource ID.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
SdkInternalList<T> filters
One or more compliance or inventory filters. Use a filter to return a more specific list of results.
String nextToken
A token to start the list. Use this token to get the next set of results.
Integer maxResults
The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.
SdkInternalList<T> complianceSummaryItems
A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
String name
The name of the change template.
String documentVersion
The version of the change template.
String metadata
The type of data for which details are being requested. Currently, the only supported value is
DocumentReviews
.
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 name
The name of the change template.
String documentVersion
The version of the change template.
String author
The user ID of the person in the organization who requested the review of the change template.
DocumentMetadataResponseInfo metadata
Information about the response to the change template approval request.
String nextToken
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.
SdkInternalList<T> documentFilterList
This data type is deprecated. Instead, use Filters
.
SdkInternalList<T> filters
One or more DocumentKeyValuesFilter
objects. Use a filter to return a more specific list of results.
For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys
include Owner
, Name
, PlatformTypes
, DocumentType
, and
TargetType
. For example, to return documents you own use Key=Owner,Values=Self
. To
specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName
.
This API operation only supports filtering documents by using a single tag key and one or more tag values. For
example: Key=tag:tagName,Values=valueName1,valueName2
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.)
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. You can specify an Amazon Resource Name (ARN).
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.)
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 managed node ID for which you want inventory information.
String typeName
The type of inventory item for which you want information.
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 managed node ID targeted by the request to query inventory information.
String schemaVersion
The inventory schema version used by the managed node(s).
String captureTime
The time that inventory information was collected for the managed node(s).
SdkInternalList<T> entries
A list of inventory items on the managed node(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.
SdkInternalList<T> filters
One or more OpsItem 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
A token to start the list. Use this token to get the next set of results.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
SdkInternalList<T> summaries
A list of event information for the specified OpsItems.
String opsItemId
The ID of the OpsItem for which you want to list all related-item resources.
SdkInternalList<T> filters
One or more OpsItem 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.)
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
SdkInternalList<T> summaries
A list of related-item resources for the specified OpsItem.
SdkInternalList<T> filters
One or more filters to limit the number of OpsMetadata objects returned by the 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 nextToken
A token to start the list. Use this token to get the next set of results.
SdkInternalList<T> opsMetadataList
Returns a list of OpsMetadata objects.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
SdkInternalList<T> filters
One or more filters. Use a filter to return a more specific list of results.
String nextToken
A token to start the list. Use this token to get the next set 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.
SdkInternalList<T> resourceComplianceSummaryItems
A summary count for specified or targeted managed nodes. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
String syncType
View a list of resource data syncs according to the sync type. Specify SyncToDestination
to view
resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource
to view
resource data syncs from Organizations or from multiple Amazon Web Services Regions.
String nextToken
A token to start the list. Use this token to get the next set 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.
SdkInternalList<T> resourceDataSyncItems
A list of your current resource data sync configurations and their statuses.
String nextToken
The token for the next set of items to return. Use this token to get the next set of results.
SdkInternalList<T> tagList
A list of tags.
String documentVersion
The version of an Automation runbook to use during task execution.
Map<K,V> parameters
The parameters for the AUTOMATION
task.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
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 Amazon Web Services 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, Amazon Web Services Systems Manager ignores any values specified for
these parameters.
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. Not available for all 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. Not available for all status values.
Date startTime
The time the task execution started.
Date endTime
The time the task execution finished.
String taskArn
The Amazon Resource Name (ARN) of the task that ran.
String taskType
The type of task that ran.
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 taskType
The task type.
String parameters
The parameters that were provided for the invocation when it was run.
String status
The status of the task invocation.
String statusDetails
The details explaining the status of the task invocation. Not available for all 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 Amazon CloudWatch Events 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.
SdkInternalList<T> values
The filter values.
String windowId
The ID of the maintenance window.
String name
The name of the maintenance window.
String description
A description of the maintenance window.
Boolean enabled
Indicates 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 Amazon Web Services Systems Manager stops scheduling new tasks for execution.
String schedule
The schedule of the maintenance window in the form of a cron or rate expression.
String scheduleTimezone
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
Integer scheduleOffset
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
String endDate
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
String startDate
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
String nextExecutionTime
The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
String clientContext
Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.
String qualifier
(Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation uses the qualified function Amazon Resource Name (ARN) to invoke a specific 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.
ByteBuffer payload
JSON to provide to your Lambda function as input.
String comment
Information about the commands to run.
CloudWatchOutputConfig cloudWatchOutputConfig
String documentHash
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
String documentHashType
SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
String documentVersion
The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify
$DEFAULT
, $LATEST
, or a specific version number. If you run commands by using the
Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a
version number, then you don't need to use the backslash. For example:
--document-version "\$DEFAULT"
--document-version "\$LATEST"
--document-version "3"
NotificationConfig notificationConfig
Configurations for sending notifications about command status changes on a per-managed node basis.
String outputS3BucketName
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
String outputS3KeyPrefix
The S3 bucket subfolder.
Map<K,V> parameters
The parameters for the RUN_COMMAND
task execution.
String serviceRoleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
Integer timeoutSeconds
If this time is reached and the command hasn't already started running, it doesn't run.
String windowId
The ID of the maintenance window to register the target with.
String windowTargetId
The ID of the target.
String resourceType
The type of target that is being registered with the maintenance window.
SdkInternalList<T> targets
The targets, either managed nodes or tags.
Specify managed nodes using the following format:
Key=instanceids,Values=<instanceid1>,<instanceid2>
Tags are specified using the following format:
Key=<tag name>,Values=<tag value>
.
String 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.
String name
The name for the maintenance window target.
String description
A description for the target.
String windowId
The ID of the maintenance window where the task is registered.
String windowTaskId
The task ID.
String taskArn
The resource that the task uses during execution. For RUN_COMMAND
and AUTOMATION
task
types, TaskArn
is the Amazon Web Services 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.
String type
The type of task.
SdkInternalList<T> targets
The targets (either managed nodes or tags). Managed nodes 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 run.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead
use the Parameters
option in the TaskInvocationParameters
structure. For information
about how Systems Manager handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
Integer 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.
LoggingInfo loggingInfo
Information about an S3 bucket to write task-level logs to.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
contain logs, instead use the OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager
handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
String serviceRoleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
String maxConcurrency
The maximum number of targets this task can be run for, in parallel.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the
system inserts a placeholder value of 1
. This value doesn't affect the running of your task.
String maxErrors
The maximum number of errors allowed before this task stops being scheduled.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the
system inserts a placeholder value of 1
. This value doesn't affect the running of your task.
String name
The task name.
String description
A description of the task.
String cutoffBehavior
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
MaintenanceWindowRunCommandParameters runCommand
The parameters for a RUN_COMMAND
task type.
MaintenanceWindowAutomationParameters automation
The parameters for an AUTOMATION
task type.
MaintenanceWindowStepFunctionsParameters stepFunctions
The parameters for a STEP_FUNCTIONS
task type.
MaintenanceWindowLambdaParameters lambda
The parameters for a LAMBDA
task type.
SdkInternalList<T> values
This field contains an array of 0 or more strings, each 1 to 255 characters in length.
String value
Metadata value to assign to an Application Manager application.
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.
SdkInternalList<T> accountIdsToAdd
The Amazon Web Services user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
SdkInternalList<T> accountIdsToRemove
The Amazon Web Services user accounts that should no longer have access to the document. The Amazon Web Services 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 sharedDocumentVersion
(Optional) The version of the document to share. If it isn't specified, the system choose the
Default
version to share.
Integer nonCompliantCount
The total number of compliance items that aren't compliant.
SeveritySummary severitySummary
A summary of the non-compliance severity by compliance type
String notificationArn
An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
SdkInternalList<T> notificationEvents
The different events for which you can receive notifications. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
String notificationType
The type of notification.
Command
: Receive notification when the status of a command changes.
Invocation
: For commands sent to multiple managed nodes, receive notification on a per-node basis
when the status of a command changes.
String aggregatorType
Either a Range
or Count
aggregator for limiting an OpsData summary.
String typeName
The data type name to use for viewing counts of OpsData.
String attributeName
The name of an OpsData attribute on which to limit the count of OpsData.
Map<K,V> values
The aggregator value.
SdkInternalList<T> filters
The aggregator filters.
SdkInternalList<T> aggregators
A nested aggregator for viewing counts of OpsData.
String captureTime
The time the OpsData was captured.
SdkInternalList<T> content
The details of an OpsData summary.
String key
The name of the filter.
SdkInternalList<T> values
The filter value.
String type
The type of filter.
String createdBy
The ARN of the Amazon Web Services account that created the OpsItem.
String opsItemType
The type of OpsItem. Currently, the only valid values are /aws/changerequest
and
/aws/issue
.
Date createdTime
The date and time the OpsItem was created.
String description
The OpsItem description.
String lastModifiedBy
The ARN of the Amazon Web Services account that last updated the OpsItem.
Date lastModifiedTime
The date and time the OpsItem was last updated.
SdkInternalList<T> notifications
The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
Integer priority
The importance of this OpsItem in relation to other OpsItems in the system.
SdkInternalList<T> 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.
String status
The OpsItem status. Status can be Open
, In Progress
, or Resolved
. For more
information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
String opsItemId
The ID of the OpsItem.
String version
The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
String title
A short heading that describes the nature of the OpsItem and the impacted resource.
String source
The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.
Map<K,V> operationalData
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon
, aws
,
amzn
, ssm
, /amazon
, /aws
, /amzn
,
/ssm
.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API 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
Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
String category
An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
String severity
The severity of the OpsItem. Severity options range from 1 to 4.
Date actualStartTime
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest
.
Date actualEndTime
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest
.
Date plannedStartTime
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem
type /aws/changerequest
.
Date plannedEndTime
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem
type /aws/changerequest
.
String opsItemId
String key
The name of the filter key. Currently, the only supported value is OpsItemId
.
SdkInternalList<T> values
The values for the filter, consisting of one or more OpsItem IDs.
String operator
The operator used by the filter call. Currently, the only supported value is Equal
.
String opsItemId
The ID of the OpsItem.
String eventId
The ID of the OpsItem event.
String source
The source of the OpsItem event.
String detailType
The type of information provided as a detail.
String detail
Specific information about the OpsItem event.
OpsItemIdentity createdBy
Information about the user or resource that created the OpsItem event.
Date createdTime
The date and time the OpsItem event was created.
String key
The name of the filter.
SdkInternalList<T> values
The filter value.
String operator
The operator used by the filter call.
String arn
The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.
SdkInternalList<T> parameterNames
SdkInternalList<T> resourceTypes
Integer limit
String limitType
String arn
The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
String key
The name of the filter key. Supported values include ResourceUri
, ResourceType
, or
AssociationId
.
SdkInternalList<T> values
The values for the filter.
String operator
The operator used by the filter call. The only supported operator is EQUAL
.
String opsItemId
The OpsItem ID.
String associationId
The association ID.
String resourceType
The resource type.
String associationType
The association type.
String resourceUri
The Amazon Resource Name (ARN) of the related-item resource.
OpsItemIdentity createdBy
Date createdTime
The time the related-item association was created.
OpsItemIdentity lastModifiedBy
Date lastModifiedTime
The time the related-item association was last updated.
String createdBy
The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
Date createdTime
The date and time the OpsItem was created.
String lastModifiedBy
The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
Date lastModifiedTime
The date and time the OpsItem was last updated.
Integer priority
The importance of this OpsItem in relation to other OpsItems in the system.
String source
The impacted Amazon Web Services resource.
String status
The OpsItem status. Status can be Open
, In Progress
, or Resolved
.
String opsItemId
The ID of the OpsItem.
String title
A short heading that describes the nature of the OpsItem and the impacted resource.
Map<K,V> operationalData
Operational data is custom data that provides useful reference details about the OpsItem.
String category
A list of OpsItems by category.
String severity
A list of OpsItems by severity.
String opsItemType
The type of OpsItem. Currently, the only valid values are /aws/changerequest
and
/aws/issue
.
Date actualStartTime
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest
.
Date actualEndTime
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest
.
Date plannedStartTime
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem
type /aws/changerequest
.
Date plannedEndTime
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem
type /aws/changerequest
.
String resourceId
The ID of the Application Manager application.
String opsMetadataArn
The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.
Date lastModifiedDate
The date the OpsMetadata object was last updated.
String lastModifiedUser
The user name who last updated the OpsMetadata object.
Date creationDate
The date the OpsMetadata objects was created.
String key
A filter key.
SdkInternalList<T> values
A filter value.
String typeName
Name of the data type. Valid value: AWS:OpsItem
, AWS:EC2InstanceInformation
,
AWS:OpsItemTrendline
, or AWS:ComplianceSummary
.
String name
The name of the parameter.
String type
The type of parameter. Valid values include the following: String
, StringList
, and
SecureString
.
If type is StringList
, the system returns a comma-separated string with no spaces between commas in
the Value
field.
String value
The parameter value.
If type is StringList
, the system returns a comma-separated string with no spaces between commas in
the Value
field.
Long version
The parameter version.
String selector
Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:
parameter_name:version
parameter_name:label
String sourceResult
Applies to parameters that reference information in other Amazon Web Services services. SourceResult
is the raw result or response from the source.
Date lastModifiedDate
Date the parameter was last changed or updated and the parameter version was created.
String aRN
The Amazon Resource Name (ARN) of the parameter.
String dataType
The data type of the parameter, such as text
or aws:ec2:image
. The default is
text
.
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 Amazon Web Services user who last changed the parameter.
String description
Information about the parameter.
String value
The parameter value.
String allowedPattern
Parameter names can include the following letters and symbols.
a-zA-Z0-9_.-
Long version
The parameter version.
SdkInternalList<T> labels
Labels assigned to the parameter version.
String tier
The parameter tier.
SdkInternalList<T> policies
Information about the policies assigned to a parameter.
Assigning parameter policies in the Amazon Web Services Systems Manager User Guide.
String dataType
The data type of the parameter, such as text
or aws:ec2:image
. The default is
text
.
String policyText
The JSON text of the policy.
String policyType
The type of policy. Parameter Store, a capability of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
String 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).
String name
The parameter name.
String type
The type of parameter. Valid parameter types include the following: String
, StringList
,
and SecureString
.
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 Amazon Web Services user who last changed the parameter.
String description
Description of the parameter actions.
String allowedPattern
A parameter name can include only the following letters and symbols.
a-zA-Z0-9_.-
Long version
The parameter version.
String tier
The parameter tier.
SdkInternalList<T> policies
A list of policies associated with a parameter.
String dataType
The data type of the parameter, such as text
or aws:ec2:image
. The default is
text
.
String key
The name of the filter.
SdkInternalList<T> values
The filter values.
String key
The name of the filter.
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 Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.
String option
For all filters used with DescribeParameters, valid options include Equals
and
BeginsWith
. The Name
filter additionally supports the Contains
option.
(Exception: For filters using the key Path
, valid options include Recursive
and
OneLevel
.)
For filters used with GetParametersByPath, valid options include Equals
and
BeginsWith
. (Exception: For filters using Label
as the Key name, the only valid option
is Equals
.)
SdkInternalList<T> values
The value you want to search for.
String id
The ID of the patch. Applies to Windows patches only.
This ID isn't the same as 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
or Amazon Linux 2
.
String product
The specific product the patch is applicable for. For example, WindowsServer2016
or
AmazonLinux2018.03
.
String classification
The classification of the patch. For example, SecurityUpdates
, Updates
, or
CriticalUpdates
.
String msrcSeverity
The severity of the patch, such as Critical
, Important
, or Moderate
.
Applies to Windows patches only.
String kbNumber
The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.
String 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.
String language
The language of the patch if it's language-specific.
SdkInternalList<T> advisoryIds
The Advisory ID of the patch. For example, RHSA-2020:3779
. Applies to Linux-based managed nodes
only.
SdkInternalList<T> bugzillaIds
The Bugzilla ID of the patch. For example, 1600646
. Applies to Linux-based managed nodes only.
SdkInternalList<T> cVEIds
The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example, CVE-2011-3192
. Applies
to Linux-based managed nodes only.
String name
The name of the patch. Applies to Linux-based managed nodes only.
Integer 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.
String 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.
String 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.
String 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.
String severity
The severity level of the patch. For example, CRITICAL
or MODERATE
.
String 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.
String baselineId
The ID of the patch baseline.
String baselineName
The name of the patch baseline.
String operatingSystem
Defines the operating system the patch baseline applies to. The default value is WINDOWS
.
String baselineDescription
The description of the patch baseline.
Boolean defaultBaseline
Whether this is the default baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
String title
The title of the patch.
String kBId
The operating system-specific ID of the patch.
String classification
The classification of the patch, such as SecurityUpdates
, Updates
, and
CriticalUpdates
.
String severity
The severity of the patch such as Critical
, Important
, and Moderate
.
String 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 Amazon Web Services Systems Manager User Guide.
Date installedTime
The date/time the patch was installed on the managed node. Not all operating systems provide this level of information.
String cVEIds
The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch.
String key
The key for the filter.
Run the DescribePatchProperties command to view lists of valid keys for each operating system type.
SdkInternalList<T> values
The value for the filter key.
Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.
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.
SdkInternalList<T> values
The value for the filter.
PatchFilterGroup patchFilterGroup
The patch filter group that defines the criteria for the rule.
String complianceLevel
A compliance severity level for all approved patches in a patch baseline.
Integer 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. Not supported on Debian Server or Ubuntu Server.
String approveUntilDate
The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Not supported on Debian Server or Ubuntu Server.
Enter dates in the format YYYY-MM-DD
. For example, 2021-12-31
.
Boolean enableNonSecurity
For managed nodes identified by the approval rule filters, enables a patch baseline to apply non-security updates
available in the specified repository. The default value is false
. Applies to Linux managed nodes
only.
SdkInternalList<T> patchRules
The rules that make up the rule group.
String name
The name specified to identify the patch source.
SdkInternalList<T> products
The specific 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.
String configuration
The value of the yum repo configuration. For example:
[main]
name=MyCustomRepository
baseurl=https://my-custom-repository
enabled=1
For information about other options available for your yum repository configuration, see dnf.conf(5).
Integer totalSteps
The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
Integer successSteps
The total number of steps that successfully completed in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
Integer failedSteps
The total number of steps that failed to run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
Integer cancelledSteps
The total number of steps that the system cancelled in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
Integer timedOutSteps
The total number of steps that timed out in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
String resourceId
Specify an ID for this resource. For a managed node, this is the node ID.
String resourceType
Specify the type of resource. ManagedInstance
is currently the only supported resource type.
String complianceType
Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or
Custom:string
.
ComplianceExecutionSummary executionSummary
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'.
SdkInternalList<T> items
Information about the compliance as defined by the resource type. For example, for a patch compliance type,
Items
includes information about the PatchSeverity, Classification, and so on.
String itemContentHash
MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.
String uploadType
The mode for uploading compliance items. You can specify COMPLETE
or PARTIAL
. In
COMPLETE
mode, the system overwrites all existing compliance information for the resource. You must
provide a full list of compliance items each time you send the request.
In PARTIAL
mode, the system overwrites compliance information for a specific association. The
association must be configured with SyncCompliance
set to MANUAL
. By default, all
requests use COMPLETE
mode.
This attribute is only valid for association compliance.
String instanceId
An managed node ID where you want to add or update inventory items.
SdkInternalList<T> items
The inventory items that you want to add or update on managed nodes.
String message
Information about the request.
String name
The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes
the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading
forward slash character (/) when you create or reference a parameter. For example:
/Dev/DBServer/MySQL/db-string13
Naming Constraints:
Parameter names are case sensitive.
A parameter name must be unique within an Amazon Web Services Region
A parameter name can't be prefixed with "aws
" or "ssm
" (case-insensitive).
Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-
In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example:
/Dev/Production/East/Project-ABC/MyParameter
A parameter name can't include spaces.
Parameter hierarchies are limited to a maximum depth of fifteen levels.
For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.
The maximum length constraint of 2048 characters listed below includes 1037 characters reserved for internal use
by Systems Manager. The maximum length for a parameter name that you create is 1011 characters. This includes the
characters in the ARN that precede the name you specify, such as
arn:aws:ssm:us-east-2:111122223333:parameter/
.
String description
Information about the parameter that you want to add to the system. Optional but recommended.
Don't enter personally identifiable information in this field.
String value
The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
Parameters can't be referenced or nested in the values of other parameters. You can't include {{}}
or {{ssm:parameter-name}}
in a parameter value.
String type
The type of parameter that you want to add to the system.
SecureString
isn't currently supported for CloudFormation templates.
Items in a StringList
must be separated by a comma (,). You can't use other punctuation or special
character to escape items in the list. If you have a parameter value that requires a comma, then use the
String
data type.
Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.
String keyId
The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Either the default KMS key
automatically assigned to your Amazon Web Services account or a custom key. Required for parameters that use the
SecureString
data type.
If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account.
To use your default KMS key, choose the SecureString
data type, and do not specify the
Key ID
when you create the parameter. The system automatically populates Key ID
with
your default KMS key.
To use a custom KMS key, choose the SecureString
data type with the Key ID
parameter.
Boolean overwrite
Overwrite an existing parameter. The default value is false
.
String allowedPattern
A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
SdkInternalList<T> tags
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:
Key=Resource,Value=S3bucket
Key=OS,Value=Windows
Key=ParameterType,Value=LicenseKey
To add tags to an existing Systems Manager parameter, use the AddTagsToResource operation.
String tier
The parameter tier to assign to a parameter.
Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an Amazon Web Services account. Standard parameters are offered at no additional cost.
Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an Amazon Web Services account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the Amazon Web Services Systems Manager User Guide.
You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.
If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.
Using the Default Tier Configuration
In PutParameter
requests, you can specify the tier to create the parameter in. Whenever you specify
a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if
you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store
default tier configuration.
The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:
Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.
Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.
If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.
This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.
Options that require an advanced parameter include the following:
The content size of the parameter is more than 4 KB.
The parameter uses a parameter policy.
More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.
For more information about configuring the default tier option, see Specifying a default parameter tier in the Amazon Web Services Systems Manager User Guide.
String policies
One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a capability of Amazon Web Services Systems Manager supports the following policy types:
Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.
ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.
NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.
All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.
String dataType
The data type for a String
parameter. Supported data types include plain text and Amazon Machine
Image (AMI) IDs.
The following data type values are supported.
text
aws:ec2:image
aws:ssm:integration
When you create a String
parameter and specify aws:ec2:image
, Amazon Web Services
Systems Manager validates the parameter value is in the required format, such as
ami-12345abcdeEXAMPLE
, and that the specified AMI is available in your Amazon Web Services account.
For more information, see Native
parameter support for Amazon Machine Image (AMI) IDs in the Amazon Web Services Systems Manager User
Guide.
Long version
The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API operations or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.
String tier
The tier assigned to the 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.
SdkInternalList<T> targets
The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.
If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.
You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.
Example 1: Specify managed node IDs
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
Example 2: Use tag key-pairs applied to managed nodes
Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
Example 3: Use tag-keys applied to managed nodes
Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
Example 4: Use resource group names
Key=resource-groups:Name,Values=<resource-group-name>
Example 5: Use filters for resource group types
Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
For Key=resource-groups:ResourceTypeFilters
, specify resource types in the following format
Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.
String 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.
String name
An optional name for the target.
String description
An optional description for the target.
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.
SdkInternalList<T> targets
The targets (either managed nodes or maintenance window targets).
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
Specify managed nodes using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
Specify maintenance window targets using the following format:
Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>
String taskArn
The ARN of the task to run.
String serviceRoleArn
The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when
running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's
service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you
run RegisterTaskWithMaintenanceWindow
.
For more information, see the following topics in the in the Amazon Web Services Systems Manager User Guide:
String taskType
The type of task being registered.
Map<K,V> taskParameters
The parameters that should be passed to the task when it is run.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead
use the Parameters
option in the TaskInvocationParameters
structure. For information
about how Systems Manager handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
MaintenanceWindowTaskInvocationParameters taskInvocationParameters
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
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.
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 specified, you can't supply a value for this option. Instead, the
system inserts a placeholder value of 1
. This value doesn't affect the running of your task.
String maxErrors
The maximum number of errors allowed before this task stops being scheduled.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the
system inserts a placeholder value of 1
. This value doesn't affect the running of your task.
LoggingInfo loggingInfo
A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
contain logs, instead use the OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager
handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
String name
An optional name for the task.
String description
An optional description for the task.
String clientToken
User-provided idempotency token.
String cutoffBehavior
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
CONTINUE_TASK
: When the cutoff time is reached, any tasks that are running continue. The default
value.
CANCEL_TASK
:
For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand 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
.
String windowTaskId
The ID of the task in the maintenance window.
String opsItemId
The ID of an OpsItem related to the current OpsItem.
String resourceType
The type of resource from which you want to remove a tag.
The ManagedInstance
type for this API operation is only for on-premises managed nodes. Specify the
name of the managed node in the following format: mi-ID_number
. For example,
mi-1a2b3c4d5e6f
.
String resourceId
The ID of the resource from which you want to remove tags. For example:
ManagedInstance: mi-012345abcde
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID
for tagging is created from the Amazon Resource Name (ARN) for the
object. Specifically, ResourceID
is created from the strings that come after the word
opsmetadata
in the ARN. For example, an OpsMetadata object with an ARN of
arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has a
ResourceID
of either aws/ssm/MyGroup/appmanager
or
/aws/ssm/MyGroup/appmanager
.
For the Document and Parameter values, use the name of the resource.
The ManagedInstance
type for this API operation is only for on-premises managed nodes. Specify the
name of the managed node in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
SdkInternalList<T> tagKeys
Tag keys that you want to remove from the specified resource.
String settingId
The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.
/ssm/automation/customer-script-log-destination
/ssm/automation/customer-script-log-group-name
/ssm/documents/console/public-sharing-permission
/ssm/parameter-store/default-parameter-tier
/ssm/parameter-store/high-throughput-enabled
/ssm/managed-instance/activation-tier
ServiceSetting serviceSetting
The current, effective service setting after calling the ResetServiceSetting API operation.
SdkInternalList<T> parameterValues
A list of parameter values sent to targets that resolved during the Automation execution.
Boolean truncated
A boolean value indicating whether the resolved target list is truncated.
String complianceType
The compliance type.
String resourceType
The resource type.
String resourceId
The resource ID.
String status
The compliance status for the resource.
String overallSeverity
The highest severity item found for the resource. The resource is compliant for this item.
ComplianceExecutionSummary executionSummary
Information about the execution.
CompliantSummary compliantSummary
A list of items that are compliant for the resource.
NonCompliantSummary nonCompliantSummary
A list of items that aren't compliant for the resource.
String syncName
String organizationSourceType
If an Amazon Web Services 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 Amazon Web
Services organization.
SdkInternalList<T> organizationalUnits
The Organizations organization units included in the sync.
String destinationDataSharingType
The sharing data type. Only Organization
is supported.
String syncName
The name of the resource data sync.
String 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 Organizations or from multiple Amazon Web Services Regions.
ResourceDataSyncSourceWithState syncSource
Information about the source where the data was synchronized.
ResourceDataSyncS3Destination s3Destination
Configuration information for the target S3 bucket.
Date lastSyncTime
The last time the configuration attempted to sync (UTC).
Date lastSuccessfulSyncTime
The last time the sync operations returned a status of SUCCESSFUL
(UTC).
Date syncLastModifiedTime
The date and time the resource data sync was changed.
String lastStatus
The status reported by the last sync.
Date syncCreatedTime
The date and time the configuration was created (UTC).
String lastSyncStatusMessage
The status message details reported by the last sync.
String organizationalUnitId
The Organizations unit ID data source for the sync.
String bucketName
The name of the S3 bucket where the aggregated data is stored.
String prefix
An Amazon S3 prefix for the bucket.
String syncFormat
A supported sync format. The following format is currently supported: JsonSerDe
String region
The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.
String aWSKMSKeyARN
The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.
ResourceDataSyncDestinationDataSharing destinationDataSharing
Enables destination data sharing. By default, this field is null
.
String sourceType
The type of data source for the resource data sync. SourceType
is either
AwsOrganizations
(if an organization is present in Organizations) or
SingleAccountMultiRegions
.
ResourceDataSyncAwsOrganizationsSource awsOrganizationsSource
Information about the AwsOrganizationsSource
resource data sync source. A sync source of this type
can synchronize data from Organizations.
SdkInternalList<T> sourceRegions
The SyncSource
Amazon Web Services Regions included in the resource data sync.
Boolean includeFutureRegions
Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.
Boolean enableAllOpsDataSources
When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the Amazon Web Services Systems Manager User Guide.
String sourceType
The type of data source for the resource data sync. SourceType
is either
AwsOrganizations
(if an organization is present in Organizations) or
singleAccountMultiRegions
.
ResourceDataSyncAwsOrganizationsSource awsOrganizationsSource
The field name in SyncSource
for the ResourceDataSyncAwsOrganizationsSource
type.
SdkInternalList<T> sourceRegions
The SyncSource
Amazon Web Services Regions included in the resource data sync.
Boolean includeFutureRegions
Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.
String 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 specified or selected an invalid unit in the resource data sync
configuration.
TrustedAccessDisabled
: You disabled Systems Manager access in the organization in Organizations.
Boolean enableAllOpsDataSources
When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the Amazon Web Services Systems Manager User Guide.
String typeName
Name of the inventory item type. Valid value: AWS:InstanceInformation
. Default Value:
AWS:InstanceInformation
.
String sessionId
The ID of the disconnected session to resume.
String sessionId
The ID of the session.
String tokenValue
An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.
String 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 identifier for an Amazon Web Services Region supported by Amazon Web Services
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
.
String documentName
The name of the Automation runbook used in a runbook workflow.
String documentVersion
The version of the Automation runbook used in a runbook workflow.
Map<K,V> parameters
The key-value map of execution parameters, which were supplied when calling
StartChangeRequestExecution
.
String targetParameterName
The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you
specify Targets
.
SdkInternalList<T> targets
A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify
TargetParameterName
.
String maxConcurrency
The MaxConcurrency
value specified by the user when the operation started, indicating the maximum
number of resources that the runbook operation can run on at the same time.
String maxErrors
The MaxErrors
value specified 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.
SdkInternalList<T> targetLocations
Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
String outputUrl
A URL for an S3 bucket where you want to store the results of this request.
String automationExecutionId
The unique identifier for an existing Automation execution that you want to send the signal to.
String signalType
The type of signal to send to an Automation execution.
Map<K,V> 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:
StepName="step1"
For the StopStep
signal type, you must send the step execution ID as the payload. For example:
StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
SdkInternalList<T> 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 Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.
SdkInternalList<T> 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 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 Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.
String documentName
The name of the Amazon Web Services 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 Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.
If you specify a document name or ARN that hasn't been shared with your account, you receive an
InvalidDocument
error.
String documentVersion
The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
--document-version "\$DEFAULT"
--document-version "\$LATEST"
--document-version "3"
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 hasn't already started running, it won't run.
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 document being run.
String outputS3Region
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
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 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 Amazon Web Services Systems Manager User Guide.
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 0
. For more information about how to
use MaxErrors
, see Using error controls in the Amazon Web Services Systems Manager User Guide.
String serviceRoleArn
The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
NotificationConfig notificationConfig
Configurations for sending notifications.
CloudWatchOutputConfig cloudWatchOutputConfig
Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
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 settingId
The ID of the service setting.
String settingValue
The value of the service setting.
Date lastModifiedDate
The last time the service setting was modified.
String lastModifiedUser
The ARN of the last modified user. This field is populated only if the setting value was overwritten.
String aRN
The ARN of the service setting.
String 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 Amazon Web Services service team.
Customized: The current setting use a custom value specified by the customer.
PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.
String sessionId
The ID of the session.
String target
The managed node that the Session Manager session connected to.
String status
The status of the session. For example, "Connected" or "Terminated".
Date startDate
The date and time, in ISO-8601 Extended format, when the session began.
Date endDate
The date and time, in ISO-8601 Extended format, when the session was terminated.
String documentName
The name of the Session Manager SSM document used to define the parameters and plugin settings for the session.
For example, SSM-SessionManagerRunShell
.
String owner
The ID of the Amazon Web Services user account that started the session.
String reason
The reason for connecting to the instance.
String details
Reserved for future use.
SessionManagerOutputUrl outputUrl
Reserved for future use.
String maxSessionDuration
The maximum duration of a session before it terminates.
String key
The name of the filter.
String value
The filter value. Valid values for each filter key are as follows:
InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
Target: Specify a managed node to which session connections have been made.
Owner: Specify an Amazon Web Services user account 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.
Integer 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.
Integer 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.
Integer 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.
Integer 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.
Integer 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.
Integer unspecifiedCount
The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.
SdkInternalList<T> associationIds
The association IDs that you want to run immediately and only one time.
String 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 Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.
String documentVersion
The version of the Automation runbook to use for this execution.
Map<K,V> parameters
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
String clientToken
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
String mode
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
String targetParameterName
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
SdkInternalList<T> targets
A key-value mapping to target resources. Required if you specify TargetParameterName.
SdkInternalList<T> targetMaps
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
String 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
.
String 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 first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.
Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.
SdkInternalList<T> targetLocations
A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services Systems Manager User Guide.
SdkInternalList<T> tags
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource operation.
String automationExecutionId
The unique ID of a newly scheduled automation execution.
Date scheduledTime
The date and time specified in the change request to run the Automation runbooks.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
String documentName
The name of the change template document to run during the runbook workflow.
String documentVersion
The version of the change template document to run during the runbook workflow.
Map<K,V> parameters
A key-value map of parameters that match the declared parameters in the change template document.
String changeRequestName
The name of the change request associated with the runbook workflow to be run.
String clientToken
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
Boolean autoApprove
Indicates whether the change request can be approved automatically without the need for manual approvals.
If AutoApprovable
is enabled in a change template, then setting AutoApprove
to
true
in StartChangeRequestExecution
creates a change request that bypasses approver
review.
Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is
CLOSED
, change freeze approvers must still grant permission for this change request to run. If they
don't, the change won't be processed until the calendar state is again OPEN
.
SdkInternalList<T> runbooks
Information about the Automation runbooks that are run during the runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
SdkInternalList<T> tags
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:
Key=Environment,Value=Production
Key=Region,Value=us-east-2
Date scheduledEndTime
The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.
String changeDetails
User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.
String automationExecutionId
The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.)
String target
The managed node to connect to for the session.
String documentName
The name of the SSM document to define the parameters and plugin settings for the session. For example,
SSM-SessionManagerRunShell
. You can call the GetDocument API to verify the document exists
before attempting to start a session. If no document name is provided, a shell to the managed node is launched by
default.
String 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.
Map<K,V> parameters
The values you want to specify for the parameters defined in the Session document.
String sessionId
The ID of the session.
String tokenValue
An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.
String 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 identifier for an Amazon Web Services Region supported by Amazon Web Services
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
.
String stepName
The name of this execution step.
String action
The action this step performs. The action determines the behavior of the step.
Long timeoutSeconds
The timeout seconds of the step.
String onFailure
The action to take if the step fails. The default value is Abort
.
Integer maxAttempts
The maximum number of tries to run the action of the step. The default value is 1
.
Date executionStartTime
If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.
Date executionEndTime
If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.
String stepStatus
The execution status for this step.
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.
FailureDetails failureDetails
Information about the Automation failure.
String stepExecutionId
The unique ID of a step execution.
Map<K,V> overriddenParameters
A user-specified list of parameters to override when running a step.
Boolean isEnd
The flag which can be used to end automation no matter whether the step succeeds or fails.
String nextStep
The next step after the step succeeds.
Boolean isCritical
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
SdkInternalList<T> 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 specific step.
SdkInternalList<T> targets
The targets for the step execution.
TargetLocation targetLocation
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
String key
One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.
SdkInternalList<T> values
The values of the filter key.
String key
User-defined criteria for sending commands that target managed nodes that meet the criteria.
SdkInternalList<T> values
User-defined criteria that maps to Key
. For example, if you specified tag:ServerRole
,
you could specify value:WebServer
to run a command on instances that include EC2 tags of
ServerRole,WebServer
.
Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
SdkInternalList<T> accounts
The Amazon Web Services accounts targeted by the current Automation execution.
SdkInternalList<T> regions
The Amazon Web Services Regions targeted by the current Automation execution.
String targetLocationMaxConcurrency
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.
String targetLocationMaxErrors
The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
String executionRoleName
The Automation execution role used by the currently running Automation. If not specified, the default value is
AWS-SystemsManager-AutomationExecutionRole
.
String sessionId
The ID of the session to terminate.
String sessionId
The ID of the session that has been terminated.
String name
The name of the parameter from which you want to delete one or more labels.
Long parameterVersion
The specific version of the parameter which you want to delete one or more labels from. If it isn't present, the call will fail.
SdkInternalList<T> labels
One or more labels to delete from the specified parameter version.
SdkInternalList<T> removedLabels
A list of all labels deleted from the parameter.
SdkInternalList<T> invalidLabels
The labels that aren't attached to the given parameter version.
String typeName
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, a
capability of Amazon Web Services Systems Manager, you can reference the parameter using
{{ssm:parameter-name}}
.
String documentVersion
The document version you want update for the association.
State Manager doesn't support running associations that use a new version of a document if that document is
shared from another account. State Manager always runs the default
version of a document if shared
from another account, even though the Systems Manager console shows that a new version was processed. If you want
to run an association using a new version of a document shared form another account, you must set the document
version to default
.
String scheduleExpression
The cron expression used to schedule the association that you want to update.
InstanceAssociationOutputLocation outputLocation
An S3 bucket where you want to store the results of this request.
String name
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services 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 Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to
specify the document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
SdkInternalList<T> targets
The targets of the association.
String associationName
The name of the association that you want to update.
String 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.
String automationTargetParameterName
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
String 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 first error is returned. If
you run an association on 50 managed nodes and set MaxError
to 10%, then the system stops sending
the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to
complete, but some of these executions may fail as well. If you need to ensure that there won't be more than
max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at a time.
String 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 specified for
MaxConcurrency
.
String complianceSeverity
The severity level to assign to the association.
String 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
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
Boolean applyOnlyAtCronInterval
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
If you chose this option when you created an association and later you edit that association or you make changes
to the SSM document on which that association is based (by using the Documents page in the console), State
Manager applies the association at the next specified cron interval. For example, if you chose the
Latest
version of an SSM document when you created an association and you edit the association by
choosing a different document version on the Documents page, State Manager applies the association at the next
specified cron interval if you previously selected this option. If this option wasn't selected, State Manager
immediately runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval
parameter when you
update the association from the command line. This parameter forces the association to run immediately after
updating it and according to the interval specified.
SdkInternalList<T> 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 Amazon Web Services Systems Manager Change Calendar.
SdkInternalList<T> targetLocations
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
AssociationDescription associationDescription
The description of the association that was updated.
String name
The name of the SSM document.
String instanceId
The managed node ID.
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.
String name
The name of the change template for which a version's metadata is to be updated.
String documentVersion
The version of a change template in which to update approval metadata.
DocumentReviews documentReviews
The change template review details to update.
String content
A valid JSON or YAML string.
SdkInternalList<T> attachments
A list of key-value pairs that describe attachments to a version of a document.
String name
The name of the SSM document that you want to update.
String displayName
The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.
String versionName
An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
String 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.
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.
String documentFormat
Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.
String targetType
Specify a new target type for the document.
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 description
An optional description for the update request.
String 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 specified future date.
String endDate
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.
String schedule
The schedule of the maintenance window in the form of a cron or rate expression.
String 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.
Integer scheduleOffset
The number of days to wait after the date and time specified by a cron expression before running the maintenance window.
For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.
cron(30 23 ? * TUE#3 *)
If the schedule offset is 2
, the maintenance window won't run until two days later.
Integer duration
The duration of the maintenance window in hours.
Integer cutoff
The number of hours before the end of the maintenance window that Amazon Web Services 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.
Boolean replace
If True
, then all fields that are required by the CreateMaintenanceWindow operation are also
required for this API request. Optional fields that aren't specified are set to null.
String windowId
The ID of the created maintenance window.
String name
The name of the maintenance window.
String description
An optional description of the update.
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 specified time.
String 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 specified time.
String schedule
The schedule of the maintenance window in the form of a cron or rate expression.
String 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.
Integer scheduleOffset
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
Integer duration
The duration of the maintenance window in hours.
Integer cutoff
The number of hours before the end of the maintenance window that Amazon Web Services 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 maintenance window ID with which to modify the target.
String windowTargetId
The target ID to modify.
SdkInternalList<T> targets
The targets to add or replace.
String 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.
String name
A name for the update.
String description
An optional description for the update.
Boolean replace
If True
, then all fields that are required by the RegisterTargetWithMaintenanceWindow
operation are also required for this API request. Optional fields that aren't specified are set to null.
String windowId
The maintenance window ID specified in the update request.
String windowTargetId
The target ID specified in the update request.
SdkInternalList<T> targets
The updated targets.
String ownerInformation
The updated owner.
String name
The updated name.
String description
The updated description.
String windowId
The maintenance window ID that contains the task to modify.
String windowTaskId
The task ID to modify.
SdkInternalList<T> targets
The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format
Key=instanceids,Values=instanceID_1,instanceID_2
. Tags are specified using the format
Key=tag_name,Values=tag_value
.
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
String taskArn
The task ARN to modify.
String serviceRoleArn
The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when
running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's
service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you
run RegisterTaskWithMaintenanceWindow
.
For more information, see the following topics in the in the Amazon Web Services Systems Manager User Guide:
Map<K,V> taskParameters
The parameters to modify.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead
use the Parameters
option in the TaskInvocationParameters
structure. For information
about how Systems Manager handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
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
MaintenanceWindowTaskInvocationParameters taskInvocationParameters
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in TaskInvocationParameters
,
you must provide again all the TaskInvocationParameters
values that you want to retain. The values
you don't specify again are removed. For example, suppose that when you registered a Run Command task, you
specified TaskInvocationParameters
values for Comment
, NotificationConfig
,
and OutputS3BucketName
. If you update the maintenance window task and specify only a different
OutputS3BucketName
value, the values for Comment
and NotificationConfig
are removed.
Integer 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.
String maxConcurrency
The new MaxConcurrency
value you want to specify. MaxConcurrency
is the number of
targets that are allowed to run this task, in parallel.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the
system inserts a placeholder value of 1
. This value doesn't affect the running of your task.
String maxErrors
The new MaxErrors
value to specify. MaxErrors
is the maximum number of errors that are
allowed before the task stops being scheduled.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the
system inserts a placeholder value of 1
. This value doesn't affect the running of your task.
LoggingInfo loggingInfo
The new logging location in Amazon S3 to specify.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
contain logs, instead use the OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager
handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
String name
The new task name to specify.
String description
The new task description to specify.
Boolean replace
If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.
String cutoffBehavior
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
CONTINUE_TASK
: When the cutoff time is reached, any tasks that are running continue. The default
value.
CANCEL_TASK
:
For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand 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
.
String windowId
The ID of the maintenance window that was updated.
String windowTaskId
The task ID of the maintenance window that was updated.
SdkInternalList<T> targets
The updated target values.
String taskArn
The updated task ARN value.
String serviceRoleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
Map<K,V> taskParameters
The updated parameter values.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead
use the Parameters
option in the TaskInvocationParameters
structure. For information
about how Systems Manager handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
MaintenanceWindowTaskInvocationParameters taskInvocationParameters
The updated parameter values.
Integer priority
The updated priority value.
String maxConcurrency
The updated MaxConcurrency
value.
String maxErrors
The updated MaxErrors
value.
LoggingInfo loggingInfo
The updated logging information in Amazon S3.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
contain logs, instead use the OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager
handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
String name
The updated task name.
String description
The updated task description.
String cutoffBehavior
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
String description
Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.
Map<K,V> 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 files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon
, aws
,
amzn
, ssm
, /amazon
, /aws
, /amzn
,
/ssm
.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API 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
Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
SdkInternalList<T> operationalDataToDelete
Keys that you want to remove from the OperationalData map.
SdkInternalList<T> notifications
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
Integer priority
The importance of this OpsItem in relation to other OpsItems in the system.
SdkInternalList<T> 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.
String status
The OpsItem status. Status can be Open
, In Progress
, or Resolved
. For more
information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
String opsItemId
The ID of the OpsItem.
String title
A short heading that describes the nature of the OpsItem and the impacted resource.
String category
Specify a new category for an OpsItem.
String severity
Specify a new severity for an OpsItem.
Date actualStartTime
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest
.
Date actualEndTime
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest
.
Date plannedStartTime
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem
type /aws/changerequest
.
Date plannedEndTime
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem
type /aws/changerequest
.
String opsMetadataArn
The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.
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 include patches in the baseline.
PatchRuleGroup approvalRules
A set of rules used to include patches in the baseline.
SdkInternalList<T> approvedPatches
A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
String approvedPatchesComplianceLevel
Assigns a new compliance severity level to an existing patch baseline.
Boolean 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.
SdkInternalList<T> rejectedPatches
A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
String rejectedPatchesAction
The action for Patch Manager to take on patches included in the RejectedPackages
list.
ALLOW_AS_DEPENDENCY
: 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 InstalledOther
. This is the default action if no option is specified.
BLOCK
: Packages in the RejectedPatches
list, and packages that include them as
dependencies, aren't installed under any circumstances. If a package was installed before it was added to the
Rejected
patches list, it is considered non-compliant with the patch baseline, and its status is
reported as InstalledRejected
.
String description
A description of the patch baseline.
SdkInternalList<T> 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.
Boolean replace
If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.
String baselineId
The ID of the deleted patch baseline.
String name
The name of the patch baseline.
String operatingSystem
The operating system rule used by the updated 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.
SdkInternalList<T> approvedPatches
A list of explicitly approved patches for the baseline.
String approvedPatchesComplianceLevel
The compliance severity level assigned to the patch baseline after the update completed.
Boolean 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.
SdkInternalList<T> rejectedPatches
A list of explicitly rejected patches for the baseline.
String rejectedPatchesAction
The action specified to take on patches included in the RejectedPatches
list. A patch can be allowed
only if it is a dependency of another package, or blocked entirely along with packages that include it as a
dependency.
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.
SdkInternalList<T> 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.
String syncName
The name of the resource data sync you want to update.
String syncType
The type of resource data sync. The supported SyncType
is SyncFromSource.
ResourceDataSyncSource syncSource
Specify information about the data sources to synchronize.
String settingId
The Amazon Resource Name (ARN) of the service setting to reset. 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/automation/customer-script-log-destination
/ssm/automation/customer-script-log-group-name
/ssm/documents/console/public-sharing-permission
/ssm/parameter-store/default-parameter-tier
/ssm/parameter-store/high-throughput-enabled
/ssm/managed-instance/activation-tier
String settingValue
The new value to specify for the service setting. The following list specifies the available values for each setting.
/ssm/parameter-store/default-parameter-tier
: Standard
, Advanced
,
Intelligent-Tiering
/ssm/parameter-store/high-throughput-enabled
: true
or false
/ssm/managed-instance/activation-tier
: true
or false
/ssm/automation/customer-script-log-destination
: CloudWatch
/ssm/automation/customer-script-log-group-name
: the name of an Amazon CloudWatch Logs log group
/ssm/documents/console/public-sharing-permission
: Enable
or Disable
/ssm/managed-instance/activation-tier
: standard
or advanced
Copyright © 2022. All rights reserved.