Obtaining the Summary of the Usage and Quota of IAM Entities in an Account

Function

This API is used to obtain the summary of the usage and quota of IAM entities in an account.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iam::getAccountSummaryV5	List	-	-	-	-

URI

GET /v5/account-summary

Request Parameters

None

Response Parameters

Status code: 200

**Table 1** Response body parameters
Parameter	Type	Description
attached_policies_per_agency_quota	Integer	Maximum number of identity policies that can be attached to an agency or trust agency.
attached_policies_per_group_quota	Integer	Maximum number of identity policies that can be attached to a group.
attached_policies_per_user_quota	Integer	Maximum number of identity policies that can be attached to an IAM user.
policies_quota	Integer	Maximum number of custom identity policies.
policy_size_quota	Integer	Maximum characters in the policy documents of identity and trust policies, excluding spaces.
versions_per_policy_quota	Integer	Maximum number of versions that can be retained for a custom identity policy at a time.
policies	Integer	Number of custom identity policies created by the account.
agencies	Integer	Total number of agencies and trust agencies created by the account.
agencies_quota	Integer	Maximum number of agencies and trust agencies that can be created by the account.
users	Integer	Number of IAM users created by the account, including the root user.
users_quota	Integer	Maximum number of IAM users that can be created by the account, including the root user.
groups	Integer	Number of groups created by the account.
groups_quota	Integer	Maximum number of groups that can be created by the account.
root_user_mfa_enabled	Integer	Number of enabled MFA devices bound to the root user.

Status code: 404

**Table 2** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Example Requests

Obtaining the summary of the usage and quota of IAM entities in an account

GET https://{endpoint}/v5/account-summary

Example Responses

Status code: 200

Successful

{
  "attached_policies_per_agency_quota" : 10,
  "attached_policies_per_group_quota" : 10,
  "attached_policies_per_user_quota" : 10,
  "policies_quota" : 1500,
  "policy_size_quota" : 6144,
  "versions_per_policy_quota" : 5,
  "policies" : 133,
  "agencies" : 50,
  "agencies_quota" : 50,
  "users" : 135,
  "users_quota" : 500,
  "groups" : 34,
  "groups_quota" : 500,
  "root_user_mfa_enabled" : 0
}