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.

Gets information about an on-premises instance.

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 BeginGetOnPremisesInstance and EndGetOnPremisesInstance.

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

Syntax

C#
public virtual Task<GetOnPremisesInstanceResponse> GetOnPremisesInstanceAsync(
         GetOnPremisesInstanceRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest

Container for the necessary parameters to execute the GetOnPremisesInstance 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 GetOnPremisesInstance service method, as returned by CodeDeploy.

Exceptions

ExceptionCondition
InstanceNameRequiredException An on-premises instance name was not specified.
InstanceNotRegisteredException The specified on-premises instance is not registered.
InvalidInstanceNameException The on-premises instance name was specified in an invalid format.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also