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

GetAccountAssociation

Get an account association for an AWS account linked to a customer-managed destination.

Request Syntax


GET /account-associations/AccountAssociationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AccountAssociationId

The unique identifier of the account association to retrieve.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AccountAssociationId": "string",
   "Arn": "string",
   "AssociationState": "string",
   "ConnectorDestinationId": "string",
   "Description": "string",
   "ErrorMessage": "string",
   "Name": "string",
   "OAuthAuthorizationUrl": "string",
   "Tags": { 
      "string" : "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.

AccountAssociationId

The unique identifier of the retrieved account association.

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 status state for the account association.

Type: String

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

ConnectorDestinationId

The identifier of the connector destination associated with this account association.

Type: String

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

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

Description

The description of the account association.

Type: String

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

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

ErrorMessage

The error message explaining the current account association error.

Type: String

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

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

Name

The name of the account association.

Type: String

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

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

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)://.*

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.

Errors

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

AccessDeniedException

User is not authorized.

HTTP Status Code: 403

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