---
updatedAt: 2025-11-12T00:56:27.000Z
agentTools:
  projectIndex: https://public.docs.kivera.io/llms.txt
---

# AMPLIFY

<Embed url="https://docs.aws.amazon.com/" title="AWS documentation" provider="docs.aws.amazon.com" href="https://docs.aws.amazon.com/" />

# CreateApp

```erlang
enum_BuildComputeType := [ "STANDARD_8GB", "LARGE_16GB", "XLARGE_72GB" ]
enum_CacheConfigType := [ "AMPLIFY_MANAGED", "AMPLIFY_MANAGED_NO_COOKIES" ]
enum_Platform := [ "WEB", "WEB_DYNAMIC", "WEB_COMPUTE" ]
enum_Stage := [ "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL", "PULL_REQUEST" ]

valid {
    input.Body.name == STRING
    input.Body.description == STRING
    input.Body.repository == STRING
    input.Body.platform == enum_Platform[_]
    input.Body.computeRoleArn == STRING
    input.Body.iamServiceRoleArn == STRING
    input.Body.oauthToken == STRING
    input.Body.accessToken == STRING
    input.Body.environmentVariables.STRING == STRING
    input.Body.enableBranchAutoBuild == BOOLEAN
    input.Body.enableBranchAutoDeletion == BOOLEAN
    input.Body.enableBasicAuth == BOOLEAN
    input.Body.basicAuthCredentials == STRING
    input.Body.customRules[_].source == STRING
    input.Body.customRules[_].target == STRING
    input.Body.customRules[_].status == STRING
    input.Body.customRules[_].condition == STRING
    input.Body.tags.STRING == STRING
    input.Body.buildSpec == STRING
    input.Body.customHeaders == STRING
    input.Body.enableAutoBranchCreation == BOOLEAN
    input.Body.autoBranchCreationPatterns[_] == STRING
    input.Body.autoBranchCreationConfig.stage == enum_Stage[_]
    input.Body.autoBranchCreationConfig.framework == STRING
    input.Body.autoBranchCreationConfig.enableAutoBuild == BOOLEAN
    input.Body.autoBranchCreationConfig.environmentVariables.STRING == STRING
    input.Body.autoBranchCreationConfig.basicAuthCredentials == STRING
    input.Body.autoBranchCreationConfig.enableBasicAuth == BOOLEAN
    input.Body.autoBranchCreationConfig.enablePerformanceMode == BOOLEAN
    input.Body.autoBranchCreationConfig.buildSpec == STRING
    input.Body.autoBranchCreationConfig.enablePullRequestPreview == BOOLEAN
    input.Body.autoBranchCreationConfig.pullRequestEnvironmentName == STRING
    input.Body.jobConfig.buildComputeType == enum_BuildComputeType[_]
    input.Body.cacheConfig.type == enum_CacheConfigType[_]
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# CreateBackendEnvironment

```erlang
valid {
    input.Body.environmentName == STRING
    input.Body.stackName == STRING
    input.Body.deploymentArtifacts == STRING
    input.ReqMap.appId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# CreateBranch

```erlang
enum_Stage := [ "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL", "PULL_REQUEST" ]

valid {
    input.Body.branchName == STRING
    input.Body.description == STRING
    input.Body.stage == enum_Stage[_]
    input.Body.framework == STRING
    input.Body.enableNotification == BOOLEAN
    input.Body.enableAutoBuild == BOOLEAN
    input.Body.enableSkewProtection == BOOLEAN
    input.Body.environmentVariables.STRING == STRING
    input.Body.basicAuthCredentials == STRING
    input.Body.enableBasicAuth == BOOLEAN
    input.Body.enablePerformanceMode == BOOLEAN
    input.Body.tags.STRING == STRING
    input.Body.buildSpec == STRING
    input.Body.ttl == STRING
    input.Body.displayName == STRING
    input.Body.enablePullRequestPreview == BOOLEAN
    input.Body.pullRequestEnvironmentName == STRING
    input.Body.backendEnvironmentArn == STRING
    input.Body.backend.stackArn == STRING
    input.Body.computeRoleArn == STRING
    input.ReqMap.appId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# CreateDeployment

```erlang
valid {
    input.Body.fileMap.STRING == STRING
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# CreateDomainAssociation

```erlang
enum_CertificateType := [ "AMPLIFY_MANAGED", "CUSTOM" ]

valid {
    input.Body.domainName == STRING
    input.Body.enableAutoSubDomain == BOOLEAN
    input.Body.subDomainSettings[_].prefix == STRING
    input.Body.subDomainSettings[_].branchName == STRING
    input.Body.autoSubDomainCreationPatterns[_] == STRING
    input.Body.autoSubDomainIAMRole == STRING
    input.Body.certificateSettings.type == enum_CertificateType[_]
    input.Body.certificateSettings.customCertificateArn == STRING
    input.ReqMap.appId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# CreateWebhook

```erlang
valid {
    input.Body.branchName == STRING
    input.Body.description == STRING
    input.ReqMap.appId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DeleteApp

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DeleteBackendEnvironment

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.environmentName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DeleteBranch

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DeleteDomainAssociation

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.domainName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DeleteJob

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.ReqMap.jobId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# DeleteWebhook

```erlang
valid {
    input.ReqMap.webhookId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GenerateAccessLogs

```erlang
valid {
    input.Body.startTime == TIMESTAMP
    input.Body.endTime == TIMESTAMP
    input.Body.domainName == STRING
    input.ReqMap.appId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GetApp

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GetArtifactUrl

```erlang
valid {
    input.ReqMap.artifactId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GetBackendEnvironment

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.environmentName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GetBranch

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GetDomainAssociation

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.domainName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GetJob

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.ReqMap.jobId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# GetWebhook

```erlang
valid {
    input.ReqMap.webhookId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListApps

```erlang
valid {
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListArtifacts

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.ReqMap.jobId == STRING
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListBackendEnvironments

```erlang
valid {
    input.ReqMap.appId == STRING
    input.Qs.environmentName == STRING
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListBranches

```erlang
valid {
    input.ReqMap.appId == STRING
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListDomainAssociations

```erlang
valid {
    input.ReqMap.appId == STRING
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListJobs

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListTagsForResource

```erlang
valid {
    input.ReqMap.resourceArn == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# ListWebhooks

```erlang
valid {
    input.ReqMap.appId == STRING
    input.Qs.nextToken == STRING
    input.Qs.maxResults == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# StartDeployment

```erlang
enum_SourceUrlType := [ "ZIP", "BUCKET_PREFIX" ]

valid {
    input.Body.jobId == STRING
    input.Body.sourceUrl == STRING
    input.Body.sourceUrlType == enum_SourceUrlType[_]
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# StartJob

```erlang
enum_JobType := [ "RELEASE", "RETRY", "MANUAL", "WEB_HOOK" ]

valid {
    input.Body.jobId == STRING
    input.Body.jobType == enum_JobType[_]
    input.Body.jobReason == STRING
    input.Body.commitId == STRING
    input.Body.commitMessage == STRING
    input.Body.commitTime == TIMESTAMP
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# StopJob

```erlang
valid {
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.ReqMap.jobId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# TagResource

```erlang
valid {
    input.Body.tags.STRING == STRING
    input.ReqMap.resourceArn == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# UntagResource

```erlang
valid {
    input.ReqMap.resourceArn == STRING
    input.Qs.tagKeys[_] == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# UpdateApp

```erlang
enum_BuildComputeType := [ "STANDARD_8GB", "LARGE_16GB", "XLARGE_72GB" ]
enum_CacheConfigType := [ "AMPLIFY_MANAGED", "AMPLIFY_MANAGED_NO_COOKIES" ]
enum_Platform := [ "WEB", "WEB_DYNAMIC", "WEB_COMPUTE" ]
enum_Stage := [ "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL", "PULL_REQUEST" ]

valid {
    input.Body.name == STRING
    input.Body.description == STRING
    input.Body.platform == enum_Platform[_]
    input.Body.computeRoleArn == STRING
    input.Body.iamServiceRoleArn == STRING
    input.Body.environmentVariables.STRING == STRING
    input.Body.enableBranchAutoBuild == BOOLEAN
    input.Body.enableBranchAutoDeletion == BOOLEAN
    input.Body.enableBasicAuth == BOOLEAN
    input.Body.basicAuthCredentials == STRING
    input.Body.customRules[_].source == STRING
    input.Body.customRules[_].target == STRING
    input.Body.customRules[_].status == STRING
    input.Body.customRules[_].condition == STRING
    input.Body.buildSpec == STRING
    input.Body.customHeaders == STRING
    input.Body.enableAutoBranchCreation == BOOLEAN
    input.Body.autoBranchCreationPatterns[_] == STRING
    input.Body.autoBranchCreationConfig.stage == enum_Stage[_]
    input.Body.autoBranchCreationConfig.framework == STRING
    input.Body.autoBranchCreationConfig.enableAutoBuild == BOOLEAN
    input.Body.autoBranchCreationConfig.environmentVariables.STRING == STRING
    input.Body.autoBranchCreationConfig.basicAuthCredentials == STRING
    input.Body.autoBranchCreationConfig.enableBasicAuth == BOOLEAN
    input.Body.autoBranchCreationConfig.enablePerformanceMode == BOOLEAN
    input.Body.autoBranchCreationConfig.buildSpec == STRING
    input.Body.autoBranchCreationConfig.enablePullRequestPreview == BOOLEAN
    input.Body.autoBranchCreationConfig.pullRequestEnvironmentName == STRING
    input.Body.repository == STRING
    input.Body.oauthToken == STRING
    input.Body.accessToken == STRING
    input.Body.jobConfig.buildComputeType == enum_BuildComputeType[_]
    input.Body.cacheConfig.type == enum_CacheConfigType[_]
    input.ReqMap.appId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# UpdateBranch

```erlang
enum_Stage := [ "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL", "PULL_REQUEST" ]

valid {
    input.Body.description == STRING
    input.Body.framework == STRING
    input.Body.stage == enum_Stage[_]
    input.Body.enableNotification == BOOLEAN
    input.Body.enableAutoBuild == BOOLEAN
    input.Body.enableSkewProtection == BOOLEAN
    input.Body.environmentVariables.STRING == STRING
    input.Body.basicAuthCredentials == STRING
    input.Body.enableBasicAuth == BOOLEAN
    input.Body.enablePerformanceMode == BOOLEAN
    input.Body.buildSpec == STRING
    input.Body.ttl == STRING
    input.Body.displayName == STRING
    input.Body.enablePullRequestPreview == BOOLEAN
    input.Body.pullRequestEnvironmentName == STRING
    input.Body.backendEnvironmentArn == STRING
    input.Body.backend.stackArn == STRING
    input.Body.computeRoleArn == STRING
    input.ReqMap.appId == STRING
    input.ReqMap.branchName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# UpdateDomainAssociation

```erlang
enum_CertificateType := [ "AMPLIFY_MANAGED", "CUSTOM" ]

valid {
    input.Body.enableAutoSubDomain == BOOLEAN
    input.Body.subDomainSettings[_].prefix == STRING
    input.Body.subDomainSettings[_].branchName == STRING
    input.Body.autoSubDomainCreationPatterns[_] == STRING
    input.Body.autoSubDomainIAMRole == STRING
    input.Body.certificateSettings.type == enum_CertificateType[_]
    input.Body.certificateSettings.customCertificateArn == STRING
    input.ReqMap.appId == STRING
    input.ReqMap.domainName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```

# UpdateWebhook

```erlang
valid {
    input.Body.branchName == STRING
    input.Body.description == STRING
    input.ReqMap.webhookId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}
```