Actions, resources, and condition keys for Amazon EventBridge Schemas
Amazon EventBridge Schemas (service prefix: schemas) provides the following
service-specific operations, resources, actions, and condition 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.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon EventBridge Schemas
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
CreateDiscoverer |
Write |
|||
Tagging, Write |
||||
|
CreateRegistry |
Write |
|||
Tagging, Write |
||||
|
CreateSchema |
Write |
|||
Tagging, Write |
||||
|
DeleteDiscoverer |
Write |
|||
|
DeleteRegistry |
Write |
|||
|
DeleteResourcePolicy |
Write |
|||
|
DeleteSchema |
Write |
|||
|
DeleteSchemaVersion |
Write |
|||
|
DescribeCodeBinding |
Read |
|||
|
DescribeDiscoverer |
Read |
|||
|
DescribeRegistry |
Read |
|||
|
DescribeSchema |
Read |
|||
|
ExportSchema |
Read |
|||
|
GetCodeBindingSource |
Read |
|||
|
GetDiscoveredSchema |
Read |
|||
|
GetResourcePolicy |
Read |
|||
|
ListDiscoverers |
List |
|||
|
ListRegistries |
List |
|||
|
ListSchemaVersions |
List |
|||
|
ListSchemas |
List |
|||
|
ListTagsForResource |
Read |
|||
|
PutCodeBinding |
Write |
|||
|
PutResourcePolicy |
Write |
|||
|
SearchSchemas |
List |
|||
|
StartDiscoverer |
Write |
|||
|
StopDiscoverer |
Write |
|||
|
TagResource |
Tagging, Write |
|||
|
UntagResource |
Tagging, Write |
|||
|
UpdateDiscoverer |
Write |
|||
|
UpdateRegistry |
Write |
|||
|
UpdateSchema |
Write |
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.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to create an event schema discoverer. Once created, your events will be automatically map into corresponding schema documents |
Write |
|||
Grants permission to create a new schema registry in your account |
Write |
|||
Grants permission to create a new schema in your account |
Write |
|||
Grants permission to delete discoverer in your account |
Write |
|||
Grants permission to delete an existing registry in your account |
Write |
|||
Grants permission to delete the resource-based policy attached to a given registry |
Write |
|||
Grants permission to delete an existing schema in your account |
Write |
|||
Grants permission to delete a specific version of schema in your account |
Write |
|||
Grants permission to retrieve metadata for generated code for specific schema in your account |
Read |
|||
Grants permission to retrieve discoverer metadata in your account |
Read |
|||
Grants permission to describe an existing registry metadata in your account |
Read |
|||
Grants permission to retrieve an existing schema in your account |
Read |
|||
Grants permission to export the AWS registry or discovered schemas in OpenAPI 3 format to JSONSchema format |
Read |
|||
Grants permission to retrieve metadata for generated code for specific schema in your account |
Read |
|||
Grants permission to retrieve a schema for the provided list of sample events |
Read |
|||
Grants permission to retrieve the resource-based policy attached to a given registry |
Read |
|||
Grants permission to list all discoverers in your account |
List |
|||
Grants permission to list all registries in your account |
List |
|||
Grants permission to list all versions of a schema |
List |
|||
Grants permission to list all schemas |
List |
|||
Grants permission to lists tags for a resource |
Read |
|||
Grants permission to generate code for specific schema in your account |
Write |
|||
Grants permission to attach a resource-based policy to a given registry |
Write |
|||
Grants permission to search schemas based on specified keywords in your account |
List |
|||
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 |
|||
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 |
|||
Grants permission to tag a resource |
Tagging, Write |
|||
Grants permission to remove a tag from a resource |
Tagging, Write |
|||
Grants permission to update an existing discoverer in your account |
Write |
|||
Grants permission to update an existing registry metadata in your account |
Write |
|||
Grants permission to update an existing schema in your account |
Write |
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.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:schemas:${Region}:${Account}:discoverer/${DiscovererId} |
||
arn:${Partition}:schemas:${Region}:${Account}:registry/${RegistryName} |
||
arn:${Partition}:schemas:${Region}:${Account}:schema/${RegistryName}/${SchemaName} |
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.
| Condition keys | Description | Type |
|---|---|---|
Filters access by allowed set of values for each of the tags |
String |
|
Filters access by tag-value associated with the resource |
String |
|
Filters access by the presence of mandatory tags in the request |
ArrayOfString |