Using the Player Account CLI - Lumberyard User Guide

Using the Player Account CLI

Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more.

When you enable the Player Account Cloud Gem, associated commands become available in the lmbr_aws CLI. You can then use these commands to perform player account operations.

The following lmbr_aws CLI extension commands are enabled by the Player Account Cloud Gem.

player-account add-player

Create a new player account in Amazon Cognito. Validation is performed server-side using the OpenID Connect specification rules.

In addition to the Common Arguments, this command accepts the following arguments:

  • --username <username>

    Amazon Cognito username of the account to create.

  • --email <email_address>

    Email address of the player.

  • --playername <player_name>

    (Optional) Player name of the player.

  • --familyname <family_name>

    (Optional) Family name of the player.

  • --givenname <given_name>

    (Optional) Given name of the player.

  • --nickname <nickname>

    (Optional) Nickname of the player.

  • --gender <gender>

    (Optional) Gender of the player. The values "male" and "female" are defined by the OpenID Connect specification, but any value may be used.

  • --locale <locale>

    (Optional) Locale of the player.

player-account ban-player

Ban a player account by account ID.

In addition to the Common Arguments, this command accepts the following arguments:

  • --account-id <account_id>

    Account ID to ban.

player-account confirm-player

Confirm a player account whose status is "Unconfirmed" to make it usable.

In addition to the Common Arguments, this command accepts the following arguments:

  • --username <username>

    Amazon Cognito username of the account to confirm.

player-account edit-player

Edit the attribute values of a player account by account ID. Validation is performed server-side using the OpenID Connect specification rules.

In addition to the Common Arguments, this command accepts the following arguments:

  • --account-id <account_id>

    Account ID to edit.

  • --email <email_address>

    (Optional) New email address for the player.

  • --playername <player_name>

    (Optional) New player name for the player.

  • --familyname <family_name>

    (Optional) New family name for the player.

  • --givenname <given_name>

    (Optional) New given name for the player.

  • --nickname <nickname>

    (Optional) New nickname for the player.

  • --gender <gender>

    (Optional) New gender for the player. The values "male" and "female" are defined by the OpenID Connect specification, but any value may be used.

  • --locale <locale>

    (Optional) New locale for the player.

player-account remove-player-ban

Remove the ban on a player account by account ID.

In addition to the Common Arguments, this command accepts the following arguments:

  • --account-id <account_id>

    Account ID for which the ban should be removed.

player-account reset-player-password

Reset the password for a player account by username.

In addition to the Common Arguments, this command accepts the following arguments:

  • --username <username>

    Amazon Cognito username of the account for which the password should be reset.

player-account show-banned-players

List all banned players.

In addition to the Common Arguments, this command accepts the following arguments:

  • --page-token <page_token>

    (Optional) The pagination token to get to the next page.

player-account show-logs

Show recent log events.

In addition to the Common Arguments, this command accepts the following arguments:

  • --minutes <minutes>

    (Optional) Display log events for the specified number of minutes before now. The default is 10 minutes.

player-account show-players

List all registered players, using optional filters.

In addition to the Common Arguments, this command accepts the following arguments:

  • --filter-type <AccountId | PlayerName | CognitoIdentity | CognitoUsername | CognitoEmail>

    (Optional) Type of filter to apply.

  • --filter-value <filter_value>

    (Optional) String value to use for the filter.

  • --page-token <page_token>

    (Optional) The pagination token to get to the next page.

player-account show-player-details

List account details for a player by account ID.

In addition to the Common Arguments, this command accepts the following arguments:

  • --account-id <account_id>

    Account ID for which to show details.