AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing SimpleSystemsManagement Amazon EC2 Systems Manager

Amazon EC2 Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon EC2 instance or on-premises machine in your hybrid environment that has been configured for Systems Manager.

This reference is intended to be used with the Amazon EC2 Systems Manager User Guide.

To get started, verify prerequisites and configure managed instances. For more information, see Systems Manager Prerequisites.

For information about other API actions you can perform on Amazon EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API Requests.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient

Namespace: Amazon.SimpleSystemsManagement
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonSimpleSystemsManagementClient : AmazonServiceClient
         IAmazonService, IAmazonSimpleSystemsManagement, IDisposable

The AmazonSimpleSystemsManagementClient type exposes the following members

Constructors

NameDescription
Public Method 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.



    
        
    

             

Public Method 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.



    
        
    

             

Public Method 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.



    
        
    

             

Public Method AmazonSimpleSystemsManagementClient(AWSCredentials)

Constructs AmazonSimpleSystemsManagementClient with AWS Credentials

Public Method AmazonSimpleSystemsManagementClient(AWSCredentials, RegionEndpoint)

Constructs AmazonSimpleSystemsManagementClient with AWS Credentials

Public Method AmazonSimpleSystemsManagementClient(AWSCredentials, AmazonSimpleSystemsManagementConfig)

Constructs AmazonSimpleSystemsManagementClient with AWS Credentials and an AmazonSimpleSystemsManagementClient Configuration object.

Public Method AmazonSimpleSystemsManagementClient(string, string)

Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleSystemsManagementClient(string, string, RegionEndpoint)

Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleSystemsManagementClient(string, string, AmazonSimpleSystemsManagementConfig)

Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleSystemsManagementClient Configuration object.

Public Method AmazonSimpleSystemsManagementClient(string, string, string)

Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleSystemsManagementClient(string, string, string, RegionEndpoint)

Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleSystemsManagementClient(string, string, string, AmazonSimpleSystemsManagementConfig)

Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleSystemsManagementClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddTagsToResource(AddTagsToResourceRequest)

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources 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.

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.

For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

Public Method AddTagsToResourceAsync(AddTagsToResourceRequest, CancellationToken)

Initiates the asynchronous execution of the AddTagsToResource operation.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method CancelCommandAsync(string, CancellationToken)

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.

Public Method CancelCommandAsync(string, List<String>, CancellationToken)

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.

Public Method CancelCommandAsync(CancelCommandRequest, CancellationToken)

Initiates the asynchronous execution of the CancelCommand operation.

Public Method CreateActivation(CreateActivationRequest)

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 Setting Up Systems Manager in Hybrid Environments.

