View a markdown version of this page

ListOrganizationEnrollmentConfigurations - AWS Compute Optimizer

ListOrganizationEnrollmentConfigurations

Lists the organization enrollment configurations that are stored directly on accounts, organizational units (OUs), and the organization root.

Note

Only the management account or a delegated administrator can perform this action.

Request Syntax

{ "maxResults": number, "nextToken": "string", "targetType": "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.

maxResults

The maximum number of organization enrollment configurations to return in a single response. If you don't specify a value, the default is 1,000.

Type: Integer

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

Required: No

nextToken

The token to use to retrieve the next page of results.

Type: String

Pattern: [A-Za-z0-9+/=]+

Required: No

targetType

The target type to use to filter the results. If you specify OrganizationalUnit, the results also include configurations stored on the organization root. If you don't specify a target type, the operation returns configurations for every target type.

Type: String

Valid Values: Account | OrganizationalUnit

Required: No

Response Syntax

{ "nextToken": "string", "organizationEnrollmentConfigurations": [ { "organizationRuleMode": "string", "targetId": "string", "targetType": "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.

nextToken

The token to use to retrieve the next page of results.

Type: String

Pattern: [A-Za-z0-9+/=]+

organizationEnrollmentConfigurations

The organization enrollment configurations stored on each target in this page of results.

Type: Array of OrganizationEnrollmentConfiguration objects

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ForbiddenException

You are not authorized to perform this action.

HTTP Status Code: 403

InternalServerException

An internal error occurred while processing the request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400

OptInRequiredException

The account must be opted in to Compute Optimizer Automation before performing this action.

HTTP Status Code: 403

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also

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