"activeJobId": "string",
"associatedResources": [ "string" ], "backendEnvironmentArn": "string", "basicAuthCredentials": "string", "branchArn": "string",
"branchName": "string", "buildSpec": "string", "createTime": number,
"customDomains": [ "string" ], "description": "string", "destinationBranch": "string", "displayName": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enableNotification": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "environmentVariables": {
"string" : "string"
},
"framework": "string",
"pullRequestEnvironmentName": "string", "sourceBranch": "string",
"stage": "string", "tags": {
"string" : "string"
},
"thumbnailUrl": "string", "totalNumberOfJobs": "string", "ttl": "string",
"updateTime": number }}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
branch (p. 16)
Describes the branch for an Amplify app, which maps to a third-party repository branch.
Type: Branch (p. 135) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 156).
BadRequestException
A request contains unexpected data.
HTTP Status Code: 400
DependentServiceFailureException
An operation failed because a dependent service threw an exception.
HTTP Status Code: 503
See Also
InternalFailureException
The service failed to perform an operation due to an internal issue.
HTTP Status Code: 500 LimitExceededException
A resource could not be created because service quotas were exceeded.
HTTP Status Code: 429 NotFoundException
An entity was not found during an operation.
HTTP Status Code: 404 UnauthorizedException
An operation failed due to a lack of access.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateDeployment
CreateDeployment
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
Request Syntax
POST /apps/appId/branches/branchName/deployments HTTP/1.1 Content-type: application/json
{ "fileMap": {
"string" : "string"
}}
URI Request Parameters
The request uses the following URI parameters.
appId (p. 19)
The unique ID for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
Required: Yes branchName (p. 19)
The name for the branch, for the job.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: (?s).+
Required: Yes
Request Body
The request accepts the following data in JSON format.
fileMap (p. 19)
An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files.
Type: String to string map
Key Length Constraints: Maximum length of 255.
Key Pattern: (?s).*
Value Length Constraints: Maximum length of 32.
Response Syntax
Value Pattern: (?s).*
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "fileUploadUrls": {
"string" : "string"
},
"jobId": "string", "zipUploadUrl": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
fileUploadUrls (p. 20)
When the fileMap argument is provided in the request, fileUploadUrls will contain a map of file names to upload URLs.
Type: String to string map
Key Length Constraints: Maximum length of 255.
Key Pattern: (?s).*
Value Length Constraints: Maximum length of 1000.
jobId (p. 20)
The job ID for this deployment. will supply to start deployment api.
Type: String
Length Constraints: Maximum length of 255.
Pattern: [0-9]+
zipUploadUrl (p. 20)
When the fileMap argument is not provided in the request, this zipUploadUrl is returned.
Type: String
Length Constraints: Maximum length of 1000.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 156).
See Also
BadRequestException
A request contains unexpected data.
HTTP Status Code: 400 InternalFailureException
The service failed to perform an operation due to an internal issue.
HTTP Status Code: 500 LimitExceededException
A resource could not be created because service quotas were exceeded.
HTTP Status Code: 429 UnauthorizedException
An operation failed due to a lack of access.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateDomainAssociation
CreateDomainAssociation
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
Request Syntax
POST /apps/appId/domains HTTP/1.1 Content-type: application/json
{ "autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string",
"domainName": "string",
"enableAutoSubDomain": boolean, "subDomainSettings": [
{
"branchName": "string", "prefix": "string"
} ]}
URI Request Parameters
The request uses the following URI parameters.
appId (p. 22)
The unique ID for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
Required: Yes
Request Body
The request accepts the following data in JSON format.
autoSubDomainCreationPatterns (p. 22)
Sets the branch patterns for automatic subdomain creation.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: (?s).+
Required: No
autoSubDomainIAMRole (p. 22)
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
Response Syntax
Type: String
Length Constraints: Maximum length of 1000.
Pattern: ^$|^arn:aws:iam::\d{12}:role.+
Required: No domainName (p. 22)
The domain name for the domain association.
Type: String
Length Constraints: Maximum length of 64.
Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\.)?$
Required: Yes
enableAutoSubDomain (p. 22)
Enables the automated creation of subdomains for branches.
Type: Boolean Required: No
subDomainSettings (p. 22) The setting for the subdomain.
Type: Array of SubDomainSetting (p. 151) objects Array Members: Maximum number of 255 items.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "domainAssociation": {
"autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string",
"certificateVerificationDNSRecord": "string", "domainAssociationArn": "string",
"domainName": "string", "domainStatus": "string", "enableAutoSubDomain": boolean, "statusReason": "string", "subDomains": [
Response Elements
] }}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
domainAssociation (p. 23)
Describes the structure of a domain association, which associates a custom domain with an Amplify app.
Type: DomainAssociation (p. 142) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 156).
BadRequestException
A request contains unexpected data.
HTTP Status Code: 400
DependentServiceFailureException
An operation failed because a dependent service threw an exception.
HTTP Status Code: 503 InternalFailureException
The service failed to perform an operation due to an internal issue.
HTTP Status Code: 500 LimitExceededException
A resource could not be created because service quotas were exceeded.
HTTP Status Code: 429 NotFoundException
An entity was not found during an operation.
HTTP Status Code: 404 UnauthorizedException
An operation failed due to a lack of access.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateWebhook
CreateWebhook
Creates a new webhook on an Amplify app.
Request Syntax
POST /apps/appId/webhooks HTTP/1.1 Content-type: application/json { "branchName": "string", "description": "string"
}
URI Request Parameters
The request uses the following URI parameters.
appId (p. 26)
The unique ID for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
Required: Yes
Request Body
The request accepts the following data in JSON format.
branchName (p. 26)
The name for a branch that is part of an Amplify app.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: (?s).+
Required: Yes description (p. 26)
The description for a webhook.
Type: String
Length Constraints: Maximum length of 1000.
Pattern: (?s).*
Required: No
Response Syntax
Response Syntax
HTTP/1.1 200
Content-type: application/json { "webhook": {
"branchName": "string", "createTime": number, "description": "string", "updateTime": number, "webhookArn": "string", "webhookId": "string", "webhookUrl": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
webhook (p. 27)
Describes a webhook that connects repository events to an Amplify app.
Type: Webhook (p. 152) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 156).
BadRequestException
A request contains unexpected data.
HTTP Status Code: 400
DependentServiceFailureException
An operation failed because a dependent service threw an exception.
HTTP Status Code: 503 InternalFailureException
The service failed to perform an operation due to an internal issue.
HTTP Status Code: 500 LimitExceededException
A resource could not be created because service quotas were exceeded.
HTTP Status Code: 429 NotFoundException
An entity was not found during an operation.
See Also
HTTP Status Code: 404 UnauthorizedException
An operation failed due to a lack of access.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteApp
DeleteApp
Deletes an existing Amplify app specified by an app ID.
Request Syntax
DELETE /apps/appId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
appId (p. 29)
The unique ID for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
"autoBranchCreationConfig": { "basicAuthCredentials": "string", "buildSpec": "string",
"enableAutoBuild": boolean, "enableBasicAuth": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "environmentVariables": {
"string" : "string"
},
"framework": "string",
"pullRequestEnvironmentName": "string", "stage": "string"
},
"autoBranchCreationPatterns": [ "string" ], "basicAuthCredentials": "string",
"buildSpec": "string", "createTime": number, "customHeaders": "string", "customRules": [
Response Elements
"defaultDomain": "string", "description": "string",
"enableAutoBranchCreation": boolean, "enableBasicAuth": boolean,
"enableBranchAutoBuild": boolean, "enableBranchAutoDeletion": boolean, "environmentVariables": {
"string" : "string"
},
"iamServiceRoleArn": "string", "name": "string",
"repository": "string", "tags": {
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
app (p. 29)
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
Type: App (p. 124) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 156).
BadRequestException
A request contains unexpected data.
HTTP Status Code: 400
DependentServiceFailureException
An operation failed because a dependent service threw an exception.
HTTP Status Code: 503
See Also
InternalFailureException
The service failed to perform an operation due to an internal issue.
HTTP Status Code: 500 NotFoundException
An entity was not found during an operation.
HTTP Status Code: 404 UnauthorizedException
An operation failed due to a lack of access.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteBackendEnvironment
DeleteBackendEnvironment
Deletes a backend environment for an Amplify app.
Request Syntax
DELETE /apps/appId/backendenvironments/environmentName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
appId (p. 32)
The unique ID of an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
Required: Yes
environmentName (p. 32)
The name of a backend environment of an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: (?s).+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "backendEnvironment": {
"backendEnvironmentArn": "string", "createTime": number,
"deploymentArtifacts": "string", "environmentName": "string", "stackName": "string", "updateTime": number }}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Errors
The following data is returned in JSON format by the service.
backendEnvironment (p. 32)
Describes the backend environment for an Amplify app.
Type: BackendEnvironment (p. 133) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 156).
BadRequestException
A request contains unexpected data.
HTTP Status Code: 400
DependentServiceFailureException
An operation failed because a dependent service threw an exception.
HTTP Status Code: 503 InternalFailureException
The service failed to perform an operation due to an internal issue.
HTTP Status Code: 500 NotFoundException
An entity was not found during an operation.
HTTP Status Code: 404 UnauthorizedException
An operation failed due to a lack of access.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteBranch
DeleteBranch
Deletes a branch for an Amplify app.
Request Syntax
DELETE /apps/appId/branches/branchName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
appId (p. 34)
The unique ID for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
Required: Yes branchName (p. 34)
The name for the branch.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: (?s).+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"branch": {
"activeJobId": "string",
"associatedResources": [ "string" ], "backendEnvironmentArn": "string", "basicAuthCredentials": "string", "branchArn": "string",
"branchName": "string", "buildSpec": "string", "createTime": number,
"customDomains": [ "string" ], "description": "string", "destinationBranch": "string", "displayName": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean,
Response Elements
"enableNotification": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "environmentVariables": {
"string" : "string"
},
"framework": "string",
"pullRequestEnvironmentName": "string", "sourceBranch": "string",
"stage": "string", "tags": {
"string" : "string"
},
"thumbnailUrl": "string", "totalNumberOfJobs": "string", "ttl": "string",
"updateTime": number }}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
branch (p. 34)
The branch for an Amplify app, which maps to a third-party repository branch.
Type: Branch (p. 135) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 156).
BadRequestException
A request contains unexpected data.
HTTP Status Code: 400
DependentServiceFailureException
An operation failed because a dependent service threw an exception.
HTTP Status Code: 503 InternalFailureException
The service failed to perform an operation due to an internal issue.
HTTP Status Code: 500 NotFoundException
An entity was not found during an operation.
HTTP Status Code: 404 UnauthorizedException
An operation failed due to a lack of access.
See Also
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteDomainAssociation
DeleteDomainAssociation
Deletes a domain association for an Amplify app.
Request Syntax
DELETE /apps/appId/domains/domainName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
appId (p. 37)
The unique id for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
Required: Yes domainName (p. 37)
The name of the domain.
Length Constraints: Maximum length of 64.
Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\.)?$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "domainAssociation": {
"autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string",
"certificateVerificationDNSRecord": "string", "domainAssociationArn": "string",
"domainName": "string", "domainStatus": "string", "enableAutoSubDomain": boolean, "statusReason": "string", "subDomains": [
{
"dnsRecord": "string", "subDomainSetting": {
Response Elements
"branchName": "string", "prefix": "string"
},
"verified": boolean }
] }}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
domainAssociation (p. 37)
Describes a domain association that associates a custom domain with an Amplify app.
Type: DomainAssociation (p. 142) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 156).
BadRequestException
A request contains unexpected data.
HTTP Status Code: 400
DependentServiceFailureException
An operation failed because a dependent service threw an exception.
HTTP Status Code: 503 InternalFailureException
The service failed to perform an operation due to an internal issue.
HTTP Status Code: 500 NotFoundException
An entity was not found during an operation.
HTTP Status Code: 404 UnauthorizedException
An operation failed due to a lack of access.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteJob
DeleteJob
Deletes a job for a branch of an Amplify app.
Request Syntax
DELETE /apps/appId/branches/branchName/jobs/jobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
appId (p. 40)
The unique ID for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
Required: Yes branchName (p. 40)
The name for the branch, for the job.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: (?s).+
Required: Yes jobId (p. 40)
The unique ID for the job.
Length Constraints: Maximum length of 255.
Pattern: [0-9]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "jobSummary": {
"commitId": "string", "commitMessage": "string", "commitTime": number,
Response Elements
"endTime": number, "jobArn": "string", "jobId": "string", "jobType": "string", "startTime": number, "status": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
jobSummary (p. 40)
Describes the summary for an execution job for an Amplify app.
Type: JobSummary (p. 145) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 156).
BadRequestException
A request contains unexpected data.
HTTP Status Code: 400 InternalFailureException
The service failed to perform an operation due to an internal issue.
HTTP Status Code: 500 LimitExceededException
A resource could not be created because service quotas were exceeded.
HTTP Status Code: 429 NotFoundException
An entity was not found during an operation.
HTTP Status Code: 404 UnauthorizedException
An operation failed due to a lack of access.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteWebhook
DeleteWebhook
Deletes a webhook.
Request Syntax
DELETE /webhooks/webhookId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
webhookId (p. 43)
The unique ID for a webhook.
Length Constraints: Maximum length of 255.
Pattern: (?s).*
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"webhook": {
"branchName": "string", "createTime": number, "description": "string", "updateTime": number, "webhookArn": "string", "webhookId": "string", "webhookUrl": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
webhook (p. 43)
Describes a webhook that connects repository events to an Amplify app.
Type: Webhook (p. 152) object
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 156).
BadRequestException
A request contains unexpected data.
HTTP Status Code: 400 InternalFailureException
The service failed to perform an operation due to an internal issue.
HTTP Status Code: 500 LimitExceededException
A resource could not be created because service quotas were exceeded.
HTTP Status Code: 429 NotFoundException
An entity was not found during an operation.
HTTP Status Code: 404 UnauthorizedException
An operation failed due to a lack of access.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GenerateAccessLogs
GenerateAccessLogs
Returns the website access logs for a specific time range using a presigned URL.
Request Syntax
POST /apps/appId/accesslogs HTTP/1.1 Content-type: application/json { "domainName": "string", "endTime": number, "startTime": number }
URI Request Parameters
The request uses the following URI parameters.
appId (p. 45)
The unique ID for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
Required: Yes
Request Body
The request accepts the following data in JSON format.
domainName (p. 45)
The name of the domain.
Type: String
Length Constraints: Maximum length of 64.
Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\.)?$
Required: Yes endTime (p. 45)
The time at which the logs should end. The time range specified is inclusive of the end time.
The time at which the logs should end. The time range specified is inclusive of the end time.