View a markdown version of this page

ConfigureTagsForOrganization - AWS Health

ConfigureTagsForOrganization

Configures which tag keys are tracked by Health for all accounts in your organization. This operation replaces the existing configuration with the specified tag keys. Only configured tag keys will appear in Health event data across the organization.

Request Syntax

{ "tagKeys": [ { "enabledForEventBridge": boolean, "key": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

tagKeys

The list of tag keys to configure for Health event tracking across the organization.

Type: Array of TagKeyForOrganization objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax

{ "configuredTagKeys": [ { "enabledForEventBridge": boolean, "key": "string", "status": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

configuredTagKeys

The list of tag keys that were successfully configured for the organization, with the current status of each tag key.

Type: Array of OrganizationTagKey objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Errors

For information about the errors that are common to all actions, see Common Error Types.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: