AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . gamelift ]

describe-fleet-deployment

Description

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.

See also: AWS API Documentation

Synopsis

  describe-fleet-deployment
--fleet-id <value>
[--deployment-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--fleet-id (string)

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

--deployment-id (string)

A unique identifier for the deployment to return information for.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

FleetDeployment -> (structure)

The requested deployment information.

DeploymentId -> (string)

A unique identifier for the deployment.

FleetId -> (string)

A unique identifier for the container fleet.

GameServerBinaryArn -> (string)

The unique identifier for the version of the game server container group definition that is being deployed.

RollbackGameServerBinaryArn -> (string)

The unique identifier for the version of the game server container group definition to roll back to if deployment fails.

PerInstanceBinaryArn -> (string)

The unique identifier for the version of the per-instance container group definition that is being deployed.

RollbackPerInstanceBinaryArn -> (string)

The unique identifier for the version of the per-instance container group definition to roll back to if deployment fails.

DeploymentStatus -> (string)

The status of fleet deployment activity in the location.

  • IN_PROGRESS -- The deployment is in progress.
  • IMPAIRED -- The deployment failed and the fleet has some impaired containers.
  • COMPLETE -- The deployment has completed successfully.
  • ROLLBACK_IN_PROGRESS -- The deployment failed and rollback has been initiated.
  • ROLLBACK_IN_COMPLETE -- The deployment failed and rollback has been completed.
  • CANCELLED -- The deployment was cancelled.

DeploymentConfiguration -> (structure)

Instructions for how to deploy updates to a container fleet and what actions to take if the deployment fails.

ProtectionStrategy -> (string)

Determines how fleet deployment activity affects active game sessions on the fleet. With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection.

MinimumHealthyPercentage -> (integer)

Sets a minimum level of healthy tasks to maintain during deployment activity.

ImpairmentStrategy -> (string)

Determines what actions to take if a deployment fails. If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment.

CreationTime -> (timestamp)

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

LocationalDeployments -> (map)

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

key -> (string)

value -> (structure)

For a multi-location container fleet, describes the progress of a deployment across all fleet locations.

DeploymentStatus -> (string)

The status of fleet deployment activity in the location.

  • IN_PROGRESS -- The deployment is in progress.
  • IMPAIRED -- The deployment failed and the fleet has some impaired containers.
  • COMPLETE -- The deployment has completed successfully.
  • ROLLBACK_IN_PROGRESS -- The deployment failed and rollback has been initiated.
  • ROLLBACK_IN_COMPLETE -- The deployment failed and rollback has been completed.
  • CANCELLED -- The deployment was cancelled.