Actions, resources, and condition keys for AWS Health APIs and Notifications - Service Authorization Reference
ActionsResource typesCondition keys

Actions, resources, and condition keys for AWS Health APIs and Notifications

AWS Health APIs and Notifications (service prefix: health) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by AWS Health APIs and Notifications

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
DescribeAffectedAccountsForOrganization Grants permission to retrieve a list of accounts that have been affected by the specified events in organization Read

organizations:ListAccounts

DescribeAffectedEntities Grants permission to retrieve a list of entities that have been affected by the specified events Read

event*

health:eventTypeCode

health:service

DescribeAffectedEntitiesForOrganization Grants permission to retrieve a list of entities that have been affected by the specified events and accounts in organization Read

organizations:ListAccounts

DescribeEntityAggregates Grants permission to retrieve the number of entities that are affected by each of the specified events Read
DescribeEntityAggregatesForOrganization Grants permission to retrieve the number of entities that are affected by each of the specified events in an organization Read

organizations:ListAccounts

DescribeEventAggregates Grants permission to retrieve the number of events of each event type (issue, scheduled change, and account notification) Read
DescribeEventDetails Grants permission to retrieve detailed information about one or more specified events Read

event*

health:eventTypeCode

health:service

DescribeEventDetailsForOrganization Grants permission to retrieve detailed information about one or more specified events for provided accounts in organization Read

organizations:ListAccounts

DescribeEventTypes Grants permission to retrieve the event types that meet the specified filter criteria Read
DescribeEvents Grants permission to retrieve information about events that meet the specified filter criteria Read
DescribeEventsForOrganization Grants permission to retrieve information about events that meet the specified filter criteria in organization Read

organizations:ListAccounts

DescribeHealthServiceStatusForOrganization Grants permission to retrieve the status of enabling or disabling the Organizational View feature Read

organizations:ListAccounts

DisableHealthServiceAccessForOrganization Grants permission to disable the Organizational View feature Permissions management

organizations:DisableAWSServiceAccess

organizations:ListAccounts

EnableHealthServiceAccessForOrganization Grants permission to enable the Organizational View feature Permissions management

iam:CreateServiceLinkedRole

organizations:EnableAWSServiceAccess

organizations:ListAccounts

Resource types defined by AWS Health APIs and Notifications

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types ARN Condition keys
event arn:${Partition}:health:*::event/${Service}/${EventTypeCode}/*

Condition keys for AWS Health APIs and Notifications

AWS Health APIs and Notifications defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys Description Type
health:eventTypeCode Filters access by event type String
health:service Filters access by impacted service String