Run Command provides an on-demand experience for executing commands. You can use pre-defined Amazon SSM documents to perform the actions listed later in this section, or you can create your own documents. With these documents, you can remotely configure your instances by sending commands using the Commands page in the Amazon EC2 console, AWS Tools for Windows PowerShell, or the AWS CLI.
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 (Linux or Windows).
SSM ConfigSSM 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 Managing Windows Instance Configuration.
SSM Config and Run Command include the following pre-defined documents.
Inheritance Hierarchy
Amazon.Runtime.AmazonServiceClient
Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient
Namespace: Amazon.SimpleSystemsManagement
Assembly: AWSSDK.dll
Version: (assembly version)
Syntax
public class AmazonSimpleSystemsManagementClient : AmazonServiceClient IAmazonSimpleSystemsManagement, IDisposable
The AmazonSimpleSystemsManagementClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonSimpleSystemsManagementClient() |
Constructs AmazonSimpleSystemsManagementClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonSimpleSystemsManagementClient(RegionEndpoint) |
Constructs AmazonSimpleSystemsManagementClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonSimpleSystemsManagementClient(AmazonSimpleSystemsManagementConfig) |
Constructs AmazonSimpleSystemsManagementClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonSimpleSystemsManagementClient(AWSCredentials) | Constructs AmazonSimpleSystemsManagementClient with AWS Credentials |
|
|
AmazonSimpleSystemsManagementClient(AWSCredentials, RegionEndpoint) | Constructs AmazonSimpleSystemsManagementClient with AWS Credentials |
|
|
AmazonSimpleSystemsManagementClient(AWSCredentials, AmazonSimpleSystemsManagementConfig) | Constructs AmazonSimpleSystemsManagementClient with AWS Credentials and an AmazonSimpleSystemsManagementClient Configuration object. |
|
|
AmazonSimpleSystemsManagementClient(string, string) | Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonSimpleSystemsManagementClient(string, string, RegionEndpoint) | Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonSimpleSystemsManagementClient(string, string, AmazonSimpleSystemsManagementConfig) | Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleSystemsManagementClient Configuration object. |
|
|
AmazonSimpleSystemsManagementClient(string, string, string) | Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonSimpleSystemsManagementClient(string, string, string, RegionEndpoint) | Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonSimpleSystemsManagementClient(string, string, string, AmazonSimpleSystemsManagementConfig) | Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleSystemsManagementClient Configuration object. |
Methods
| Name | Description | |
|---|---|---|
|
|
CancelCommand(string) | 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. |
|
|
CancelCommand(string, List<String>) | 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. |
|
|
CancelCommand(CancelCommandRequest) | 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. |
|
|
CancelCommandAsync(CancelCommandRequest, CancellationToken) | Initiates the asynchronous execution of the CancelCommand operation. |
|
|
CreateAssociation(string, string) |
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. |
|
|
CreateAssociation(CreateAssociationRequest) |
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. |
|
|
CreateAssociationAsync(CreateAssociationRequest, CancellationToken) | Initiates the asynchronous execution of the CreateAssociation operation. |
|
|
CreateAssociationBatch(CreateAssociationBatchRequest) |
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. |
|
|
CreateAssociationBatchAsync(CreateAssociationBatchRequest, CancellationToken) | Initiates the asynchronous execution of the CreateAssociationBatch operation. |
|
|
CreateDocument(string, string) |
Creates an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances. |
|
|
CreateDocument(CreateDocumentRequest) |
Creates an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances. |
|
|
CreateDocumentAsync(CreateDocumentRequest, CancellationToken) | Initiates the asynchronous execution of the CreateDocument operation. |
|
|
DeleteAssociation(string, string) |
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. |
|
|
DeleteAssociation(DeleteAssociationRequest) |
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. |
|
|
DeleteAssociationAsync(DeleteAssociationRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteAssociation operation. |
|
|
DeleteDocument(string) |
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. |
|
|
DeleteDocument(DeleteDocumentRequest) |
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. |
|
|
DeleteDocumentAsync(DeleteDocumentRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteDocument operation. |
|
|
DescribeAssociation(string, string) | Describes the associations for the specified SSM document or instance. |
|
|
DescribeAssociation(DescribeAssociationRequest) | Describes the associations for the specified SSM document or instance. |
|
|
DescribeAssociationAsync(DescribeAssociationRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeAssociation operation. |
|
|
DescribeDocument(string) | Describes the specified SSM document. |
|
|
DescribeDocument(DescribeDocumentRequest) | Describes the specified SSM document. |
|
|
DescribeDocumentAsync(DescribeDocumentRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeDocument operation. |
|
|
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. |
|
|
DescribeInstanceInformation(DescribeInstanceInformationRequest) | 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. |
|
|
DescribeInstanceInformationAsync(DescribeInstanceInformationRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeInstanceInformation operation. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
GetDocument(string) | Gets the contents of the specified SSM document. |
|
|
GetDocument(GetDocumentRequest) | Gets the contents of the specified SSM document. |
|
|
GetDocumentAsync(GetDocumentRequest, CancellationToken) | Initiates the asynchronous execution of the GetDocument operation. |
|
|
ListAssociations(ListAssociationsRequest) | Lists the associations for the specified SSM document or instance. |
|
|
ListAssociationsAsync(ListAssociationsRequest, CancellationToken) | Initiates the asynchronous execution of the ListAssociations operation. |
|
|
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. |
|
|
ListCommandInvocations(string) | 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. |
|
|
ListCommandInvocations(ListCommandInvocationsRequest) | 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. |
|
|
ListCommandInvocationsAsync(ListCommandInvocationsRequest, CancellationToken) | Initiates the asynchronous execution of the ListCommandInvocations operation. |
|
|
ListCommands() | Lists the commands requested by users of the AWS account. |
|
|
ListCommands(string) | Lists the commands requested by users of the AWS account. |
|
|
ListCommands(ListCommandsRequest) | Lists the commands requested by users of the AWS account. |
|
|
ListCommandsAsync(ListCommandsRequest, CancellationToken) | Initiates the asynchronous execution of the ListCommands operation. |
|
|
ListDocuments() | Describes one or more of your SSM documents. |
|
|
ListDocuments(ListDocumentsRequest) | Describes one or more of your SSM documents. |
|
|
ListDocumentsAsync(ListDocumentsRequest, CancellationToken) | Initiates the asynchronous execution of the ListDocuments operation. |
|
|
SendCommand(string, List<String>) | Executes commands on one or more remote instances. |
|
|
SendCommand(SendCommandRequest) | Executes commands on one or more remote instances. |
|
|
SendCommandAsync(SendCommandRequest, CancellationToken) | Initiates the asynchronous execution of the SendCommand operation. |
|
|
UpdateAssociationStatus(UpdateAssociationStatusRequest) | Updates the status of the SSM document associated with the specified instance. |
|
|
UpdateAssociationStatusAsync(UpdateAssociationStatusRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateAssociationStatus operation. |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
Version Information
.NET Framework:
Supported in: 4.5, 4.0, 3.5