GetConsoleAuthorizationConfiguration
Retrieves AWS Management Console authorization configuration for an AWS account or organization.
The operation automatically detects whether the targetId is an account ID or an organization ID.
Request Syntax
{
"targetId": "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.
- targetId
The target identifier to retrieve the configuration for. Accepts a 12-digit account ID, an organization ID (
o-xxxxxxxxxx), or null/empty to use the caller's account ID.Type: String
Length Constraints: Minimum length of 12. Maximum length of 32.
Pattern:
(\d{12}|o-[a-z0-9]{10}|r-[0-9a-z]{4,32})Required: No
Response Syntax
{
"consoleAuthorizationEnabled": boolean,
"scope": "string",
"targetId": "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.
- consoleAuthorizationEnabled
Indicates whether AWS Management Console authorization is enabled for the target.
Type: Boolean
- scope
The scope of the configuration. Indicates whether the configuration applies at the account or organization level.
Type: String
- targetId
The target identifier the configuration applies to.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 32.
Pattern:
(\d{12}|o-[a-z0-9]{10}|r-[0-9a-z]{4,32})
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- InternalServerException
The request processing has failed because of an unknown error, exception or failure with an internal server.
HTTP Status Code: 500
- ResourceNotFoundException
The request was denied because the specified resource was not found.
HTTP Status Code: 400
- TooManyRequestsError
The request was denied due to rate limiting.
HTTP Status Code: 400
- ValidationException
The request failed because it contains a syntax error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
