Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeFleetDeployment

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.

Request Syntax


{
   "DeploymentId": "string",
   "FleetId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

FleetId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+$|^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$

Required: Yes

DeploymentId

A unique identifier for the deployment to return information for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[a-zA-Z0-9\-]+$

Required: No

Response Syntax


{
   "FleetDeployment": { 
      "CreationTime": number,
      "DeploymentConfiguration": { 
         "ImpairmentStrategy": "string",
         "MinimumHealthyPercentage": number,
         "ProtectionStrategy": "string"
      },
      "DeploymentId": "string",
      "DeploymentStatus": "string",
      "FleetId": "string",
      "GameServerBinaryArn": "string",
      "PerInstanceBinaryArn": "string",
      "RollbackGameServerBinaryArn": "string",
      "RollbackPerInstanceBinaryArn": "string"
   },
   "LocationalDeployments": { 
      "string" : { 
         "DeploymentStatus": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FleetDeployment

The requested deployment information.

Type: FleetDeployment object

LocationalDeployments

If the deployment is for a multi-location fleet, the requests returns the deployment status in each fleet location.

Type: String to LocationalDeployment object map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^[a-zA-Z0-9\-]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

NotFoundException

The requested resources was not found. The resource was either not created yet or deleted.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400

UnsupportedRegionException

The requested operation is not supported in the Region specified.

HTTP Status Code: 400

Examples

Retrieve information on a fleet deployment

This example gets information on a specific deployment for a container fleet.

HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.

Sample Request


{
  "FleetId": "containerfleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
  "DeploymentId": "deployment-3333aaaa-44bb-55cc-66dd-7777eeee88ff"
}

Sample Response


{
   "FleetDeployment": { 
      "CreationTime": 1736365885.22,
      "DeploymentConfiguration": { 
         "ImpairmentStrategy": "ROLLBACK",
         "MinimumHealthyPercentage": 30,
         "ProtectionStrategy": "WITH_PROTECTION"
      },
      "DeploymentId": "deployment-3333aaaa-44bb-55cc-66dd-7777eeee88ff",
      "DeploymentStatus": "COMPLETE",
      "FleetId": "containerfleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
      "GameServerBinaryArn": "arn:aws:gamelift:us-west-2:111122223333:containergroupdefinition/MyAdventureGameContainerGroup:2",
      "RollbackGameServerBinaryArn": "arn:aws:gamelift:us-west-2:111122223333:containergroupdefinition/MyAdventureGameContainerGroup:1",
   }
}