Skip to content

CloudFormation  >  Operations  >  describe_organizations_access

describe_organizations_access

Operation

describe_organizations_access async

describe_organizations_access(request: DescribeOrganizationsAccessInput | DescribeOrganizationsAccessInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeOrganizationsAccessOutput
describe_organizations_access(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeOrganizationsAccessInputDict]) -> DescribeOrganizationsAccessOutput

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:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeOrganizationsAccessOutput

An instance of DescribeOrganizationsAccessOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeOrganizationsAccessInput dataclass

Bases: _SerdeShape

Dataclass for DescribeOrganizationsAccessInput structure.

Attributes
call_as class-attribute instance-attribute
call_as: str | 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.

Dictionaries

DescribeOrganizationsAccessInputDict

Bases: TypedDict

Dictionary form of DescribeOrganizationsAccessInput.

Attributes
call_as instance-attribute
call_as: str | 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.

Output

DescribeOrganizationsAccessOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeOrganizationsAccessOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status class-attribute instance-attribute
status: str | None = ...

Presents the status of the OrganizationAccess.