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>',
    'cacheConfig' => [
        'type' => 'AMPLIFY_MANAGED|AMPLIFY_MANAGED_NO_COOKIES', // REQUIRED
    ],
    '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

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>',
        'cacheConfig' => [
            'type' => 'AMPLIFY_MANAGED|AMPLIFY_MANAGED_NO_COOKIES',
        ],
        '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>,
        'wafConfiguration' => [
            'statusReason' => '<string>',
            'wafStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ASSOCIATION_SUCCESS|DISASSOCIATING|DISASSOCIATION_FAILED',
            'webAclArn' => '<string>',
        ],
        'webhookCreateTime' => <DateTime>,
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

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

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 Git 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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

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>',
        'cacheConfig' => [
            'type' => 'AMPLIFY_MANAGED|AMPLIFY_MANAGED_NO_COOKIES',
        ],
        '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>,
        'wafConfiguration' => [
            'statusReason' => '<string>',
            'wafStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ASSOCIATION_SUCCESS|DISASSOCIATING|DISASSOCIATION_FAILED',
            'webAclArn' => '<string>',
        ],
        'webhookCreateTime' => <DateTime>,
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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>',
        'cacheConfig' => [
            'type' => 'AMPLIFY_MANAGED|AMPLIFY_MANAGED_NO_COOKIES',
        ],
        '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>,
        'wafConfiguration' => [
            'statusReason' => '<string>',
            'wafStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ASSOCIATION_SUCCESS|DISASSOCIATING|DISASSOCIATION_FAILED',
            'webAclArn' => '<string>',
        ],
        'webhookCreateTime' => <DateTime>,
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

[
    'job' => [
        'steps' => [
            [
                'artifactsUrl' => '<string>',
                'context' => '<string>',
                'endTime' => <DateTime>,
                'logUrl' => '<string>',
                'screenshots' => ['<string>', ...],
                'startTime' => <DateTime>,
                'status' => 'CREATED|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',
            'sourceUrl' => '<string>',
            'sourceUrlType' => 'ZIP|BUCKET_PREFIX',
            'startTime' => <DateTime>,
            'status' => 'CREATED|PENDING|PROVISIONING|RUNNING|FAILED|SUCCEED|CANCELLING|CANCELLED',
        ],
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

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>',
            'cacheConfig' => [
                'type' => 'AMPLIFY_MANAGED|AMPLIFY_MANAGED_NO_COOKIES',
            ],
            '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>,
            'wafConfiguration' => [
                'statusReason' => '<string>',
                'wafStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ASSOCIATION_SUCCESS|DISASSOCIATING|DISASSOCIATION_FAILED',
                'webAclArn' => '<string>',
            ],
            'webhookCreateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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 Git 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>',
    'sourceUrlType' => 'ZIP|BUCKET_PREFIX',
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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>',
    'cacheConfig' => [
        'type' => 'AMPLIFY_MANAGED|AMPLIFY_MANAGED_NO_COOKIES', // REQUIRED
    ],
    '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

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>',
        'cacheConfig' => [
            'type' => 'AMPLIFY_MANAGED|AMPLIFY_MANAGED_NO_COOKIES',
        ],
        '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>,
        'wafConfiguration' => [
            'statusReason' => '<string>',
            'wafStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ASSOCIATION_SUCCESS|DISASSOCIATING|DISASSOCIATION_FAILED',
            'webAclArn' => '<string>',
        ],
        'webhookCreateTime' => <DateTime>,
    ],
]

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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.