Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAccountLinks

Lists all account links.

Request Syntax


{
   "LinkStatusFilter": [ "string" ],
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

The request accepts the following data in JSON format.

LinkStatusFilter

Filters the account based on their link status.

Type: Array of strings

Valid Values: LINKED | LINKING_FAILED | LINK_NOT_FOUND | PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT | REJECTED

Required: No

MaxResults

The maximum number of accounts to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

NextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

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

Required: No

Response Syntax


{
   "AccountLinks": [ 
      { 
         "AccountLinkId": "string",
         "AccountLinkStatus": "string",
         "SourceAccountId": "string",
         "TargetAccountId": "string"
      }
   ],
   "NextToken": "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.

AccountLinks

Information about the account links.

Type: Array of AccountLink objects

NextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

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

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

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