Public Method CreateActivationAsync(CreateActivationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateActivation operation.

Public Method CreateAssociation(string, string)

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running 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.

Public Method CreateAssociation(CreateAssociationRequest)

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running 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.

Public Method CreateAssociationAsync(string, string, CancellationToken)

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running 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.

Public Method CreateAssociationAsync(CreateAssociationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAssociation operation.

Public Method CreateAssociationBatch(CreateAssociationBatchRequest)

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running 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.

Public Method CreateAssociationBatchAsync(CreateAssociationBatchRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAssociationBatch operation.

Public Method CreateDocument(string, string)

Creates a Systems Manager document.

After you create a document, you can use CreateAssociation to associate it with one or more running instances.

Public Method CreateDocument(CreateDocumentRequest)

Creates a Systems Manager document.

After you create a document, you can use CreateAssociation to associate it with one or more running instances.

Public Method CreateDocumentAsync(string, string, CancellationToken)

Creates a Systems Manager document.

After you create a document, you can use CreateAssociation to associate it with one or more running instances.

Public Method CreateDocumentAsync(CreateDocumentRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDocument operation.

Public Method CreateMaintenanceWindow(CreateMaintenanceWindowRequest)

Creates a new Maintenance Window.

Public Method CreateMaintenanceWindowAsync(CreateMaintenanceWindowRequest, CancellationToken)

Initiates the asynchronous execution of the CreateMaintenanceWindow operation.

Public Method CreatePatchBaseline(CreatePatchBaselineRequest)

Creates a patch baseline.

Public Method CreatePatchBaselineAsync(CreatePatchBaselineRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePatchBaseline operation.

Public Method CreateResourceDataSync(CreateResourceDataSyncRequest)

Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync operation.

By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Configuring Resource Data Sync for Inventory.

Public Method CreateResourceDataSyncAsync(CreateResourceDataSyncRequest, CancellationToken)

Initiates the asynchronous execution of the CreateResourceDataSync operation.

Public Method DeleteActivation(DeleteActivationRequest)

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.

Public Method DeleteActivationAsync(DeleteActivationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteActivation operation.

Public Method DeleteAssociation(string, string)

Disassociates the specified Systems Manager document from the specified instance.

When you disassociate a 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.

Public Method DeleteAssociation(DeleteAssociationRequest)

Disassociates the specified Systems Manager document from the specified instance.

When you disassociate a 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.

Public Method DeleteAssociationAsync(string, string, CancellationToken)

Disassociates the specified Systems Manager document from the specified instance.

When you disassociate a 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.

Public Method DeleteAssociationAsync(DeleteAssociationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAssociation operation.

Public Method DeleteDocument(string)

Deletes the Systems Manager document and all instance associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

Public Method DeleteDocument(DeleteDocumentRequest)

Deletes the Systems Manager document and all instance associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

Public Method DeleteDocumentAsync(string, CancellationToken)

Deletes the Systems Manager document and all instance associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

Public Method DeleteDocumentAsync(DeleteDocumentRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDocument operation.

Public Method DeleteMaintenanceWindow(DeleteMaintenanceWindowRequest)

Deletes a Maintenance Window.

Public Method DeleteMaintenanceWindowAsync(DeleteMaintenanceWindowRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteMaintenanceWindow operation.

Public Method DeleteParameter(DeleteParameterRequest)

Delete a parameter from the system.

Public Method DeleteParameterAsync(DeleteParameterRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteParameter operation.

Public Method DeleteParameters(DeleteParametersRequest)

Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console.

Public Method DeleteParametersAsync(DeleteParametersRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteParameters operation.

Public Method DeletePatchBaseline(DeletePatchBaselineRequest)

Deletes a patch baseline.

Public Method DeletePatchBaselineAsync(DeletePatchBaselineRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePatchBaseline operation.

Public Method DeleteResourceDataSync(DeleteResourceDataSyncRequest)

Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.

Public Method DeleteResourceDataSyncAsync(DeleteResourceDataSyncRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteResourceDataSync operation.

Public Method DeregisterManagedInstance(DeregisterManagedInstanceRequest)

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.

Public Method DeregisterManagedInstanceAsync(DeregisterManagedInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterManagedInstance operation.

Public Method DeregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest)

Removes a patch group from a patch baseline.

Public Method DeregisterPatchBaselineForPatchGroupAsync(DeregisterPatchBaselineForPatchGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterPatchBaselineForPatchGroup operation.

Public Method DeregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest)

Removes a target from a Maintenance Window.

Public Method DeregisterTargetFromMaintenanceWindowAsync(DeregisterTargetFromMaintenanceWindowRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterTargetFromMaintenanceWindow operation.

Public Method DeregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest)

Removes a task from a Maintenance Window.

Public Method DeregisterTaskFromMaintenanceWindowAsync(DeregisterTaskFromMaintenanceWindowRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterTaskFromMaintenanceWindow operation.

Public Method DescribeActivations(DescribeActivationsRequest)

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.

Public Method DescribeActivationsAsync(DescribeActivationsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeActivations operation.

Public Method DescribeAssociation(string, string)

Describes the associations for the specified Systems Manager document or instance.

Public Method DescribeAssociation(DescribeAssociationRequest)

Describes the associations for the specified Systems Manager document or instance.

Public Method DescribeAssociationAsync(string, string, CancellationToken)

Describes the associations for the specified Systems Manager document or instance.

Public Method DescribeAssociationAsync(DescribeAssociationRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAssociation operation.

Public Method DescribeAutomationExecutions(DescribeAutomationExecutionsRequest)

Provides details about all active and terminated Automation executions.

Public Method DescribeAutomationExecutionsAsync(DescribeAutomationExecutionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAutomationExecutions operation.

Public Method DescribeAvailablePatches(DescribeAvailablePatchesRequest)

Lists all patches that could possibly be included in a patch baseline.

Public Method DescribeAvailablePatchesAsync(DescribeAvailablePatchesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAvailablePatches operation.

Public Method DescribeDocument(string)

Describes the specified Systems Manager document.

Public Method DescribeDocument(DescribeDocumentRequest)

Describes the specified Systems Manager document.

Public Method DescribeDocumentAsync(string, CancellationToken)

Describes the specified Systems Manager document.

Public Method DescribeDocumentAsync(DescribeDocumentRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDocument operation.

Public Method DescribeDocumentPermission(DescribeDocumentPermissionRequest)

Describes the permissions for a Systems Manager 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 (All).

Public Method DescribeDocumentPermissionAsync(DescribeDocumentPermissionRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDocumentPermission operation.

Public Method DescribeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest)

All associations for the instance(s).

Public Method DescribeEffectiveInstanceAssociationsAsync(DescribeEffectiveInstanceAssociationsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEffectiveInstanceAssociations operation.

Public Method DescribeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest)

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.

Public Method DescribeEffectivePatchesForPatchBaselineAsync(DescribeEffectivePatchesForPatchBaselineRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEffectivePatchesForPatchBaseline operation.

Public Method DescribeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest)

The status of the associations for the instance(s).

Public Method DescribeInstanceAssociationsStatusAsync(DescribeInstanceAssociationsStatusRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeInstanceAssociationsStatus operation.

Public Method 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 (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.

Public Method 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 (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.

Public Method DescribeInstanceInformationAsync(CancellationToken)

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.

Public Method DescribeInstanceInformationAsync(DescribeInstanceInformationRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeInstanceInformation operation.

Public Method DescribeInstancePatches(DescribeInstancePatchesRequest)

Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.

Public Method DescribeInstancePatchesAsync(DescribeInstancePatchesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeInstancePatches operation.

Public Method DescribeInstancePatchStates(DescribeInstancePatchStatesRequest)

Retrieves the high-level patch state of one or more instances.

Public Method DescribeInstancePatchStatesAsync(DescribeInstancePatchStatesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeInstancePatchStates operation.

Public Method DescribeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest)

Retrieves the high-level patch state for the instances in the specified patch group.

Public Method DescribeInstancePatchStatesForPatchGroupAsync(DescribeInstancePatchStatesForPatchGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeInstancePatchStatesForPatchGroup operation.

Public Method DescribeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest)

Lists the executions of a Maintenance Window. This includes information about when the Maintenance Window was scheduled to be active, and information about tasks registered and run with the Maintenance Window.

Public Method DescribeMaintenanceWindowExecutionsAsync(DescribeMaintenanceWindowExecutionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeMaintenanceWindowExecutions operation.

Public Method DescribeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest)

Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.

Public Method DescribeMaintenanceWindowExecutionTaskInvocationsAsync(DescribeMaintenanceWindowExecutionTaskInvocationsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeMaintenanceWindowExecutionTaskInvocations operation.

Public Method DescribeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest)

For a given Maintenance Window execution, lists the tasks that were executed.

Public Method DescribeMaintenanceWindowExecutionTasksAsync(DescribeMaintenanceWindowExecutionTasksRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeMaintenanceWindowExecutionTasks operation.

Public Method DescribeMaintenanceWindows(DescribeMaintenanceWindowsRequest)

Retrieves the Maintenance Windows in an AWS account.

Public Method DescribeMaintenanceWindowsAsync(DescribeMaintenanceWindowsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeMaintenanceWindows operation.

Public Method DescribeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest)

Lists the targets registered with the Maintenance Window.

Public Method DescribeMaintenanceWindowTargetsAsync(DescribeMaintenanceWindowTargetsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeMaintenanceWindowTargets operation.

Public Method DescribeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest)

Lists the tasks in a Maintenance Window.

Public Method DescribeMaintenanceWindowTasksAsync(DescribeMaintenanceWindowTasksRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeMaintenanceWindowTasks operation.

Public Method DescribeParameters(DescribeParametersRequest)

Get information about a parameter.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Public Method DescribeParametersAsync(DescribeParametersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeParameters operation.

Public Method DescribePatchBaselines(DescribePatchBaselinesRequest)

Lists the patch baselines in your AWS account.

Public Method DescribePatchBaselinesAsync(DescribePatchBaselinesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribePatchBaselines operation.

Public Method DescribePatchGroups(DescribePatchGroupsRequest)

Lists all patch groups that have been registered with patch baselines.

Public Method DescribePatchGroupsAsync(DescribePatchGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribePatchGroups operation.

Public Method DescribePatchGroupState(DescribePatchGroupStateRequest)

Returns high-level aggregated patch compliance state for a patch group.

Public Method DescribePatchGroupStateAsync(DescribePatchGroupStateRequest, CancellationToken)

Initiates the asynchronous execution of the DescribePatchGroupState operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetAutomationExecution(GetAutomationExecutionRequest)

Get detailed information about a particular Automation execution.

Public Method GetAutomationExecutionAsync(GetAutomationExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the GetAutomationExecution operation.

Public Method GetCommandInvocation(GetCommandInvocationRequest)

Returns detailed information about command execution for an invocation or plugin.

Public Method GetCommandInvocationAsync(GetCommandInvocationRequest, CancellationToken)

Initiates the asynchronous execution of the GetCommandInvocation operation.

Public Method GetDefaultPatchBaseline(GetDefaultPatchBaselineRequest)

Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

Public Method GetDefaultPatchBaselineAsync(GetDefaultPatchBaselineRequest, CancellationToken)

Initiates the asynchronous execution of the GetDefaultPatchBaseline operation.

Public Method GetDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest)

Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.

Public Method GetDeployablePatchSnapshotForInstanceAsync(GetDeployablePatchSnapshotForInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the GetDeployablePatchSnapshotForInstance operation.

Public Method GetDocument(string)

Gets the contents of the specified Systems Manager document.

Public Method GetDocument(GetDocumentRequest)

Gets the contents of the specified Systems Manager document.

Public Method GetDocumentAsync(string, CancellationToken)

Gets the contents of the specified Systems Manager document.

Public Method GetDocumentAsync(GetDocumentRequest, CancellationToken)

Initiates the asynchronous execution of the GetDocument operation.

Public Method GetInventory(GetInventoryRequest)

Query inventory information.

Public Method GetInventoryAsync(GetInventoryRequest, CancellationToken)

Initiates the asynchronous execution of the GetInventory operation.

Public Method GetInventorySchema(GetInventorySchemaRequest)

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

Public Method GetInventorySchemaAsync(GetInventorySchemaRequest, CancellationToken)

Initiates the asynchronous execution of the GetInventorySchema operation.

Public Method GetMaintenanceWindow(GetMaintenanceWindowRequest)

Retrieves a Maintenance Window.

Public Method GetMaintenanceWindowAsync(GetMaintenanceWindowRequest, CancellationToken)

Initiates the asynchronous execution of the GetMaintenanceWindow operation.

Public Method GetMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest)

Retrieves details about a specific task executed as part of a Maintenance Window execution.

Public Method GetMaintenanceWindowExecutionAsync(GetMaintenanceWindowExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the GetMaintenanceWindowExecution operation.

Public Method GetMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest)

Retrieves the details about a specific task executed as part of a Maintenance Window execution.

Public Method GetMaintenanceWindowExecutionTaskAsync(GetMaintenanceWindowExecutionTaskRequest, CancellationToken)

Initiates the asynchronous execution of the GetMaintenanceWindowExecutionTask operation.

Public Method GetMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest)

Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations.

Public Method GetMaintenanceWindowExecutionTaskInvocationAsync(GetMaintenanceWindowExecutionTaskInvocationRequest, CancellationToken)

Initiates the asynchronous execution of the GetMaintenanceWindowExecutionTaskInvocation operation.

Public Method GetMaintenanceWindowTask(GetMaintenanceWindowTaskRequest)

Lists the tasks in a Maintenance Window.

Public Method GetMaintenanceWindowTaskAsync(GetMaintenanceWindowTaskRequest, CancellationToken)

Initiates the asynchronous execution of the GetMaintenanceWindowTask operation.

Public Method GetParameter(GetParameterRequest)

Get information about a parameter by using the parameter name.

Public Method GetParameterAsync(GetParameterRequest, CancellationToken)

Initiates the asynchronous execution of the GetParameter operation.

Public Method GetParameterHistory(GetParameterHistoryRequest)

Query a list of all parameters used by the AWS account.

Public Method GetParameterHistoryAsync(GetParameterHistoryRequest, CancellationToken)

Initiates the asynchronous execution of the GetParameterHistory operation.

Public Method GetParameters(GetParametersRequest)

Get details of a parameter.

Public Method GetParametersAsync(GetParametersRequest, CancellationToken)

Initiates the asynchronous execution of the GetParameters operation.

Public Method GetParametersByPath(GetParametersByPathRequest)

Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Public Method GetParametersByPathAsync(GetParametersByPathRequest, CancellationToken)

Initiates the asynchronous execution of the GetParametersByPath operation.

Public Method GetPatchBaseline(GetPatchBaselineRequest)

Retrieves information about a patch baseline.

Public Method GetPatchBaselineAsync(GetPatchBaselineRequest, CancellationToken)

Initiates the asynchronous execution of the GetPatchBaseline operation.

Public Method GetPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest)

Retrieves the patch baseline that should be used for the specified patch group.

Public Method GetPatchBaselineForPatchGroupAsync(GetPatchBaselineForPatchGroupRequest, CancellationToken)

Initiates the asynchronous execution of the GetPatchBaselineForPatchGroup operation.

Public Method ListAssociations(ListAssociationsRequest)

Lists the associations for the specified Systems Manager document or instance.

Public Method ListAssociationsAsync(ListAssociationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListAssociations operation.

Public Method ListAssociationVersions(ListAssociationVersionsRequest)

Retrieves all versions of an association for a specific association ID.

Public Method ListAssociationVersionsAsync(ListAssociationVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListAssociationVersions operation.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method ListCommandInvocationsAsync(CancellationToken)

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.

Public Method ListCommandInvocationsAsync(string, CancellationToken)

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.

Public Method ListCommandInvocationsAsync(ListCommandInvocationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListCommandInvocations operation.

Public Method ListCommands()

Lists the commands requested by users of the AWS account.

Public Method ListCommands(string)

Lists the commands requested by users of the AWS account.

Public Method ListCommands(ListCommandsRequest)

Lists the commands requested by users of the AWS account.

Public Method ListCommandsAsync(CancellationToken)

Lists the commands requested by users of the AWS account.

Public Method ListCommandsAsync(string, CancellationToken)

Lists the commands requested by users of the AWS account.

Public Method ListCommandsAsync(ListCommandsRequest, CancellationToken)

Initiates the asynchronous execution of the ListCommands operation.

Public Method ListComplianceItems(ListComplianceItemsRequest)

For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

Public Method ListComplianceItemsAsync(ListComplianceItemsRequest, CancellationToken)

Initiates the asynchronous execution of the ListComplianceItems operation.

Public Method ListComplianceSummaries(ListComplianceSummariesRequest)

Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

Public Method ListComplianceSummariesAsync(ListComplianceSummariesRequest, CancellationToken)

Initiates the asynchronous execution of the ListComplianceSummaries operation.

Public Method ListDocuments()

Describes one or more of your Systems Manager documents.

Public Method ListDocuments(ListDocumentsRequest)

Describes one or more of your Systems Manager documents.

Public Method ListDocumentsAsync(CancellationToken)

Describes one or more of your Systems Manager documents.

Public Method ListDocumentsAsync(ListDocumentsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDocuments operation.

Public Method ListDocumentVersions(ListDocumentVersionsRequest)

List all versions for a document.

Public Method ListDocumentVersionsAsync(ListDocumentVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDocumentVersions operation.

Public Method ListInventoryEntries(ListInventoryEntriesRequest)

A list of inventory items returned by the request.

Public Method ListInventoryEntriesAsync(ListInventoryEntriesRequest, CancellationToken)

Initiates the asynchronous execution of the ListInventoryEntries operation.

Public Method ListResourceComplianceSummaries(ListResourceComplianceSummariesRequest)

Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

Public Method ListResourceComplianceSummariesAsync(ListResourceComplianceSummariesRequest, CancellationToken)

Initiates the asynchronous execution of the ListResourceComplianceSummaries operation.

Public Method ListResourceDataSync(ListResourceDataSyncRequest)

Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

Public Method ListResourceDataSyncAsync(ListResourceDataSyncRequest, CancellationToken)

Initiates the asynchronous execution of the ListResourceDataSync operation.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Returns a list of the tags assigned to the specified resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForResource operation.

Public Method ModifyDocumentPermission(ModifyDocumentPermissionRequest)

Shares a Systems Manager 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 All as the account ID.

Public Method ModifyDocumentPermissionAsync(ModifyDocumentPermissionRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyDocumentPermission operation.

Public Method PutComplianceItems(PutComplianceItemsRequest)

Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

Public Method PutComplianceItemsAsync(PutComplianceItemsRequest, CancellationToken)

Initiates the asynchronous execution of the PutComplianceItems operation.

Public Method PutInventory(PutInventoryRequest)

Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

Public Method PutInventoryAsync(PutInventoryRequest, CancellationToken)

Initiates the asynchronous execution of the PutInventory operation.

Public Method PutParameter(PutParameterRequest)

Add one or more parameters to the system.

Public Method PutParameterAsync(PutParameterRequest, CancellationToken)

Initiates the asynchronous execution of the PutParameter operation.

Public Method RegisterDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest)

Defines the default patch baseline.

Public Method RegisterDefaultPatchBaselineAsync(RegisterDefaultPatchBaselineRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterDefaultPatchBaseline operation.

Public Method RegisterPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest)

Registers a patch baseline for a patch group.

Public Method RegisterPatchBaselineForPatchGroupAsync(RegisterPatchBaselineForPatchGroupRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterPatchBaselineForPatchGroup operation.

Public Method RegisterTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest)

Registers a target with a Maintenance Window.

Public Method RegisterTargetWithMaintenanceWindowAsync(RegisterTargetWithMaintenanceWindowRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterTargetWithMaintenanceWindow operation.

Public Method RegisterTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest)

Adds a new task to a Maintenance Window.

Public Method RegisterTaskWithMaintenanceWindowAsync(RegisterTaskWithMaintenanceWindowRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterTaskWithMaintenanceWindow operation.

Public Method RemoveTagsFromResource(RemoveTagsFromResourceRequest)

Removes all tags from the specified resource.

Public Method RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveTagsFromResource operation.

Public Method SendAutomationSignal(SendAutomationSignalRequest)

Sends a signal to an Automation execution to change the current behavior or status of the execution.

Public Method SendAutomationSignalAsync(SendAutomationSignalRequest, CancellationToken)

Initiates the asynchronous execution of the SendAutomationSignal operation.

Public Method SendCommand(string, List<String>)

Executes commands on one or more managed instances.

Public Method SendCommand(SendCommandRequest)

Executes commands on one or more managed instances.

Public Method SendCommandAsync(string, List<String>, CancellationToken)

Executes commands on one or more managed instances.

Public Method SendCommandAsync(SendCommandRequest, CancellationToken)

Initiates the asynchronous execution of the SendCommand operation.

Public Method StartAutomationExecution(StartAutomationExecutionRequest)

Initiates execution of an Automation document.

Public Method StartAutomationExecutionAsync(StartAutomationExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the StartAutomationExecution operation.

Public Method StopAutomationExecution(StopAutomationExecutionRequest)

Stop an Automation that is currently executing.

Public Method StopAutomationExecutionAsync(StopAutomationExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the StopAutomationExecution operation.

Public Method UpdateAssociation(UpdateAssociationRequest)

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.

Public Method UpdateAssociationAsync(UpdateAssociationRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAssociation operation.

Public Method UpdateAssociationStatus(UpdateAssociationStatusRequest)

Updates the status of the Systems Manager document associated with the specified instance.

Public Method UpdateAssociationStatusAsync(UpdateAssociationStatusRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAssociationStatus operation.

Public Method UpdateDocument(UpdateDocumentRequest)

The document you want to update.

Public Method UpdateDocumentAsync(UpdateDocumentRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDocument operation.

Public Method UpdateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest)

Set the default version of a document.

Public Method UpdateDocumentDefaultVersionAsync(UpdateDocumentDefaultVersionRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDocumentDefaultVersion operation.

Public Method UpdateMaintenanceWindow(UpdateMaintenanceWindowRequest)

Updates an existing Maintenance Window. Only specified parameters are modified.

Public Method UpdateMaintenanceWindowAsync(UpdateMaintenanceWindowRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateMaintenanceWindow operation.

Public Method UpdateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest)

Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following:

The target from being an ID target to a Tag target, or a Tag target to an ID target.

IDs for an ID target.

Tags for a Tag target.

Owner.

Name.

Description.

If a parameter is null, then the corresponding field is not modified.

Public Method UpdateMaintenanceWindowTargetAsync(UpdateMaintenanceWindowTargetRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateMaintenanceWindowTarget operation.

Public Method UpdateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest)

Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values:

Task ARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

Service role ARN.

Task parameters.

Task priority.

Task MaxConcurrency and MaxErrors.

Log location.

If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.

Public Method UpdateMaintenanceWindowTaskAsync(UpdateMaintenanceWindowTaskRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateMaintenanceWindowTask operation.

Public Method UpdateManagedInstanceRole(UpdateManagedInstanceRoleRequest)

Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.

Public Method UpdateManagedInstanceRoleAsync(UpdateManagedInstanceRoleRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateManagedInstanceRole operation.

Public Method UpdatePatchBaseline(UpdatePatchBaselineRequest)

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

Public Method UpdatePatchBaselineAsync(UpdatePatchBaselineRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePatchBaseline operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms