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

ListAccountAssociations

This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group that's associated with the linked account.

Request Syntax


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

{
   "BillingPeriod": "string",
   "Filters": { 
      "AccountId": "string",
      "AccountIds": [ "string" ],
      "Association": "string"
   },
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

BillingPeriod

The preferred billing period to get account associations.

Type: String

Pattern: \d{4}-(0?[1-9]|1[012])

Required: No

Filters

The filter on the account ID of the linked account, or any of the following:

MONITORED: linked accounts that are associated to billing groups.

UNMONITORED: linked accounts that aren't associated to billing groups.

Billing Group Arn: linked accounts that are associated to the provided billing group Arn.

Type: ListAccountAssociationsFilter object

Required: No

NextToken

The pagination token that's used on subsequent calls to retrieve accounts.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "LinkedAccounts": [ 
      { 
         "AccountEmail": "string",
         "AccountId": "string",
         "AccountName": "string",
         "BillingGroupArn": "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.

LinkedAccounts

The list of linked accounts in the payer account.

Type: Array of AccountAssociationsListElement objects

NextToken

The pagination token that's used on subsequent calls to get accounts.

Type: String

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input doesn't match with the constraints specified by AWS services.

HTTP Status Code: 400