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 one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.

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 BeginBatchGetOnPremisesInstances and EndBatchGetOnPremisesInstances.

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

Syntax

C#
public abstract Task<BatchGetOnPremisesInstancesResponse> BatchGetOnPremisesInstancesAsync(
         BatchGetOnPremisesInstancesRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest

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

Exceptions

ExceptionCondition
BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
InstanceNameRequiredException An on-premises instance name was not specified.
InvalidInstanceNameException The on-premises instance name was specified in an invalid format.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also