Skip to content

EC2  >  Operations  >  update_capacity_manager_organizations_access

update_capacity_manager_organizations_access

Operation

update_capacity_manager_organizations_access async

update_capacity_manager_organizations_access(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateCapacityManagerOrganizationsAccessInputDict]) -> UpdateCapacityManagerOrganizationsAccessOutput

Updates the Organizations access setting for EC2 Capacity Manager. This controls whether Capacity Manager can aggregate data from all accounts in your Amazon Web Services Organization or only from the current 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
UpdateCapacityManagerOrganizationsAccessOutput

An instance of UpdateCapacityManagerOrganizationsAccessOutput.

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

UpdateCapacityManagerOrganizationsAccessInput dataclass

Bases: _SerdeShape

Dataclass for UpdateCapacityManagerOrganizationsAccessInput structure.

Attributes
client_token class-attribute instance-attribute
client_token: str | None = ...

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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 is UnauthorizedOperation.

organizations_access class-attribute instance-attribute
organizations_access: bool | None = ...

Specifies whether to enable or disable cross-account access for Amazon Web Services Organizations. When enabled, Capacity Manager aggregates data from all accounts in your organization.

Dictionaries

UpdateCapacityManagerOrganizationsAccessInputDict

Bases: TypedDict

Dictionary form of UpdateCapacityManagerOrganizationsAccessInput.

Attributes
client_token instance-attribute
client_token: str | None

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

dry_run instance-attribute
dry_run: bool | None

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 is UnauthorizedOperation.

organizations_access instance-attribute
organizations_access: Required[bool]

Specifies whether to enable or disable cross-account access for Amazon Web Services Organizations. When enabled, Capacity Manager aggregates data from all accounts in your organization.

Output

UpdateCapacityManagerOrganizationsAccessOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateCapacityManagerOrganizationsAccessOutput structure.

Attributes

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

The current status of Capacity Manager after the update operation.

organizations_access class-attribute instance-attribute
organizations_access: bool | None = ...

The updated Organizations access setting indicating whether cross-account data aggregation is enabled.

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.