The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
UpdateAccount
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
Request Syntax
POST /accounts/accountId
HTTP/1.1
Content-type: application/json
{
"DefaultLicense": "string
",
"Name": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- accountId
-
The Amazon Chime account ID.
Pattern:
.*\S.*
Required: Yes
Request Body
The request accepts the following data in JSON format.
- DefaultLicense
-
The default license applied when you add users to an Amazon Chime account.
Type: String
Valid Values:
Basic | Plus | Pro | ProTrial
Required: No
- Name
-
The new name for the specified Amazon Chime account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
.*\S.*
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Account": {
"AccountId": "string",
"AccountStatus": "string",
"AccountType": "string",
"AwsAccountId": "string",
"CreatedTimestamp": "string",
"DefaultLicense": "string",
"Name": "string",
"SigninDelegateGroups": [
{
"GroupName": "string"
}
],
"SupportedLicenses": [ "string" ]
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
- ForbiddenException
-
The client is permanently forbidden from making the request.
HTTP Status Code: 403
- NotFoundException
-
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404
- ServiceFailureException
-
The service encountered an unexpected error.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable.
HTTP Status Code: 503
- ThrottledClientException
-
The client exceeded its request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client is not currently authorized to make the request.
HTTP Status Code: 401
Examples
In the following example or examples, the Authorization header contents(
AUTHPARAMS
) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see
Signature Version 4 Signing Process in the AWS General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create them. When
you use the AWS Command Line Interface (AWS
CLI)
Example
This example updates the specified account name.
Sample Request
POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45 HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T182558Z Authorization: AUTHPARAMS Content-Length: 19 {"Name": "Example3"}
Sample Response
HTTP/1.1 200 OK x-amzn-RequestId: 1cbd30b4-ee17-400a-ab81-4d1eb65783dc Content-Type: application/json Content-Length: 424 Date: Tue, 08 Jan 2019 18:25:58 GMT Connection: keep-alive {"Account": {"AccountId": "12a3456b-7c89-012d-3456-78901e23fg45","AccountStatus": "Active","AccountType": "Team","Admins": null,"AwsAccountId": "111122223333","BillingType": "SeatBilling","CreatedTimestamp": "2018-09-04T21:44:22.292Z","DefaultLicense": "Pro","DelegationStatus": "NoDelegation","DirectoryId": null,"Domains": null,"Groups": [],"Name": "Example3","Owner": null,"SupportedLicenses": ["Basic", "Pro"],"UseProTrialLicense": false} }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: