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.

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 BeginRegisterOnPremisesInstance and EndRegisterOnPremisesInstance.

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

Syntax

C#
public abstract Task<RegisterOnPremisesInstanceResponse> RegisterOnPremisesInstanceAsync(
         RegisterOnPremisesInstanceRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest

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

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 RegisterOnPremisesInstance service method, as returned by CodeDeploy.

Exceptions

ExceptionCondition
IamArnRequiredException No IAM ARN was included in the request. You must use an IAM session ARN or 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 user ARN is already registered with an on-premises instance.
IamUserArnRequiredException An 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 user ARN was specified in an invalid format.
InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
MultipleIamArnsProvidedException Both an user ARN and an IAM session ARN were included in the request. Use only one ARN type.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also