SDK for PHP 3.x

Client: Aws\Amplify\AmplifyClient
Service ID: amplify
Version: 2017-07-25

This page describes the parameters and results for the operations of the AWS Amplify (2017-07-25), and shows how to use the Aws\Amplify\AmplifyClient object to call the described operations. This documentation is specific to the 2017-07-25 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateApp ( array $params = [] )
Creates a new Amplify app.
CreateBackendEnvironment ( array $params = [] )
Creates a new backend environment for an Amplify app.
CreateBranch ( array $params = [] )
Creates a new branch for an Amplify app.
CreateDeployment ( array $params = [] )
Creates a deployment for a manually deployed Amplify app.
CreateDomainAssociation ( array $params = [] )
Creates a new domain association for an Amplify app.
CreateWebhook ( array $params = [] )
Creates a new webhook on an Amplify app.
DeleteApp ( array $params = [] )
Deletes an existing Amplify app specified by an app ID.
DeleteBackendEnvironment ( array $params = [] )
Deletes a backend environment for an Amplify app.
DeleteBranch ( array $params = [] )
Deletes a branch for an Amplify app.
DeleteDomainAssociation ( array $params = [] )
Deletes a domain association for an Amplify app.
DeleteJob ( array $params = [] )
Deletes a job for a branch of an Amplify app.
DeleteWebhook ( array $params = [] )
Deletes a webhook.
GenerateAccessLogs ( array $params = [] )
Returns the website access logs for a specific time range using a presigned URL.
GetApp ( array $params = [] )
Returns an existing Amplify app specified by an app ID.
GetArtifactUrl ( array $params = [] )
Returns the artifact info that corresponds to an artifact id.
GetBackendEnvironment ( array $params = [] )
Returns a backend environment for an Amplify app.
GetBranch ( array $params = [] )
Returns a branch for an Amplify app.
GetDomainAssociation ( array $params = [] )
Returns the domain information for an Amplify app.
GetJob ( array $params = [] )
Returns a job for a branch of an Amplify app.
GetWebhook ( array $params = [] )
Returns the webhook information that corresponds to a specified webhook ID.
ListApps ( array $params = [] )
Returns a list of the existing Amplify apps.
ListArtifacts ( array $params = [] )
Returns a list of artifacts for a specified app, branch, and job.
ListBackendEnvironments ( array $params = [] )
Lists the backend environments for an Amplify app.
ListBranches ( array $params = [] )
Lists the branches of an Amplify app.
ListDomainAssociations ( array $params = [] )
Returns the domain associations for an Amplify app.
ListJobs ( array $params = [] )
Lists the jobs for a branch of an Amplify app.
ListTagsForResource ( array $params = [] )
Returns a list of tags for a specified Amazon Resource Name (ARN).
ListWebhooks ( array $params = [] )
Returns a list of webhooks for an Amplify app.
StartDeployment ( array $params = [] )
Starts a deployment for a manually deployed app.
StartJob ( array $params = [] )
Starts a new job for a branch of an Amplify app.
StopJob ( array $params = [] )
Stops a job that is in progress for a branch of an Amplify app.
TagResource ( array $params = [] )
Tags the resource with a tag key and value.
UntagResource ( array $params = [] )
Untags a resource with a specified Amazon Resource Name (ARN).
UpdateApp ( array $params = [] )
Updates an existing Amplify app.
UpdateBranch ( array $params = [] )
Updates a branch for an Amplify app.
UpdateDomainAssociation ( array $params = [] )
Creates a new domain association for an Amplify app.
UpdateWebhook ( array $params = [] )
Updates a webhook.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListApps
ListBranches
ListDomainAssociations
ListJobs

Operations

CreateApp

$result = $client->createApp([/* ... */]);
$promise = $client->createAppAsync([/* ... */]);

Creates a new Amplify app.

Parameter Syntax

