update-account¶

Description¶

Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.

Synopsis¶

  update-account
--account-id <value>
[--name <value>]
[--default-license <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--account-id (string)

The Amazon Chime account ID.

--name (string)

The new name for the specified Amazon Chime account.

--default-license (string)

The default license applied when you add users to an Amazon Chime account.

Possible values:

Basic

Plus

Pro

ProTrial

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update an account

The following update-account example updates the specified account name.

aws chime update-account \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --name MyAccountName

Output:

{
    "Account": {
        "AwsAccountId": "111122223333",
        "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "Name": "MyAccountName",
        "AccountType": "Team",
        "CreatedTimestamp": "2018-09-04T21:44:22.292Z",
        "DefaultLicense": "Pro",
        "SupportedLicenses": [
            "Basic",
            "Pro"
        ],
        "SigninDelegateGroups": [
            {
                "GroupName": "myGroup"
            },
        ]
    }
}

For more information, see Renaming Your Account in the Amazon Chime Administration Guide.

Output¶

Account -> (structure)

The updated Amazon Chime account details.

AwsAccountId -> (string)

The AWS account ID.

AccountId -> (string)

The Amazon Chime account ID.

Name -> (string)

The Amazon Chime account name.

AccountType -> (string)

The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide .

CreatedTimestamp -> (timestamp)

The Amazon Chime account creation timestamp, in ISO 8601 format.

DefaultLicense -> (string)

The default license for the Amazon Chime account.

SupportedLicenses -> (list)

Supported licenses for the Amazon Chime account.

(string)

AccountStatus -> (string)

The status of the account.

SigninDelegateGroups -> (list)

The sign-in delegate groups associated with the account.

(structure)

An Active Directory (AD) group whose members are granted permission to act as delegates.

GroupName -> (string)

The group name.

Table of Contents

Feedback

User Guide