Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

CreateAccount

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Request Syntax


POST /accounts HTTP/1.1
Content-type: application/json

{
   "Name": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Name

The name of the Amazon Chime account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: Yes

Response Syntax


HTTP/1.1 201
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 201 response.

The following data is returned in JSON format by the service.

Account

The Amazon Chime account details.

Type: Account object

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) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example creates a new Amazon Chime account under the administrator's AWS account.

Sample Request


POST /console/accounts 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: 20190108T175917Z Authorization: AUTHPARAMS Content-Length: 17 {"Name": "example"}

Sample Response


HTTP/1.1 201 Created x-amzn-RequestId: d4f09103-9543-4ff9-b0a0-f1d4c6e2aec7 Content-Type: application/json Content-Length: 422 Date: Tue, 08 Jan 2019 17:59:18 GMT Connection: keep-alive {"Account": {"AccountId": "12a3456b-7c89-012d-3456-78901e23fg45","AccountStatus": "Active","AccountType": "Team","Admins": null,"AwsAccountId": "111122223333","BillingType": "SeatBilling","CreatedTimestamp": "2019-01-08T17:59:18.006Z","DefaultLicense": "Pro","DelegationStatus": "NoDelegation","DirectoryId": null,"Domains": null,"Groups": [],"Name": "example","Owner": null,"SupportedLicenses": ["Basic", "Pro"],"UseProTrialLicense": false} }