ListEnrollmentStatuses - AWS Billing and Cost Management

ListEnrollmentStatuses

Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.

Request Syntax

{ "accountId": "string", "includeOrganizationInfo": boolean, "maxResults": number, "nextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

accountId

The account ID of a member account in the organization.

Type: String

Pattern: [0-9]{12}

Required: No

includeOrganizationInfo

Indicates whether to return the enrollment status for the organization.

Type: Boolean

Required: No

maxResults

The maximum number of objects that are returned for the request.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

nextToken

The token to retrieve the next set of results.

Type: String

Required: No

Response Syntax

{ "includeMemberAccounts": boolean, "items": [ { "accountId": "string", "createdTimestamp": number, "lastUpdatedTimestamp": number, "status": "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.

includeMemberAccounts

The enrollment status of all member accounts in the organization if the account is the management account or delegated administrator.

Type: Boolean

items

The enrollment status of a specific account ID, including creation and last updated timestamps.

Type: Array of AccountEnrollmentStatus objects

nextToken

The token to retrieve the next set of results.

Type: String

Errors

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

AccessDeniedException

You are not authorized to use this operation with the given parameters.

HTTP Status Code: 400

InternalServerException

An error on the server occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: