Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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 . chime ]

update-account

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-account
--account-id <value>
[--name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The Amazon Chime account ID.

--name (string)

The new name for the specified Amazon Chime account.

--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.

See 'aws help' for descriptions of global parameters.

Examples

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)

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.