describeScript method

Future<DescribeScriptOutput> describeScript({ required String scriptId, })

This API works with the following fleet types: EC2

Retrieves properties for a Realtime script.

To request a script record, specify the script ID. If successful, an object containing the script properties is returned.

Learn more

Amazon GameLift Servers Amazon GameLift Servers Realtime

Related actions

All APIs by task

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

Parameter scriptId : A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.

Implementation

Future<DescribeScriptOutput> describeScript({
  required String scriptId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'GameLift.DescribeScript'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ScriptId': scriptId,
    },
  );

  return DescribeScriptOutput.fromJson(jsonResponse.body);
}