Operations Actions Resource types Condition keys

Actions, resources, and condition keys for AWS Amplify UI Builder

AWS Amplify UI Builder (service prefix: amplifyuibuilder) 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 AWS Amplify UI Builder
Actions defined by AWS Amplify UI Builder
Resource types defined by AWS Amplify UI Builder
Condition keys for AWS Amplify UI Builder

API operations defined by AWS Amplify UI Builder

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	Access level
CreateComponent	amplifyuibuilder:CreateComponent	Write
CreateComponent	amplifyuibuilder:TagResource	Tagging, Write
CreateForm	amplifyuibuilder:CreateForm	Write
CreateForm	amplifyuibuilder:TagResource	Tagging, Write
CreateTheme	amplifyuibuilder:CreateTheme	Write
CreateTheme	amplifyuibuilder:TagResource	Tagging, Write
DeleteComponent	amplifyuibuilder:DeleteComponent	Write
DeleteForm	amplifyuibuilder:DeleteForm	Write
DeleteTheme	amplifyuibuilder:DeleteTheme	Write
ExchangeCodeForToken	amplifyuibuilder:ExchangeCodeForToken	Write
ExportComponents	amplifyuibuilder:ExportComponents	Read
ExportForms	amplifyuibuilder:ExportForms	Read
ExportThemes	amplifyuibuilder:ExportThemes	Read
GetCodegenJob	amplifyuibuilder:GetCodegenJob	Read
GetComponent	amplifyuibuilder:GetComponent	Read
GetForm	amplifyuibuilder:GetForm	Read
GetMetadata	amplifyuibuilder:GetMetadata	Read
GetTheme	amplifyuibuilder:GetTheme	Read
ListCodegenJobs	amplifyuibuilder:ListCodegenJobs	List
ListComponents	amplifyuibuilder:ListComponents	List
ListForms	amplifyuibuilder:ListForms	List
ListTagsForResource	amplifyuibuilder:ListTagsForResource	List
ListThemes	amplifyuibuilder:ListThemes	List
PutMetadataFlag	amplifyuibuilder:PutMetadataFlag	Write
RefreshToken	amplifyuibuilder:RefreshToken	Write
StartCodegenJob	amplifyuibuilder:StartCodegenJob	Write
TagResource	amplifyuibuilder:TagResource	Tagging, Write
UntagResource	amplifyuibuilder:UntagResource	Tagging, Write
UpdateComponent	amplifyuibuilder:UpdateComponent	Write
UpdateForm	amplifyuibuilder:UpdateForm	Write
UpdateTheme	amplifyuibuilder:UpdateTheme	Write

