UpdateCapacityManagerOrganizationsAccess
Updates the Organizations access setting for EC2 Capacity Manager. This controls whether Capacity Manager can aggregate data from all accounts in your Amazon Organization or only from the current account.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- ClientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Required: No
- DryRun
-
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.Type: Boolean
Required: No
- OrganizationsAccess
-
Specifies whether to enable or disable cross-account access for Amazon Organizations. When enabled, Capacity Manager aggregates data from all accounts in your organization.
Type: Boolean
Required: Yes
Response Elements
The following elements are returned by the service.
- capacityManagerStatus
-
The current status of Capacity Manager after the update operation.
Type: String
Valid Values:
enabled | disabled - organizationsAccess
-
The updated Organizations access setting indicating whether cross-account data aggregation is enabled.
Type: Boolean
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: