Retrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by using the CallAs parameter. This API can also be called without the CallAs parameter by the management account.
Parameters:
-
call_as
(Optional[CallAs], default:
None
)
–
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified.
-
If you are signed in to the management account, specify SELF.
-
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Raises:
Source code in docs_src/capo_cloudformation/_services/cloud_formation.py
| def describe_organizations_access(
self,
*,
config_overrides: Optional[CloudFormationClientConfig] = None,
call_as: Optional["capo_cloudformation.types.call_as.CallAs"] = None,
) -> "capo_cloudformation.types.describe_organizations_access_output.DescribeOrganizationsAccessOutput":
"""<p>Retrieves information about the account's <code>OrganizationAccess</code> status. This API can be called either by the management account or the delegated administrator by using the <code>CallAs</code> parameter. This API can also be called without the <code>CallAs</code> parameter by the management account.</p>
Args:
call_as: <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>
Raises:
capo_cloudformation.errors.invalid_operation_exception.InvalidOperationException: <p>The specified operation isn't valid.</p>
capo_cloudformation.errors.operation_not_found_exception.OperationNotFoundException: <p>The specified ID refers to an operation that doesn't exist.</p>
capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_cloudformation.types.describe_organizations_access_input.DescribeOrganizationsAccessInput]",
) -> OperationResponse[
"capo_cloudformation.types.describe_organizations_access_output.DescribeOrganizationsAccessOutput"
]:
import capo_cloudformation._operations.cloud_formation.describe_organizations_access
output, http_response = (
capo_cloudformation._operations.cloud_formation.describe_organizations_access.describe_organizations_access(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeOrganizationsAccess")
)
input_: capo_cloudformation.types.describe_organizations_access_input.DescribeOrganizationsAccessInput = {}
if call_as is not None:
input_["call_as"] = call_as
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|