Actions defined by AWS Amplify UI Builder

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
CreateComponent	Grants permission to create a component		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateForm	Grants permission to create a form		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateTheme	Grants permission to create a theme		aws:RequestTag/${TagKey} aws:TagKeys	Write
DeleteComponent	Grants permission to delete a component	ComponentResource*	amplifyuibuilder:ComponentResourceAppId amplifyuibuilder:ComponentResourceEnvironmentName amplifyuibuilder:ComponentResourceId aws:ResourceTag/${TagKey}	Write
DeleteForm	Grants permission to delete a form	FormResource*	amplifyuibuilder:FormResourceAppId amplifyuibuilder:FormResourceEnvironmentName amplifyuibuilder:FormResourceId aws:ResourceTag/${TagKey}	Write
DeleteTheme	Grants permission to delete a theme	ThemeResource*	amplifyuibuilder:ThemeResourceAppId amplifyuibuilder:ThemeResourceEnvironmentName amplifyuibuilder:ThemeResourceId aws:ResourceTag/${TagKey}	Write
ExchangeCodeForToken	Grants permission to exchange a code for a token			Write
ExportComponents	Grants permission to export components			Read
ExportForms	Grants permission to export forms			Read
ExportThemes	Grants permission to export themes			Read
GetCodegenJob	Grants permission to get an existing codegen job	CodegenJobResource*	amplifyuibuilder:CodegenJobResourceAppId amplifyuibuilder:CodegenJobResourceEnvironmentName amplifyuibuilder:CodegenJobResourceId aws:ResourceTag/${TagKey}	Read
GetComponent	Grants permission to get an existing component	ComponentResource*	amplifyuibuilder:ComponentResourceAppId amplifyuibuilder:ComponentResourceEnvironmentName amplifyuibuilder:ComponentResourceId aws:ResourceTag/${TagKey}	Read
GetForm	Grants permission to get an existing form	FormResource*	amplifyuibuilder:FormResourceAppId amplifyuibuilder:FormResourceEnvironmentName amplifyuibuilder:FormResourceId aws:ResourceTag/${TagKey}	Read
GetMetadata	Grants permission to get an existing metadata			Read
GetTheme	Grants permission to get an existing theme	ThemeResource*	amplifyuibuilder:ThemeResourceAppId amplifyuibuilder:ThemeResourceEnvironmentName amplifyuibuilder:ThemeResourceId aws:ResourceTag/${TagKey}	Read
ListCodegenJobs	Grants permission to list codegen jobs			List
ListComponents	Grants permission to list components			List
ListForms	Grants permission to list forms			List
ListTagsForResource	Grants permission to list tags for a specified Amazon Resource Name (ARN)	CodegenJobResource	amplifyuibuilder:CodegenJobResourceAppId amplifyuibuilder:CodegenJobResourceEnvironmentName amplifyuibuilder:CodegenJobResourceId aws:ResourceTag/${TagKey}	List
		ComponentResource	amplifyuibuilder:ComponentResourceAppId amplifyuibuilder:ComponentResourceEnvironmentName amplifyuibuilder:ComponentResourceId aws:ResourceTag/${TagKey}
		FormResource	amplifyuibuilder:FormResourceAppId amplifyuibuilder:FormResourceEnvironmentName amplifyuibuilder:FormResourceId aws:ResourceTag/${TagKey}
		ThemeResource	amplifyuibuilder:ThemeResourceAppId amplifyuibuilder:ThemeResourceEnvironmentName amplifyuibuilder:ThemeResourceId aws:ResourceTag/${TagKey}
ListThemes	Grants permission to list themes			List
PutMetadataFlag	Grants permission to put an existing metadata			Write
RefreshToken	Grants permission to refresh an access token			Write
ResetMetadataFlag	Grants permission to reset an existing metadata			Write
StartCodegenJob	Grants permission to start a codegen job		aws:RequestTag/${TagKey} aws:TagKeys	Write
TagResource	Grants permission to tag the resource with a tag key and value	CodegenJobResource	amplifyuibuilder:CodegenJobResourceAppId amplifyuibuilder:CodegenJobResourceEnvironmentName amplifyuibuilder:CodegenJobResourceId aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
		ComponentResource	amplifyuibuilder:ComponentResourceAppId amplifyuibuilder:ComponentResourceEnvironmentName amplifyuibuilder:ComponentResourceId aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
		FormResource	amplifyuibuilder:FormResourceAppId amplifyuibuilder:FormResourceEnvironmentName amplifyuibuilder:FormResourceId aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
		ThemeResource	amplifyuibuilder:ThemeResourceAppId amplifyuibuilder:ThemeResourceEnvironmentName amplifyuibuilder:ThemeResourceId aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to untag a resource with a specified Amazon Resource Name (ARN)	CodegenJobResource	amplifyuibuilder:CodegenJobResourceAppId amplifyuibuilder:CodegenJobResourceEnvironmentName amplifyuibuilder:CodegenJobResourceId aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
		ComponentResource	amplifyuibuilder:ComponentResourceAppId amplifyuibuilder:ComponentResourceEnvironmentName amplifyuibuilder:ComponentResourceId aws:ResourceTag/${TagKey} aws:TagKeys
		FormResource	amplifyuibuilder:FormResourceAppId amplifyuibuilder:FormResourceEnvironmentName amplifyuibuilder:FormResourceId aws:ResourceTag/${TagKey} aws:TagKeys
		ThemeResource	amplifyuibuilder:ThemeResourceAppId amplifyuibuilder:ThemeResourceEnvironmentName amplifyuibuilder:ThemeResourceId aws:ResourceTag/${TagKey} aws:TagKeys
