EC2 / Client / update_capacity_manager_organizations_access

update_capacity_manager_organizations_access

EC2.Client.update_capacity_manager_organizations_access(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_capacity_manager_organizations_access(
    OrganizationsAccess=True|False,
    DryRun=True|False,
    ClientToken='string'
)
Parameters:

  • OrganizationsAccess (boolean) –

    [REQUIRED]

    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.

  • DryRun (boolean) – 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.

  • ClientToken (string) –

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

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'CapacityManagerStatus': 'enabled'|'disabled',
    'OrganizationsAccess': True|False
}

Response Structure

  • (dict) –

    • CapacityManagerStatus (string) –

      The current status of Capacity Manager after the update operation.

    • OrganizationsAccess (boolean) –

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