GetEnrollmentStatusesForOrganization - AWS Compute Optimizer

GetEnrollmentStatusesForOrganization

Returns the AWS Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.

To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.

Request Syntax

{ "filters": [ { "name": "string", "values": [ "string" ] } ], "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.

filters

An array of objects to specify a filter that returns a more specific list of account enrollment statuses.

Type: Array of EnrollmentFilter objects

Required: No

maxResults

The maximum number of account enrollment statuses to return with a single request. You can specify up to 100 statuses to return with each request.

To retrieve the remaining results, make another request with the returned nextToken value.

Type: Integer

Required: No

nextToken

The token to advance to the next page of account enrollment statuses.

Type: String

Required: No

Response Syntax

{ "accountEnrollmentStatuses": [ { "accountId": "string", "lastUpdatedTimestamp": number, "status": "string", "statusReason": "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.

accountEnrollmentStatuses

An array of objects that describe the enrollment statuses of organization member accounts.

Type: Array of AccountEnrollmentStatus objects

nextToken

The token to use to advance to the next page of account enrollment statuses.

This value is null when there are no more pages of account enrollment statuses to return.

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: 400

InternalServerException

An internal error has occurred. Try your call again.

HTTP Status Code: 500

InvalidParameterValueException

The value supplied for the input parameter is out of range or not valid.

HTTP Status Code: 400

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed due to a temporary failure of the server.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

See Also

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