UpdateComponent	Grants permission to update a component	ComponentResource*	amplifyuibuilder:ComponentResourceAppId amplifyuibuilder:ComponentResourceEnvironmentName amplifyuibuilder:ComponentResourceId aws:ResourceTag/${TagKey}	Write
UpdateForm	Grants permission to update a form	FormResource*	amplifyuibuilder:FormResourceAppId amplifyuibuilder:FormResourceEnvironmentName amplifyuibuilder:FormResourceId aws:ResourceTag/${TagKey}	Write
UpdateTheme	Grants permission to update a theme	ThemeResource*	amplifyuibuilder:ThemeResourceAppId amplifyuibuilder:ThemeResourceEnvironmentName amplifyuibuilder:ThemeResourceId aws:ResourceTag/${TagKey}	Write

Resource types defined by AWS Amplify UI Builder

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
CodegenJobResource	arn:${Partition}:amplifyuibuilder:${Region}:${Account}:app/${AppId}/environment/${EnvironmentName}/codegen-jobs/${Id}	amplifyuibuilder:CodegenJobResourceAppId amplifyuibuilder:CodegenJobResourceEnvironmentName amplifyuibuilder:CodegenJobResourceId aws:ResourceTag/${TagKey}
ComponentResource	arn:${Partition}:amplifyuibuilder:${Region}:${Account}:app/${AppId}/environment/${EnvironmentName}/components/${Id}	amplifyuibuilder:ComponentResourceAppId amplifyuibuilder:ComponentResourceEnvironmentName amplifyuibuilder:ComponentResourceId aws:ResourceTag/${TagKey}
FormResource	arn:${Partition}:amplifyuibuilder:${Region}:${Account}:app/${AppId}/environment/${EnvironmentName}/forms/${Id}	amplifyuibuilder:FormResourceAppId amplifyuibuilder:FormResourceEnvironmentName amplifyuibuilder:FormResourceId aws:ResourceTag/${TagKey}
ThemeResource	arn:${Partition}:amplifyuibuilder:${Region}:${Account}:app/${AppId}/environment/${EnvironmentName}/themes/${Id}	amplifyuibuilder:ThemeResourceAppId amplifyuibuilder:ThemeResourceEnvironmentName amplifyuibuilder:ThemeResourceId aws:ResourceTag/${TagKey}

Condition keys for AWS Amplify UI Builder

AWS Amplify UI Builder defines the following condition keys that can be used in the Condition element of an IAM policy.

Condition keys	Description	Type
amplifyuibuilder:CodegenJobResourceAppId	Filters access by the app ID	String
amplifyuibuilder:CodegenJobResourceEnvironmentName	Filters access by the backend environment name	String
amplifyuibuilder:CodegenJobResourceId	Filters access by the codegen job ID	String
amplifyuibuilder:ComponentResourceAppId	Filters access by the app ID	String
amplifyuibuilder:ComponentResourceEnvironmentName	Filters access by the backend environment name	String
amplifyuibuilder:ComponentResourceId	Filters access by the component ID	String
amplifyuibuilder:FormResourceAppId	Filters access by the app ID	String
amplifyuibuilder:FormResourceEnvironmentName	Filters access by the backend environment name	String
amplifyuibuilder:FormResourceId	Filters access by the form ID	String
amplifyuibuilder:ThemeResourceAppId	Filters access by the app ID	String
amplifyuibuilder:ThemeResourceEnvironmentName	Filters access by the backend environment name	String
amplifyuibuilder:ThemeResourceId	Filters access by the theme ID	String
aws:RequestTag/${TagKey}	Filters access by the tags that are passed in the request	String
aws:ResourceTag/${TagKey}	Filters access by the tags associated with the resource	String
aws:TagKeys	Filters access by the tag keys that are passed in the request	ArrayOfString

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

AWS Amplify Admin (amplifybackend)

AWS App Mesh (appmesh)