describeContainerFleet method

Future<DescribeContainerFleetOutput> describeContainerFleet({
  1. required String fleetId,
})

This API works with the following fleet types: Container

Retrieves the properties for a container fleet. When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

Request options

  • Get container fleet properties for a single fleet. Provide either the fleet ID or ARN value.
Results

If successful, a ContainerFleet object is returned. This object includes the fleet properties, including information about the most recent deployment.

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

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

Implementation

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

  return DescribeContainerFleetOutput.fromJson(jsonResponse.body);
}