"documentation":"<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>"
"documentation":"<p>Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.</p>"
"documentation":"<p>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>"
"documentation":"<p>Associates the specified SSM document with the specified instance.</p> <p>When you associate an SSM document with an instance, the configuration agent on the instance (SSM agent for Linux and EC2Config service for Windows) processes the document and configures the instance as specified.</p> <p>If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.</p>"
"documentation":"<p>Associates the specified SSM document with the specified instances.</p> <p>When you associate an SSM document with an instance, the configuration agent on the instance (SSM agent for Linux and EC2Config service for Windows) processes the document and configures the instance as specified.</p> <p>If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.</p>"
"documentation":"<p>Creates an SSM document.</p> <p>After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.</p>"
},
"DeleteActivation":{
"name":"DeleteActivation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteActivationRequest"},
"output":{"shape":"DeleteActivationResult"},
"errors":[
{"shape":"InvalidActivationId"},
{"shape":"InvalidActivation"},
{"shape":"InternalServerError"}
],
"documentation":"<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>"
"documentation":"<p>Disassociates the specified SSM document from the specified instance.</p> <p>When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.</p>"
"documentation":"<p>Deletes the SSM document and all instance associations to the document.</p> <p>Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.</p>"
"documentation":"<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":{
"name":"DescribeActivations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeActivationsRequest"},
"output":{"shape":"DescribeActivationsResult"},
"errors":[
{"shape":"InvalidFilter"},
{"shape":"InvalidNextToken"},
{"shape":"InternalServerError"}
],
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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 (Linux), 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>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<p>The ID created by SSM when you submitted the activation.</p>"
},
"Description":{
"shape":"ActivationDescription",
"documentation":"<p>A user defined description of the activation.</p>"
},
"DefaultInstanceName":{
"shape":"DefaultInstanceName",
"documentation":"<p>A name for the managed instance when it is created.</p>"
},
"IamRole":{
"shape":"IamRole",
"documentation":"<p>The Amazon Identity and Access Management (IAM) role to assign to the managed instance.</p>"
},
"RegistrationLimit":{
"shape":"RegistrationLimit",
"documentation":"<p>The maximum number of managed instances that can be registered using this activation.</p>"
},
"RegistrationsCount":{
"shape":"RegistrationsCount",
"documentation":"<p>The number of managed instances already registered with this activation.</p>"
},
"ExpirationDate":{
"shape":"ExpirationDate",
"documentation":"<p>The date when this activation can no longer be used to register managed instances.</p>"
},
"Expired":{
"shape":"Boolean",
"documentation":"<p>Whether or not the activation is expired.</p>"
},
"CreatedDate":{
"shape":"CreatedDate",
"documentation":"<p>The date the activation was created.</p>"
}
},
"documentation":"<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>"
"documentation":"<p>Specifies the type of resource you are tagging.</p>"
},
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The resource ID you want to tag.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<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>"
"documentation":"<p>(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.</p>"
"documentation":"<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>"
"documentation":"<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>"
},
"ServiceRole":{
"shape":"ServiceRole",
"documentation":"<p>The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes. </p>"
},
"NotificationConfig":{
"shape":"NotificationConfig",
"documentation":"<p>Configurations for sending notifications about command status changes. </p>"
"documentation":"<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>"
},
"NotificationConfig":{
"shape":"NotificationConfig",
"documentation":"<p>Configurations for sending notifications about command status changes on a per instance basis.</p>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<p>A user-defined description of the resource that you want to register with Amazon EC2. </p>"
},
"DefaultInstanceName":{
"shape":"DefaultInstanceName",
"documentation":"<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>"
},
"IamRole":{
"shape":"IamRole",
"documentation":"<p>The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. </p>"
},
"RegistrationLimit":{
"shape":"RegistrationLimit",
"documentation":"<p>Specify the maximum number of managed instances you want to register. The default value is 1 instance.</p>",
"box":true
},
"ExpirationDate":{
"shape":"ExpirationDate",
"documentation":"<p>The date by which this activation request should expire. The default value is 24 hours.</p>"
}
}
},
"CreateActivationResult":{
"type":"structure",
"members":{
"ActivationId":{
"shape":"ActivationId",
"documentation":"<p>The ID number generated by the system when it processed the activation. The activation ID functions like a user name.</p>"
},
"ActivationCode":{
"shape":"ActivationCode",
"documentation":"<p>The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID. </p>"
"documentation":"<p>The ID assigned to the managed instance when you registered it using the activation process. </p>"
}
}
},
"DeregisterManagedInstanceResult":{
"type":"structure",
"members":{
}
},
"DescribeActivationsFilter":{
"type":"structure",
"members":{
"FilterKey":{
"shape":"DescribeActivationsFilterKeys",
"documentation":"<p>The name of the filter.</p>"
},
"FilterValues":{
"shape":"StringList",
"documentation":"<p>The filter values.</p>"
}
},
"documentation":"<p>Filter for the DescribeActivation API.</p>"
},
"DescribeActivationsFilterKeys":{
"type":"string",
"enum":[
"ActivationIds",
"DefaultInstanceName",
"IamRole"
]
},
"DescribeActivationsFilterList":{
"type":"list",
"member":{"shape":"DescribeActivationsFilter"}
},
"DescribeActivationsRequest":{
"type":"structure",
"members":{
"Filters":{
"shape":"DescribeActivationsFilterList",
"documentation":"<p>A filter to view information about your activations.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token to start the list. Use this token to get the next set of results. </p>"
}
}
},
"DescribeActivationsResult":{
"type":"structure",
"members":{
"ActivationList":{
"shape":"ActivationList",
"documentation":"<p>A list of activations for your AWS account.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> The token for the next set of items to return. Use this token to get the next set of results. </p>"
"documentation":"<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </p>",
"documentation":"<p>The Sha256 or Sha1 hash created by the system when the document was created. </p> <note> <p>Sha1 hashes have been deprecated.</p> </note>"
},
"HashType":{
"shape":"DocumentHashType",
"documentation":"<p>Sha256 or Sha1.</p> <note> <p>Sha1 hashes have been deprecated.</p> </note>"
"documentation":"<p>The name of the parameter.</p>"
},
"Type":{
"shape":"DocumentParameterType",
"documentation":"<p>The type of parameter. The type can be either “String” or “StringList”.</p>"
},
"Description":{
"shape":"DocumentParameterDescrption",
"documentation":"<p>A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.</p>"
},
"DefaultValue":{
"shape":"DocumentParameterDefaultValue",
"documentation":"<p>If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.</p>"
"documentation":"<p>The 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>",
"documentation":"<p>The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.</p>",
"exception":true
},
"InvalidActivationId":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.</p>",
"documentation":"<p>The SSM document does not exist or the document is not available to the user. This exception can be issued by CreateAssociation, CreateAssociationBatch, DeleteAssociation, DeleteDocument, DescribeAssociation, DescribeDocument, GetDocument, SendCommand, or UpdateAssociationStatus. </p>"
"documentation":"<p>The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </p>",
"documentation":"<p>One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.</p>",
"documentation":"<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>",
"exception":true
},
"InvalidPermissionType":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The permission type is not supported. <i>Share</i> is the only supported permission type.</p>",
"exception":true
},
"InvalidResourceId":{
"type":"structure",
"members":{
},
"documentation":"<p>The resource ID is not valid. Verify that you entered the correct ID and try again.</p>",
"exception":true
},
"InvalidResourceType":{
"type":"structure",
"members":{
},
"documentation":"<p>The resource type is not valid. If you are attempting to tag an instance, the instance must be a registered, managed instance.</p>",
"exception":true
},
"InvalidRole":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<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>",
"documentation":"<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>",
"documentation":"<p>(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>",
"documentation":"<p>(Optional) If set this returns the response of the command executions and any command output. By default this is set to False. </p>"
"documentation":"<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>",
"documentation":"<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>",
"documentation":"<p>The name of the document that you want to share.</p>"
},
"PermissionType":{
"shape":"DocumentPermissionType",
"documentation":"<p>The permission type for the document. The permission type can be <i>Share</i>.</p>"
},
"AccountIdsToAdd":{
"shape":"AccountIdList",
"documentation":"<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>"
},
"AccountIdsToRemove":{
"shape":"AccountIdList",
"documentation":"<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>"
"documentation":"<p>An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. SSM pushes notifications about command status changes to this topic.</p>"
},
"NotificationEvents":{
"shape":"NotificationEventList",
"documentation":"<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":{
"shape":"NotificationType",
"documentation":"<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>"
}
},
"documentation":"<p>Configurations for sending notifications.</p>"
"documentation":"<p>Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.</p>"
},
"DocumentHash":{
"shape":"DocumentHash",
"documentation":"<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":{
"shape":"DocumentHashType",
"documentation":"<p>Sha256 or Sha1.</p> <note> <p>Sha1 hashes have been deprecated.</p> </note>"
"documentation":"<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>"
"documentation":"<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>",
"documentation":"<p>Amazon EC2 Simple Systems Manager (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\">ManagingWindowsInstanceConfiguration</a>.</p><p>SSMConfigandRunCommandincludethefollowingpre-defineddocuments.</p><p>
