describeFleetDeployment method

Future<DescribeFleetDeploymentOutput> describeFleetDeployment({
  1. required String fleetId,
  2. String? deploymentId,
})

This API works with the following fleet types: Container

Retrieves information about a managed container fleet deployment.

Request options

  • Get information about the latest deployment for a specific fleet. Provide the fleet ID or ARN.
  • Get information about a specific deployment. Provide the fleet ID or ARN and the deployment ID.
Results

If successful, a FleetDeployment object is returned.

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

Parameter fleetId : A unique identifier for the container fleet. You can use either the fleet ID or ARN value.

Parameter deploymentId : A unique identifier for the deployment to return information for.

Implementation

Future<DescribeFleetDeploymentOutput> describeFleetDeployment({
  required String fleetId,
  String? deploymentId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'GameLift.DescribeFleetDeployment'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'FleetId': fleetId,
      if (deploymentId != null) 'DeploymentId': deploymentId,
    },
  );

  return DescribeFleetDeploymentOutput.fromJson(jsonResponse.body);
}