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.

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

Alias-related operations include:

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 BeginDescribeAlias and EndDescribeAlias.

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

Syntax

C#
public virtual Task<DescribeAliasResponse> DescribeAliasAsync(
         String aliasId,
         CancellationToken cancellationToken
)
Parameters
aliasId
Type: System.String

Unique identifier for a fleet alias. Specify the alias you want to retrieve.

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 DescribeAlias service method, as returned by GameLift.

Exceptions

ExceptionCondition
InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.
UnauthorizedException The client failed authentication. Clients should not retry such requests.

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