String activationId
The ID created by Systems Manager when you submitted the activation.
String description
A user defined description of the activation.
String defaultInstanceName
A name for the managed instance when it is created.
String iamRole
The Amazon Identity and Access Management (IAM) role to assign to the managed instance.
Integer registrationLimit
The maximum number of managed instances that can be registered using this activation.
Integer registrationsCount
The number of managed instances already registered with this activation.
Date expirationDate
The date when this activation can no longer be used to register managed instances.
Boolean expired
Whether or not the activation is expired.
Date createdDate
The date the activation was created.
SdkInternalList<T> tags
Tags assigned to the activation.
String resourceType
Specifies the type of resource you are tagging.
The ManagedInstance type for this API action is for on-premises managed instances. You must specify the the name of the managed instance 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:
ManagedInstance: mi-012345abcde
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
For the Document and Parameter values, use the name of the resource.
The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
SdkInternalList<T> tags
One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Do not enter personally identifiable information in this field.
String name
The name of the Systems Manager document.
String instanceId
The ID of the instance.
String associationId
The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.
String associationVersion
The association version.
String documentVersion
The version of the document used in the association.
SdkInternalList<T> targets
The instances targeted by the request to create an association.
Date lastExecutionDate
The date on which the association was last run.
AssociationOverview overview
Information about the association.
String scheduleExpression
A cron expression that specifies a schedule when the association runs.
String associationName
The association name.
String name
The name of the Systems Manager document.
String instanceId
The ID of the instance.
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
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
Map<K,V> parameters
A description of the parameters for a document.
String associationId
The association ID.
SdkInternalList<T> targets
The instances targeted by the request.
String scheduleExpression
A cron expression that specifies a schedule when the association runs.
InstanceAssociationOutputLocation outputLocation
An Amazon S3 bucket where you want to store the output details of the request.
Date lastExecutionDate
The date on which the association was last run.
Date lastSuccessfulExecutionDate
The last date on which the association was successfully run.
String 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 instances 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 instance 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 instance will process its association within the limit specified for MaxConcurrency.
String complianceSeverity
The severity level that is assigned to 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 instance ID where the association ran.
String resourceType
The resource type, for example, instance.
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 instances, and one of them was successful, this would return the count of instances 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 a Systems Manager 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 instances 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 instance 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 instance will process its association within the limit specified for MaxConcurrency.
String complianceSeverity
The severity level that is assigned to the association.
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 and value pair that identifies the location of an attachment to a document.
SdkInternalList<T> values
The URL of the location of a document attachment, such as the URL of an Amazon S3 bucket.
String automationExecutionId
The execution ID.
String documentName
The name of the Automation document used during the execution.
String documentVersion
The version of the document to use during execution.
Date executionStartTime
The time the execution started.
Date executionEndTime
The time the execution finished.
String automationExecutionStatus
The execution status of the Automation.
SdkInternalList<T> stepExecutions
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are 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 action 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 document.
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 AWS Regions and/or AWS accounts where you want to run the Automation.
ProgressCounters progressCounters
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
String key
One or more keys to limit the results. Valid filter keys include the following: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter.
SdkInternalList<T> values
The values used to limit the execution information associated with the filter's key.
String automationExecutionId
The execution ID.
String documentName
The name of the Automation document used during execution.
String documentVersion
The document version used during the execution.
String automationExecutionStatus
The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
Date executionStartTime
The time the execution started.>
Date executionEndTime
The time the execution finished. This is not populated if the execution is still in progress.
String executedBy
The IAM role ARN of the user who ran the Automation.
String logFile
An Amazon S3 bucket where execution information is stored.
Map<K,V> outputs
The list of execution outputs as defined in the Automation document.
String mode
The Automation execution mode.
String parentAutomationExecutionId
The ExecutionId 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 document.
String targetParameterName
The list of execution outputs as defined in the Automation document.
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 document.
String automationType
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
String commandId
The ID of the command you want to cancel.
SdkInternalList<T> instanceIds
(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.
String 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 log group where you want to send command output. If you don't specify a group name, 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 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 has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
Map<K,V> parameters
The parameter values to be inserted in the document when running the command.
SdkInternalList<T> instanceIds
The instance IDs against which this command was requested.
SdkInternalList<T> targets
An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
Date requestedDateTime
The date and time the command was requested.
String status
The status of the command.
String statusDetails
A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command has not been sent to any instances.
In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.
Success: The command successfully 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 instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. 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 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.
String outputS3KeyPrefix
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
String maxConcurrency
The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running Commands Using Systems Manager Run Command in the AWS 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 AWS 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, Canceled, 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 IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
NotificationConfig notificationConfig
Configurations for sending notifications about command status changes.
CloudWatchOutputConfig cloudWatchOutputConfig
CloudWatch Logs information where you want Systems Manager to send the command output.
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-07-07T00:00:00Z
to see a list of command executions occurring July 7, 2018, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify
2018-07-07T00:00:00Z
to see a list of command executions from before July 7, 2018.
Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include:
Pending
InProgress
Success
Cancelled
Failed
TimedOut
Cancelling
DocumentName: Specify name of the 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 instances.
ExecutionStage: Specify one of the following values:
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 instance ID in which this invocation was requested.
String instanceName
The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.
String comment
User-specified information about the command, such as a brief description of what the command should do.
String documentName
The document name that was requested for execution.
String documentVersion
The SSM document version.
Date requestedDateTime
The time and date the request was sent to this instance.
String status
Whether or not the invocation succeeded, failed, or is pending.
String statusDetails
A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command has not been sent to the instance.
In Progress: The command has been sent to the instance but has not reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
String traceOutput
Gets the trace output sent by the agent.
String standardOutputUrl
The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.
String standardErrorUrl
The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.
SdkInternalList<T> commandPlugins
String serviceRole
The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.
NotificationConfig notificationConfig
Configurations for sending notifications about command status changes on a per instance basis.
CloudWatchOutputConfig cloudWatchOutputConfig
CloudWatch Logs information where you want 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 AWS Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command has not been sent to the instance.
In Progress: The command has been sent to the instance but has not reached a terminal state.
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
Integer responseCode
A numeric response code generated after 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 Amazon S3 bucket for the command was not specified, then this string is empty.
String standardErrorUrl
The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.
String outputS3Region
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon 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:
test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript
test_folder is the name of the Amazon S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
i-1234567876543 is the instance ID;
awsrunShellScript is the name of the plugin.
String outputS3KeyPrefix
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:
test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript
test_folder is the name of the Amazon S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
i-1234567876543 is the instance ID;
awsrunShellScript is the name of the plugin.
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 instance, this is the instance 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 or NON_COMPLIANT.
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 Amazon EC2.
Do not enter personally identifiable information in this field.
String defaultInstanceName
The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources.
Do not enter personally identifiable information in this field.
String iamRole
The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.
Integer registrationLimit
Specify the maximum number of managed instances you want to register. The default value is 1 instance.
Date expirationDate
The date by which this activation request should expire. The default value is 24 hours.
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 name/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 and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.
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 instance. You can specify Command or Automation documents.
You can specify AWS-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 AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document
name. For example, AWS-ApplyPatchBaseline
or My-Document
.
String instanceId
The ID of the instance.
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 document and target resources by using rate controls.
String documentVersion
The document version.
SdkInternalList<T> targets
The instances targeted by the request.
String scheduleExpression
A cron expression that specifies a schedule when the association runs.
InstanceAssociationOutputLocation outputLocation
An Amazon S3 bucket where you want to store the results of this request.
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 instances 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 instance 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 instance will process its association within the limit specified for MaxConcurrency.
String complianceSeverity
The severity level to assign to the association.
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 document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-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 AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:partition:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document
name. For example, AWS-ApplyPatchBaseline
or My-Document
.
String documentVersion
The document version you want to associate with the target(s). Can be a specific version or the default version.
String instanceId
The instance ID.
Map<K,V> parameters
The parameters for the runtime configuration of the document.
SdkInternalList<T> targets
The targets (either instances or tags) for the association.
String scheduleExpression
A cron expression when the association will be applied to the target(s).
InstanceAssociationOutputLocation outputLocation
An 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
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
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 instances 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 instance 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 instance will process its association within the limit specified for MaxConcurrency.
String complianceSeverity
The severity level to assign to the association.
AssociationDescription associationDescription
Information about the association.
String content
A valid JSON or YAML string.
SdkInternalList<T> attachments
A list of key and value pairs that describe attachments to a version of a document.
String name
A name for the Systems Manager document.
Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes:
aws
amazon
amzn
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 cannot be changed.
String documentType
The type of document to create. Valid document types include: Command
, Policy
,
Automation
, Session
, and Package
.
String documentFormat
Specify the document format for the request. The document format can be either JSON or YAML. 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 AWS Resource Types Reference in the AWS 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 name/value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource action.
DocumentDescription documentDescription
Information about the Systems Manager 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", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
Integer duration
The duration of the Maintenance Window in hours.
Integer cutoff
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Boolean allowUnassociatedTargets
Enables a Maintenance Window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance 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 name/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 action.
String windowId
The ID of the created Maintenance Window.
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 Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.
String approvedPatchesComplianceLevel
Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is 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 instances. The default value is 'false'. Applies to Linux instances 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 Package Name Formats for Approved and Rejected Patch Lists in the AWS 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, are not 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 instances, including target operating systems and source repositories. Applies to Linux instances 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 name/value pairs:
Key=PatchSeverity,Value=Critical
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource action.
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.
String activationId
The ID of the activation that you want to delete.
String name
The name of the document.
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
action for a
version greater than the disbled 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
action 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 actions.
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 Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide.
String windowId
The ID of the Maintenance Window to delete.
String windowId
The ID of the deleted Maintenance Window.
String name
The name of the parameter to delete.
SdkInternalList<T> names
The names of the parameters to delete.
SdkInternalList<T> deletedParameters
The names of the deleted parameters.
SdkInternalList<T> invalidParameters
The names of parameters that weren't deleted because the parameters are not valid.
String baselineId
The ID of the patch baseline to delete.
String baselineId
The ID of the deleted patch baseline.
String syncName
The name of the configuration to delete.
String instanceId
The ID assigned to the managed instance 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 does not 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 AWS 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 Systems Manager document.
String instanceId
The instance 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 an instance, 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
A boolean that 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
Filters used to scope down the returned patches.
Integer maxResults
The maximum number of patches to return (per page).
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
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.
SdkInternalList<T> accountIds
The account IDs that have permission to use this document. The ID can be either an AWS account or All.
String name
The name of the Systems Manager 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 cannot be changed.
DocumentDescription document
Information about the Systems Manager document.
String instanceId
The instance ID for which you want to view all associations.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
SdkInternalList<T> associations
The associations for the requested instance.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String baselineId
The ID of the patch baseline to retrieve the effective patches for.
Integer maxResults
The maximum number of patches to return (per page).
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
SdkInternalList<T> effectivePatches
An array of patches and patch status.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String instanceId
The instance IDs for which you want association status information.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
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
InstanceInformationFilter action. The InstanceInformationFilter
action enables you to return
instance information by using tags that are specified as a key-value mapping.
If you do use this method, then you can't use the InstanceInformationFilter
action. Using this
method and the InstanceInformationFilter
action causes an exception error.
SdkInternalList<T> filters
One or more filters. Use a filter to return a more specific list of instances. You can filter on Amazon EC2 tag. Specify tags by using a key-value mapping.
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 instance information list.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String instanceId
The ID of the instance whose patch state information should be retrieved.
SdkInternalList<T> filters
Each entry in the array is a structure containing:
Key (string, between 1 and 128 characters)
Values (array of strings, each string between 1 and 256 characters)
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 instances.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
SdkInternalList<T> instanceIds
The ID of the instance whose patch state information should be retrieved.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxResults
The maximum number of instances to return (per page).
SdkInternalList<T> instancePatchStates
The high-level patch state for the requested instances.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String deletionId
Specify the delete inventory ID for which you want information. This ID was returned by the
DeleteInventory
action.
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 (string, between 1 and 128 characters)
Values (array of strings, each string is between 1 and 256 characters)
The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
SdkInternalList<T> windowExecutions
Information about the Maintenance Windows execution.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String windowExecutionId
The ID of the Maintenance Window execution the task is part of.
String taskId
The ID of the specific task in the Maintenance Window task that should be retrieved.
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 instance 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 instance 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 an instance 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.
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> filters
One or more filters. Use a filter to return a more specific list of results.
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. If there are no additional items to return, the string is empty.
SdkInternalList<T> filters
Each element in the array is a structure containing:
Key: (string, "NAME_PREFIX" or "OWNER")
Value: (array of strings, exactly 1 entry, between 1 and 255 characters)
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
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.)
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 instances in the patch group.
Integer instancesWithInstalledPatches
The number of instances with installed patches.
Integer instancesWithInstalledOtherPatches
The number of instances with patches installed that aren't defined in the patch baseline.
Integer instancesWithInstalledRejectedPatches
The number of instances 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 instances with missing patches from the patch baseline.
Integer instancesWithFailedPatches
The number of instances with patches from the patch baseline that failed to install.
Integer instancesWithNotApplicablePatches
The number of instances with patches that aren't applicable.
Integer instancesWithUnreportedNotApplicablePatches
The number of instances with NotApplicable
patches beyond the supported limit, which are not
reported by name to Systems Manager Inventory.
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 Microsoft applications. Not applicable for Linux 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 Systems Manager document.
String versionName
The version of the artifact associated with the document.
String owner
The AWS user account that created the document.
Date createdDate
The date when the document was created.
String status
The status of the Systems Manager document.
String statusInformation
A message returned by AWS Systems Manager that explains the Status
value. For example, a
Failed
status might be explained by the StatusInformation
message,
"The specified S3 bucket does not 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 OS platforms compatible with this Systems Manager 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 AWS Resource Types Reference in the AWS 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, etc.
String name
The name of the Systems Manager document.
String owner
The AWS 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 cannot 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 AWS Resource Types Reference in the AWS CloudFormation User Guide.
SdkInternalList<T> tags
The tags, or metadata, that have been applied to the document.
String key
The name of the filter key.
SdkInternalList<T> values
The value for the filter key.
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.
String name
The document name.
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 cannot 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 Systems Manager document, such as Creating
, Active
,
Failed
, and Deleting
.
String statusInformation
A message returned by AWS Systems Manager that explains the Status
value. For example, a
Failed
status might be explained by the StatusInformation
message,
"The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
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 document is initiated.
AutomationExecution automationExecution
Detailed information about the current state of an automation execution.
String commandId
(Required) The parent command ID of the invocation plugin.
String instanceId
(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
String pluginName
(Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned.
String commandId
The parent command ID of the invocation plugin.
String instanceId
The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
String comment
The comment text for the command.
String documentName
The name of the document that was run. For example, AWS-RunShellScript.
String documentVersion
The SSM document version used in the request.
String pluginName
The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.
Integer responseCode
The error level response code for the plugin script. If the response code is -1, then the command has not started running on the instance, or it was not received by the instance.
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 AWS CLI command uses the InvokedBefore
filter.
aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z
If the plugin has not started to run, the string is empty.
String executionElapsedTime
Duration since ExecutionStartDateTime.
String executionEndDateTime
The date and time the plugin was finished running. Date and time are written in ISO 8601 format. For example,
June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter
filter.
aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z
If the plugin has not 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 AWS Systems Manager User Guide. StatusDetails can be one of the following values:
Pending: The command has not been sent to the instance.
In Progress: The command has been sent to the instance but has not reached a terminal state.
Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again.
Success: The command or plugin was run successfully. This is a terminal state.
Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Execution Timed Out: The command started to run on the instance, but the execution was not complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't run successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
String standardOutputContent
The first 24,000 characters written by the plugin to stdout. If the command has not finished 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 S3. If an Amazon S3 bucket was not specified, then this string is empty.
String standardErrorContent
The first 8,000 characters written by the plugin to stderr. If the command has not finished running, then this string is empty.
String standardErrorUrl
The URL for the complete text written by the plugin to stderr. If the command has not finished running, then this string is empty.
CloudWatchOutputConfig cloudWatchOutputConfig
CloudWatch Logs information where Systems Manager sent the command output.
String target
The ID of the instance.
String operatingSystem
Returns the default patch baseline for the specified operating system.
String instanceId
The ID of the instance.
String snapshotId
The user-defined snapshot ID.
String snapshotDownloadUrl
A pre-signed 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 instance for the specified patch snapshot.
String name
The name of the Systems Manager 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 cannot 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 Systems Manager document.
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 cannot be changed.
String documentVersion
The document version.
String status
The status of the Systems Manager document, such as Creating
, Active
,
Updating
, Failed
, and Deleting
.
String statusInformation
A message returned by AWS Systems Manager that explains the Status
value. For example, a
Failed
status might be explained by the StatusInformation
message,
"The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
String content
The contents of the Systems Manager document.
String documentType
The document type.
String documentFormat
The document format, either JSON or YAML.
SdkInternalList<T> attachmentsContent
A description of the document attachments, including names, locations, sizes, etc.
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 instances 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 instance inventory.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String typeName
The type of inventory item to return.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
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. Only available for certain 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. Task types include the following: LAMBDA, STEP_FUNCTION, AUTOMATION, RUN_COMMAND.
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 CloudWatch 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 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 string is 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. Only available for certain status values.
Date startTime
The time the task execution started.
Date endTime
The time the task execution completed.
String windowId
The ID of the desired Maintenance Window.
String windowId
The ID of the created Maintenance Window.
String name
The name of the Maintenance Window.
String 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 will not 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 will not 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", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
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 Systems Manager stops scheduling new tasks for execution.
Boolean allowUnassociatedTargets
Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
Boolean enabled
Whether the Maintenance Windows is enabled.
Date createdDate
The date the Maintenance Window was created.
Date modifiedDate
The date the Maintenance Window was last modified.
String 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 TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTION tasks, the value is the state machine ARN.
String serviceRoleArn
The IAM service role to assume during task execution.
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.
String maxErrors
The maximum number of errors allowed before the task stops being scheduled.
LoggingInfo loggingInfo
The location in Amazon S3 where the task results are logged.
LoggingInfo
has been deprecated. To specify an S3 bucket to contain logs, instead use the
OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how 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 name
The name of a parameter you want to query.
Boolean withDecryption
Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
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.
Parameter parameter
Information about a parameter.
String path
The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. 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 action recursively for /a
and view /a/b
.
SdkInternalList<T> parameterFilters
Filters to limit the request results.
You can't filter using the parameter name.
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.
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 are not formatted correctly or do not run when executed.
String baselineId
The ID of the patch baseline to retrieve.
String baselineId
The ID of the retrieved patch baseline.
String name
The name of the patch baseline.
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 instances. The default value is 'false'. Applies to Linux instances 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 instances, including target operating systems and source repositories. Applies to Linux instances only.
String settingId
The ID of the service setting to get.
ServiceSetting serviceSetting
The query result of the current service setting.
S3OutputLocation s3Location
An Amazon S3 bucket where you want to store the results of this request.
S3OutputUrl s3OutputUrl
The URL of Amazon S3 bucket where you want to store the results of this request.
String associationId
The association ID.
String name
The name of the association.
String documentVersion
The association document verions.
String associationVersion
The version of the association applied to the instance.
String instanceId
The instance ID where the association was created.
Date executionDate
The date the instance association ran.
String status
Status information about the instance association.
String detailedStatus
Detailed status information about the instance association.
String executionSummary
Summary information about association execution.
String errorCode
An error code returned by the request to create the association.
InstanceAssociationOutputUrl outputUrl
A URL for an Amazon S3 bucket where you want to store the results of this request.
String associationName
The name of the association applied to the instance.
String instanceId
The instance ID.
String pingStatus
Connection status of SSM Agent.
Date lastPingDateTime
The date and time when agent last pinged Systems Manager service.
String agentVersion
The version of SSM Agent running on your Linux instance.
Boolean isLatestVersion
Indicates whether latest version of SSM Agent is running on your instance. Some older versions of Windows Server use the EC2Config service to process SSM requests. For this reason, this field does not indicate whether or not the latest version is installed on Windows managed instances.
String platformType
The operating system platform type.
String platformName
The name of the operating system platform running on your instance.
String platformVersion
The version of the OS platform running on your instance.
String activationId
The activation ID created by Systems Manager when the server or VM was registered.
String iamRole
The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instances. This call does not return the IAM role for Amazon EC2 instances.
Date registrationDate
The date the server or VM was registered with AWS as a managed instance.
String resourceType
The type of instance. Instances are either EC2 instances or managed instances.
String name
The name of the managed instance.
String iPAddress
The IP address of the managed instance.
String computerName
The fully qualified host name of the managed instance.
String associationStatus
The status of the association.
Date lastAssociationExecutionDate
The date the association was last run.
Date lastSuccessfulAssociationExecutionDate
The last date the association was successfully run.
InstanceAggregatedAssociationOverview associationOverview
Information about the association.
String key
The name of the filter.
SdkInternalList<T> valueSet
The filter values.
String key
The filter key name to describe your instances. For example:
"InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"| "AssociationStatus"|"Tag Key"
SdkInternalList<T> values
The filter values.
String instanceId
The ID of the managed instance the high-level patch compliance information was collected for.
String patchGroup
The name of the patch group the managed instance belongs to.
String baselineId
The ID of the patch baseline used to patch the instance.
String snapshotId
The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
String installOverrideList
An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list,
which you maintain in an Amazon 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 SSM Document AWS-RunPatchBaseline in the AWS 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 instance.
Integer installedOtherCount
The number of patches not specified in the patch baseline that are installed on the instance.
Integer installedRejectedCount
The number of instances with patches installed 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 instance but aren't currently installed.
Integer failedCount
The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
Integer unreportedNotApplicableCount
The number of patches beyond the supported limit of NotApplicableCount
that are not reported by name
to Systems Manager Inventory.
Integer notApplicableCount
The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't
installed on the instance. 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 instance.
Date operationEndTime
The time the most recent patching operation completed on the instance.
String operation
The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
String key
The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.
SdkInternalList<T> values
The value for the filter, must be an integer greater than or equal to 0.
String type
The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.
String typeName
String 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
action.
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 AWS 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 does not 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 instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal
String type
The type of filter. Valid values include the following: "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"
String 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 does not update the inventory item type contents if the MD5 hash has not 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 AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.
String version
The schema version for the inventory item.
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 does not update the inventory item type contents if the MD5 hash has not 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 does not meet the requirements. For information about parameter label requirements, see Labeling Parameters in the AWS Systems Manager User Guide.
SdkInternalList<T> associationFilterList
One or more filters. Use a filter to return a more specific list of results.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
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 instance ID.
Integer maxResults
(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
SdkInternalList<T> filters
(Optional) One or more filters. Use a filter to return a more specific list of results.
Boolean details
(Optional) If set this returns the response of the command executions and any command output. By default this is set to False.
SdkInternalList<T> commandInvocations
(Optional) A list of all invocations.
String nextToken
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
String commandId
(Optional) If provided, lists only the specified command.
String instanceId
(Optional) Lists commands issued against this instance ID.
Integer maxResults
(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
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.
SdkInternalList<T> documentFilterList
One or more filters. Use a filter to return a more specific list of results.
SdkInternalList<T> filters
One or more filters. Use a filter to return a more specific list of results.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
SdkInternalList<T> documentIdentifiers
The names of the Systems Manager documents.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String name
The name of the document about which you want version information.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
SdkInternalList<T> documentVersions
The document versions.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String instanceId
The instance ID for which you want inventory information.
String typeName
The type of inventory item for which you want information.
SdkInternalList<T> filters
One or more filters. Use a filter to return a more specific list of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String typeName
The type of inventory item returned by the request.
String instanceId
The instance ID targeted by the request to query inventory information.
String schemaVersion
The inventory schema version used by the instance(s).
String captureTime
The time that inventory information was collected for the instance(s).
SdkInternalList<T> entries
A list of inventory items on the instance(s).
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
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 instances. 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.
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 document 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 S3 bucket to contain logs, instead use the
OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how 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, 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. Only available for certain status values.
Date startTime
The time the execution started.
Date endTime
The time the execution finished.
String windowExecutionId
The ID of the Maintenance Window execution that ran the task.
String taskExecutionId
The ID of the specific task execution in the Maintenance Window execution.
String status
The status of the task execution.
String statusDetails
The details explaining the status of the task execution. Only available for certain status values.
Date startTime
The time the task execution started.
Date endTime
The time the task execution finished.
String taskArn
The ARN of the 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. Only available for certain Status values.
Date startTime
The time the invocation started.
Date endTime
The time the invocation finished.
String ownerInformation
User-provided value that was specified when the target was registered with the Maintenance Window. This was also included in any CloudWatch events raised during the task invocation.
String windowTargetId
The ID of the target definition in this Maintenance Window the invocation was performed for.
String key
The name of the filter.
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
Whether the Maintenance Window is enabled.
Integer duration
The duration of the Maintenance Window in hours.
Integer cutoff
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
String 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.
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 a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action 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 command(s) to run.
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.
NotificationConfig notificationConfig
Configurations for sending notifications about command status changes on a per-instance basis.
String outputS3BucketName
The name of the Amazon S3 bucket.
String outputS3KeyPrefix
The Amazon S3 bucket subfolder.
Map<K,V> parameters
The parameters for the RUN_COMMAND task execution.
String serviceRoleArn
The IAM service role to assume during task execution.
Integer timeoutSeconds
If this time is reached and the command has not 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 instances or tags.
Specify instances 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 CloudWatch events that are raised while running tasks for these targets in this Maintenance Window.
String name
The target name.
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 Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTION
tasks, it's the state machine ARN.
String type
The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
SdkInternalList<T> targets
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
Map<K,V> taskParameters
The parameters that should be passed to the task when it is 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 Amazon S3 bucket to write task-level logs to.
LoggingInfo
has been deprecated. To specify an S3 bucket to contain logs, instead use the
OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how Systems Manager handles these options
for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.
String serviceRoleArn
The role that should be assumed when running the task.
String maxConcurrency
The maximum number of targets this task can be run for, in parallel.
String maxErrors
The maximum number of errors allowed before this task stops being scheduled.
String name
The task name.
String description
A description of the task.
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_FUNCTION 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 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 AWS 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 AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
Integer nonCompliantCount
The total number of compliance items that are not compliant.
SeveritySummary severitySummary
A summary of the non-compliance severity by compliance type
String notificationArn
An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
SdkInternalList<T> notificationEvents
The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.
String notificationType
Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
String name
The name of the parameter.
String type
The type of parameter. Valid values include the following: String, String list, Secure string.
String value
The parameter value.
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 AWS 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 name
The name of the parameter.
String type
The type of parameter used.
String keyId
The ID of the query key used for this parameter.
Date lastModifiedDate
Date the parameter was last changed or updated.
String lastModifiedUser
Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
String description
Information about the parameter.
String value
The parameter value.
String 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.
String policyText
The JSON text of the policy.
String policyType
The type of policy. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
String policyStatus
The status of the policy. Policies report the following statuses: Pending (the policy has not been enforced or applied yet), Finished (the policy was applied), Failed (the policy was not 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, String list, Secure string.
String keyId
The ID of the query key used for this parameter.
Date lastModifiedDate
Date the parameter was last changed or updated.
String lastModifiedUser
Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
String description
Description of the parameter actions.
String 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 key
The name of the filter.
SdkInternalList<T> values
The filter values.
String key
The name of the filter.
String option
Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
SdkInternalList<T> values
The value you want to search for.
String id
The ID of the patch (this is different than the Microsoft Knowledge Base ID).
Date releaseDate
The date the patch was released.
String title
The title of the patch.
String description
The description of the patch.
String contentUrl
The URL where more information can be obtained about the patch.
String vendor
The name of the vendor providing the patch.
String productFamily
The product family the patch is applicable for (for example, Windows).
String product
The specific product the patch is applicable for (for example, WindowsServer2016).
String classification
The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).
String msrcSeverity
The severity of the patch (for example Critical, Important, Moderate).
String kbNumber
The Microsoft Knowledge Base ID of the patch.
String msrcNumber
The ID of the MSRC bulletin the patch is related to.
String language
The language of the patch if it's language-specific.
String 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. Note that 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 (for example, SecurityUpdates, Updates, CriticalUpdates).
String severity
The severity of the patch (for example, Critical, Important, Moderate).
String state
The state of the patch on the instance, such as INSTALLED or FAILED.
For descriptions of each patch state, see About Patch Compliance in the AWS Systems Manager User Guide.
Date installedTime
The date/time the patch was installed on the instance. Note that not all operating systems provide this level of information.
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. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational.
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.
Boolean enableNonSecurity
For instances 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 instances 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]
cachedir=/var/cache/yum/$basesearch$releasever
keepcache=0
debuglevel=2
String deploymentStatus
The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, EXPLICIT_REJECTED).
String complianceLevel
The compliance severity level for a patch.
Date approvalDate
The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).
Integer totalSteps
The total number of steps run in all specified AWS Regions and accounts for the current Automation execution.
Integer successSteps
The total number of steps that successfully completed in all specified AWS Regions and accounts for the current Automation execution.
Integer failedSteps
The total number of steps that failed to run in all specified AWS Regions and accounts for the current Automation execution.
Integer cancelledSteps
The total number of steps that the system cancelled in all specified AWS Regions and accounts for the current Automation execution.
Integer timedOutSteps
The total number of steps that timed out in all specified AWS Regions and accounts for the current Automation execution.
String resourceId
Specify an ID for this resource. For a managed instance, this is the instance 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, etc.
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 instanceId
One or more instance IDs where you want to add or update inventory items.
SdkInternalList<T> items
The inventory items that you want to add or update on instances.
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 example: /Dev/DBServer/MySQL/db-string13
Naming Constraints:
Parameter names are case sensitive.
A parameter name must be unique within an AWS Region
A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/
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 Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.
The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
String description
Information about the parameter that you want to add to the system. Optional but recommended.
Do not 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.
String type
The type of parameter that you want to add to the system.
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.
SecureString
is not currently supported for AWS CloudFormation templates or in the China Regions.
String keyId
The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS
KMS) key automatically assigned to your AWS 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 AWS account.
To use your default AWS 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. If not specified, will default to "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 name/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 action.
String tier
Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.
Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.
If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at 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. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.
String policies
One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store 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 does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.
ExpirationNotification: This policy triggers 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 triggers a CloudWatch event if a parameter has not 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 has not been changed.
All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.
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 actions 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 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 (either instances or tags).
Specify instances using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
Specify tags using either of the following formats:
Key=tag:<tag-key>,Values=<tag-value-1>,<tag-value-2>
Key=tag-key,Values=<tag-key-1>,<tag-key-2>
String ownerInformation
User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
String 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 instances or Maintenance Window targets).
Specify instances 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 role to assume when running the Maintenance Window task.
If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems
Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when
you run RegisterTaskWithMaintenanceWindow
without specifying a service role ARN.
For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS 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.
String maxErrors
The maximum number of errors allowed before this task stops being scheduled.
LoggingInfo loggingInfo
A structure containing information about an Amazon S3 bucket to write instance-level logs to.
LoggingInfo
has been deprecated. To specify an S3 bucket to contain logs, instead use the
OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how 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 windowTaskId
The ID of the task in the Maintenance Window.
String resourceType
The type of resource of which you want to remove a tag.
The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
String resourceId
The resource ID for which you want to remove tags. Use the ID of the resource. Here are some examples:
ManagedInstance: mi-012345abcde
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
For the Document and Parameter values, use the name of the resource.
The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance 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 ID of the service setting to reset.
ServiceSetting serviceSetting
The current, effective service setting after calling the ResetServiceSetting API action.
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 syncName
The name of the Resource Data Sync.
ResourceDataSyncS3Destination s3Destination
Configuration information for the target Amazon 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).
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 syncName
String bucketName
The name of the Amazon 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 AWS Region with the Amazon 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 Amazon S3 bucket.
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 instance.
String streamUrl
A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output
from the instance. Format:
wss://ssm-messages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
.
region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as
us-east-2
for the US East (Ohio) Region. For a list of supported region values, see the
Region column in the AWS
Systems Manager table of regions and endpoints in the AWS General Reference.
session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE
.
String outputS3Region
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
String outputS3BucketName
The name of the Amazon S3 bucket.
String outputS3KeyPrefix
The Amazon S3 bucket subfolder.
String outputUrl
A URL for an Amazon 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. Valid signal types include the following: Approve and Reject
Map<K,V> payload
The data sent with the signal. The data schema depends on the type of signal used in the request.
SdkInternalList<T> instanceIds
The instance IDs where the command should run. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use targets, see Sending Commands to a Fleet in the AWS Systems Manager User Guide.
SdkInternalList<T> targets
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use targets, see Sending Commands to a Fleet in the AWS Systems Manager User Guide.
String documentName
Required. The name of the Systems Manager document to run. This can be a public document or a custom document.
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 AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
--document-version "\$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 has not already started running, it will not 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 S3 bucket region.
String outputS3BucketName
The name of the S3 bucket where command execution responses should be stored.
String outputS3KeyPrefix
The directory structure within the S3 bucket where the responses should be stored.
String maxConcurrency
(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls in the AWS Systems Manager User Guide.
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 AWS Systems Manager User Guide.
String serviceRoleArn
The IAM role that Systems Manager uses to send notifications.
NotificationConfig notificationConfig
Configurations for sending notifications.
CloudWatchOutputConfig cloudWatchOutputConfig
Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
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 AWS 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 instance 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 AWS user account that started the session.
String details
Reserved for future use.
SessionManagerOutputUrl outputUrl
Reserved for future use.
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 an instance to which session connections have been made.
Owner: Specify an AWS 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
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 Automation document to use for this execution.
String documentVersion
The version of the Automation document to use for this execution.
Map<K,V> parameters
A key-value map of execution parameters, which match the declared parameters in the Automation document.
String 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 cannot 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 AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
String automationExecutionId
The unique ID of a newly scheduled automation execution.
String target
The instance 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
. If no document name is provided, a shell to the instance is launched by
default.
Map<K,V> parameters
Reserved for future use.
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 instance.
String streamUrl
A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output
from the instance. Format:
wss://ssm-messages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as
us-east-2
for the US East (Ohio) Region. For a list of supported region values, see the
Region column in the AWS
Systems Manager table of regions and endpoints in the AWS 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 is not populated.
Date executionEndTime
If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
String stepStatus
The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
String responseCode
The response code returned by the execution of the step.
Map<K,V> inputs
Fully-resolved values passed into the step before execution.
Map<K,V> outputs
Returned values from the execution of the step.
String response
A message associated with the response code for an execution.
String failureMessage
If a step failed, this message explains why the execution failed.
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 AWS Regions and 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 instances that meet the criteria. Key
can be
tag:<Amazon EC2 tag>
or InstanceIds
. For more information about how to send
commands that target instances using Key,Value
parameters, see Using Targets and Rate Controls to Send Commands to a Fleet in the AWS Systems Manager User Guide.
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 Amazon EC2 tags of
ServerRole,WebServer
. For more information about how to send commands that target instances using
Key,Value
parameters, see Using Targets and
Rate Controls to Send Commands to a Fleet in the AWS Systems Manager User Guide.
SdkInternalList<T> accounts
The AWS accounts targeted by the current Automation execution.
SdkInternalList<T> regions
The AWS Regions targeted by the current Automation execution.
String targetLocationMaxConcurrency
The maxium number of AWS accounts and AWS regions allowed to run the Automation concurrently
String targetLocationMaxErrors
The maxium 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.
String sessionId
The ID of the session to terminate.
String sessionId
The ID of the session that has been terminated.
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, you can reference the parameter using {{ssm:parameter-name}}
String documentVersion
The document version you want update for the association.
String scheduleExpression
The cron expression used to schedule the association that you want to update.
InstanceAssociationOutputLocation outputLocation
An Amazon S3 bucket where you want to store the results of this request.
String name
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-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 AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document
name. For example, AWS-ApplyPatchBaseline
or My-Document
.
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
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
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 instances 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 instance 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 instance will process its association within the limit specified for MaxConcurrency.
String complianceSeverity
The severity level to assign to the association.
AssociationDescription associationDescription
The description of the association that was updated.
String name
The name of the Systems Manager document.
String instanceId
The ID of the instance.
AssociationStatus associationStatus
The association status.
AssociationDescription associationDescription
Information about the association.
DocumentDefaultVersionDescription description
The description of a custom document that you want to set as the default version.
String content
A valid JSON or YAML string.
SdkInternalList<T> attachments
A list of key and value pairs that describe attachments to a version of a document.
String name
The name of the document that you want to update.
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 cannot be changed.
String documentVersion
The version of the document that you want to update.
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 time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
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", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
Integer duration
The duration of the Maintenance Window in hours.
Integer cutoff
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Boolean allowUnassociatedTargets
Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
Boolean enabled
Whether the Maintenance Window is enabled.
Boolean replace
If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not 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 will not 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 will not 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", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
Integer duration
The duration of the Maintenance Window in hours.
Integer cutoff
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Boolean allowUnassociatedTargets
Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
Boolean enabled
Whether the Maintenance Window is enabled.
String windowId
The 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 CloudWatch 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 action are also required for this API request. Optional fields that are not 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 instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.
String taskArn
The task ARN to modify.
String serviceRoleArn
The IAM service role ARN to modify. The system assumes this role during task execution.
If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems
Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when
you run RegisterTaskWithMaintenanceWindow
without specifying a service role ARN.
For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS 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.
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.
String maxErrors
The new MaxErrors
value to specify. MaxErrors
is the maximum number of errors that are
allowed before the task stops being scheduled.
LoggingInfo loggingInfo
The new logging location in Amazon S3 to specify.
LoggingInfo
has been deprecated. To specify an S3 bucket to contain logs, instead use the
OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how 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 RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.
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 updated service role ARN value.
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 S3 bucket to contain logs, instead use the
OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how 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 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 Package Name Formats for Approved and Rejected Patch Lists in the AWS 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 instances. The default value is 'false'. Applies to Linux instances 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 Package Name Formats for Approved and Rejected Patch Lists in the AWS 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, are not 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 instances, including target operating systems and source repositories. Applies to Linux instances only.
Boolean replace
If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not 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 instances. The default value is 'false'. Applies to Linux instances 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 instances, including target operating systems and source repositories. Applies to Linux instances only.
Copyright © 2019. All rights reserved.