Skip to content

Describe Organizations Access

cloudformation_describe_organizations_access R Documentation

Retrieves information about the account's OrganizationAccess status

Description

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.

Usage

cloudformation_describe_organizations_access(CallAs)

Arguments

CallAs

[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.

Value

A list with the following syntax: 

list(
  Status = "ENABLED"|"DISABLED"|"DISABLED_PERMANENTLY"
)

Request syntax

svc$describe_organizations_access(
  CallAs = "SELF"|"DELEGATED_ADMIN"
)