"documentation":"<p>Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.</p>"
"documentation":"<p>Associates the specified SSM document with the specified instance.</p> <p>When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified.</p> <p>If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.</p>"
"documentation":"<p>Associates the specified SSM document with the specified instances.</p> <p>When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified.</p> <p>If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.</p>"
"documentation":"<p>Creates an SSM document.</p> <p>After you create an SSM document, you can use <a>CreateAssociation</a> to associate it with one or more running instances.</p>"
"documentation":"<p>Disassociates the specified SSM document from the specified instance.</p> <p>When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.</p>"
"documentation":"<p>Deletes the SSM document and all instance associations to the document.</p> <p>Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.</p>"
"documentation":"Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version, status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error."
"documentation":"An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution."
"documentation":"<p>The date when the status changed.</p>"
},
"Name":{
"shape":"AssociationStatusName",
"documentation":"<p>The status.</p>"
},
"Message":{
"shape":"StatusMessage",
"documentation":"<p>The reason for the status.</p>"
},
"AdditionalInfo":{
"shape":"StatusAdditionalInfo",
"documentation":"<p>A user-defined string.</p>"
}
},
"documentation":"<p>Describes an association status.</p>"
},
"AssociationStatusName":{
"type":"string",
"enum":[
"Pending",
"Success",
"Failed"
]
},
"BatchErrorMessage":{"type":"string"},
"Boolean":{"type":"boolean"},
"CancelCommandRequest":{
"type":"structure",
"required":["CommandId"],
"members":{
"CommandId":{
"shape":"CommandId",
"documentation":"The ID of the command you want to cancel."
},
"InstanceIds":{
"shape":"InstanceIdList",
"documentation":"<p>(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.</p>"
}
}
},
"CancelCommandResult":{
"type":"structure",
"members":{
},
"documentation":"<p>Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.</p>"
},
"Command":{
"type":"structure",
"members":{
"CommandId":{
"shape":"CommandId",
"documentation":"A unique identifier for this command."
},
"DocumentName":{
"shape":"DocumentName",
"documentation":"The name of the SSM document requested for execution."
},
"Comment":{
"shape":"Comment",
"documentation":"User-specified information about the command, such as a brief description of what the command should do."
},
"ExpiresAfter":{
"shape":"DateTime",
"documentation":"If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API."
},
"Parameters":{
"shape":"Parameters",
"documentation":"The parameter values to be inserted in the SSM document when executing the command."
},
"InstanceIds":{
"shape":"InstanceIdList",
"documentation":"The instance IDs against which this command was requested."
},
"RequestedDateTime":{
"shape":"DateTime",
"documentation":"The date and time the command was requested."
},
"Status":{
"shape":"CommandStatus",
"documentation":"The status of the command."
},
"OutputS3BucketName":{
"shape":"S3BucketName",
"documentation":"The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command."
},
"OutputS3KeyPrefix":{
"shape":"S3KeyPrefix",
"documentation":"The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command."
}
},
"documentation":"Describes a command request."
},
"CommandFilter":{
"type":"structure",
"required":[
"key",
"value"
],
"members":{
"key":{
"shape":"CommandFilterKey",
"documentation":"The name of the filter. For example, requested date and time."
},
"value":{
"shape":"CommandFilterValue",
"documentation":"The filter value. For example: June 30, 2015."
"documentation":"The command against which this invocation was requested."
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"The instance ID in which this invocation was requested."
},
"Comment":{
"shape":"Comment",
"documentation":"User-specified information about the command, such as a brief description of what the command should do."
},
"DocumentName":{
"shape":"DocumentName",
"documentation":"The document name that was requested for execution."
},
"RequestedDateTime":{
"shape":"DateTime",
"documentation":"The time and date the request was sent to this instance."
},
"Status":{
"shape":"CommandInvocationStatus",
"documentation":"Whether or not the invocation succeeded, failed, or is pending."
},
"TraceOutput":{
"shape":"InvocationTraceOutput",
"documentation":"Gets the trace output sent by the agent."
},
"CommandPlugins":{"shape":"CommandPluginList"}
},
"documentation":"An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you executed."
"documentation":"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."
"documentation":"The status of this plugin. You can execute a document with multiple plugins."
},
"ResponseCode":{
"shape":"ResponseCode",
"documentation":"A numeric response code generated after executing the plugin."
},
"ResponseStartDateTime":{
"shape":"DateTime",
"documentation":"The time the plugin started executing."
},
"ResponseFinishDateTime":{
"shape":"DateTime",
"documentation":"The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent."
},
"Output":{
"shape":"CommandPluginOutput",
"documentation":"Output of the plugin execution."
},
"OutputS3BucketName":{
"shape":"S3BucketName",
"documentation":"The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command."
},
"OutputS3KeyPrefix":{
"shape":"S3KeyPrefix",
"documentation":"The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command."
}
},
"documentation":"Describes plugin details."
},
"CommandPluginList":{
"type":"list",
"member":{"shape":"CommandPlugin"}
},
"CommandPluginName":{
"type":"string",
"min":4
},
"CommandPluginOutput":{
"type":"string",
"max":2500
},
"CommandPluginStatus":{
"type":"string",
"enum":[
"Pending",
"InProgress",
"Success",
"TimedOut",
"Cancelled",
"Failed"
]
},
"CommandStatus":{
"type":"string",
"enum":[
"Pending",
"InProgress",
"Cancelling",
"Success",
"TimedOut",
"Cancelled",
"Failed"
]
},
"Comment":{
"type":"string",
"max":100
},
"CreateAssociationBatchRequest":{
"type":"structure",
"required":["Entries"],
"members":{
"Entries":{
"shape":"CreateAssociationBatchRequestEntries",
"documentation":"<p>One or more associations.</p>"
}
}
},
"CreateAssociationBatchRequestEntries":{
"type":"list",
"member":{
"shape":"CreateAssociationBatchRequestEntry",
"locationName":"entries"
}
},
"CreateAssociationBatchRequestEntry":{
"type":"structure",
"members":{
"Name":{
"shape":"DocumentName",
"documentation":"The name of the configuration document."
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"The ID of the instance."
},
"Parameters":{
"shape":"Parameters",
"documentation":"A description of the parameters for a document."
}
},
"documentation":"Describes the association of an SSM document and an instance."
},
"CreateAssociationBatchResult":{
"type":"structure",
"members":{
"Successful":{
"shape":"AssociationDescriptionList",
"documentation":"<p>Information about the associations that succeeded.</p>"
},
"Failed":{
"shape":"FailedCreateAssociationList",
"documentation":"<p>Information about the associations that failed.</p>"
}
}
},
"CreateAssociationRequest":{
"type":"structure",
"required":[
"Name",
"InstanceId"
],
"members":{
"Name":{
"shape":"DocumentName",
"documentation":"<p>The name of the SSM document.</p>"
"documentation":"<p>Information about the association.</p>"
}
}
},
"CreateDocumentRequest":{
"type":"structure",
"required":[
"Content",
"Name"
],
"members":{
"Content":{
"shape":"DocumentContent",
"documentation":"<p>A valid JSON string. For more information about the contents of this string, see <a href=\"http://docs.aws.amazon.com/ssm/latest/APIReference/aws-ssm-document.html\">SSM Document</a>.</p>"
},
"Name":{
"shape":"DocumentName",
"documentation":"<p>A name for the SSM document.</p>"
}
}
},
"CreateDocumentResult":{
"type":"structure",
"members":{
"DocumentDescription":{
"shape":"DocumentDescription",
"documentation":"<p>Information about the SSM document.</p>"
}
}
},
"DateTime":{"type":"timestamp"},
"DeleteAssociationRequest":{
"type":"structure",
"required":[
"Name",
"InstanceId"
],
"members":{
"Name":{
"shape":"DocumentName",
"documentation":"<p>The name of the SSM document.</p>"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The ID of the instance.</p>"
}
}
},
"DeleteAssociationResult":{
"type":"structure",
"members":{
}
},
"DeleteDocumentRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"DocumentName",
"documentation":"<p>The name of the SSM document.</p>"
}
}
},
"DeleteDocumentResult":{
"type":"structure",
"members":{
}
},
"DescribeAssociationRequest":{
"type":"structure",
"required":[
"Name",
"InstanceId"
],
"members":{
"Name":{
"shape":"DocumentName",
"documentation":"<p>The name of the SSM document.</p>"
"documentation":"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.",
"documentation":"<p>The name of the parameter.</p>"
},
"Type":{
"shape":"DocumentParameterType",
"documentation":"<p>The type of parameter. The type can be either “String” or “StringList”.</p>"
},
"Description":{
"shape":"DocumentParameterDescrption",
"documentation":"<p>A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.</p>"
},
"DefaultValue":{
"shape":"DocumentParameterDefaultValue",
"documentation":"<p>If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.</p>"
"documentation":"<p>The SSM document does not exist or the document is not available to the user. This exception can be issued by CreateAssociation, CreateAssociationBatch, DeleteAssociation, DeleteDocument, DescribeAssociation, DescribeDocument, GetDocument, SendCommand, or UpdateAssociationStatus. </p>"
"documentation":"<p>The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </p>",
"documentation":"<p>The parameter values entered by the user do not work in the SSM document. For example, incorrect type. This exception can be issued by CreateAssociation, CreateAssociationBatch, or SendCommand. </p>"
"documentation":"You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document.",
"documentation":"<p>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.</p>",
"documentation":"(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.",
"documentation":"(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.",
"documentation":"<p>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.</p>",
"documentation":"<p>Simple Systems Manager (SSM) enables you to remotely manage the configuration of your Amazon EC2 instance. Using SSM, you can run scripts or commands using either EC2 Run Command or SSM Config. (SSM Config is currently available only for Windows instances.) </p> <p/> <b>Run Command</b> <p>Run Command provides an on-demand experience for executing commands. You can use pre-defined Amazon SSM documents to perform the actions listed later in this section, or you can create your own documents. With these documents, you can remotely configure your instances by sending commands using the <b>Commands</b> page in the <a href=\"http://console.aws.amazon.com/ec2/\">Amazon EC2 console</a>, <a href=\"http://docs.aws.amazon.com/powershell/latest/reference/items/Amazon_Simple_Systems_Management_cmdlets.html\">AWS Tools for Windows PowerShell</a>, or the <a href=\"http://docs.aws.amazon.com/cli/latest/reference/ssm/index.html\">AWS CLI</a>.</p> <p>Run Command reports the status of the command execution for each instance targeted by a command. You can also audit the command execution to understand who executed commands, when, and what changes were made. By switching between different SSM documents, you can quickly configure your instances with different types of commands. To get started with Run Command, verify that your environment meets the prerequisites for remotely running commands on EC2 instances (<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/remote-commands-prereq.html\">Linux</a> or <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/remote-commands-prereq.html\">Windows</a>). </p> <p/> <b>SSM Config</b> <p>SSM Config is a lightweight instance configuration solution. SSM Config is currently only available for Windows instances. With SSM Config, you can specify a setup configuration for your instances. SSM Config is similar to EC2 User Data, which is another way of running one-time scripts or applying settings during instance launch. SSM Config is an extension of this capability. Using SSM documents, you can specify which actions the system should perform on your instances, including which applications to install, which AWS Directory Service directory to join, which Microsoft PowerShell modules to install, etc. If an instance is missing one or more of these configurations, the system makes those changes. By default, the system checks every five minutes to see if there is a new configuration to apply as defined in a new SSM document. If so, the system updates the instances accordingly. In this way, you can remotely maintain a consistent configuration baseline on your instances. SSM Config is available using the AWS CLI or the AWS Tools for Windows PowerShell. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-configuration-manage.html\">Managing Windows Instance Configuration</a>.</p> <p>SSM Config and Run Command include the following pre-defined documents.</p> <table> <title>Amazon Pre-defined SSM Documents</title> <tgroup cols=\"3\"> <colspec colname=\"col1\" colnum=\"1\" colwidth=\"1*\"/> <colspec colname=\"col2\" colnum=\"2\" colwidth=\"1*\"/> <colspec colname=\"col3\" colnum=\"3\" colwidth=\"1*\"/><thead><row><entry>Name</entry><entry>Description</entry><entry>Platform</entry></row></thead><tbody><row><entry><p>AWS-RunShellScript</p></entry><entry><p>Runshellscripts</p></entry><entry><p>Linux</p></entry></row><row><entry><p>AWS-UpdateSSMAgent</p></entry><entry><p>UpdatetheAmazonSSMagent</p></entry><entry><p>Linux</p></entry></row><row><entry><p>AWS-JoinDirectoryServiceDomain</p></entry><entry><p>JoinanAWSDirectory</p></entry><entry><p>Windows</p></entry></row><row><entry><p>AWS-RunPowerShellScript</p></entry><entry><p>RunPowerShellcommandsorscripts</p></entry><entry><p>Windows</p></entry></row><row><entry><p>AWS-UpdateEC2Config</p></entry><entry><p>UpdatetheEC2Configservice</p></entry><entry><p>Windows</p></entry></row><row><entry><p>AWS-ConfigureWin