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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateAssociation and EndCreateAssociation.

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

Syntax

C#
public virtual Task<CreateAssociationResponse> CreateAssociationAsync(
         String instanceId,
         String name,
         CancellationToken cancellationToken
)
Parameters
instanceId
Type: System.String

The instance ID.

name
Type: System.String

The name of the Systems Manager document.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value
The response from the CreateAssociation service method, as returned by SimpleSystemsManagement.

Exceptions

ExceptionCondition
AssociationAlreadyExistsException The specified association already exists.
AssociationLimitExceededException You can have at most 2,000 active associations.
InternalServerErrorException An error occurred on the server side.
InvalidDocumentException The specified document does not exist.
InvalidDocumentVersionException The document version is not valid or does not exist.
InvalidInstanceIdException The following problems can cause this exception: You do not have permission to access the instance. The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running. The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service. The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidOutputLocationException The output location is not valid or does not exist.
InvalidParametersException You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.
InvalidScheduleException The schedule is invalid. Verify your cron or rate expression and try again.
InvalidTargetException The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you might not have permission to perform the operation.
UnsupportedPlatformTypeException The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.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

See Also