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

CreateAccountAssociation

Creates a new account association via the destination id.

Request Syntax


POST /account-associations HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ConnectorDestinationId": "string",
   "Description": "string",
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

Type: String

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

Pattern: [a-zA-Z0-9=_-]+

Required: No

ConnectorDestinationId

The identifier of the connector destination.

Type: String

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

Pattern: [A-Za-z0-9-_]+

Required: Yes

Description

A description of the account association request.

Type: String

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

Pattern: [A-Za-z0-9-_ ]+

Required: No

Name

The name of the destination for the new account association.

Type: String

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

Pattern: [A-Za-z0-9-_ ]+

Required: No

Tags

A set of key/value pairs that are used to manage the account association.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "AccountAssociationId": "string",
   "Arn": "string",
   "AssociationState": "string",
   "OAuthAuthorizationUrl": "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.

AccountAssociationId

The identifier for the account association request.

Type: String

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

Pattern: [0-9a-zA-Z]+

Arn

The Amazon Resource Name (ARN) of the account association.

Type: String

Length Constraints: Minimum length of 67. Maximum length of 1011.

Pattern: arn:aws:iotmanagedintegrations:[0-9a-zA-Z-]+:[0-9]+:account-association/[0-9a-zA-Z]+

AssociationState

The current state of the account association request.

Type: String

Valid Values: ASSOCIATION_IN_PROGRESS | ASSOCIATION_FAILED | ASSOCIATION_SUCCEEDED | ASSOCIATION_DELETING | REFRESH_TOKEN_EXPIRED

OAuthAuthorizationUrl

Third-party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication.

Type: String

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

Pattern: (https)://.*

Errors

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

AccessDeniedException

User is not authorized.

HTTP Status Code: 403

ConflictException

There is a conflict with the request.

HTTP Status Code: 409

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

A validation error occurred when performing the API request.

HTTP Status Code: 400