| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303 |
- {
- "version": "2.0",
- "service": "<p>This is the Amazon EC2 Simple Systems Manager (SSM) API Reference. SSM enables you to remotely manage the configuration of your Amazon EC2 instances, virtual machines (VMs), or servers in your on-premises environment or in an environment provided by other cloud providers using scripts, commands, or the Amazon EC2 console. SSM includes an on-demand solution called <i>Amazon EC2 Run Command</i> and a lightweight instance configuration solution called <i>SSM Config</i>. </p> <p>This references is intended to be used with the EC2 Run Command User Guide for <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/execute-remote-commands.html\">Linux</a> or <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/execute-remote-commands.html\">Windows</a>.</p> <note> <p>You must register your on-premises servers and VMs through an activation process before you can configure them using Run Command. Registered servers and VMs are called <i>managed instances</i>. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/managed-instances.html\">Setting Up Run Command On Managed Instances (On-Premises Servers and VMs) on Linux</a> or <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/managed-instances.html\">Setting Up Run Command On Managed Instances (On-Premises Servers and VMs) on Windows</a>.</p> </note> <p> <b>Run Command</b> </p> <p>Run Command provides an on-demand experience for executing commands. You can use pre-defined 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>, the <a href=\"http://docs.aws.amazon.com/cli/latest/reference/ssm/index.html\">AWS CLI</a>, or AWS SDKs.</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/> <p> <b>SSM Config</b> </p> <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> <p> <b>Linux</b> </p> <ul> <li> <p> <b>AWS-RunShellScript</b> to run shell scripts</p> </li> <li> <p> <b>AWS-UpdateSSMAgent</b> to update the Amazon SSM agent</p> </li> </ul> <p/> <p> <b>Windows</b> </p> <ul> <li> <p> <b>AWS-JoinDirectoryServiceDomain</b> to join an AWS Directory</p> </li> <li> <p> <b>AWS-RunPowerShellScript</b> to run PowerShell commands or scripts</p> </li> <li> <p> <b>AWS-UpdateEC2Config</b> to update the EC2Config service</p> </li> <li> <p> <b>AWS-ConfigureWindowsUpdate</b> to configure Windows Update settings</p> </li> <li> <p> <b>AWS-InstallApplication</b> to install, repair, or uninstall software using an MSI package</p> </li> <li> <p> <b>AWS-InstallPowerShellModule</b> to install PowerShell modules </p> </li> <li> <p> <b>AWS-ConfigureCloudWatch</b> to configure Amazon CloudWatch Logs to monitor applications and systems</p> </li> <li> <p> <b>AWS-ListWindowsInventory</b> to collect information about an EC2 instance running in Windows.</p> </li> <li> <p> <b>AWS-FindWindowsUpdates</b> to scan an instance and determines which updates are missing.</p> </li> <li> <p> <b>AWS-InstallMissingWindowsUpdates</b> to install missing updates on your EC2 instance.</p> </li> <li> <p> <b>AWS-InstallSpecificWindowsUpdates</b> to install one or more specific updates.</p> </li> </ul> <important> <p>The commands or scripts specified in SSM documents run with administrative privilege on your instances because the Amazon SSM agent runs as root on Linux and the EC2Config service runs in the Local System account on Windows. 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 Run Command and SSM Config 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 at your own risk. As a security best practice, we recommend that you assign access to \"AWS-*\" documents, especially the AWS-RunShellScript document on Linux and the AWS-RunPowerShellScript document on Windows, to trusted administrators only. You can create SSM documents for specific tasks and delegate access to non-administrators.</p> </important> <p>For information about creating and sharing SSM documents, see the following topics in the SSM User Guide: </p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-ssm-doc.html\">Creating SSM Documents</a> and <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssm-sharing.html\">Sharing SSM Documents</a> (Linux)</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/create-ssm-doc.html\">Creating SSM Documents</a> and <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ssm-sharing.html\">Sharing SSM Documents</a> (Windows)</p> </li> </ul>",
- "operations": {
- "AddTagsToResource": "<p>Adds or overwrites one or more tags for the specified resource. Tags are metadata that you assign to your managed instances. Tags enable you to categorize your managed instances in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 10 tags. </p> <p> We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters. </p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging Your Amazon EC2 Resources</a> in the Amazon EC2 User Guide. </p>",
- "CancelCommand": "<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>",
- "CreateActivation": "<p>Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/managed-instances.html\">Setting Up Managed Instances (Linux)</a> or <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/managed-instances.html\">Setting Up Managed Instances (Windows)</a> in the Amazon EC2 User Guide. </p>",
- "CreateAssociation": "<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>",
- "CreateAssociationBatch": "<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>",
- "CreateDocument": "<p>Creates an SSM document.</p> <p>After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.</p>",
- "DeleteActivation": "<p>Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.</p>",
- "DeleteAssociation": "<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>",
- "DeleteDocument": "<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>",
- "DeregisterManagedInstance": "<p>Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don’t plan to use Run Command on the server, we suggest uninstalling the SSM agent first.</p>",
- "DescribeActivations": "<p>Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.</p>",
- "DescribeAssociation": "<p>Describes the associations for the specified SSM document or instance.</p>",
- "DescribeDocument": "<p>Describes the specified SSM document.</p>",
- "DescribeDocumentPermission": "<p>Describes the permissions for an SSM document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user’s AWS account ID) or publicly (<i>All</i>). </p>",
- "DescribeInstanceInformation": "<p>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. </p>",
- "GetDocument": "<p>Gets the contents of the specified SSM document.</p>",
- "ListAssociations": "<p>Lists the associations for the specified SSM document or instance.</p>",
- "ListCommandInvocations": "<p>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.</p>",
- "ListCommands": "<p>Lists the commands requested by users of the AWS account.</p>",
- "ListDocuments": "<p>Describes one or more of your SSM documents.</p>",
- "ListTagsForResource": "<p>Returns a list of the tags assigned to the specified resource.</p>",
- "ModifyDocumentPermission": "<p>Share a document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify <i>All</i> as the account ID.</p>",
- "RemoveTagsFromResource": "<p>Removes all tags from the specified resource.</p>",
- "SendCommand": "<p>Executes commands on one or more remote instances.</p>",
- "UpdateAssociationStatus": "<p>Updates the status of the SSM document associated with the specified instance.</p>",
- "UpdateManagedInstanceRole": "<p>Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.</p>"
- },
- "shapes": {
- "AccountId": {
- "base": null,
- "refs": {
- "AccountIdList$member": null
- }
- },
- "AccountIdList": {
- "base": null,
- "refs": {
- "DescribeDocumentPermissionResponse$AccountIds": "<p>The account IDs that have permission to use this document. The ID can be either an AWS account or <i>All</i>.</p>",
- "ModifyDocumentPermissionRequest$AccountIdsToAdd": "<p>The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>.</p>",
- "ModifyDocumentPermissionRequest$AccountIdsToRemove": "<p>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 <i>All</i>. This action has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID to add and the same ID to remove, the system removes access to the document.</p>"
- }
- },
- "Activation": {
- "base": "<p>An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.</p>",
- "refs": {
- "ActivationList$member": null
- }
- },
- "ActivationCode": {
- "base": null,
- "refs": {
- "CreateActivationResult$ActivationCode": "<p>The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID. </p>"
- }
- },
- "ActivationDescription": {
- "base": null,
- "refs": {
- "Activation$Description": "<p>A user defined description of the activation.</p>",
- "CreateActivationRequest$Description": "<p>A user-defined description of the resource that you want to register with Amazon EC2. </p>"
- }
- },
- "ActivationId": {
- "base": null,
- "refs": {
- "Activation$ActivationId": "<p>The ID created by SSM when you submitted the activation.</p>",
- "CreateActivationResult$ActivationId": "<p>The ID number generated by the system when it processed the activation. The activation ID functions like a user name.</p>",
- "DeleteActivationRequest$ActivationId": "<p>The ID of the activation that you want to delete.</p>",
- "InstanceInformation$ActivationId": "<p>The activation ID created by SSM when the server or VM was registered.</p>"
- }
- },
- "ActivationList": {
- "base": null,
- "refs": {
- "DescribeActivationsResult$ActivationList": "<p>A list of activations for your AWS account.</p>"
- }
- },
- "AddTagsToResourceRequest": {
- "base": null,
- "refs": {
- }
- },
- "AddTagsToResourceResult": {
- "base": null,
- "refs": {
- }
- },
- "AssociatedInstances": {
- "base": "<p>You must disassociate an SSM document from all instances before you can delete it.</p>",
- "refs": {
- }
- },
- "Association": {
- "base": "<p>Describes an association of an SSM document and an instance.</p>",
- "refs": {
- "AssociationList$member": null
- }
- },
- "AssociationAlreadyExists": {
- "base": "<p>The specified association already exists.</p>",
- "refs": {
- }
- },
- "AssociationDescription": {
- "base": "<p>Describes the parameters for a document.</p>",
- "refs": {
- "AssociationDescriptionList$member": null,
- "CreateAssociationResult$AssociationDescription": "<p>Information about the association.</p>",
- "DescribeAssociationResult$AssociationDescription": "<p>Information about the association.</p>",
- "UpdateAssociationStatusResult$AssociationDescription": "<p>Information about the association.</p>"
- }
- },
- "AssociationDescriptionList": {
- "base": null,
- "refs": {
- "CreateAssociationBatchResult$Successful": "<p>Information about the associations that succeeded.</p>"
- }
- },
- "AssociationDoesNotExist": {
- "base": "<p>The specified association does not exist.</p>",
- "refs": {
- }
- },
- "AssociationFilter": {
- "base": "<p>Describes a filter.</p>",
- "refs": {
- "AssociationFilterList$member": null
- }
- },
- "AssociationFilterKey": {
- "base": null,
- "refs": {
- "AssociationFilter$key": "<p>The name of the filter.</p>"
- }
- },
- "AssociationFilterList": {
- "base": null,
- "refs": {
- "ListAssociationsRequest$AssociationFilterList": "<p>One or more filters. Use a filter to return a more specific list of results.</p>"
- }
- },
- "AssociationFilterValue": {
- "base": null,
- "refs": {
- "AssociationFilter$value": "<p>The filter value.</p>"
- }
- },
- "AssociationLimitExceeded": {
- "base": "<p>You can have at most 2,000 active associations.</p>",
- "refs": {
- }
- },
- "AssociationList": {
- "base": null,
- "refs": {
- "ListAssociationsResult$Associations": "<p>The associations.</p>"
- }
- },
- "AssociationStatus": {
- "base": "<p>Describes an association status.</p>",
- "refs": {
- "AssociationDescription$Status": "<p>The association status.</p>",
- "UpdateAssociationStatusRequest$AssociationStatus": "<p>The association status.</p>"
- }
- },
- "AssociationStatusName": {
- "base": null,
- "refs": {
- "AssociationStatus$Name": "<p>The status.</p>"
- }
- },
- "BatchErrorMessage": {
- "base": null,
- "refs": {
- "FailedCreateAssociation$Message": "<p>A description of the failure.</p>"
- }
- },
- "Boolean": {
- "base": null,
- "refs": {
- "Activation$Expired": "<p>Whether or not the activation is expired.</p>",
- "InstanceInformation$IsLatestVersion": "<p>Indicates whether latest version of the SSM agent is running on your instance. </p>",
- "ListCommandInvocationsRequest$Details": "<p>(Optional) If set this returns the response of the command executions and any command output. By default this is set to False. </p>"
- }
- },
- "CancelCommandRequest": {
- "base": "<p/>",
- "refs": {
- }
- },
- "CancelCommandResult": {
- "base": "<p>Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.</p>",
- "refs": {
- }
- },
- "Command": {
- "base": "<p>Describes a command request.</p>",
- "refs": {
- "CommandList$member": null,
- "SendCommandResult$Command": "<p>The request as it was received by SSM. Also provides the command ID which can be used future references to this request.</p>"
- }
- },
- "CommandFilter": {
- "base": "<p>Describes a command filter.</p>",
- "refs": {
- "CommandFilterList$member": null
- }
- },
- "CommandFilterKey": {
- "base": null,
- "refs": {
- "CommandFilter$key": "<p>The name of the filter. For example, requested date and time.</p>"
- }
- },
- "CommandFilterList": {
- "base": null,
- "refs": {
- "ListCommandInvocationsRequest$Filters": "<p>(Optional) One or more filters. Use a filter to return a more specific list of results.</p>",
- "ListCommandsRequest$Filters": "<p>(Optional) One or more filters. Use a filter to return a more specific list of results. </p>"
- }
- },
- "CommandFilterValue": {
- "base": null,
- "refs": {
- "CommandFilter$value": "<p>The filter value. For example: June 30, 2015.</p>"
- }
- },
- "CommandId": {
- "base": null,
- "refs": {
- "CancelCommandRequest$CommandId": "<p>The ID of the command you want to cancel.</p>",
- "Command$CommandId": "<p>A unique identifier for this command.</p>",
- "CommandInvocation$CommandId": "<p>The command against which this invocation was requested.</p>",
- "ListCommandInvocationsRequest$CommandId": "<p>(Optional) The invocations for a specific command ID.</p>",
- "ListCommandsRequest$CommandId": "<p>(Optional) If provided, lists only the specified command.</p>"
- }
- },
- "CommandInvocation": {
- "base": "<p>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. </p>",
- "refs": {
- "CommandInvocationList$member": null
- }
- },
- "CommandInvocationList": {
- "base": null,
- "refs": {
- "ListCommandInvocationsResult$CommandInvocations": "<p>(Optional) A list of all invocations. </p>"
- }
- },
- "CommandInvocationStatus": {
- "base": null,
- "refs": {
- "CommandInvocation$Status": "<p>Whether or not the invocation succeeded, failed, or is pending.</p>"
- }
- },
- "CommandList": {
- "base": null,
- "refs": {
- "ListCommandsResult$Commands": "<p>(Optional) The list of commands requested by the user. </p>"
- }
- },
- "CommandMaxResults": {
- "base": null,
- "refs": {
- "ListCommandInvocationsRequest$MaxResults": "<p>(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.</p>",
- "ListCommandsRequest$MaxResults": "<p>(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.</p>"
- }
- },
- "CommandPlugin": {
- "base": "<p>Describes plugin details.</p>",
- "refs": {
- "CommandPluginList$member": null
- }
- },
- "CommandPluginList": {
- "base": null,
- "refs": {
- "CommandInvocation$CommandPlugins": null
- }
- },
- "CommandPluginName": {
- "base": null,
- "refs": {
- "CommandPlugin$Name": "<p>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. </p>"
- }
- },
- "CommandPluginOutput": {
- "base": null,
- "refs": {
- "CommandPlugin$Output": "<p>Output of the plugin execution.</p>"
- }
- },
- "CommandPluginStatus": {
- "base": null,
- "refs": {
- "CommandPlugin$Status": "<p>The status of this plugin. You can execute a document with multiple plugins.</p>"
- }
- },
- "CommandStatus": {
- "base": null,
- "refs": {
- "Command$Status": "<p>The status of the command.</p>"
- }
- },
- "Comment": {
- "base": null,
- "refs": {
- "Command$Comment": "<p>User-specified information about the command, such as a brief description of what the command should do.</p>",
- "CommandInvocation$Comment": "<p>User-specified information about the command, such as a brief description of what the command should do.</p>",
- "SendCommandRequest$Comment": "<p>User-specified information about the command, such as a brief description of what the command should do.</p>"
- }
- },
- "ComputerName": {
- "base": null,
- "refs": {
- "InstanceInformation$ComputerName": "<p>The fully qualified host name of the managed instance.</p>"
- }
- },
- "CreateActivationRequest": {
- "base": null,
- "refs": {
- }
- },
- "CreateActivationResult": {
- "base": null,
- "refs": {
- }
- },
- "CreateAssociationBatchRequest": {
- "base": null,
- "refs": {
- }
- },
- "CreateAssociationBatchRequestEntries": {
- "base": null,
- "refs": {
- "CreateAssociationBatchRequest$Entries": "<p>One or more associations.</p>"
- }
- },
- "CreateAssociationBatchRequestEntry": {
- "base": "<p> Describes the association of an SSM document and an instance. </p>",
- "refs": {
- "CreateAssociationBatchRequestEntries$member": null,
- "FailedCreateAssociation$Entry": "<p>The association.</p>"
- }
- },
- "CreateAssociationBatchResult": {
- "base": null,
- "refs": {
- }
- },
- "CreateAssociationRequest": {
- "base": null,
- "refs": {
- }
- },
- "CreateAssociationResult": {
- "base": null,
- "refs": {
- }
- },
- "CreateDocumentRequest": {
- "base": null,
- "refs": {
- }
- },
- "CreateDocumentResult": {
- "base": null,
- "refs": {
- }
- },
- "CreatedDate": {
- "base": null,
- "refs": {
- "Activation$CreatedDate": "<p>The date the activation was created.</p>"
- }
- },
- "DateTime": {
- "base": null,
- "refs": {
- "AssociationDescription$Date": "<p>The date when the association was made.</p>",
- "AssociationStatus$Date": "<p>The date when the status changed.</p>",
- "Command$ExpiresAfter": "<p>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.</p>",
- "Command$RequestedDateTime": "<p>The date and time the command was requested.</p>",
- "CommandInvocation$RequestedDateTime": "<p>The time and date the request was sent to this instance.</p>",
- "CommandPlugin$ResponseStartDateTime": "<p>The time the plugin started executing. </p>",
- "CommandPlugin$ResponseFinishDateTime": "<p>The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent. </p>",
- "DocumentDescription$CreatedDate": "<p> The date when the SSM document was created. </p>",
- "InstanceInformation$LastPingDateTime": "<p>The date and time when agent last pinged SSM service. </p>",
- "InstanceInformation$RegistrationDate": "<p>The date the server or VM was registered with AWS as a managed instance.</p>"
- }
- },
- "DefaultInstanceName": {
- "base": null,
- "refs": {
- "Activation$DefaultInstanceName": "<p>A name for the managed instance when it is created.</p>",
- "CreateActivationRequest$DefaultInstanceName": "<p>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.</p>"
- }
- },
- "DeleteActivationRequest": {
- "base": null,
- "refs": {
- }
- },
- "DeleteActivationResult": {
- "base": null,
- "refs": {
- }
- },
- "DeleteAssociationRequest": {
- "base": null,
- "refs": {
- }
- },
- "DeleteAssociationResult": {
- "base": null,
- "refs": {
- }
- },
- "DeleteDocumentRequest": {
- "base": null,
- "refs": {
- }
- },
- "DeleteDocumentResult": {
- "base": null,
- "refs": {
- }
- },
- "DeregisterManagedInstanceRequest": {
- "base": null,
- "refs": {
- }
- },
- "DeregisterManagedInstanceResult": {
- "base": null,
- "refs": {
- }
- },
- "DescribeActivationsFilter": {
- "base": "<p>Filter for the DescribeActivation API.</p>",
- "refs": {
- "DescribeActivationsFilterList$member": null
- }
- },
- "DescribeActivationsFilterKeys": {
- "base": null,
- "refs": {
- "DescribeActivationsFilter$FilterKey": "<p>The name of the filter.</p>"
- }
- },
- "DescribeActivationsFilterList": {
- "base": null,
- "refs": {
- "DescribeActivationsRequest$Filters": "<p>A filter to view information about your activations.</p>"
- }
- },
- "DescribeActivationsRequest": {
- "base": null,
- "refs": {
- }
- },
- "DescribeActivationsResult": {
- "base": null,
- "refs": {
- }
- },
- "DescribeAssociationRequest": {
- "base": null,
- "refs": {
- }
- },
- "DescribeAssociationResult": {
- "base": null,
- "refs": {
- }
- },
- "DescribeDocumentPermissionRequest": {
- "base": null,
- "refs": {
- }
- },
- "DescribeDocumentPermissionResponse": {
- "base": null,
- "refs": {
- }
- },
- "DescribeDocumentRequest": {
- "base": null,
- "refs": {
- }
- },
- "DescribeDocumentResult": {
- "base": null,
- "refs": {
- }
- },
- "DescribeInstanceInformationRequest": {
- "base": null,
- "refs": {
- }
- },
- "DescribeInstanceInformationResult": {
- "base": null,
- "refs": {
- }
- },
- "DescriptionInDocument": {
- "base": null,
- "refs": {
- "DocumentDescription$Description": "<p> A description of the document. </p>"
- }
- },
- "DocumentARN": {
- "base": null,
- "refs": {
- "DescribeDocumentRequest$Name": "<p>The name of the SSM document.</p>",
- "DocumentDescription$Name": "<p>The name of the SSM document.</p>",
- "DocumentIdentifier$Name": "<p>The name of the SSM document.</p>",
- "GetDocumentRequest$Name": "<p>The name of the SSM document.</p>",
- "GetDocumentResult$Name": "<p>The name of the SSM document.</p>",
- "SendCommandRequest$DocumentName": "<p>Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.</p>"
- }
- },
- "DocumentAlreadyExists": {
- "base": "<p>The specified SSM document already exists.</p>",
- "refs": {
- }
- },
- "DocumentContent": {
- "base": null,
- "refs": {
- "CreateDocumentRequest$Content": "<p>A valid JSON string.</p>",
- "GetDocumentResult$Content": "<p>The contents of the SSM document.</p>"
- }
- },
- "DocumentDescription": {
- "base": "<p> Describes an SSM document. </p>",
- "refs": {
- "CreateDocumentResult$DocumentDescription": "<p>Information about the SSM document.</p>",
- "DescribeDocumentResult$Document": "<p>Information about the SSM document.</p>"
- }
- },
- "DocumentFilter": {
- "base": "<p>Describes a filter.</p>",
- "refs": {
- "DocumentFilterList$member": null
- }
- },
- "DocumentFilterKey": {
- "base": null,
- "refs": {
- "DocumentFilter$key": "<p>The name of the filter.</p>"
- }
- },
- "DocumentFilterList": {
- "base": null,
- "refs": {
- "ListDocumentsRequest$DocumentFilterList": "<p>One or more filters. Use a filter to return a more specific list of results.</p>"
- }
- },
- "DocumentFilterValue": {
- "base": null,
- "refs": {
- "DocumentFilter$value": "<p>The value of the filter.</p>"
- }
- },
- "DocumentHash": {
- "base": null,
- "refs": {
- "DocumentDescription$Hash": "<p>The Sha256 or Sha1 hash created by the system when the document was created. </p> <note> <p>Sha1 hashes have been deprecated.</p> </note>",
- "SendCommandRequest$DocumentHash": "<p>The Sha256 or Sha1 hash created by the system when the document was created. </p> <note> <p>Sha1 hashes have been deprecated.</p> </note>"
- }
- },
- "DocumentHashType": {
- "base": null,
- "refs": {
- "DocumentDescription$HashType": "<p>Sha256 or Sha1.</p> <note> <p>Sha1 hashes have been deprecated.</p> </note>",
- "SendCommandRequest$DocumentHashType": "<p>Sha256 or Sha1.</p> <note> <p>Sha1 hashes have been deprecated.</p> </note>"
- }
- },
- "DocumentIdentifier": {
- "base": "<p>Describes the name of an SSM document.</p>",
- "refs": {
- "DocumentIdentifierList$member": null
- }
- },
- "DocumentIdentifierList": {
- "base": null,
- "refs": {
- "ListDocumentsResult$DocumentIdentifiers": "<p>The names of the SSM documents.</p>"
- }
- },
- "DocumentLimitExceeded": {
- "base": "<p>You can have at most 100 active SSM documents.</p>",
- "refs": {
- }
- },
- "DocumentName": {
- "base": null,
- "refs": {
- "Association$Name": "<p>The name of the SSM document.</p>",
- "AssociationDescription$Name": "<p>The name of the SSM document.</p>",
- "Command$DocumentName": "<p>The name of the SSM document requested for execution.</p>",
- "CommandInvocation$DocumentName": "<p>The document name that was requested for execution.</p>",
- "CreateAssociationBatchRequestEntry$Name": "<p> The name of the configuration document. </p>",
- "CreateAssociationRequest$Name": "<p>The name of the SSM document.</p>",
- "CreateDocumentRequest$Name": "<p>A name for the SSM document.</p>",
- "DeleteAssociationRequest$Name": "<p>The name of the SSM document.</p>",
- "DeleteDocumentRequest$Name": "<p>The name of the SSM document.</p>",
- "DescribeAssociationRequest$Name": "<p>The name of the SSM document.</p>",
- "DescribeDocumentPermissionRequest$Name": "<p>The name of the document for which you are the owner.</p>",
- "ModifyDocumentPermissionRequest$Name": "<p>The name of the document that you want to share.</p>",
- "UpdateAssociationStatusRequest$Name": "<p>The name of the SSM document.</p>"
- }
- },
- "DocumentOwner": {
- "base": null,
- "refs": {
- "DocumentDescription$Owner": "<p>The AWS user account of the person who created the document.</p>",
- "DocumentIdentifier$Owner": "<p>The AWS user account of the person who created the document.</p>"
- }
- },
- "DocumentParameter": {
- "base": "<p>Parameters specified in the SSM document that execute on the server when the command is run. </p>",
- "refs": {
- "DocumentParameterList$member": null
- }
- },
- "DocumentParameterDefaultValue": {
- "base": null,
- "refs": {
- "DocumentParameter$DefaultValue": "<p>If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.</p>"
- }
- },
- "DocumentParameterDescrption": {
- "base": null,
- "refs": {
- "DocumentParameter$Description": "<p>A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.</p>"
- }
- },
- "DocumentParameterList": {
- "base": null,
- "refs": {
- "DocumentDescription$Parameters": "<p>A description of the parameters for a document.</p>"
- }
- },
- "DocumentParameterName": {
- "base": null,
- "refs": {
- "DocumentParameter$Name": "<p>The name of the parameter.</p>"
- }
- },
- "DocumentParameterType": {
- "base": null,
- "refs": {
- "DocumentParameter$Type": "<p>The type of parameter. The type can be either “String” or “StringList”.</p>"
- }
- },
- "DocumentPermissionLimit": {
- "base": "<p>The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS Support.</p>",
- "refs": {
- }
- },
- "DocumentPermissionType": {
- "base": null,
- "refs": {
- "DescribeDocumentPermissionRequest$PermissionType": "<p>The permission type for the document. The permission type can be <i>Share</i>.</p>",
- "ModifyDocumentPermissionRequest$PermissionType": "<p>The permission type for the document. The permission type can be <i>Share</i>.</p>"
- }
- },
- "DocumentSha1": {
- "base": null,
- "refs": {
- "DocumentDescription$Sha1": "<p>The SHA1 hash of the document, which you can use for verification purposes.</p>"
- }
- },
- "DocumentStatus": {
- "base": null,
- "refs": {
- "DocumentDescription$Status": "<p>The status of the SSM document.</p>"
- }
- },
- "DuplicateInstanceId": {
- "base": "<p>You cannot specify an instance ID in more than one association.</p>",
- "refs": {
- }
- },
- "ExpirationDate": {
- "base": null,
- "refs": {
- "Activation$ExpirationDate": "<p>The date when this activation can no longer be used to register managed instances.</p>",
- "CreateActivationRequest$ExpirationDate": "<p>The date by which this activation request should expire. The default value is 24 hours.</p>"
- }
- },
- "FailedCreateAssociation": {
- "base": "<p>Describes a failed association.</p>",
- "refs": {
- "FailedCreateAssociationList$member": null
- }
- },
- "FailedCreateAssociationList": {
- "base": null,
- "refs": {
- "CreateAssociationBatchResult$Failed": "<p>Information about the associations that failed.</p>"
- }
- },
- "Fault": {
- "base": null,
- "refs": {
- "FailedCreateAssociation$Fault": "<p>The source of the failure.</p>"
- }
- },
- "GetDocumentRequest": {
- "base": null,
- "refs": {
- }
- },
- "GetDocumentResult": {
- "base": null,
- "refs": {
- }
- },
- "IPAddress": {
- "base": null,
- "refs": {
- "InstanceInformation$IPAddress": "<p>The IP address of the managed instance.</p>"
- }
- },
- "IamRole": {
- "base": null,
- "refs": {
- "Activation$IamRole": "<p>The Amazon Identity and Access Management (IAM) role to assign to the managed instance.</p>",
- "CreateActivationRequest$IamRole": "<p>The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. </p>",
- "InstanceInformation$IamRole": "<p>The Amazon Identity and Access Management (IAM) role assigned to EC2 instances or managed instances. </p>",
- "UpdateManagedInstanceRoleRequest$IamRole": "<p>The IAM role you want to assign or change.</p>"
- }
- },
- "InstanceId": {
- "base": null,
- "refs": {
- "Association$InstanceId": "<p>The ID of the instance.</p>",
- "AssociationDescription$InstanceId": "<p>The ID of the instance.</p>",
- "CommandInvocation$InstanceId": "<p>The instance ID in which this invocation was requested.</p>",
- "CreateAssociationBatchRequestEntry$InstanceId": "<p> The ID of the instance. </p>",
- "CreateAssociationRequest$InstanceId": "<p>The instance ID.</p>",
- "DeleteAssociationRequest$InstanceId": "<p>The ID of the instance.</p>",
- "DescribeAssociationRequest$InstanceId": "<p>The instance ID.</p>",
- "InstanceIdList$member": null,
- "InstanceInformation$InstanceId": "<p>The instance ID. </p>",
- "ListCommandInvocationsRequest$InstanceId": "<p>(Optional) The command execution details for a specific instance ID.</p>",
- "ListCommandsRequest$InstanceId": "<p>(Optional) Lists commands issued against this instance ID.</p>",
- "UpdateAssociationStatusRequest$InstanceId": "<p>The ID of the instance.</p>"
- }
- },
- "InstanceIdList": {
- "base": null,
- "refs": {
- "CancelCommandRequest$InstanceIds": "<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>",
- "Command$InstanceIds": "<p>The instance IDs against which this command was requested.</p>",
- "SendCommandRequest$InstanceIds": "<p>Required. The instance IDs where the command should execute. You can specify a maximum of 50 IDs.</p>"
- }
- },
- "InstanceInformation": {
- "base": "<p>Describes a filter for a specific list of instances. </p>",
- "refs": {
- "InstanceInformationList$member": null
- }
- },
- "InstanceInformationFilter": {
- "base": "<p>Describes a filter for a specific list of instances. </p>",
- "refs": {
- "InstanceInformationFilterList$member": null
- }
- },
- "InstanceInformationFilterKey": {
- "base": null,
- "refs": {
- "InstanceInformationFilter$key": "<p>The name of the filter. </p>"
- }
- },
- "InstanceInformationFilterList": {
- "base": null,
- "refs": {
- "DescribeInstanceInformationRequest$InstanceInformationFilterList": "<p>One or more filters. Use a filter to return a more specific list of instances.</p>"
- }
- },
- "InstanceInformationFilterValue": {
- "base": null,
- "refs": {
- "InstanceInformationFilterValueSet$member": null
- }
- },
- "InstanceInformationFilterValueSet": {
- "base": null,
- "refs": {
- "InstanceInformationFilter$valueSet": "<p>The filter values. </p>"
- }
- },
- "InstanceInformationList": {
- "base": null,
- "refs": {
- "DescribeInstanceInformationResult$InstanceInformationList": "<p>The instance information list.</p>"
- }
- },
- "InternalServerError": {
- "base": "<p>An error occurred on the server side.</p>",
- "refs": {
- }
- },
- "InvalidActivation": {
- "base": "<p>The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.</p>",
- "refs": {
- }
- },
- "InvalidActivationId": {
- "base": "<p>The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.</p>",
- "refs": {
- }
- },
- "InvalidCommandId": {
- "base": null,
- "refs": {
- }
- },
- "InvalidDocument": {
- "base": "<p>The specified document does not exist.</p>",
- "refs": {
- }
- },
- "InvalidDocumentContent": {
- "base": "<p>The content for the SSM document is not valid.</p>",
- "refs": {
- }
- },
- "InvalidDocumentOperation": {
- "base": "<p>You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.</p>",
- "refs": {
- }
- },
- "InvalidFilter": {
- "base": "<p>The filter name is not valid. Verify the you entered the correct name and try again.</p>",
- "refs": {
- }
- },
- "InvalidFilterKey": {
- "base": "<p>The specified key is not valid.</p>",
- "refs": {
- }
- },
- "InvalidInstanceId": {
- "base": "<p>The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </p>",
- "refs": {
- }
- },
- "InvalidInstanceInformationFilterValue": {
- "base": "<p>The specified filter value is not valid.</p>",
- "refs": {
- }
- },
- "InvalidNextToken": {
- "base": "<p>The specified token is not valid.</p>",
- "refs": {
- }
- },
- "InvalidNotificationConfig": {
- "base": "<p>One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.</p>",
- "refs": {
- }
- },
- "InvalidOutputFolder": {
- "base": "<p>The S3 bucket does not exist.</p>",
- "refs": {
- }
- },
- "InvalidParameters": {
- "base": "<p>You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document.</p>",
- "refs": {
- }
- },
- "InvalidPermissionType": {
- "base": "<p>The permission type is not supported. <i>Share</i> is the only supported permission type.</p>",
- "refs": {
- }
- },
- "InvalidResourceId": {
- "base": "<p>The resource ID is not valid. Verify that you entered the correct ID and try again.</p>",
- "refs": {
- }
- },
- "InvalidResourceType": {
- "base": "<p>The resource type is not valid. If you are attempting to tag an instance, the instance must be a registered, managed instance.</p>",
- "refs": {
- }
- },
- "InvalidRole": {
- "base": "<p>The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for SSM notifications, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/rc-sns.html\">Configuring SNS Notifications SSM</a> in the <i>Amazon Elastic Compute Cloud User Guide </i>.</p>",
- "refs": {
- }
- },
- "InvocationTraceOutput": {
- "base": null,
- "refs": {
- "CommandInvocation$TraceOutput": "<p> Gets the trace output sent by the agent. </p>"
- }
- },
- "KeyList": {
- "base": null,
- "refs": {
- "RemoveTagsFromResourceRequest$TagKeys": "<p>Tag keys that you want to remove from the specified resource.</p>"
- }
- },
- "ListAssociationsRequest": {
- "base": null,
- "refs": {
- }
- },
- "ListAssociationsResult": {
- "base": null,
- "refs": {
- }
- },
- "ListCommandInvocationsRequest": {
- "base": null,
- "refs": {
- }
- },
- "ListCommandInvocationsResult": {
- "base": null,
- "refs": {
- }
- },
- "ListCommandsRequest": {
- "base": null,
- "refs": {
- }
- },
- "ListCommandsResult": {
- "base": null,
- "refs": {
- }
- },
- "ListDocumentsRequest": {
- "base": null,
- "refs": {
- }
- },
- "ListDocumentsResult": {
- "base": null,
- "refs": {
- }
- },
- "ListTagsForResourceRequest": {
- "base": null,
- "refs": {
- }
- },
- "ListTagsForResourceResult": {
- "base": null,
- "refs": {
- }
- },
- "ManagedInstanceId": {
- "base": null,
- "refs": {
- "DeregisterManagedInstanceRequest$InstanceId": "<p>The ID assigned to the managed instance when you registered it using the activation process. </p>",
- "UpdateManagedInstanceRoleRequest$InstanceId": "<p>The ID of the managed instance where you want to update the role.</p>"
- }
- },
- "MaxDocumentSizeExceeded": {
- "base": "<p>The size limit of an SSM document is 64 KB.</p>",
- "refs": {
- }
- },
- "MaxResults": {
- "base": null,
- "refs": {
- "DescribeActivationsRequest$MaxResults": "<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>",
- "ListAssociationsRequest$MaxResults": "<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>",
- "ListDocumentsRequest$MaxResults": "<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>"
- }
- },
- "MaxResultsEC2Compatible": {
- "base": null,
- "refs": {
- "DescribeInstanceInformationRequest$MaxResults": "<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>"
- }
- },
- "ModifyDocumentPermissionRequest": {
- "base": null,
- "refs": {
- }
- },
- "ModifyDocumentPermissionResponse": {
- "base": null,
- "refs": {
- }
- },
- "NextToken": {
- "base": null,
- "refs": {
- "DescribeActivationsRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>",
- "DescribeActivationsResult$NextToken": "<p> The token for the next set of items to return. Use this token to get the next set of results. </p>",
- "DescribeInstanceInformationRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>",
- "DescribeInstanceInformationResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </p>",
- "ListAssociationsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>",
- "ListAssociationsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>",
- "ListCommandInvocationsRequest$NextToken": "<p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>",
- "ListCommandInvocationsResult$NextToken": "<p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>",
- "ListCommandsRequest$NextToken": "<p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>",
- "ListCommandsResult$NextToken": "<p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>",
- "ListDocumentsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>",
- "ListDocumentsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
- }
- },
- "NotificationArn": {
- "base": null,
- "refs": {
- "NotificationConfig$NotificationArn": "<p>An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. SSM pushes notifications about command status changes to this topic.</p>"
- }
- },
- "NotificationConfig": {
- "base": "<p>Configurations for sending notifications.</p>",
- "refs": {
- "Command$NotificationConfig": "<p>Configurations for sending notifications about command status changes. </p>",
- "CommandInvocation$NotificationConfig": "<p>Configurations for sending notifications about command status changes on a per instance basis.</p>",
- "SendCommandRequest$NotificationConfig": "<p>Configurations for sending notifications.</p>"
- }
- },
- "NotificationEvent": {
- "base": null,
- "refs": {
- "NotificationEventList$member": null
- }
- },
- "NotificationEventList": {
- "base": null,
- "refs": {
- "NotificationConfig$NotificationEvents": "<p>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 <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitor-commands.html\">Monitoring Commands</a> in the <i>Amazon Elastic Compute Cloud User Guide </i>.</p>"
- }
- },
- "NotificationType": {
- "base": null,
- "refs": {
- "NotificationConfig$NotificationType": "<p>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. </p>"
- }
- },
- "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": "<p>A description of the parameters for a document. </p>",
- "Command$Parameters": "<p>The parameter values to be inserted in the SSM document when executing the command.</p>",
- "CreateAssociationBatchRequestEntry$Parameters": "<p>A description of the parameters for a document. </p>",
- "CreateAssociationRequest$Parameters": "<p>The parameters for the documents runtime configuration. </p>",
- "SendCommandRequest$Parameters": "<p>The required and optional parameters specified in the SSM document being executed.</p>"
- }
- },
- "PingStatus": {
- "base": null,
- "refs": {
- "InstanceInformation$PingStatus": "<p>Connection status of the SSM agent. </p>"
- }
- },
- "PlatformType": {
- "base": null,
- "refs": {
- "InstanceInformation$PlatformType": "<p>The operating system platform type. </p>",
- "PlatformTypeList$member": null
- }
- },
- "PlatformTypeList": {
- "base": null,
- "refs": {
- "DocumentDescription$PlatformTypes": "<p>The list of OS platforms compatible with this SSM document. </p>",
- "DocumentIdentifier$PlatformTypes": "<p>The operating system platform. </p>"
- }
- },
- "RegistrationLimit": {
- "base": null,
- "refs": {
- "Activation$RegistrationLimit": "<p>The maximum number of managed instances that can be registered using this activation.</p>",
- "CreateActivationRequest$RegistrationLimit": "<p>Specify the maximum number of managed instances you want to register. The default value is 1 instance.</p>"
- }
- },
- "RegistrationsCount": {
- "base": null,
- "refs": {
- "Activation$RegistrationsCount": "<p>The number of managed instances already registered with this activation.</p>"
- }
- },
- "RemoveTagsFromResourceRequest": {
- "base": null,
- "refs": {
- }
- },
- "RemoveTagsFromResourceResult": {
- "base": null,
- "refs": {
- }
- },
- "ResourceId": {
- "base": null,
- "refs": {
- "AddTagsToResourceRequest$ResourceId": "<p>The resource ID you want to tag.</p>",
- "ListTagsForResourceRequest$ResourceId": "<p>The resource ID for which you want to see a list of tags.</p>",
- "RemoveTagsFromResourceRequest$ResourceId": "<p>The resource ID for which you want to remove tags.</p>"
- }
- },
- "ResourceType": {
- "base": null,
- "refs": {
- "InstanceInformation$ResourceType": "<p>The type of instance. Instances are either EC2 instances or managed instances. </p>"
- }
- },
- "ResourceTypeForTagging": {
- "base": null,
- "refs": {
- "AddTagsToResourceRequest$ResourceType": "<p>Specifies the type of resource you are tagging.</p>",
- "ListTagsForResourceRequest$ResourceType": "<p>Returns a list of tags for a specific resource type.</p>",
- "RemoveTagsFromResourceRequest$ResourceType": "<p>The type of resource of which you want to remove a tag.</p>"
- }
- },
- "ResponseCode": {
- "base": null,
- "refs": {
- "CommandPlugin$ResponseCode": "<p>A numeric response code generated after executing the plugin. </p>"
- }
- },
- "S3BucketName": {
- "base": null,
- "refs": {
- "Command$OutputS3BucketName": "<p>The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.</p>",
- "CommandPlugin$OutputS3BucketName": "<p>The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.</p>",
- "SendCommandRequest$OutputS3BucketName": "<p>The name of the S3 bucket where command execution responses should be stored.</p>"
- }
- },
- "S3KeyPrefix": {
- "base": null,
- "refs": {
- "Command$OutputS3KeyPrefix": "<p>The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.</p>",
- "CommandPlugin$OutputS3KeyPrefix": "<p>The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. </p>",
- "SendCommandRequest$OutputS3KeyPrefix": "<p>The directory structure within the S3 bucket where the responses should be stored.</p>"
- }
- },
- "SendCommandRequest": {
- "base": null,
- "refs": {
- }
- },
- "SendCommandResult": {
- "base": null,
- "refs": {
- }
- },
- "ServiceRole": {
- "base": null,
- "refs": {
- "Command$ServiceRole": "<p>The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes. </p>",
- "CommandInvocation$ServiceRole": "<p>The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes on a per instance basis.</p>",
- "SendCommandRequest$ServiceRoleArn": "<p>The IAM role that SSM uses to send notifications. </p>"
- }
- },
- "StatusAdditionalInfo": {
- "base": null,
- "refs": {
- "AssociationStatus$AdditionalInfo": "<p>A user-defined string.</p>"
- }
- },
- "StatusMessage": {
- "base": null,
- "refs": {
- "AssociationStatus$Message": "<p>The reason for the status.</p>"
- }
- },
- "StatusUnchanged": {
- "base": "<p>The updated status is the same as the current status.</p>",
- "refs": {
- }
- },
- "String": {
- "base": null,
- "refs": {
- "DocumentAlreadyExists$Message": null,
- "DocumentLimitExceeded$Message": null,
- "DocumentPermissionLimit$Message": null,
- "InstanceInformation$PlatformName": "<p>The name of the operating system platform running on your instance. </p>",
- "InstanceInformation$PlatformVersion": "<p>The version of the OS platform running on your instance. </p>",
- "InstanceInformation$Name": "<p>The name of the managed instance.</p>",
- "InternalServerError$Message": null,
- "InvalidActivation$Message": null,
- "InvalidActivationId$Message": null,
- "InvalidDocument$Message": "<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>",
- "InvalidDocumentContent$Message": "<p>A description of the validation error.</p>",
- "InvalidDocumentOperation$Message": null,
- "InvalidFilter$Message": null,
- "InvalidInstanceId$Message": null,
- "InvalidInstanceInformationFilterValue$message": null,
- "InvalidNotificationConfig$Message": null,
- "InvalidParameters$Message": null,
- "InvalidPermissionType$Message": null,
- "InvalidRole$Message": null,
- "MaxDocumentSizeExceeded$Message": null,
- "StringList$member": null,
- "UnsupportedPlatformType$Message": null
- }
- },
- "StringList": {
- "base": null,
- "refs": {
- "DescribeActivationsFilter$FilterValues": "<p>The filter values.</p>"
- }
- },
- "Tag": {
- "base": "<p> Metadata that you assign to your managed instances. Tags enable you to categorize your managed instances in different ways, for example, by purpose, owner, or environment.</p>",
- "refs": {
- "TagList$member": null
- }
- },
- "TagKey": {
- "base": null,
- "refs": {
- "KeyList$member": null,
- "Tag$Key": "<p>The name of the tag.</p>"
- }
- },
- "TagList": {
- "base": null,
- "refs": {
- "AddTagsToResourceRequest$Tags": "<p> 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. </p>",
- "ListTagsForResourceResult$TagList": "<p>A list of tags.</p>"
- }
- },
- "TagValue": {
- "base": null,
- "refs": {
- "Tag$Value": "<p>The value of the tag.</p>"
- }
- },
- "TimeoutSeconds": {
- "base": null,
- "refs": {
- "SendCommandRequest$TimeoutSeconds": "<p>If this time is reached and the command has not already started executing, it will not execute.</p>"
- }
- },
- "TooManyUpdates": {
- "base": "<p>There are concurrent updates for a resource that supports one update at a time.</p>",
- "refs": {
- }
- },
- "UnsupportedPlatformType": {
- "base": "<p>The document does not support the platform type of the given instance ID(s). For example, you sent an SSM document for a Windows instance to a Linux instance.</p>",
- "refs": {
- }
- },
- "UpdateAssociationStatusRequest": {
- "base": null,
- "refs": {
- }
- },
- "UpdateAssociationStatusResult": {
- "base": null,
- "refs": {
- }
- },
- "UpdateManagedInstanceRoleRequest": {
- "base": null,
- "refs": {
- }
- },
- "UpdateManagedInstanceRoleResult": {
- "base": null,
- "refs": {
- }
- },
- "Version": {
- "base": null,
- "refs": {
- "InstanceInformation$AgentVersion": "<p>The version of the SSM agent running on your instance. </p>"
- }
- }
- }
- }
|