Associates the specified configuration document with the specified instance.
When you associate a configuration document with an instance, the configuration agent on the instance processes the configuration document and configures the instance as specified.
If you associate a configuration document with an instance that already has an associated configuration document, we replace the current configuration document with the new configuration document.
", - "CreateAssociationBatch": "Associates the specified configuration documents with the specified instances.
When you associate a configuration document with an instance, the configuration agent on the instance processes the configuration document and configures the instance as specified.
If you associate a configuration document with an instance that already has an associated configuration document, we replace the current configuration document with the new configuration document.
", - "CreateDocument": "Creates a configuration document.
After you create a configuration document, you can use CreateAssociation to associate it with one or more running instances.
", - "DeleteAssociation": "Disassociates the specified configuration document from the specified instance.
When you disassociate a configuration 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 configuration document, you must create a new configuration document with the desired configuration and associate it with the instance.
", - "DeleteDocument": "Deletes the specified configuration document.
You must use DeleteAssociation to disassociate all instances that are associated with the configuration document before you can delete it.
", - "DescribeAssociation": "Describes the associations for the specified configuration document or instance.
", - "DescribeDocument": "Describes the specified configuration document.
", - "GetDocument": "Gets the contents of the specified configuration document.
", - "ListAssociations": "Lists the associations for the specified configuration document or instance.
", - "ListDocuments": "Describes one or more of your configuration documents.
", - "UpdateAssociationStatus": "Updates the status of the configuration document associated with the specified instance.
" + "CancelCommand": "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.
", + "CreateAssociation": "Associates the specified SSM document with the specified instance.
When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
", + "CreateAssociationBatch": "Associates the specified SSM document with the specified instances.
When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
", + "CreateDocument": "Creates an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
", + "DeleteAssociation": "Disassociates the specified SSM document from the specified instance.
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.
", + "DeleteDocument": "Deletes the SSM document and all instance associations to the document.
Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
", + "DescribeAssociation": "Describes the associations for the specified SSM document or instance.
", + "DescribeDocument": "Describes the specified SSM document.
", + "DescribeInstanceInformation": "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.", + "GetDocument": "Gets the contents of the specified SSM document.
", + "ListAssociations": "Lists the associations for the specified SSM document or instance.
", + "ListCommandInvocations": "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.", + "ListCommands": "Lists the commands requested by users of the AWS account.
", + "ListDocuments": "Describes one or more of your SSM documents.
", + "SendCommand": "Executes commands on one or more remote instances.", + "UpdateAssociationStatus": "Updates the status of the SSM document associated with the specified instance.
" }, - "service": "Amazon EC2 Simple Systems Manager (SSM) enables you to configure and manage your EC2 instances. You can create a configuration document and then associate it with one or more running instances.
You can use a configuration document to automate the following tasks for your Windows instances:
Join an AWS Directory
Install, repair, or uninstall software using an MSI package
Run PowerShell scripts
Configure CloudWatch Logs to monitor applications and systems
Note that configuration documents are not supported on Linux instances.
", + "service": "Simple Systems Manager (SSM) is a set of capabilities that can help you manage your Amazon EC2 instances running on Windows. SSM enables you to run scripts or other common administrative tasks on your instances using either SSM Run Command or SSM Config.
Run Command extends the server administration capabilities of SSM by offering an on-demand experience for executing commands. You can use pre-defined Amazon SSM documents (formerly called configuration documents) to perform the actions listed later in this section, or you can create your own documents. With these document, you can then remotely configure your instances by sending commands using the AWS command line interface (CLI), AWS Tools for Windows PowerShell, or the Commands page in the Amazon EC2 console. Additionally, because Run Command enables you to execute PowerShell commands or scripts, you can administer your instances remotely using PowerShell as though you were logged on locally to the instance. 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.
SSM Config is a lightweight instance configuration solution. 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.
SSM is currently not supported on Linux instances.
You can use Run Command and SSM Config to do the following:
Join an AWS Directory Service directory (SSM Config and Run Command)
Install, repair, or uninstall software using an MSI package (SSM Config and Run Command)
Install PowerShell modules (SSM Config and Run Command)
Configure CloudWatch Logs to monitor applications and systems (SSM Config and Run Command)
Run PowerShell commands or scripts (Run Command only)
Update the EC2Config service (Run Command only)
Configure Windows Update settings (Run Command only)
SSM documents run with administrative privilege on Windows instances because the EC2Config service runs in the Local System account. If a user has permission to execute any of the pre-defined SSM documents (any document that begins with AWS-*) then that user also has administrator access to the instance. Delegate access to SSM Config and Run Command judiciously. This becomes extremely important if you create your own SSM documents. Amazon Web Services does not provide guidance about how to create secure SSM documents. You create SSM documents and delegate access to Run Command actions at your own risk. As a security best practice, we recommend that you assign access to \"AWS-*\" documents, especially the AWS-RunPowerShellScript document, to trusted administrators only. You can create low-level SSM documents for low security tasks and delegate access to non-administrators.
You must disassociate a configuration document from all instances before you can delete it.
", + "base": "You must disassociate an SSM document from all instances before you can delete it.
", "refs": { } }, "Association": { - "base": "Describes an association of a configuration document and an instance.
", + "base": "Describes an association of an SSM document and an instance.
", "refs": { "AssociationList$member": null } @@ -32,7 +37,7 @@ } }, "AssociationDescription": { - "base": "Describes an association.
", + "base": "Describes the parameters for a document.
", "refs": { "AssociationDescriptionList$member": null, "CreateAssociationResult$AssociationDescription": "Information about the association.
", @@ -105,6 +110,140 @@ "FailedCreateAssociation$Message": "A description of the failure.
" } }, + "Boolean": { + "base": null, + "refs": { + "InstanceInformation$IsLatestVersion": "Indicates whether latest version of the SSM agent is running on your instance.", + "ListCommandInvocationsRequest$Details": "(Optional) If set this returns the response of the command executions. By default this is set to False." + } + }, + "CancelCommandRequest": { + "base": null, + "refs": { + } + }, + "CancelCommandResult": { + "base": "Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.
", + "refs": { + } + }, + "Command": { + "base": "Describes a command request.", + "refs": { + "CommandList$member": null, + "SendCommandResult$Command": "The request as it was received by SSM. Also provides the command ID which can be used future references to this request." + } + }, + "CommandFilter": { + "base": "Describes a command filter.", + "refs": { + "CommandFilterList$member": null + } + }, + "CommandFilterKey": { + "base": null, + "refs": { + "CommandFilter$key": "The name of the filter. For example, requested date and time." + } + }, + "CommandFilterList": { + "base": null, + "refs": { + "ListCommandInvocationsRequest$Filters": "(Optional) One or more filters. Use a filter to return a more specific list of results.", + "ListCommandsRequest$Filters": "(Optional) One or more filters. Use a filter to return a more specific list of results." + } + }, + "CommandFilterValue": { + "base": null, + "refs": { + "CommandFilter$value": "The filter value. For example: June 30, 2015." + } + }, + "CommandId": { + "base": null, + "refs": { + "CancelCommandRequest$CommandId": "The ID of the command you want to cancel.", + "Command$CommandId": "A unique identifier for this command.", + "CommandInvocation$CommandId": "The command against which this invocation was requested.", + "ListCommandInvocationsRequest$CommandId": "(Optional) The invocations for a specific command ID.", + "ListCommandsRequest$CommandId": "(Optional) If provided, lists only the specified command." + } + }, + "CommandInvocation": { + "base": "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.", + "refs": { + "CommandInvocationList$member": null + } + }, + "CommandInvocationList": { + "base": null, + "refs": { + "ListCommandInvocationsResult$CommandInvocations": "(Optional) A list of all invocations." + } + }, + "CommandInvocationStatus": { + "base": null, + "refs": { + "CommandInvocation$Status": "Whether or not the invocation succeeded, failed, or is pending." + } + }, + "CommandList": { + "base": null, + "refs": { + "ListCommandsResult$Commands": "(Optional) The list of commands requested by the user." + } + }, + "CommandMaxResults": { + "base": null, + "refs": { + "ListCommandInvocationsRequest$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.", + "ListCommandsRequest$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." + } + }, + "CommandPlugin": { + "base": "Describes plugin details.", + "refs": { + "CommandPluginList$member": null + } + }, + "CommandPluginList": { + "base": null, + "refs": { + "CommandInvocation$CommandPlugins": null + } + }, + "CommandPluginName": { + "base": null, + "refs": { + "CommandPlugin$Name": "The name of the plugin. Must be one of the following: AWS-JoinDirectoryServiceDomain, AWS-InstallApplication, AWS-RunPowerShellScript, AWS-InstallPowerShellModule, AWS-ConfigureCloudWatch." + } + }, + "CommandPluginOutput": { + "base": null, + "refs": { + "CommandPlugin$Output": "Output of the plugin execution." + } + }, + "CommandPluginStatus": { + "base": null, + "refs": { + "CommandPlugin$Status": "The status of this plugin. You can execute a document with multiple plugins." + } + }, + "CommandStatus": { + "base": null, + "refs": { + "Command$Status": "The status of the command." + } + }, + "Comment": { + "base": null, + "refs": { + "Command$Comment": "User-specified information about the command, such as a brief description of what the command should do.", + "CommandInvocation$Comment": "User-specified information about the command, such as a brief description of what the command should do.", + "SendCommandRequest$Comment": "User-specified information about the command, such as a brief description of what the command should do." + } + }, "CreateAssociationBatchRequest": { "base": null, "refs": { @@ -117,7 +256,7 @@ } }, "CreateAssociationBatchRequestEntry": { - "base": "Describes the association of a configuration document and an instance.
", + "base": "Describes the association of an SSM document and an instance.", "refs": { "CreateAssociationBatchRequestEntries$member": null, "FailedCreateAssociation$Entry": "The association.
" @@ -153,7 +292,13 @@ "refs": { "AssociationDescription$Date": "The date when the association was made.
", "AssociationStatus$Date": "The date when the status changed.
", - "DocumentDescription$CreatedDate": "The date when the configuration document was created.
" + "Command$ExpiresAfter": "If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.", + "Command$RequestedDateTime": "The date and time the command was requested.", + "CommandInvocation$RequestedDateTime": "The time and date the request was sent to this instance.", + "CommandPlugin$ResponseStartDateTime": "The time the plugin started executing.", + "CommandPlugin$ResponseFinishDateTime": "The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.", + "DocumentDescription$CreatedDate": "The date when the SSM document was created.", + "InstanceInformation$LastPingDateTime": "The date and time when agent last pinged SSM service." } }, "DeleteAssociationRequest": { @@ -196,23 +341,39 @@ "refs": { } }, + "DescribeInstanceInformationRequest": { + "base": null, + "refs": { + } + }, + "DescribeInstanceInformationResult": { + "base": null, + "refs": { + } + }, + "DescriptionInDocument": { + "base": null, + "refs": { + "DocumentDescription$Description": "A description of the document." + } + }, "DocumentAlreadyExists": { - "base": "The specified configuration document already exists.
", + "base": "The specified SSM document already exists.
", "refs": { } }, "DocumentContent": { "base": null, "refs": { - "CreateDocumentRequest$Content": "A valid JSON file. For more information about the contents of this file, see Configuration Document.
", - "GetDocumentResult$Content": "The contents of the configuration document.
" + "CreateDocumentRequest$Content": "A valid JSON string. For more information about the contents of this string, see SSM Document.
", + "GetDocumentResult$Content": "The contents of the SSM document.
" } }, "DocumentDescription": { - "base": "Describes a configuration document.
", + "base": "Describes an SSM document.", "refs": { - "CreateDocumentResult$DocumentDescription": "Information about the configuration document.
", - "DescribeDocumentResult$Document": "Information about the configuration document.
" + "CreateDocumentResult$DocumentDescription": "Information about the SSM document.
", + "DescribeDocumentResult$Document": "Information about the SSM document.
" } }, "DocumentFilter": { @@ -240,7 +401,7 @@ } }, "DocumentIdentifier": { - "base": "Describes the name of a configuration document.
", + "base": "Describes the name of an SSM document.
", "refs": { "DocumentIdentifierList$member": null } @@ -248,31 +409,70 @@ "DocumentIdentifierList": { "base": null, "refs": { - "ListDocumentsResult$DocumentIdentifiers": "The names of the configuration documents.
" + "ListDocumentsResult$DocumentIdentifiers": "The names of the SSM documents.
" } }, "DocumentLimitExceeded": { - "base": "You can have at most 100 active configuration documents.
", + "base": "You can have at most 100 active SSM documents.
", "refs": { } }, "DocumentName": { "base": null, "refs": { - "Association$Name": "The name of the configuration document.
", - "AssociationDescription$Name": "The name of the configuration document.
", - "CreateAssociationBatchRequestEntry$Name": "The name of the configuration document.
", - "CreateAssociationRequest$Name": "The name of the configuration document.
", - "CreateDocumentRequest$Name": "A name for the configuration document.
", - "DeleteAssociationRequest$Name": "The name of the configuration document.
", - "DeleteDocumentRequest$Name": "The name of the configuration document.
", - "DescribeAssociationRequest$Name": "The name of the configuration document.
", - "DescribeDocumentRequest$Name": "The name of the configuration document.
", - "DocumentDescription$Name": "The name of the configuration document.
", - "DocumentIdentifier$Name": "The name of the configuration document.
", - "GetDocumentRequest$Name": "The name of the configuration document.
", - "GetDocumentResult$Name": "The name of the configuration document.
", - "UpdateAssociationStatusRequest$Name": "The name of the configuration document.
" + "Association$Name": "The name of the SSM document.
", + "AssociationDescription$Name": "The name of the SSM document.
", + "Command$DocumentName": "The name of the SSM document requested for execution.", + "CommandInvocation$DocumentName": "The document name that was requested for execution.", + "CreateAssociationBatchRequestEntry$Name": "The name of the configuration document.", + "CreateAssociationRequest$Name": "The name of the SSM document.
", + "CreateDocumentRequest$Name": "A name for the SSM document.
", + "DeleteAssociationRequest$Name": "The name of the SSM document.
", + "DeleteDocumentRequest$Name": "The name of the SSM document.
", + "DescribeAssociationRequest$Name": "The name of the SSM document.
", + "DescribeDocumentRequest$Name": "The name of the SSM document.
", + "DocumentDescription$Name": "The name of the SSM document.
", + "DocumentIdentifier$Name": "The name of the SSM document.
", + "GetDocumentRequest$Name": "The name of the SSM document.
", + "GetDocumentResult$Name": "The name of the SSM document.
", + "SendCommandRequest$DocumentName": "Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.", + "UpdateAssociationStatusRequest$Name": "The name of the SSM document.
" + } + }, + "DocumentParameter": { + "base": null, + "refs": { + "DocumentParameterList$member": null + } + }, + "DocumentParameterDefaultValue": { + "base": null, + "refs": { + "DocumentParameter$DefaultValue": "If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
" + } + }, + "DocumentParameterDescrption": { + "base": null, + "refs": { + "DocumentParameter$Description": "A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
" + } + }, + "DocumentParameterList": { + "base": null, + "refs": { + "DocumentDescription$Parameters": "A description of the parameters for a document.
" + } + }, + "DocumentParameterName": { + "base": null, + "refs": { + "DocumentParameter$Name": "The name of the parameter.
" + } + }, + "DocumentParameterType": { + "base": null, + "refs": { + "DocumentParameter$Type": "The type of parameter. The type can be either “String” or “StringList”.
" } }, "DocumentSha1": { @@ -284,7 +484,7 @@ "DocumentStatus": { "base": null, "refs": { - "DocumentDescription$Status": "The status of the configuration document.
" + "DocumentDescription$Status": "The status of the SSM document.
" } }, "DuplicateInstanceId": { @@ -325,30 +525,100 @@ "refs": { "Association$InstanceId": "The ID of the instance.
", "AssociationDescription$InstanceId": "The ID of the instance.
", - "CreateAssociationBatchRequestEntry$InstanceId": "The ID of the instance.
", - "CreateAssociationRequest$InstanceId": "The ID of the instance.
", + "CommandInvocation$InstanceId": "The instance ID in which this invocation was requested.", + "CreateAssociationBatchRequestEntry$InstanceId": "The ID of the instance.", + "CreateAssociationRequest$InstanceId": "The instance ID.
", "DeleteAssociationRequest$InstanceId": "The ID of the instance.
", "DescribeAssociationRequest$InstanceId": "The ID of the instance.
", + "InstanceIdList$member": null, + "InstanceInformation$InstanceId": "The instance ID.", + "ListCommandInvocationsRequest$InstanceId": "(Optional) The command execution details for a specific instance ID.", + "ListCommandsRequest$InstanceId": "(Optional) Lists commands issued against this instance ID.", "UpdateAssociationStatusRequest$InstanceId": "The ID of the instance.
" } }, + "InstanceIdList": { + "base": null, + "refs": { + "CancelCommandRequest$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.
", + "Command$InstanceIds": "The instance IDs against which this command was requested.", + "SendCommandRequest$InstanceIds": "Required. The instance IDs where the command should execute." + } + }, + "InstanceInformation": { + "base": "Describes a filter for a specific list of instances.", + "refs": { + "InstanceInformationList$member": null + } + }, + "InstanceInformationFilter": { + "base": "Describes a filter for a specific list of instances.", + "refs": { + "InstanceInformationFilterList$member": null + } + }, + "InstanceInformationFilterKey": { + "base": null, + "refs": { + "InstanceInformationFilter$key": "The name of the filter." + } + }, + "InstanceInformationFilterList": { + "base": null, + "refs": { + "DescribeInstanceInformationRequest$InstanceInformationFilterList": "One or more filters. Use a filter to return a more specific list of instances." + } + }, + "InstanceInformationFilterValue": { + "base": null, + "refs": { + "InstanceInformationFilterValueSet$member": null + } + }, + "InstanceInformationFilterValueSet": { + "base": null, + "refs": { + "InstanceInformationFilter$valueSet": "The filter values." + } + }, + "InstanceInformationList": { + "base": null, + "refs": { + "DescribeInstanceInformationResult$InstanceInformationList": "The instance information list." + } + }, "InternalServerError": { "base": "An error occurred on the server side.
", "refs": { } }, + "InvalidCommandId": { + "base": null, + "refs": { + } + }, "InvalidDocument": { - "base": "The configuration document is not valid.
", + "base": "The specified document does not exist.
", "refs": { } }, "InvalidDocumentContent": { - "base": "The content for the configuration document is not valid.
", + "base": "The content for the SSM document is not valid.
", + "refs": { + } + }, + "InvalidFilterKey": { + "base": "The specified key is not valid.", "refs": { } }, "InvalidInstanceId": { - "base": "You must specify the ID of a running instance.
", + "base": "The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
", + "refs": { + } + }, + "InvalidInstanceInformationFilterValue": { + "base": "The specified filter value is not valid.", "refs": { } }, @@ -357,6 +627,22 @@ "refs": { } }, + "InvalidOutputFolder": { + "base": "The S3 bucket does not exist.", + "refs": { + } + }, + "InvalidParameters": { + "base": "You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document.", + "refs": { + } + }, + "InvocationTraceOutput": { + "base": null, + "refs": { + "CommandInvocation$TraceOutput": "Gets the trace output sent by the agent." + } + }, "ListAssociationsRequest": { "base": null, "refs": { @@ -367,6 +653,26 @@ "refs": { } }, + "ListCommandInvocationsRequest": { + "base": null, + "refs": { + } + }, + "ListCommandInvocationsResult": { + "base": null, + "refs": { + } + }, + "ListCommandsRequest": { + "base": null, + "refs": { + } + }, + "ListCommandsResult": { + "base": null, + "refs": { + } + }, "ListDocumentsRequest": { "base": null, "refs": { @@ -378,7 +684,7 @@ } }, "MaxDocumentSizeExceeded": { - "base": "The size limit of a configuration document is 64 KB.
", + "base": "The size limit of an SSM document is 64 KB.
", "refs": { } }, @@ -389,15 +695,107 @@ "ListDocumentsRequest$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.
" } }, + "MaxResultsEC2Compatible": { + "base": null, + "refs": { + "DescribeInstanceInformationRequest$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." + } + }, "NextToken": { "base": null, "refs": { + "DescribeInstanceInformationRequest$NextToken": "The token for the next set of items to return. (You received this token from a previous call.)", + "DescribeInstanceInformationResult$NextToken": "The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.", "ListAssociationsRequest$NextToken": "The token for the next set of items to return. (You received this token from a previous call.)
", "ListAssociationsResult$NextToken": "The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", + "ListCommandInvocationsRequest$NextToken": "(Optional) The token for the next set of items to return. (You received this token from a previous call.)", + "ListCommandInvocationsResult$NextToken": "(Optional) The token for the next set of items to return. (You received this token from a previous call.)", + "ListCommandsRequest$NextToken": "(Optional) The token for the next set of items to return. (You received this token from a previous call.)", + "ListCommandsResult$NextToken": "(Optional) The token for the next set of items to return. (You received this token from a previous call.)", "ListDocumentsRequest$NextToken": "The token for the next set of items to return. (You received this token from a previous call.)
", "ListDocumentsResult$NextToken": "The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } }, + "ParameterName": { + "base": null, + "refs": { + "Parameters$key": null + } + }, + "ParameterValue": { + "base": null, + "refs": { + "ParameterValueList$member": null + } + }, + "ParameterValueList": { + "base": null, + "refs": { + "Parameters$value": null + } + }, + "Parameters": { + "base": null, + "refs": { + "AssociationDescription$Parameters": "A description of the parameters for a document.", + "Command$Parameters": "The parameter values to be inserted in the SSM document when executing the command.", + "CreateAssociationBatchRequestEntry$Parameters": "A description of the parameters for a document.", + "CreateAssociationRequest$Parameters": "The parameters for the document’s runtime configuration.", + "SendCommandRequest$Parameters": "The required and optional parameters specified in the SSM document being executed." + } + }, + "PingStatus": { + "base": null, + "refs": { + "InstanceInformation$PingStatus": "Connection status of the SSM agent." + } + }, + "PlatformType": { + "base": null, + "refs": { + "InstanceInformation$PlatformType": "The operating system platform type.", + "PlatformTypeList$member": null + } + }, + "PlatformTypeList": { + "base": null, + "refs": { + "DocumentDescription$PlatformTypes": "The list of OS platforms compatible with this SSM document.", + "DocumentIdentifier$PlatformTypes": "The operating system platform." + } + }, + "ResponseCode": { + "base": null, + "refs": { + "CommandPlugin$ResponseCode": "A numeric response code generated after executing the plugin." + } + }, + "S3BucketName": { + "base": null, + "refs": { + "Command$OutputS3BucketName": "The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.", + "CommandPlugin$OutputS3BucketName": "The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.", + "SendCommandRequest$OutputS3BucketName": "The name of the S3 bucket where command execution responses should be stored." + } + }, + "S3KeyPrefix": { + "base": null, + "refs": { + "Command$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.", + "CommandPlugin$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.", + "SendCommandRequest$OutputS3KeyPrefix": "The directory structure within the S3 bucket where the responses should be stored." + } + }, + "SendCommandRequest": { + "base": null, + "refs": { + } + }, + "SendCommandResult": { + "base": null, + "refs": { + } + }, "StatusAdditionalInfo": { "base": null, "refs": { @@ -418,7 +816,20 @@ "String": { "base": null, "refs": { - "InvalidDocumentContent$message": "A description of the validation error.
" + "InstanceInformation$PlatformName": "The name of the operating system platform running on your instance.", + "InstanceInformation$PlatformVersion": "The version of the OS platform running on your instance.", + "InternalServerError$message": "An error occurred on the server side.", + "InvalidDocument$message": "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.
", + "InvalidDocumentContent$message": "A description of the validation error.
", + "InvalidInstanceInformationFilterValue$message": null, + "InvalidParameters$message": "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.
", + "UnsupportedPlatformType$message": null + } + }, + "TimeoutSeconds": { + "base": null, + "refs": { + "SendCommandRequest$TimeoutSeconds": "If this time is reached and the command has not already started executing, it will not execute." } }, "TooManyUpdates": { @@ -426,6 +837,11 @@ "refs": { } }, + "UnsupportedPlatformType": { + "base": "The document does not support the platform type of the given instance ID(s).", + "refs": { + } + }, "UpdateAssociationStatusRequest": { "base": null, "refs": { @@ -435,6 +851,12 @@ "base": null, "refs": { } + }, + "Version": { + "base": null, + "refs": { + "InstanceInformation$AgentVersion": "The version of the SSM agent running on your instance." + } } } }