Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateAccountLinkInvitation

Creates the account link invitation.

Request Syntax


{
   "ClientToken": "string",
   "TargetAccountId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

ClientToken

A string of up to 64 ASCII characters that Amazon WorkSpaces uses to ensure idempotent creation.

Type: String

Pattern: ^.{1,64}$

Required: No

TargetAccountId

The identifier of the target account.

Type: String

Pattern: ^\d{12}$

Required: Yes

Response Syntax


{
   "AccountLink": { 
      "AccountLinkId": "string",
      "AccountLinkStatus": "string",
      "SourceAccountId": "string",
      "TargetAccountId": "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.

AccountLink

Information about the account link.

Type: AccountLink object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

ConflictException

The TargetAccountId is already linked or invited.

HTTP Status Code: 400

InternalServerException

Unexpected server error occured.

HTTP Status Code: 400

ValidationException

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.

HTTP Status Code: 400