amplifybackend:GetBackendAPI

Read

amplifybackend:GetBackendAPI is a Read access-level action in the amplifybackend service. Grants permission to retrieve an API of an existing Amplify Admin backend environment by appId and backendEnvironmentName

Resource types

ARNs that amplifybackend:GetBackendAPI can be scoped to in an IAM policy.

arn:${Partition}:amplifybackend:${Region}:${Account}:/backend/${AppId}/api/ required
api
arn:${Partition}:amplifybackend:${Region}:${Account}:/backend/${AppId}/ required
backend
arn:${Partition}:amplifybackend:${Region}:${Account}:/backend/${AppId}/environments/ required
environment

Condition keys

No condition keys are documented for this action.

Example IAM policy

A minimal policy that allows amplifybackend:GetBackendAPI. Replace "Resource": "*" with a specific ARN to follow least privilege.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowAmplifybackendGetBackendAPI",
      "Effect": "Allow",
      "Action": "amplifybackend:GetBackendAPI",
      "Resource": "*"
    }
  ]
}

Related actions in amplifybackend

amplifybackend:CloneBackend Write amplifybackend:CreateBackend Write amplifybackend:CreateBackendAPI Write amplifybackend:CreateBackendAuth Write amplifybackend:CreateBackendConfig Write amplifybackend:CreateBackendStorage Write amplifybackend:CreateToken Write amplifybackend:DeleteBackend Write amplifybackend:DeleteBackendAPI Write amplifybackend:DeleteBackendAuth Write amplifybackend:DeleteBackendStorage Write amplifybackend:DeleteToken Write

View all amplifybackend actions →