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.

Registers an on-premises instance.

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.


For .NET Core and PCL this operation is only available in asynchronous form. Please refer to RegisterOnPremisesInstanceAsync.

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


public abstract RegisterOnPremisesInstanceResponse RegisterOnPremisesInstance(
         RegisterOnPremisesInstanceRequest request
Type: Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest

Container for the necessary parameters to execute the RegisterOnPremisesInstance service method.

Return Value
The response from the RegisterOnPremisesInstance service method, as returned by CodeDeploy.


IamArnRequiredException No IAM ARN was included in the request. You must use an IAM session ARN or IAM user ARN in the request.
IamSessionArnAlreadyRegisteredException The request included an IAM session ARN that has already been used to register a different instance.
IamUserArnAlreadyRegisteredException The specified IAM user ARN is already registered with an on-premises instance.
IamUserArnRequiredException An IAM user ARN was not specified.
InstanceNameAlreadyRegisteredException The specified on-premises instance name is already registered.
InstanceNameRequiredException An on-premises instance name was not specified.
InvalidIamSessionArnException The IAM session ARN was specified in an invalid format.
InvalidIamUserArnException The IAM user ARN was specified in an invalid format.
InvalidInstanceNameException The specified on-premises instance name was specified in an invalid format.
MultipleIamArnsProvidedException Both an IAM user ARN and an IAM session ARN were included in the request. Use only one ARN type.

Version Information

.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

See Also