$result = $client->createApp([
    'accessToken' => '<string>',
    'autoBranchCreationConfig' => [
        'basicAuthCredentials' => '<string>',
        'buildSpec' => '<string>',
        'enableAutoBuild' => true || false,
        'enableBasicAuth' => true || false,
        'enablePerformanceMode' => true || false,
        'enablePullRequestPreview' => true || false,
        'environmentVariables' => ['<string>', ...],
        'framework' => '<string>',
        'pullRequestEnvironmentName' => '<string>',
        'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
    ],
    'autoBranchCreationPatterns' => ['<string>', ...],
    'basicAuthCredentials' => '<string>',
    'buildSpec' => '<string>',
    'customHeaders' => '<string>',
    'customRules' => [
        [
            'condition' => '<string>',
            'source' => '<string>', // REQUIRED
            'status' => '<string>',
            'target' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'enableAutoBranchCreation' => true || false,
    'enableBasicAuth' => true || false,
    'enableBranchAutoBuild' => true || false,
    'enableBranchAutoDeletion' => true || false,
    'environmentVariables' => ['<string>', ...],
    'iamServiceRoleArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'oauthToken' => '<string>',
    'platform' => 'WEB|WEB_DYNAMIC|WEB_COMPUTE',
    'repository' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
accessToken
Type: string

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

autoBranchCreationConfig
Type: AutoBranchCreationConfig structure

The automated branch creation configuration for an Amplify app.

autoBranchCreationPatterns
Type: Array of strings

The automated branch creation glob patterns for an Amplify app.

basicAuthCredentials
Type: string

The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

buildSpec
Type: string

The build specification (build spec) for an Amplify app.

customHeaders
Type: string

The custom HTTP headers for an Amplify app.

customRules
Type: Array of CustomRule structures

The custom rewrite and redirect rules for an Amplify app.

description
Type: string

The description of the Amplify app.

enableAutoBranchCreation
Type: boolean

Enables automated branch creation for an Amplify app.

enableBasicAuth
Type: boolean

Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

enableBranchAutoBuild
Type: boolean

Enables the auto building of branches for an Amplify app.

enableBranchAutoDeletion
Type: boolean

Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.

environmentVariables
Type: Associative array of custom strings keys (EnvKey) to strings

The environment variables map for an Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

iamServiceRoleArn
Type: string

The AWS Identity and Access Management (IAM) service role for an Amplify app.

name
Required: Yes
Type: string

The name of the Amplify app.

oauthToken
Type: string

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

platform
Type: string

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

repository
Type: string

The Git repository for the Amplify app.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tag for an Amplify app.

Result Syntax

[
    'app' => [
        'appArn' => '<string>',
        'appId' => '<string>',
        'autoBranchCreationConfig' => [
            'basicAuthCredentials' => '<string>',
            'buildSpec' => '<string>',
            'enableAutoBuild' => true || false,
            'enableBasicAuth' => true || false,
            'enablePerformanceMode' => true || false,
            'enablePullRequestPreview' => true || false,
            'environmentVariables' => ['<string>', ...],
            'framework' => '<string>',
            'pullRequestEnvironmentName' => '<string>',
            'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
        ],
        'autoBranchCreationPatterns' => ['<string>', ...],
        'basicAuthCredentials' => '<string>',
        'buildSpec' => '<string>',
        'createTime' => <DateTime>,
        'customHeaders' => '<string>',
        'customRules' => [
            [
                'condition' => '<string>',
                'source' => '<string>',
                'status' => '<string>',
                'target' => '<string>',
            ],
            // ...
        ],
        'defaultDomain' => '<string>',
        'description' => '<string>',
        'enableAutoBranchCreation' => true || false,
        'enableBasicAuth' => true || false,
        'enableBranchAutoBuild' => true || false,
        'enableBranchAutoDeletion' => true || false,
        'environmentVariables' => ['<string>', ...],
        'iamServiceRoleArn' => '<string>',
        'name' => '<string>',
        'platform' => 'WEB|WEB_DYNAMIC|WEB_COMPUTE',
        'productionBranch' => [
            'branchName' => '<string>',
            'lastDeployTime' => <DateTime>,
            'status' => '<string>',
            'thumbnailUrl' => '<string>',
        ],
        'repository' => '<string>',
        'repositoryCloneMethod' => 'SSH|TOKEN|SIGV4',
        'tags' => ['<string>', ...],
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
app
Required: Yes
Type: App structure

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

CreateBackendEnvironment

$result = $client->createBackendEnvironment([/* ... */]);
$promise = $client->createBackendEnvironmentAsync([/* ... */]);

Creates a new backend environment for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Parameter Syntax

$result = $client->createBackendEnvironment([
    'appId' => '<string>', // REQUIRED
    'deploymentArtifacts' => '<string>',
    'environmentName' => '<string>', // REQUIRED
    'stackName' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

deploymentArtifacts
Type: string

The name of deployment artifacts.

environmentName
Required: Yes
Type: string

The name for the backend environment.

stackName
Type: string

The AWS CloudFormation stack name of a backend environment.

Result Syntax

[
    'backendEnvironment' => [
        'backendEnvironmentArn' => '<string>',
        'createTime' => <DateTime>,
        'deploymentArtifacts' => '<string>',
        'environmentName' => '<string>',
        'stackName' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
backendEnvironment
Required: Yes
Type: BackendEnvironment structure

Describes the backend environment for an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

CreateBranch

$result = $client->createBranch([/* ... */]);
$promise = $client->createBranchAsync([/* ... */]);

Creates a new branch for an Amplify app.

Parameter Syntax

$result = $client->createBranch([
    'appId' => '<string>', // REQUIRED
    'backend' => [
        'stackArn' => '<string>',
    ],
    'backendEnvironmentArn' => '<string>',
    'basicAuthCredentials' => '<string>',
    'branchName' => '<string>', // REQUIRED
    'buildSpec' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'enableAutoBuild' => true || false,
    'enableBasicAuth' => true || false,
    'enableNotification' => true || false,
    'enablePerformanceMode' => true || false,
    'enablePullRequestPreview' => true || false,
    'environmentVariables' => ['<string>', ...],
    'framework' => '<string>',
    'pullRequestEnvironmentName' => '<string>',
    'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
    'tags' => ['<string>', ...],
    'ttl' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

backend
Type: Backend structure

The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

backendEnvironmentArn
Type: string

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.

This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).

basicAuthCredentials
Type: string

The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.

branchName
Required: Yes
Type: string

The name for the branch.

buildSpec
Type: string

The build specification (build spec) for the branch.

description
Type: string

The description for the branch.

displayName
Type: string

The display name for a branch. This is used as the default domain prefix.

enableAutoBuild
Type: boolean

Enables auto building for the branch.

enableBasicAuth
Type: boolean

Enables basic authorization for the branch.

enableNotification
Type: boolean

Enables notifications for the branch.

enablePerformanceMode
Type: boolean

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

enablePullRequestPreview
Type: boolean

Enables pull request previews for this branch.

environmentVariables
Type: Associative array of custom strings keys (EnvKey) to strings

The environment variables for the branch.

framework
Type: string

The framework for the branch.

pullRequestEnvironmentName
Type: string

The Amplify environment name for the pull request.

stage
Type: string

Describes the current stage for the branch.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tag for the branch.

ttl
Type: string

The content Time To Live (TTL) for the website in seconds.

Result Syntax

[
    'branch' => [
        'activeJobId' => '<string>',
        'associatedResources' => ['<string>', ...],
        'backend' => [
            'stackArn' => '<string>',
        ],
        'backendEnvironmentArn' => '<string>',
        'basicAuthCredentials' => '<string>',
        'branchArn' => '<string>',
        'branchName' => '<string>',
        'buildSpec' => '<string>',
        'createTime' => <DateTime>,
        'customDomains' => ['<string>', ...],
        'description' => '<string>',
        'destinationBranch' => '<string>',
        'displayName' => '<string>',
        'enableAutoBuild' => true || false,
        'enableBasicAuth' => true || false,
        'enableNotification' => true || false,
        'enablePerformanceMode' => true || false,
        'enablePullRequestPreview' => true || false,
        'environmentVariables' => ['<string>', ...],
        'framework' => '<string>',
        'pullRequestEnvironmentName' => '<string>',
        'sourceBranch' => '<string>',
        'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
        'tags' => ['<string>', ...],
        'thumbnailUrl' => '<string>',
        'totalNumberOfJobs' => '<string>',
        'ttl' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
branch
Required: Yes
Type: Branch structure

Describes the branch for an Amplify app, which maps to a third-party repository branch.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

CreateDeployment

$result = $client->createDeployment([/* ... */]);
$promise = $client->createDeploymentAsync([/* ... */]);

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.

The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.

Parameter Syntax

$result = $client->createDeployment([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
    'fileMap' => ['<string>', ...],
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name of the branch to use for the job.

fileMap
Type: Associative array of custom strings keys (FileName) to strings

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.

Result Syntax

[
    'fileUploadUrls' => ['<string>', ...],
    'jobId' => '<string>',
    'zipUploadUrl' => '<string>',
]

Result Details

Members
fileUploadUrls
Required: Yes
Type: Associative array of custom strings keys (FileName) to strings

When the fileMap argument is provided in the request, fileUploadUrls will contain a map of file names to upload URLs.

jobId
Type: string

The job ID for this deployment. will supply to start deployment api.

zipUploadUrl
Required: Yes
Type: string

When the fileMap argument is not provided in the request, this zipUploadUrl is returned.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

CreateDomainAssociation

$result = $client->createDomainAssociation([/* ... */]);
$promise = $client->createDomainAssociationAsync([/* ... */]);

Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

Parameter Syntax

$result = $client->createDomainAssociation([
    'appId' => '<string>', // REQUIRED
    'autoSubDomainCreationPatterns' => ['<string>', ...],
    'autoSubDomainIAMRole' => '<string>',
    'certificateSettings' => [
        'customCertificateArn' => '<string>',
        'type' => 'AMPLIFY_MANAGED|CUSTOM', // REQUIRED
    ],
    'domainName' => '<string>', // REQUIRED
    'enableAutoSubDomain' => true || false,
    'subDomainSettings' => [ // REQUIRED
        [
            'branchName' => '<string>', // REQUIRED
            'prefix' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

autoSubDomainCreationPatterns
Type: Array of strings

Sets the branch patterns for automatic subdomain creation.

autoSubDomainIAMRole
Type: string

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

certificateSettings
Type: CertificateSettings structure

The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.

domainName
Required: Yes
Type: string

The domain name for the domain association.

enableAutoSubDomain
Type: boolean

Enables the automated creation of subdomains for branches.

subDomainSettings
Required: Yes
Type: Array of SubDomainSetting structures

The setting for the subdomain.

Result Syntax

[
    'domainAssociation' => [
        'autoSubDomainCreationPatterns' => ['<string>', ...],
        'autoSubDomainIAMRole' => '<string>',
        'certificate' => [
            'certificateVerificationDNSRecord' => '<string>',
            'customCertificateArn' => '<string>',
            'type' => 'AMPLIFY_MANAGED|CUSTOM',
        ],
        'certificateVerificationDNSRecord' => '<string>',
        'domainAssociationArn' => '<string>',
        'domainName' => '<string>',
        'domainStatus' => 'PENDING_VERIFICATION|IN_PROGRESS|AVAILABLE|IMPORTING_CUSTOM_CERTIFICATE|PENDING_DEPLOYMENT|AWAITING_APP_CNAME|FAILED|CREATING|REQUESTING_CERTIFICATE|UPDATING',
        'enableAutoSubDomain' => true || false,
        'statusReason' => '<string>',
        'subDomains' => [
            [
                'dnsRecord' => '<string>',
                'subDomainSetting' => [
                    'branchName' => '<string>',
                    'prefix' => '<string>',
                ],
                'verified' => true || false,
            ],
            // ...
        ],
        'updateStatus' => 'REQUESTING_CERTIFICATE|PENDING_VERIFICATION|IMPORTING_CUSTOM_CERTIFICATE|PENDING_DEPLOYMENT|AWAITING_APP_CNAME|UPDATE_COMPLETE|UPDATE_FAILED',
    ],
]

Result Details

Members
domainAssociation
Required: Yes
Type: DomainAssociation structure

Describes the structure of a domain association, which associates a custom domain with an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

CreateWebhook

$result = $client->createWebhook([/* ... */]);
$promise = $client->createWebhookAsync([/* ... */]);

Creates a new webhook on an Amplify app.

Parameter Syntax

$result = $client->createWebhook([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
    'description' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name for a branch that is part of an Amplify app.

description
Type: string

The description for a webhook.

Result Syntax

[
    'webhook' => [
        'branchName' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'updateTime' => <DateTime>,
        'webhookArn' => '<string>',
        'webhookId' => '<string>',
        'webhookUrl' => '<string>',
    ],
]

Result Details

Members
webhook
Required: Yes
Type: Webhook structure

Describes a webhook that connects repository events to an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

DeleteApp

$result = $client->deleteApp([/* ... */]);
$promise = $client->deleteAppAsync([/* ... */]);

Deletes an existing Amplify app specified by an app ID.

Parameter Syntax

$result = $client->deleteApp([
    'appId' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

Result Syntax

[
    'app' => [
        'appArn' => '<string>',
        'appId' => '<string>',
        'autoBranchCreationConfig' => [
            'basicAuthCredentials' => '<string>',
            'buildSpec' => '<string>',
            'enableAutoBuild' => true || false,
            'enableBasicAuth' => true || false,
            'enablePerformanceMode' => true || false,
            'enablePullRequestPreview' => true || false,
            'environmentVariables' => ['<string>', ...],
            'framework' => '<string>',
            'pullRequestEnvironmentName' => '<string>',
            'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
        ],
        'autoBranchCreationPatterns' => ['<string>', ...],
        'basicAuthCredentials' => '<string>',
        'buildSpec' => '<string>',
        'createTime' => <DateTime>,
        'customHeaders' => '<string>',
        'customRules' => [
            [
                'condition' => '<string>',
                'source' => '<string>',
                'status' => '<string>',
                'target' => '<string>',
            ],
            // ...
        ],
        'defaultDomain' => '<string>',
        'description' => '<string>',
        'enableAutoBranchCreation' => true || false,
        'enableBasicAuth' => true || false,
        'enableBranchAutoBuild' => true || false,
        'enableBranchAutoDeletion' => true || false,
        'environmentVariables' => ['<string>', ...],
        'iamServiceRoleArn' => '<string>',
        'name' => '<string>',
        'platform' => 'WEB|WEB_DYNAMIC|WEB_COMPUTE',
        'productionBranch' => [
            'branchName' => '<string>',
            'lastDeployTime' => <DateTime>,
            'status' => '<string>',
            'thumbnailUrl' => '<string>',
        ],
        'repository' => '<string>',
        'repositoryCloneMethod' => 'SSH|TOKEN|SIGV4',
        'tags' => ['<string>', ...],
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
app
Required: Yes
Type: App structure

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

NotFoundException:

An entity was not found during an operation.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

DeleteBackendEnvironment

$result = $client->deleteBackendEnvironment([/* ... */]);
$promise = $client->deleteBackendEnvironmentAsync([/* ... */]);

Deletes a backend environment for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Parameter Syntax

$result = $client->deleteBackendEnvironment([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID of an Amplify app.

environmentName
Required: Yes
Type: string

The name of a backend environment of an Amplify app.

Result Syntax

[
    'backendEnvironment' => [
        'backendEnvironmentArn' => '<string>',
        'createTime' => <DateTime>,
        'deploymentArtifacts' => '<string>',
        'environmentName' => '<string>',
        'stackName' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
backendEnvironment
Required: Yes
Type: BackendEnvironment structure

Describes the backend environment for an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

DeleteBranch

$result = $client->deleteBranch([/* ... */]);
$promise = $client->deleteBranchAsync([/* ... */]);

Deletes a branch for an Amplify app.

Parameter Syntax

$result = $client->deleteBranch([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name of the branch.

Result Syntax

[
    'branch' => [
        'activeJobId' => '<string>',
        'associatedResources' => ['<string>', ...],
        'backend' => [
            'stackArn' => '<string>',
        ],
        'backendEnvironmentArn' => '<string>',
        'basicAuthCredentials' => '<string>',
        'branchArn' => '<string>',
        'branchName' => '<string>',
        'buildSpec' => '<string>',
        'createTime' => <DateTime>,
        'customDomains' => ['<string>', ...],
        'description' => '<string>',
        'destinationBranch' => '<string>',
        'displayName' => '<string>',
        'enableAutoBuild' => true || false,
        'enableBasicAuth' => true || false,
        'enableNotification' => true || false,
        'enablePerformanceMode' => true || false,
        'enablePullRequestPreview' => true || false,
        'environmentVariables' => ['<string>', ...],
        'framework' => '<string>',
        'pullRequestEnvironmentName' => '<string>',
        'sourceBranch' => '<string>',
        'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
        'tags' => ['<string>', ...],
        'thumbnailUrl' => '<string>',
        'totalNumberOfJobs' => '<string>',
        'ttl' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
branch
Required: Yes
Type: Branch structure

The branch for an Amplify app, which maps to a third-party repository branch.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

DeleteDomainAssociation

$result = $client->deleteDomainAssociation([/* ... */]);
$promise = $client->deleteDomainAssociationAsync([/* ... */]);

Deletes a domain association for an Amplify app.

Parameter Syntax

$result = $client->deleteDomainAssociation([
    'appId' => '<string>', // REQUIRED
    'domainName' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique id for an Amplify app.

domainName
Required: Yes
Type: string

The name of the domain.

Result Syntax

[
    'domainAssociation' => [
        'autoSubDomainCreationPatterns' => ['<string>', ...],
        'autoSubDomainIAMRole' => '<string>',
        'certificate' => [
            'certificateVerificationDNSRecord' => '<string>',
            'customCertificateArn' => '<string>',
            'type' => 'AMPLIFY_MANAGED|CUSTOM',
        ],
        'certificateVerificationDNSRecord' => '<string>',
        'domainAssociationArn' => '<string>',
        'domainName' => '<string>',
        'domainStatus' => 'PENDING_VERIFICATION|IN_PROGRESS|AVAILABLE|IMPORTING_CUSTOM_CERTIFICATE|PENDING_DEPLOYMENT|AWAITING_APP_CNAME|FAILED|CREATING|REQUESTING_CERTIFICATE|UPDATING',
        'enableAutoSubDomain' => true || false,
        'statusReason' => '<string>',
        'subDomains' => [
            [
                'dnsRecord' => '<string>',
                'subDomainSetting' => [
                    'branchName' => '<string>',
                    'prefix' => '<string>',
                ],
                'verified' => true || false,
            ],
            // ...
        ],
        'updateStatus' => 'REQUESTING_CERTIFICATE|PENDING_VERIFICATION|IMPORTING_CUSTOM_CERTIFICATE|PENDING_DEPLOYMENT|AWAITING_APP_CNAME|UPDATE_COMPLETE|UPDATE_FAILED',
    ],
]

Result Details

Members
domainAssociation
Required: Yes
Type: DomainAssociation structure

Describes the association between a custom domain and an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

DeleteJob

$result = $client->deleteJob([/* ... */]);
$promise = $client->deleteJobAsync([/* ... */]);

Deletes a job for a branch of an Amplify app.

Parameter Syntax

$result = $client->deleteJob([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name of the branch to use for the job.

jobId
Required: Yes
Type: string

The unique ID for the job.

Result Syntax

[
    'jobSummary' => [
        'commitId' => '<string>',
        'commitMessage' => '<string>',
        'commitTime' => <DateTime>,
        'endTime' => <DateTime>,
        'jobArn' => '<string>',
        'jobId' => '<string>',
        'jobType' => 'RELEASE|RETRY|MANUAL|WEB_HOOK',
        'startTime' => <DateTime>,
        'status' => 'PENDING|PROVISIONING|RUNNING|FAILED|SUCCEED|CANCELLING|CANCELLED',
    ],
]

Result Details

Members
jobSummary
Required: Yes
Type: JobSummary structure

Describes the summary for an execution job for an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

NotFoundException:

An entity was not found during an operation.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

DeleteWebhook

$result = $client->deleteWebhook([/* ... */]);
$promise = $client->deleteWebhookAsync([/* ... */]);

Deletes a webhook.

Parameter Syntax

$result = $client->deleteWebhook([
    'webhookId' => '<string>', // REQUIRED
]);

Parameter Details

Members
webhookId
Required: Yes
Type: string

The unique ID for a webhook.

Result Syntax

[
    'webhook' => [
        'branchName' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'updateTime' => <DateTime>,
        'webhookArn' => '<string>',
        'webhookId' => '<string>',
        'webhookUrl' => '<string>',
    ],
]

Result Details

Members
webhook
Required: Yes
Type: Webhook structure

Describes a webhook that connects repository events to an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

NotFoundException:

An entity was not found during an operation.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

GenerateAccessLogs

$result = $client->generateAccessLogs([/* ... */]);
$promise = $client->generateAccessLogsAsync([/* ... */]);

Returns the website access logs for a specific time range using a presigned URL.

Parameter Syntax

$result = $client->generateAccessLogs([
    'appId' => '<string>', // REQUIRED
    'domainName' => '<string>', // REQUIRED
    'endTime' => <integer || string || DateTime>,
    'startTime' => <integer || string || DateTime>,
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

domainName
Required: Yes
Type: string

The name of the domain.

endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the logs should end. The time range specified is inclusive of the end time.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the logs should start. The time range specified is inclusive of the start time.

Result Syntax

[
    'logUrl' => '<string>',
]

Result Details

Members
logUrl
Type: string

The pre-signed URL for the requested access logs.

Errors

NotFoundException:

An entity was not found during an operation.

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

GetApp

$result = $client->getApp([/* ... */]);
$promise = $client->getAppAsync([/* ... */]);

Returns an existing Amplify app specified by an app ID.

Parameter Syntax

$result = $client->getApp([
    'appId' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

Result Syntax

[
    'app' => [
        'appArn' => '<string>',
        'appId' => '<string>',
        'autoBranchCreationConfig' => [
            'basicAuthCredentials' => '<string>',
            'buildSpec' => '<string>',
            'enableAutoBuild' => true || false,
            'enableBasicAuth' => true || false,
            'enablePerformanceMode' => true || false,
            'enablePullRequestPreview' => true || false,
            'environmentVariables' => ['<string>', ...],
            'framework' => '<string>',
            'pullRequestEnvironmentName' => '<string>',
            'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
        ],
        'autoBranchCreationPatterns' => ['<string>', ...],
        'basicAuthCredentials' => '<string>',
        'buildSpec' => '<string>',
        'createTime' => <DateTime>,
        'customHeaders' => '<string>',
        'customRules' => [
            [
                'condition' => '<string>',
                'source' => '<string>',
                'status' => '<string>',
                'target' => '<string>',
            ],
            // ...
        ],
        'defaultDomain' => '<string>',
        'description' => '<string>',
        'enableAutoBranchCreation' => true || false,
        'enableBasicAuth' => true || false,
        'enableBranchAutoBuild' => true || false,
        'enableBranchAutoDeletion' => true || false,
        'environmentVariables' => ['<string>', ...],
        'iamServiceRoleArn' => '<string>',
        'name' => '<string>',
        'platform' => 'WEB|WEB_DYNAMIC|WEB_COMPUTE',
        'productionBranch' => [
            'branchName' => '<string>',
            'lastDeployTime' => <DateTime>,
            'status' => '<string>',
            'thumbnailUrl' => '<string>',
        ],
        'repository' => '<string>',
        'repositoryCloneMethod' => 'SSH|TOKEN|SIGV4',
        'tags' => ['<string>', ...],
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
app
Required: Yes
Type: App structure

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

NotFoundException:

An entity was not found during an operation.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

GetArtifactUrl

$result = $client->getArtifactUrl([/* ... */]);
$promise = $client->getArtifactUrlAsync([/* ... */]);

Returns the artifact info that corresponds to an artifact id.

Parameter Syntax

$result = $client->getArtifactUrl([
    'artifactId' => '<string>', // REQUIRED
]);

Parameter Details

Members
artifactId
Required: Yes
Type: string

The unique ID for an artifact.

Result Syntax

[
    'artifactId' => '<string>',
    'artifactUrl' => '<string>',
]

Result Details

Members
artifactId
Required: Yes
Type: string

The unique ID for an artifact.

artifactUrl
Required: Yes
Type: string

The presigned URL for the artifact.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

NotFoundException:

An entity was not found during an operation.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

GetBackendEnvironment

$result = $client->getBackendEnvironment([/* ... */]);
$promise = $client->getBackendEnvironmentAsync([/* ... */]);

Returns a backend environment for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Parameter Syntax

$result = $client->getBackendEnvironment([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique id for an Amplify app.

environmentName
Required: Yes
Type: string

The name for the backend environment.

Result Syntax

[
    'backendEnvironment' => [
        'backendEnvironmentArn' => '<string>',
        'createTime' => <DateTime>,
        'deploymentArtifacts' => '<string>',
        'environmentName' => '<string>',
        'stackName' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
backendEnvironment
Required: Yes
Type: BackendEnvironment structure

Describes the backend environment for an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

GetBranch

$result = $client->getBranch([/* ... */]);
$promise = $client->getBranchAsync([/* ... */]);

Returns a branch for an Amplify app.

Parameter Syntax

$result = $client->getBranch([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name of the branch.

Result Syntax

[
    'branch' => [
        'activeJobId' => '<string>',
        'associatedResources' => ['<string>', ...],
        'backend' => [
            'stackArn' => '<string>',
        ],
        'backendEnvironmentArn' => '<string>',
        'basicAuthCredentials' => '<string>',
        'branchArn' => '<string>',
        'branchName' => '<string>',
        'buildSpec' => '<string>',
        'createTime' => <DateTime>,
        'customDomains' => ['<string>', ...],
        'description' => '<string>',
        'destinationBranch' => '<string>',
        'displayName' => '<string>',
        'enableAutoBuild' => true || false,
        'enableBasicAuth' => true || false,
        'enableNotification' => true || false,
        'enablePerformanceMode' => true || false,
        'enablePullRequestPreview' => true || false,
        'environmentVariables' => ['<string>', ...],
        'framework' => '<string>',
        'pullRequestEnvironmentName' => '<string>',
        'sourceBranch' => '<string>',
        'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
        'tags' => ['<string>', ...],
        'thumbnailUrl' => '<string>',
        'totalNumberOfJobs' => '<string>',
        'ttl' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
branch
Required: Yes
Type: Branch structure

The branch for an Amplify app, which maps to a third-party repository branch.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

GetDomainAssociation

$result = $client->getDomainAssociation([/* ... */]);
$promise = $client->getDomainAssociationAsync([/* ... */]);

Returns the domain information for an Amplify app.

Parameter Syntax

$result = $client->getDomainAssociation([
    'appId' => '<string>', // REQUIRED
    'domainName' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique id for an Amplify app.

domainName
Required: Yes
Type: string

The name of the domain.

Result Syntax

[
    'domainAssociation' => [
        'autoSubDomainCreationPatterns' => ['<string>', ...],
        'autoSubDomainIAMRole' => '<string>',
        'certificate' => [
            'certificateVerificationDNSRecord' => '<string>',
            'customCertificateArn' => '<string>',
            'type' => 'AMPLIFY_MANAGED|CUSTOM',
        ],
        'certificateVerificationDNSRecord' => '<string>',
        'domainAssociationArn' => '<string>',
        'domainName' => '<string>',
        'domainStatus' => 'PENDING_VERIFICATION|IN_PROGRESS|AVAILABLE|IMPORTING_CUSTOM_CERTIFICATE|PENDING_DEPLOYMENT|AWAITING_APP_CNAME|FAILED|CREATING|REQUESTING_CERTIFICATE|UPDATING',
        'enableAutoSubDomain' => true || false,
        'statusReason' => '<string>',
        'subDomains' => [
            [
                'dnsRecord' => '<string>',
                'subDomainSetting' => [
                    'branchName' => '<string>',
                    'prefix' => '<string>',
                ],
                'verified' => true || false,
            ],
            // ...
        ],
        'updateStatus' => 'REQUESTING_CERTIFICATE|PENDING_VERIFICATION|IMPORTING_CUSTOM_CERTIFICATE|PENDING_DEPLOYMENT|AWAITING_APP_CNAME|UPDATE_COMPLETE|UPDATE_FAILED',
    ],
]

Result Details

Members
domainAssociation
Required: Yes
Type: DomainAssociation structure

Describes the structure of a domain association, which associates a custom domain with an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

GetJob

$result = $client->getJob([/* ... */]);
$promise = $client->getJobAsync([/* ... */]);

Returns a job for a branch of an Amplify app.

Parameter Syntax

$result = $client->getJob([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name of the branch to use for the job.

jobId
Required: Yes
Type: string

The unique ID for the job.

Result Syntax

[
    'job' => [
        'steps' => [
            [
                'artifactsUrl' => '<string>',
                'context' => '<string>',
                'endTime' => <DateTime>,
                'logUrl' => '<string>',
                'screenshots' => ['<string>', ...],
                'startTime' => <DateTime>,
                'status' => 'PENDING|PROVISIONING|RUNNING|FAILED|SUCCEED|CANCELLING|CANCELLED',
                'statusReason' => '<string>',
                'stepName' => '<string>',
                'testArtifactsUrl' => '<string>',
                'testConfigUrl' => '<string>',
            ],
            // ...
        ],
        'summary' => [
            'commitId' => '<string>',
            'commitMessage' => '<string>',
            'commitTime' => <DateTime>,
            'endTime' => <DateTime>,
            'jobArn' => '<string>',
            'jobId' => '<string>',
            'jobType' => 'RELEASE|RETRY|MANUAL|WEB_HOOK',
            'startTime' => <DateTime>,
            'status' => 'PENDING|PROVISIONING|RUNNING|FAILED|SUCCEED|CANCELLING|CANCELLED',
        ],
    ],
]

Result Details

Members
job
Required: Yes
Type: Job structure

Describes an execution job for an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

NotFoundException:

An entity was not found during an operation.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

GetWebhook

$result = $client->getWebhook([/* ... */]);
$promise = $client->getWebhookAsync([/* ... */]);

Returns the webhook information that corresponds to a specified webhook ID.

Parameter Syntax

$result = $client->getWebhook([
    'webhookId' => '<string>', // REQUIRED
]);

Parameter Details

Members
webhookId
Required: Yes
Type: string

The unique ID for a webhook.

Result Syntax

[
    'webhook' => [
        'branchName' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'updateTime' => <DateTime>,
        'webhookArn' => '<string>',
        'webhookId' => '<string>',
        'webhookUrl' => '<string>',
    ],
]

Result Details

Members
webhook
Required: Yes
Type: Webhook structure

Describes the structure of a webhook.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

NotFoundException:

An entity was not found during an operation.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

ListApps

$result = $client->listApps([/* ... */]);
$promise = $client->listAppsAsync([/* ... */]);

Returns a list of the existing Amplify apps.

Parameter Syntax

$result = $client->listApps([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of records to list in a single response.

nextToken
Type: string

A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

Result Syntax

[
    'apps' => [
        [
            'appArn' => '<string>',
            'appId' => '<string>',
            'autoBranchCreationConfig' => [
                'basicAuthCredentials' => '<string>',
                'buildSpec' => '<string>',
                'enableAutoBuild' => true || false,
                'enableBasicAuth' => true || false,
                'enablePerformanceMode' => true || false,
                'enablePullRequestPreview' => true || false,
                'environmentVariables' => ['<string>', ...],
                'framework' => '<string>',
                'pullRequestEnvironmentName' => '<string>',
                'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
            ],
            'autoBranchCreationPatterns' => ['<string>', ...],
            'basicAuthCredentials' => '<string>',
            'buildSpec' => '<string>',
            'createTime' => <DateTime>,
            'customHeaders' => '<string>',
            'customRules' => [
                [
                    'condition' => '<string>',
                    'source' => '<string>',
                    'status' => '<string>',
                    'target' => '<string>',
                ],
                // ...
            ],
            'defaultDomain' => '<string>',
            'description' => '<string>',
            'enableAutoBranchCreation' => true || false,
            'enableBasicAuth' => true || false,
            'enableBranchAutoBuild' => true || false,
            'enableBranchAutoDeletion' => true || false,
            'environmentVariables' => ['<string>', ...],
            'iamServiceRoleArn' => '<string>',
            'name' => '<string>',
            'platform' => 'WEB|WEB_DYNAMIC|WEB_COMPUTE',
            'productionBranch' => [
                'branchName' => '<string>',
                'lastDeployTime' => <DateTime>,
                'status' => '<string>',
                'thumbnailUrl' => '<string>',
            ],
            'repository' => '<string>',
            'repositoryCloneMethod' => 'SSH|TOKEN|SIGV4',
            'tags' => ['<string>', ...],
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
apps
Required: Yes
Type: Array of App structures

A list of Amplify apps.

nextToken
Type: string

A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

ListArtifacts

$result = $client->listArtifacts([/* ... */]);
$promise = $client->listArtifactsAsync([/* ... */]);

Returns a list of artifacts for a specified app, branch, and job.

Parameter Syntax

$result = $client->listArtifacts([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name of a branch that is part of an Amplify app.

jobId
Required: Yes
Type: string

The unique ID for a job.

maxResults
Type: int

The maximum number of records to list in a single response.

nextToken
Type: string

A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.

Result Syntax

[
    'artifacts' => [
        [
            'artifactFileName' => '<string>',
            'artifactId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
artifacts
Required: Yes
Type: Array of Artifact structures

A list of artifacts.

nextToken
Type: string

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

ListBackendEnvironments

$result = $client->listBackendEnvironments([/* ... */]);
$promise = $client->listBackendEnvironmentsAsync([/* ... */]);

Lists the backend environments for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Parameter Syntax

$result = $client->listBackendEnvironments([
    'appId' => '<string>', // REQUIRED
    'environmentName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

environmentName
Type: string

The name of the backend environment

maxResults
Type: int

The maximum number of records to list in a single response.

nextToken
Type: string

A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.

Result Syntax

[
    'backendEnvironments' => [
        [
            'backendEnvironmentArn' => '<string>',
            'createTime' => <DateTime>,
            'deploymentArtifacts' => '<string>',
            'environmentName' => '<string>',
            'stackName' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
backendEnvironments
Required: Yes
Type: Array of BackendEnvironment structures

The list of backend environments for an Amplify app.

nextToken
Type: string

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

ListBranches

$result = $client->listBranches([/* ... */]);
$promise = $client->listBranchesAsync([/* ... */]);

Lists the branches of an Amplify app.

Parameter Syntax

$result = $client->listBranches([
    'appId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

maxResults
Type: int

The maximum number of records to list in a single response.

nextToken
Type: string

A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.

Result Syntax

[
    'branches' => [
        [
            'activeJobId' => '<string>',
            'associatedResources' => ['<string>', ...],
            'backend' => [
                'stackArn' => '<string>',
            ],
            'backendEnvironmentArn' => '<string>',
            'basicAuthCredentials' => '<string>',
            'branchArn' => '<string>',
            'branchName' => '<string>',
            'buildSpec' => '<string>',
            'createTime' => <DateTime>,
            'customDomains' => ['<string>', ...],
            'description' => '<string>',
            'destinationBranch' => '<string>',
            'displayName' => '<string>',
            'enableAutoBuild' => true || false,
            'enableBasicAuth' => true || false,
            'enableNotification' => true || false,
            'enablePerformanceMode' => true || false,
            'enablePullRequestPreview' => true || false,
            'environmentVariables' => ['<string>', ...],
            'framework' => '<string>',
            'pullRequestEnvironmentName' => '<string>',
            'sourceBranch' => '<string>',
            'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
            'tags' => ['<string>', ...],
            'thumbnailUrl' => '<string>',
            'totalNumberOfJobs' => '<string>',
            'ttl' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
branches
Required: Yes
Type: Array of Branch structures

A list of branches for an Amplify app.

nextToken
Type: string

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

ListDomainAssociations

$result = $client->listDomainAssociations([/* ... */]);
$promise = $client->listDomainAssociationsAsync([/* ... */]);

Returns the domain associations for an Amplify app.

Parameter Syntax

$result = $client->listDomainAssociations([
    'appId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

maxResults
Type: int

The maximum number of records to list in a single response.

nextToken
Type: string

A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects.

Result Syntax

[
    'domainAssociations' => [
        [
            'autoSubDomainCreationPatterns' => ['<string>', ...],
            'autoSubDomainIAMRole' => '<string>',
            'certificate' => [
                'certificateVerificationDNSRecord' => '<string>',
                'customCertificateArn' => '<string>',
                'type' => 'AMPLIFY_MANAGED|CUSTOM',
            ],
            'certificateVerificationDNSRecord' => '<string>',
            'domainAssociationArn' => '<string>',
            'domainName' => '<string>',
            'domainStatus' => 'PENDING_VERIFICATION|IN_PROGRESS|AVAILABLE|IMPORTING_CUSTOM_CERTIFICATE|PENDING_DEPLOYMENT|AWAITING_APP_CNAME|FAILED|CREATING|REQUESTING_CERTIFICATE|UPDATING',
            'enableAutoSubDomain' => true || false,
            'statusReason' => '<string>',
            'subDomains' => [
                [
                    'dnsRecord' => '<string>',
                    'subDomainSetting' => [
                        'branchName' => '<string>',
                        'prefix' => '<string>',
                    ],
                    'verified' => true || false,
                ],
                // ...
            ],
            'updateStatus' => 'REQUESTING_CERTIFICATE|PENDING_VERIFICATION|IMPORTING_CUSTOM_CERTIFICATE|PENDING_DEPLOYMENT|AWAITING_APP_CNAME|UPDATE_COMPLETE|UPDATE_FAILED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
domainAssociations
Required: Yes
Type: Array of DomainAssociation structures

A list of domain associations.

nextToken
Type: string

A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

ListJobs

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

Lists the jobs for a branch of an Amplify app.

Parameter Syntax

$result = $client->listJobs([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name of the branch to use for the request.

maxResults
Type: int

The maximum number of records to list in a single response.

nextToken
Type: string

A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.

Result Syntax

[
    'jobSummaries' => [
        [
            'commitId' => '<string>',
            'commitMessage' => '<string>',
            'commitTime' => <DateTime>,
            'endTime' => <DateTime>,
            'jobArn' => '<string>',
            'jobId' => '<string>',
            'jobType' => 'RELEASE|RETRY|MANUAL|WEB_HOOK',
            'startTime' => <DateTime>,
            'status' => 'PENDING|PROVISIONING|RUNNING|FAILED|SUCCEED|CANCELLING|CANCELLED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
jobSummaries
Required: Yes
Type: Array of JobSummary structures

The result structure for the list job result request.

nextToken
Type: string

A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags for a specified Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) to use to list tags.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

A list of tags for the specified The Amazon Resource Name (ARN).

Errors

InternalFailureException:

The service failed to perform an operation due to an internal issue.

BadRequestException:

A request contains unexpected data.

ResourceNotFoundException:

An operation failed due to a non-existent resource.

ListWebhooks

$result = $client->listWebhooks([/* ... */]);
$promise = $client->listWebhooksAsync([/* ... */]);

Returns a list of webhooks for an Amplify app.

Parameter Syntax

$result = $client->listWebhooks([
    'appId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

maxResults
Type: int

The maximum number of records to list in a single response.

nextToken
Type: string

A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks.

Result Syntax

[
    'nextToken' => '<string>',
    'webhooks' => [
        [
            'branchName' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'updateTime' => <DateTime>,
            'webhookArn' => '<string>',
            'webhookId' => '<string>',
            'webhookUrl' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

webhooks
Required: Yes
Type: Array of Webhook structures

A list of webhooks.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

StartDeployment

$result = $client->startDeployment([/* ... */]);
$promise = $client->startDeploymentAsync([/* ... */]);

Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.

The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.

Parameter Syntax

$result = $client->startDeployment([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
    'jobId' => '<string>',
    'sourceUrl' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name of the branch to use for the job.

jobId
Type: string

The job ID for this deployment, generated by the create deployment request.

sourceUrl
Type: string

The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file.

Result Syntax

[
    'jobSummary' => [
        'commitId' => '<string>',
        'commitMessage' => '<string>',
        'commitTime' => <DateTime>,
        'endTime' => <DateTime>,
        'jobArn' => '<string>',
        'jobId' => '<string>',
        'jobType' => 'RELEASE|RETRY|MANUAL|WEB_HOOK',
        'startTime' => <DateTime>,
        'status' => 'PENDING|PROVISIONING|RUNNING|FAILED|SUCCEED|CANCELLING|CANCELLED',
    ],
]

Result Details

Members
jobSummary
Required: Yes
Type: JobSummary structure

The summary for the job.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

NotFoundException:

An entity was not found during an operation.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

StartJob

$result = $client->startJob([/* ... */]);
$promise = $client->startJobAsync([/* ... */]);

Starts a new job for a branch of an Amplify app.

Parameter Syntax

$result = $client->startJob([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
    'commitId' => '<string>',
    'commitMessage' => '<string>',
    'commitTime' => <integer || string || DateTime>,
    'jobId' => '<string>',
    'jobReason' => '<string>',
    'jobType' => 'RELEASE|RETRY|MANUAL|WEB_HOOK', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name of the branch to use for the job.

commitId
Type: string

The commit ID from a third-party repository provider for the job.

commitMessage
Type: string

The commit message from a third-party repository provider for the job.

commitTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The commit date and time for the job.

jobId
Type: string

The unique ID for an existing job. This is required if the value of jobType is RETRY.

jobReason
Type: string

A descriptive reason for starting the job.

jobType
Required: Yes
Type: string

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.

The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

Result Syntax

[
    'jobSummary' => [
        'commitId' => '<string>',
        'commitMessage' => '<string>',
        'commitTime' => <DateTime>,
        'endTime' => <DateTime>,
        'jobArn' => '<string>',
        'jobId' => '<string>',
        'jobType' => 'RELEASE|RETRY|MANUAL|WEB_HOOK',
        'startTime' => <DateTime>,
        'status' => 'PENDING|PROVISIONING|RUNNING|FAILED|SUCCEED|CANCELLING|CANCELLED',
    ],
]

Result Details

Members
jobSummary
Required: Yes
Type: JobSummary structure

The summary for the job.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

NotFoundException:

An entity was not found during an operation.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

StopJob

$result = $client->stopJob([/* ... */]);
$promise = $client->stopJobAsync([/* ... */]);

Stops a job that is in progress for a branch of an Amplify app.

Parameter Syntax

$result = $client->stopJob([
    'appId' => '<string>', // REQUIRED
    'branchName' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

branchName
Required: Yes
Type: string

The name of the branch to use for the stop job request.

jobId
Required: Yes
Type: string

The unique id for the job.

Result Syntax

[
    'jobSummary' => [
        'commitId' => '<string>',
        'commitMessage' => '<string>',
        'commitTime' => <DateTime>,
        'endTime' => <DateTime>,
        'jobArn' => '<string>',
        'jobId' => '<string>',
        'jobType' => 'RELEASE|RETRY|MANUAL|WEB_HOOK',
        'startTime' => <DateTime>,
        'status' => 'PENDING|PROVISIONING|RUNNING|FAILED|SUCCEED|CANCELLING|CANCELLED',
    ],
]

Result Details

Members
jobSummary
Required: Yes
Type: JobSummary structure

The summary for the job.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

NotFoundException:

An entity was not found during an operation.

LimitExceededException:

A resource could not be created because service quotas were exceeded.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags the resource with a tag key and value.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) to use to tag a resource.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags used to tag the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalFailureException:

The service failed to perform an operation due to an internal issue.

BadRequestException:

A request contains unexpected data.

ResourceNotFoundException:

An operation failed due to a non-existent resource.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Untags a resource with a specified Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) to use to untag a resource.

tagKeys
Required: Yes
Type: Array of strings

The tag keys to use to untag a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalFailureException:

The service failed to perform an operation due to an internal issue.

BadRequestException:

A request contains unexpected data.

ResourceNotFoundException:

An operation failed due to a non-existent resource.

UpdateApp

$result = $client->updateApp([/* ... */]);
$promise = $client->updateAppAsync([/* ... */]);

Updates an existing Amplify app.

Parameter Syntax

$result = $client->updateApp([
    'accessToken' => '<string>',
    'appId' => '<string>', // REQUIRED
    'autoBranchCreationConfig' => [
        'basicAuthCredentials' => '<string>',
        'buildSpec' => '<string>',
        'enableAutoBuild' => true || false,
        'enableBasicAuth' => true || false,
        'enablePerformanceMode' => true || false,
        'enablePullRequestPreview' => true || false,
        'environmentVariables' => ['<string>', ...],
        'framework' => '<string>',
        'pullRequestEnvironmentName' => '<string>',
        'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
    ],
    'autoBranchCreationPatterns' => ['<string>', ...],
    'basicAuthCredentials' => '<string>',
    'buildSpec' => '<string>',
    'customHeaders' => '<string>',
    'customRules' => [
        [
            'condition' => '<string>',
            'source' => '<string>', // REQUIRED
            'status' => '<string>',
            'target' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'enableAutoBranchCreation' => true || false,
    'enableBasicAuth' => true || false,
    'enableBranchAutoBuild' => true || false,
    'enableBranchAutoDeletion' => true || false,
    'environmentVariables' => ['<string>', ...],
    'iamServiceRoleArn' => '<string>',
    'name' => '<string>',
    'oauthToken' => '<string>',
    'platform' => 'WEB|WEB_DYNAMIC|WEB_COMPUTE',
    'repository' => '<string>',
]);

Parameter Details

Members
accessToken
Type: string

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you update an app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

appId
Required: Yes
Type: string

The unique ID for an Amplify app.

autoBranchCreationConfig
Type: AutoBranchCreationConfig structure

The automated branch creation configuration for an Amplify app.

autoBranchCreationPatterns
Type: Array of strings

Describes the automated branch creation glob patterns for an Amplify app.

basicAuthCredentials
Type: string

The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

buildSpec
Type: string

The build specification (build spec) for an Amplify app.

customHeaders
Type: string

The custom HTTP headers for an Amplify app.

customRules
Type: Array of CustomRule structures

The custom redirect and rewrite rules for an Amplify app.

description
Type: string

The description for an Amplify app.

enableAutoBranchCreation
Type: boolean

Enables automated branch creation for an Amplify app.

enableBasicAuth
Type: boolean

Enables basic authorization for an Amplify app.

enableBranchAutoBuild
Type: boolean

Enables branch auto-building for an Amplify app.

enableBranchAutoDeletion
Type: boolean

Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.

environmentVariables
Type: Associative array of custom strings keys (EnvKey) to strings

The environment variables for an Amplify app.

iamServiceRoleArn
Type: string

The AWS Identity and Access Management (IAM) service role for an Amplify app.

name
Type: string

The name for an Amplify app.

oauthToken
Type: string

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit.

To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you update an app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

platform
Type: string

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

repository
Type: string

The name of the Git repository for an Amplify app.

Result Syntax

[
    'app' => [
        'appArn' => '<string>',
        'appId' => '<string>',
        'autoBranchCreationConfig' => [
            'basicAuthCredentials' => '<string>',
            'buildSpec' => '<string>',
            'enableAutoBuild' => true || false,
            'enableBasicAuth' => true || false,
            'enablePerformanceMode' => true || false,
            'enablePullRequestPreview' => true || false,
            'environmentVariables' => ['<string>', ...],
            'framework' => '<string>',
            'pullRequestEnvironmentName' => '<string>',
            'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
        ],
        'autoBranchCreationPatterns' => ['<string>', ...],
        'basicAuthCredentials' => '<string>',
        'buildSpec' => '<string>',
        'createTime' => <DateTime>,
        'customHeaders' => '<string>',
        'customRules' => [
            [
                'condition' => '<string>',
                'source' => '<string>',
                'status' => '<string>',
                'target' => '<string>',
            ],
            // ...
        ],
        'defaultDomain' => '<string>',
        'description' => '<string>',
        'enableAutoBranchCreation' => true || false,
        'enableBasicAuth' => true || false,
        'enableBranchAutoBuild' => true || false,
        'enableBranchAutoDeletion' => true || false,
        'environmentVariables' => ['<string>', ...],
        'iamServiceRoleArn' => '<string>',
        'name' => '<string>',
        'platform' => 'WEB|WEB_DYNAMIC|WEB_COMPUTE',
        'productionBranch' => [
            'branchName' => '<string>',
            'lastDeployTime' => <DateTime>,
            'status' => '<string>',
            'thumbnailUrl' => '<string>',
        ],
        'repository' => '<string>',
        'repositoryCloneMethod' => 'SSH|TOKEN|SIGV4',
        'tags' => ['<string>', ...],
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
app
Required: Yes
Type: App structure

Represents the updated Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

NotFoundException:

An entity was not found during an operation.

UnauthorizedException:

An operation failed due to a lack of access.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

UpdateBranch

$result = $client->updateBranch([/* ... */]);
$promise = $client->updateBranchAsync([/* ... */]);

Updates a branch for an Amplify app.

Parameter Syntax

$result = $client->updateBranch([
    'appId' => '<string>', // REQUIRED
    'backend' => [
        'stackArn' => '<string>',
    ],
    'backendEnvironmentArn' => '<string>',
    'basicAuthCredentials' => '<string>',
    'branchName' => '<string>', // REQUIRED
    'buildSpec' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'enableAutoBuild' => true || false,
    'enableBasicAuth' => true || false,
    'enableNotification' => true || false,
    'enablePerformanceMode' => true || false,
    'enablePullRequestPreview' => true || false,
    'environmentVariables' => ['<string>', ...],
    'framework' => '<string>',
    'pullRequestEnvironmentName' => '<string>',
    'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
    'ttl' => '<string>',
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

backend
Type: Backend structure

The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

backendEnvironmentArn
Type: string

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.

This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).

basicAuthCredentials
Type: string

The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.

branchName
Required: Yes
Type: string

The name of the branch.

buildSpec
Type: string

The build specification (build spec) for the branch.

description
Type: string

The description for the branch.

displayName
Type: string

The display name for a branch. This is used as the default domain prefix.

enableAutoBuild
Type: boolean

Enables auto building for the branch.

enableBasicAuth
Type: boolean

Enables basic authorization for the branch.

enableNotification
Type: boolean

Enables notifications for the branch.

enablePerformanceMode
Type: boolean

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

enablePullRequestPreview
Type: boolean

Enables pull request previews for this branch.

environmentVariables
Type: Associative array of custom strings keys (EnvKey) to strings

The environment variables for the branch.

framework
Type: string

The framework for the branch.

pullRequestEnvironmentName
Type: string

The Amplify environment name for the pull request.

stage
Type: string

Describes the current stage for the branch.

ttl
Type: string

The content Time to Live (TTL) for the website in seconds.

Result Syntax

[
    'branch' => [
        'activeJobId' => '<string>',
        'associatedResources' => ['<string>', ...],
        'backend' => [
            'stackArn' => '<string>',
        ],
        'backendEnvironmentArn' => '<string>',
        'basicAuthCredentials' => '<string>',
        'branchArn' => '<string>',
        'branchName' => '<string>',
        'buildSpec' => '<string>',
        'createTime' => <DateTime>,
        'customDomains' => ['<string>', ...],
        'description' => '<string>',
        'destinationBranch' => '<string>',
        'displayName' => '<string>',
        'enableAutoBuild' => true || false,
        'enableBasicAuth' => true || false,
        'enableNotification' => true || false,
        'enablePerformanceMode' => true || false,
        'enablePullRequestPreview' => true || false,
        'environmentVariables' => ['<string>', ...],
        'framework' => '<string>',
        'pullRequestEnvironmentName' => '<string>',
        'sourceBranch' => '<string>',
        'stage' => 'PRODUCTION|BETA|DEVELOPMENT|EXPERIMENTAL|PULL_REQUEST',
        'tags' => ['<string>', ...],
        'thumbnailUrl' => '<string>',
        'totalNumberOfJobs' => '<string>',
        'ttl' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Members
branch
Required: Yes
Type: Branch structure

The branch for an Amplify app, which maps to a third-party repository branch.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

UpdateDomainAssociation

$result = $client->updateDomainAssociation([/* ... */]);
$promise = $client->updateDomainAssociationAsync([/* ... */]);

Creates a new domain association for an Amplify app.

Parameter Syntax

$result = $client->updateDomainAssociation([
    'appId' => '<string>', // REQUIRED
    'autoSubDomainCreationPatterns' => ['<string>', ...],
    'autoSubDomainIAMRole' => '<string>',
    'certificateSettings' => [
        'customCertificateArn' => '<string>',
        'type' => 'AMPLIFY_MANAGED|CUSTOM', // REQUIRED
    ],
    'domainName' => '<string>', // REQUIRED
    'enableAutoSubDomain' => true || false,
    'subDomainSettings' => [
        [
            'branchName' => '<string>', // REQUIRED
            'prefix' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
appId
Required: Yes
Type: string

The unique ID for an Amplify app.

autoSubDomainCreationPatterns
Type: Array of strings

Sets the branch patterns for automatic subdomain creation.

autoSubDomainIAMRole
Type: string

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

certificateSettings
Type: CertificateSettings structure

The type of SSL/TLS certificate to use for your custom domain.

domainName
Required: Yes
Type: string

The name of the domain.

enableAutoSubDomain
Type: boolean

Enables the automated creation of subdomains for branches.

subDomainSettings
Type: Array of SubDomainSetting structures

Describes the settings for the subdomain.

Result Syntax

[
    'domainAssociation' => [
        'autoSubDomainCreationPatterns' => ['<string>', ...],
        'autoSubDomainIAMRole' => '<string>',
        'certificate' => [
            'certificateVerificationDNSRecord' => '<string>',
            'customCertificateArn' => '<string>',
            'type' => 'AMPLIFY_MANAGED|CUSTOM',
        ],
        'certificateVerificationDNSRecord' => '<string>',
        'domainAssociationArn' => '<string>',
        'domainName' => '<string>',
        'domainStatus' => 'PENDING_VERIFICATION|IN_PROGRESS|AVAILABLE|IMPORTING_CUSTOM_CERTIFICATE|PENDING_DEPLOYMENT|AWAITING_APP_CNAME|FAILED|CREATING|REQUESTING_CERTIFICATE|UPDATING',
        'enableAutoSubDomain' => true || false,
        'statusReason' => '<string>',
        'subDomains' => [
            [
                'dnsRecord' => '<string>',
                'subDomainSetting' => [
                    'branchName' => '<string>',
                    'prefix' => '<string>',
                ],
                'verified' => true || false,
            ],
            // ...
        ],
        'updateStatus' => 'REQUESTING_CERTIFICATE|PENDING_VERIFICATION|IMPORTING_CUSTOM_CERTIFICATE|PENDING_DEPLOYMENT|AWAITING_APP_CNAME|UPDATE_COMPLETE|UPDATE_FAILED',
    ],
]

Result Details

Members
domainAssociation
Required: Yes
Type: DomainAssociation structure

Describes a domain association, which associates a custom domain with an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

UpdateWebhook

$result = $client->updateWebhook([/* ... */]);
$promise = $client->updateWebhookAsync([/* ... */]);

Updates a webhook.

Parameter Syntax

$result = $client->updateWebhook([
    'branchName' => '<string>',
    'description' => '<string>',
    'webhookId' => '<string>', // REQUIRED
]);

Parameter Details

Members
branchName
Type: string

The name for a branch that is part of an Amplify app.

description
Type: string

The description for a webhook.

webhookId
Required: Yes
Type: string

The unique ID for a webhook.

Result Syntax

[
    'webhook' => [
        'branchName' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'updateTime' => <DateTime>,
        'webhookArn' => '<string>',
        'webhookId' => '<string>',
        'webhookUrl' => '<string>',
    ],
]

Result Details

Members
webhook
Required: Yes
Type: Webhook structure

Describes a webhook that connects repository events to an Amplify app.

Errors

BadRequestException:

A request contains unexpected data.

UnauthorizedException:

An operation failed due to a lack of access.

NotFoundException:

An entity was not found during an operation.

InternalFailureException:

The service failed to perform an operation due to an internal issue.

DependentServiceFailureException:

An operation failed because a dependent service threw an exception.

Shapes

App

Description

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

Members
appArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amplify app.

appId
Required: Yes
Type: string

The unique ID of the Amplify app.

autoBranchCreationConfig
Type: AutoBranchCreationConfig structure

Describes the automated branch creation configuration for the Amplify app.

autoBranchCreationPatterns
Type: Array of strings

Describes the automated branch creation glob patterns for the Amplify app.

basicAuthCredentials
Type: string

The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

buildSpec
Type: string

Describes the content of the build specification (build spec) for the Amplify app.

createTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Creates a date and time for the Amplify app.

customHeaders
Type: string

Describes the custom HTTP headers for the Amplify app.

customRules
Type: Array of CustomRule structures

Describes the custom redirect and rewrite rules for the Amplify app.

defaultDomain
Required: Yes
Type: string

The default domain for the Amplify app.

description
Required: Yes
Type: string

The description for the Amplify app.

enableAutoBranchCreation
Type: boolean

Enables automated branch creation for the Amplify app.

enableBasicAuth
Required: Yes
Type: boolean

Enables basic authorization for the Amplify app's branches.

enableBranchAutoBuild
Required: Yes
Type: boolean

Enables the auto-building of branches for the Amplify app.

enableBranchAutoDeletion
Type: boolean

Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.

environmentVariables
Required: Yes
Type: Associative array of custom strings keys (EnvKey) to strings

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

iamServiceRoleArn
Type: string

The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

name
Required: Yes
Type: string

The name for the Amplify app.

platform
Required: Yes
Type: string

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

productionBranch
Type: ProductionBranch structure

Describes the information about a production branch of the Amplify app.

repository
Required: Yes
Type: string

The Git repository for the Amplify app.

repositoryCloneMethod
Type: string

This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tag for the Amplify app.

updateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Updates the date and time for the Amplify app.

Artifact

Description

Describes an artifact.

Members
artifactFileName
Required: Yes
Type: string

The file name for the artifact.

artifactId
Required: Yes
Type: string

The unique ID for the artifact.

AutoBranchCreationConfig

Description

Describes the automated branch creation configuration.

Members
basicAuthCredentials
Type: string

The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password.

buildSpec
Type: string

The build specification (build spec) for the autocreated branch.

enableAutoBuild
Type: boolean

Enables auto building for the autocreated branch.

enableBasicAuth
Type: boolean

Enables basic authorization for the autocreated branch.

enablePerformanceMode
Type: boolean

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

enablePullRequestPreview
Type: boolean

Enables pull request previews for the autocreated branch.

environmentVariables
Type: Associative array of custom strings keys (EnvKey) to strings

The environment variables for the autocreated branch.

framework
Type: string

The framework for the autocreated branch.

pullRequestEnvironmentName
Type: string

The Amplify environment name for the pull request.

stage
Type: string

Describes the current stage for the autocreated branch.

Backend

Description

Describes the backend associated with an Amplify Branch.

This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Members
stackArn
Type: string

The Amazon Resource Name (ARN) for the CloudFormation stack.

BackendEnvironment

Description

Describes the backend environment associated with a Branch of a Gen 1 Amplify app. Amplify Gen 1 applications are created using Amplify Studio or the Amplify command line interface (CLI).

Members
backendEnvironmentArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

createTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time for a backend environment that is part of an Amplify app.

deploymentArtifacts
Type: string

The name of deployment artifacts.

environmentName
Required: Yes
Type: string

The name for a backend environment that is part of an Amplify app.

stackName
Type: string

The AWS CloudFormation stack name of a backend environment.

updateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last updated date and time for a backend environment that is part of an Amplify app.

BadRequestException

Description

A request contains unexpected data.

Members
message
Type: string

Branch

Description

The branch for an Amplify app, which maps to a third-party repository branch.

Members
activeJobId
Required: Yes
Type: string

The ID of the active job for a branch of an Amplify app.

associatedResources
Type: Array of strings

A list of custom resources that are linked to this branch.

backend
Type: Backend structure

Describes the backend associated with an Amplify Branch.

This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

backendEnvironmentArn
Type: string

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

basicAuthCredentials
Type: string

The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

branchArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.

branchName
Required: Yes
Type: string

The name for the branch that is part of an Amplify app.

buildSpec
Type: string

The build specification (build spec) content for the branch of an Amplify app.

createTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time for a branch that is part of an Amplify app.

customDomains
Required: Yes
Type: Array of strings

The custom domains for a branch of an Amplify app.

description
Required: Yes
Type: string

The description for the branch that is part of an Amplify app.

destinationBranch
Type: string

The destination branch if the branch is a pull request branch.

displayName
Required: Yes
Type: string

The display name for the branch. This is used as the default domain prefix.

enableAutoBuild
Required: Yes
Type: boolean

Enables auto-building on push for a branch of an Amplify app.

enableBasicAuth
Required: Yes
Type: boolean

Enables basic authorization for a branch of an Amplify app.

enableNotification
Required: Yes
Type: boolean

Enables notifications for a branch that is part of an Amplify app.

enablePerformanceMode
Type: boolean

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

enablePullRequestPreview
Required: Yes
Type: boolean

Enables pull request previews for the branch.

environmentVariables
Required: Yes
Type: Associative array of custom strings keys (EnvKey) to strings

The environment variables specific to a branch of an Amplify app.

framework
Required: Yes
Type: string

The framework for a branch of an Amplify app.

pullRequestEnvironmentName
Type: string

The Amplify environment name for the pull request.

sourceBranch
Type: string

The source branch if the branch is a pull request branch.

stage
Required: Yes
Type: string

The current stage for the branch that is part of an Amplify app.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tag for the branch of an Amplify app.

thumbnailUrl
Type: string

The thumbnail URL for the branch of an Amplify app.

totalNumberOfJobs
Required: Yes
Type: string

The total number of jobs that are part of an Amplify app.

ttl
Required: Yes
Type: string

The content Time to Live (TTL) for the website in seconds.

updateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last updated date and time for a branch that is part of an Amplify app.

Certificate

Description

Describes the current SSL/TLS certificate that is in use for the domain. If you are using CreateDomainAssociation to create a new domain association, Certificate describes the new certificate that you are creating.

Members
certificateVerificationDNSRecord
Type: string

The DNS record for certificate verification.

customCertificateArn
Type: string

The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.

This field is required only when the certificate type is CUSTOM.

type
Required: Yes
Type: string

The type of SSL/TLS certificate that you want to use.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide .

CertificateSettings

Description

The type of SSL/TLS certificate to use for your custom domain. If a certificate type isn't specified, Amplify uses the default AMPLIFY_MANAGED certificate.

Members
customCertificateArn
Type: string

The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.

This field is required only when the certificate type is CUSTOM.

type
Required: Yes
Type: string

The certificate type.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide.

CustomRule

Description

Describes a custom rewrite or redirect rule.

Members
condition
Type: string

The condition for a URL rewrite or redirect rule, such as a country code.

source
Required: Yes
Type: string

The source pattern for a URL rewrite or redirect rule.

status
Type: string

The status code for a URL rewrite or redirect rule.

200

Represents a 200 rewrite rule.

301

Represents a 301 (moved permanently) redirect rule. This and all future requests should be directed to the target URL.

302

Represents a 302 temporary redirect rule.

404

Represents a 404 redirect rule.

404-200

Represents a 404 rewrite rule.

target
Required: Yes
Type: string

The target pattern for a URL rewrite or redirect rule.

DependentServiceFailureException

Description

An operation failed because a dependent service threw an exception.

Members
message
Type: string

DomainAssociation

Description

Describes the association between a custom domain and an Amplify app.

Members
autoSubDomainCreationPatterns
Type: Array of strings

Sets branch patterns for automatic subdomain creation.

autoSubDomainIAMRole
Type: string

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

certificate
Type: Certificate structure

Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.

certificateVerificationDNSRecord
Type: string

The DNS record for certificate verification.

domainAssociationArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the domain association.

domainName
Required: Yes
Type: string

The name of the domain.

domainStatus
Required: Yes
Type: string

The current status of the domain association.

enableAutoSubDomain
Required: Yes
Type: boolean

Enables the automated creation of subdomains for branches.

statusReason
Required: Yes
Type: string

Additional information that describes why the domain association is in the current state.

subDomains
Required: Yes
Type: Array of SubDomain structures

The subdomains for the domain association.

updateStatus
Type: string

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

REQUESTING_CERTIFICATE

The certificate is in the process of being updated.

PENDING_VERIFICATION

Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

IMPORTING_CUSTOM_CERTIFICATE

Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

PENDING_DEPLOYMENT

Indicates that the subdomain or certificate changes are being propagated.

AWAITING_APP_CNAME

Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

UPDATE_COMPLETE

The certificate has been associated with a domain.

UPDATE_FAILED

The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

InternalFailureException

Description

The service failed to perform an operation due to an internal issue.

Members
message
Type: string

Job

Description

Describes an execution job for an Amplify app.

Members
steps
Required: Yes
Type: Array of Step structures

The execution steps for an execution job, for an Amplify app.

summary
Required: Yes
Type: JobSummary structure

Describes the summary for an execution job for an Amplify app.

JobSummary

Description

Describes the summary for an execution job for an Amplify app.

Members
commitId
Required: Yes
Type: string

The commit ID from a third-party repository provider for the job.

commitMessage
Required: Yes
Type: string

The commit message from a third-party repository provider for the job.

commitTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The commit date and time for the job.

endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end date and time for the job.

jobArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the job.

jobId
Required: Yes
Type: string

The unique ID for the job.

jobType
Required: Yes
Type: string

The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks.

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start date and time for the job.

status
Required: Yes
Type: string

The current status for the job.

LimitExceededException

Description

A resource could not be created because service quotas were exceeded.

Members
message
Type: string

NotFoundException

Description

An entity was not found during an operation.

Members
message
Type: string

ProductionBranch

Description

Describes the information about a production branch for an Amplify app.

Members
branchName
Type: string

The branch name for the production branch.

lastDeployTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last deploy time of the production branch.

status
Type: string

The status of the production branch.

thumbnailUrl
Type: string

The thumbnail URL for the production branch.

ResourceNotFoundException

Description

An operation failed due to a non-existent resource.

Members
code
Required: Yes
Type: string
message
Required: Yes
Type: string

Step

Description

Describes an execution step, for an execution job, for an Amplify app.

Members
artifactsUrl
Type: string

The URL to the artifact for the execution step.

context
Type: string

The context for the current step. Includes a build image if the step is build.

endTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end date and time of the execution step.

logUrl
Type: string

The URL to the logs for the execution step.

screenshots
Type: Associative array of custom strings keys (ThumbnailName) to strings

The list of screenshot URLs for the execution step, if relevant.

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start date and time of the execution step.

status
Required: Yes
Type: string

The status of the execution step.

statusReason
Type: string

The reason for the current step status.

stepName
Required: Yes
Type: string

The name of the execution step.

testArtifactsUrl
Type: string

The URL to the test artifact for the execution step.

testConfigUrl
Type: string

The URL to the test configuration for the execution step.

SubDomain

Description

The subdomain for the domain association.

Members
dnsRecord
Required: Yes
Type: string

The DNS record for the subdomain.

subDomainSetting
Required: Yes
Type: SubDomainSetting structure

Describes the settings for the subdomain.

verified
Required: Yes
Type: boolean

The verified status of the subdomain

SubDomainSetting

Description

Describes the settings for the subdomain.

Members
branchName
Required: Yes
Type: string

The branch name setting for the subdomain.

prefix
Required: Yes
Type: string

The prefix setting for the subdomain.

UnauthorizedException

Description

An operation failed due to a lack of access.

Members
message
Type: string

Webhook

Description

Describes a webhook that connects repository events to an Amplify app.

Members
branchName
Required: Yes
Type: string

The name for a branch that is part of an Amplify app.

createTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The create date and time for a webhook.

description
Required: Yes
Type: string

The description for a webhook.

updateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Updates the date and time for a webhook.

webhookArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the webhook.

webhookId
Required: Yes
Type: string

The ID of the webhook.

webhookUrl
Required: Yes
Type: string

The URL of the webhook.