Actions, resources, and condition keys for AWS Amplify
AWS Amplify (service prefix: amplify
) 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.
Topics
Actions defined by AWS Amplify
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 indicates whether each action supports resource-level permissions. If
there is no value for this column, you must specify all resources ("*") 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. Required
resources are indicated in the table with an asterisk (*). If you specify a resource-level
permission ARN in a statement using this action, then it must be of this type.
Some actions support multiple resource types. If the resource type is optional (not
indicated as required), then you can choose to use one but not the other.
For details about the columns in the following table, see The actions table.
Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
---|---|---|---|---|---|
CreateApp | Creates a new Amplify App. | Write | |||
CreateBackendEnvironment | Creates a new backend environment for an Amplify App. | Write | |||
CreateBranch | Creates a new Branch for an Amplify App. | Write | |||
CreateDeployment | Create a deployment for manual deploy apps. (Apps are not connected to repository) | Write | |||
CreateDomainAssociation | Create a new DomainAssociation on an App | Write | |||
CreateWebHook | Create a new webhook on an App. | Write | |||
DeleteApp | Delete an existing Amplify App by appId. | Write | |||
DeleteBackendEnvironment | Deletes a branch for an Amplify App. | Write | |||
DeleteBranch | Deletes a branch for an Amplify App. | Write | |||
DeleteDomainAssociation | Deletes a DomainAssociation. | Write | |||
DeleteJob | Delete a job, for an Amplify branch, part of Amplify App. | Write | |||
DeleteWebHook | Delete a webhook by id. | Write | |||
GenerateAccessLogs | Generate website access logs for a specific time range via a pre-signed URL. | Write | |||
GetApp | Retrieves an existing Amplify App by appId. | Read | |||
GetArtifactUrl | Retrieves artifact info that corresponds to a artifactId. | Read | |||
GetBackendEnvironment | Retrieves a backend environment for an Amplify App. | Read | |||
GetBranch | Retrieves a branch for an Amplify App. | Read | |||
GetDomainAssociation | Retrieves domain info that corresponds to an appId and domainName. | Read | |||
GetJob | Get a job for a branch, part of an Amplify App. | Read | |||
GetWebHook | Retrieves webhook info that corresponds to a webhookId. | Read | |||
ListApps | Lists existing Amplify Apps. | List | |||
ListArtifacts | List artifacts with an app, a branch, a job and an artifact type. | List | |||
ListBackendEnvironments | Lists backend environments for an Amplify App. | List | |||
ListBranches | Lists branches for an Amplify App. | List | |||
ListDomainAssociations | List domains with an app | List | |||
ListJobs | List Jobs for a branch, part of an Amplify App. | List | |||
ListWebHooks | List webhooks on an App. | List | |||
StartDeployment | Start a deployment for manual deploy apps. (Apps are not connected to repository) | Write | |||
StartJob | Starts a new job for a branch, part of an Amplify App. | Write | |||
StopJob | Stop a job that is in progress, for an Amplify branch, part of Amplify App. | Write | |||
TagResource | This action tags an AWS Amplify Console resource. | Tagging | |||
UntagResource | This action removes a tag from an AWS Amplify Console resource. | Tagging | |||
UpdateApp | Updates an existing Amplify App. | Write | |||
UpdateBranch | Updates a branch for an Amplify App. | Write | |||
UpdateDomainAssociation | Update a DomainAssociation on an App. | Write | |||
UpdateWebHook | Update a webhook. | Write |
Resource types defined by AWS Amplify
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 table. For details about the columns
in the following table, see The resource types table.
Resource types | ARN | Condition keys |
---|---|---|
apps |
arn:${Partition}:amplify:${Region}:${Account}:apps/${AppId}
|
|
branches |
arn:${Partition}:amplify:${Region}:${Account}:apps/${AppId}/branches/${BranchName}
|
|
jobs |
arn:${Partition}:amplify:${Region}:${Account}:apps/${AppId}/branches/${BranchName}/jobs/${JobId}
|
|
domains |
arn:${Partition}:amplify:${Region}:${Account}:apps/${AppId}/domains/${DomainName}
|
Condition keys for AWS Amplify
AWS Amplify 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 The condition keys table.
To view the global condition keys that are available to all services, see Available global condition keys.