Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483477323.4 KB

Get an account association for an Amazon Web Services account linked to a customer-managed destination.

get/account-associations/{AccountAssociationId}

Path parameters

AccountAssociationIdstring required

The unique identifier of the account association to retrieve.

Response

Success

AccountAssociationIdstring required

The unique identifier of the retrieved account association.

AssociationState'ASSOCIATION_IN_PROGRESS' | 'ASSOCIATION_FAILED' | 'ASSOCIATION_SUCCEEDED' | 'ASSOCIATION_DELETING' | 'REFRESH_TOKEN_EXPIRED' required

The current status state for the account association.

ErrorMessagestring

The error message explaining the current account association error.

ConnectorDestinationIdstring

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

Namestring

The name of the account association.

Descriptionstring

The description of the account association.

Arnstring

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

OAuthAuthorizationUrlstring password required

Third party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication. This field will be empty when using General Authorization flows that do not require OAuth.

Tagsobject

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