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.
Related actions
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
public virtual Task<DescribeAliasResponse> DescribeAliasAsync( String aliasId, CancellationToken cancellationToken )
The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
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 | The requested resources was not found. The resource was either not created yet or deleted. |
UnauthorizedException | The client failed authentication. Clients should not retry such requests. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer