describeAlias method

Future<DescribeAliasOutput> describeAlias({
  1. required String aliasId,
})

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.

May throw UnauthorizedException. May throw InvalidRequestException. May throw NotFoundException. May throw InternalServiceException.

Parameter aliasId : The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value.

Implementation

Future<DescribeAliasOutput> describeAlias({
  required String aliasId,
}) async {
  ArgumentError.checkNotNull(aliasId, 'aliasId');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'GameLift.DescribeAlias'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'AliasId': aliasId,
    },
  );

  return DescribeAliasOutput.fromJson(jsonResponse.body);
}