[ aws . gamelift ]

delete-game-session-queue

Description

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name.

Learn more

Using Multi-Region Queues

Related operations

  • CreateGameSessionQueue

  • DescribeGameSessionQueues

  • UpdateGameSessionQueue

  • DeleteGameSessionQueue

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  delete-game-session-queue
--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string)

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To delete a game session queue

The following delete-game-session-queue example deletes a specified game session queue.

aws gamelift delete-game-session-queue \
    --name MegaFrogRace-NA

This command produces no output.

Output

None