Actions, resources, and condition keys for Amazon EventBridge Schemas

Amazon EventBridge Schemas (service prefix: schemas) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

• Learn how to configure this service.

• View a list of the API operations available for this service.

• Learn how to secure this service and its resources by using IAM permission policies.

Actions defined by Amazon EventBridge Schemas

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 Access level column of the Actions table describes how the action is classified (List, Read, Permissions management, or Tagging). This classification can help you understand the level of access that an action grants when you use it in a policy. For more information about access levels, see Access levels in policy summaries.

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
CreateDiscoverer	Grants permission to create an event schema discoverer. Once created, your events will be automatically map into corresponding schema documents	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateRegistry	Grants permission to create a new schema registry in your account	Write	registry*
				aws:RequestTag/${TagKey} aws:TagKeys
CreateSchema	Grants permission to create a new schema in your account	Write	schema*
				aws:RequestTag/${TagKey} aws:TagKeys
DeleteDiscoverer	Grants permission to delete discoverer in your account	Write	discoverer*
DeleteRegistry	Grants permission to delete an existing registry in your account	Write	registry*
DeleteResourcePolicy	Grants permission to delete the resource-based policy attached to a given registry	Write	registry*
DeleteSchema	Grants permission to delete an existing schema in your account	Write	schema*
DeleteSchemaVersion	Grants permission to delete a specific version of schema in your account	Write	schema*
DescribeCodeBinding	Grants permission to retrieve metadata for generated code for specific schema in your account	Read	schema*
DescribeDiscoverer	Grants permission to retrieve discoverer metadata in your account	Read	discoverer*
DescribeRegistry	Grants permission to describe an existing registry metadata in your account	Read	registry*
DescribeSchema	Grants permission to retrieve an existing schema in your account	Read	schema*
ExportSchema	Grants permission to export the AWS registry or discovered schemas in OpenAPI 3 format to JSONSchema format	Read	registry*
			schema*
GetCodeBindingSource	Grants permission to retrieve metadata for generated code for specific schema in your account	Read	schema*
GetDiscoveredSchema	Grants permission to retrieve a schema for the provided list of sample events	Read
GetResourcePolicy	Grants permission to retrieve the resource-based policy attached to a given registry	Read	registry*
ListDiscoverers	Grants permission to list all discoverers in your account	List	discoverer*
ListRegistries	Grants permission to list all registries in your account	List	registry*
ListSchemaVersions	Grants permission to list all versions of a schema	List	schema*
ListSchemas	Grants permission to list all schemas	List	schema*
ListTagsForResource	Grants permission to lists tags for a resource	Read	discoverer
			registry
			schema
PutCodeBinding	Grants permission to generate code for specific schema in your account	Write	schema*
PutResourcePolicy	Grants permission to attach a resource-based policy to a given registry	Write	registry*
SearchSchemas	Grants permission to search schemas based on specified keywords in your account	List	schema*
StartDiscoverer	Grants permission to start the specified discoverer. Once started the discoverer will automatically register schemas for published events to configured source in your account	Write	discoverer*
StopDiscoverer	Grants permission to stop the specified discoverer. Once stopped the discoverer will no longer register schemas for published events to configured source in your account	Write	discoverer*
TagResource	Grants permission to tag a resource	Tagging	discoverer
			registry
			schema
				aws:TagKeys aws:RequestTag/${TagKey}
UntagResource	Grants permission to remove a tag from a resource	Tagging	discoverer
			registry
			schema
				aws:TagKeys
UpdateDiscoverer	Grants permission to update an existing discoverer in your account	Write	discoverer*
UpdateRegistry	Grants permission to update an existing registry metadata in your account	Write	registry*
UpdateSchema	Grants permission to update an existing schema in your account	Write	schema*

Resource types defined by Amazon EventBridge Schemas

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
discoverer	arn:${Partition}:schemas:${Region}:${Account}:discoverer/${DiscovererId}	aws:ResourceTag/${TagKey}
registry	arn:${Partition}:schemas:${Region}:${Account}:registry/${RegistryName}	aws:ResourceTag/${TagKey}
schema	arn:${Partition}:schemas:${Region}:${Account}:schema/${RegistryName}/${SchemaName}	aws:ResourceTag/${TagKey}

Condition keys for Amazon EventBridge Schemas

Amazon EventBridge Schemas 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 AWS global condition context keys.

Condition keys	Description	Type
aws:RequestTag/${TagKey}	Filters access by allowed set of values for each of the tags	String
aws:ResourceTag/${TagKey}	Filters access by tag-value associated with the resource	String
aws:TagKeys	Filters access by the presence of mandatory tags in the request	ArrayOfString