Table of Contents
Amplify.Client¶A low-level client representing AWS Amplify
Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Console User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.
import boto3
client = boto3.client('amplify')
These are the available methods:
can_paginate()close()create_app()create_backend_environment()create_branch()create_deployment()create_domain_association()create_webhook()delete_app()delete_backend_environment()delete_branch()delete_domain_association()delete_job()delete_webhook()generate_access_logs()get_app()get_artifact_url()get_backend_environment()get_branch()get_domain_association()get_job()get_paginator()get_waiter()get_webhook()list_apps()list_artifacts()list_backend_environments()list_branches()list_domain_associations()list_jobs()list_tags_for_resource()list_webhooks()start_deployment()start_job()stop_job()tag_resource()untag_resource()update_app()update_branch()update_domain_association()update_webhook()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_app(**kwargs)¶Creates a new Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.create_app(
name='string',
description='string',
repository='string',
platform='WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
iamServiceRoleArn='string',
oauthToken='string',
accessToken='string',
environmentVariables={
'string': 'string'
},
enableBranchAutoBuild=True|False,
enableBranchAutoDeletion=True|False,
enableBasicAuth=True|False,
basicAuthCredentials='string',
customRules=[
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
tags={
'string': 'string'
},
buildSpec='string',
customHeaders='string',
enableAutoBranchCreation=True|False,
autoBranchCreationPatterns=[
'string',
],
autoBranchCreationConfig={
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
}
)
[REQUIRED]
The name for an Amplify app.
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 .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 .
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 .
The environment variables map for an Amplify app.
user:password .The custom rewrite and redirect rules for an Amplify app.
Describes a custom rewrite or redirect rule.
The source pattern for a URL rewrite or redirect rule.
The target pattern for a URL rewrite or redirect rule.
The status code for a URL rewrite or redirect rule.
200
Represents a 200 rewrite rule.
301
Represents a 301 (moved pemanently) 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.
The condition for a URL rewrite or redirect rule, such as a country code.
The tag for an Amplify app.
The automated branch creation glob patterns for an Amplify app.
The automated branch creation configuration for an Amplify app.
Describes the current stage for the autocreated branch.
The framework for the autocreated branch.
Enables auto building for the autocreated branch.
The environment variables for the autocreated branch.
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password .
Enables basic authorization for the autocreated branch.
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.
The build specification (build spec) for the autocreated branch.
Enables pull request previews for the autocreated branch.
The Amplify environment name for the pull request.
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBranchAutoDeletion': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'customHeaders': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
}
}
Response Structure
(dict) --
app (dict) --
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
appId (string) --
The unique ID of the Amplify app.
appArn (string) --
The Amazon Resource Name (ARN) of the Amplify app.
name (string) --
The name for the Amplify app.
tags (dict) --
The tag for the Amplify app.
description (string) --
The description for the Amplify app.
repository (string) --
The Git repository for the Amplify app.
platform (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 .
createTime (datetime) --
Creates a date and time for the Amplify app.
updateTime (datetime) --
Updates the date and time for the Amplify app.
iamServiceRoleArn (string) --
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
defaultDomain (string) --
The default domain for the Amplify app.
enableBranchAutoBuild (boolean) --
Enables the auto-building of branches for the Amplify app.
enableBranchAutoDeletion (boolean) --
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
enableBasicAuth (boolean) --
Enables basic authorization for the Amplify app's branches.
basicAuthCredentials (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 .
customRules (list) --
Describes the custom redirect and rewrite rules for the Amplify app.
(dict) --
Describes a custom rewrite or redirect rule.
source (string) --
The source pattern for a URL rewrite or redirect rule.
target (string) --
The target pattern for a URL rewrite or redirect rule.
status (string) --
The status code for a URL rewrite or redirect rule.
200
Represents a 200 rewrite rule.
301
Represents a 301 (moved pemanently) 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.
condition (string) --
The condition for a URL rewrite or redirect rule, such as a country code.
productionBranch (dict) --
Describes the information about a production branch of the Amplify app.
lastDeployTime (datetime) --
The last deploy time of the production branch.
status (string) --
The status of the production branch.
thumbnailUrl (string) --
The thumbnail URL for the production branch.
branchName (string) --
The branch name for the production branch.
buildSpec (string) --
Describes the content of the build specification (build spec) for the Amplify app.
customHeaders (string) --
Describes the custom HTTP headers for the Amplify app.
enableAutoBranchCreation (boolean) --
Enables automated branch creation for the Amplify app.
autoBranchCreationPatterns (list) --
Describes the automated branch creation glob patterns for the Amplify app.
autoBranchCreationConfig (dict) --
Describes the automated branch creation configuration for the Amplify app.
stage (string) --
Describes the current stage for the autocreated branch.
framework (string) --
The framework for the autocreated branch.
enableAutoBuild (boolean) --
Enables auto building for the autocreated branch.
environmentVariables (dict) --
The environment variables for the autocreated branch.
basicAuthCredentials (string) --
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password .
enableBasicAuth (boolean) --
Enables basic authorization for the autocreated branch.
enablePerformanceMode (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.
buildSpec (string) --
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
repositoryCloneMethod (string) --
Note
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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.LimitExceededExceptionAmplify.Client.exceptions.DependentServiceFailureExceptioncreate_backend_environment(**kwargs)¶Creates a new backend environment for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.create_backend_environment(
appId='string',
environmentName='string',
stackName='string',
deploymentArtifacts='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for the backend environment.
dict
Response Syntax
{
'backendEnvironment': {
'backendEnvironmentArn': 'string',
'environmentName': 'string',
'stackName': 'string',
'deploymentArtifacts': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
The result structure for the create backend environment request.
backendEnvironment (dict) --
Describes the backend environment for an Amplify app.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
environmentName (string) --
The name for a backend environment that is part of an Amplify app.
stackName (string) --
The AWS CloudFormation stack name of a backend environment.
deploymentArtifacts (string) --
The name of deployment artifacts.
createTime (datetime) --
The creation date and time for a backend environment that is part of an Amplify app.
updateTime (datetime) --
The last updated date and time for a backend environment that is part of an Amplify app.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.LimitExceededExceptioncreate_branch(**kwargs)¶Creates a new branch for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.create_branch(
appId='string',
branchName='string',
description='string',
stage='PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
framework='string',
enableNotification=True|False,
enableAutoBuild=True|False,
environmentVariables={
'string': 'string'
},
basicAuthCredentials='string',
enableBasicAuth=True|False,
enablePerformanceMode=True|False,
tags={
'string': 'string'
},
buildSpec='string',
ttl='string',
displayName='string',
enablePullRequestPreview=True|False,
pullRequestEnvironmentName='string',
backendEnvironmentArn='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for the branch.
The environment variables for the branch.
user:password .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.
The tag for the branch.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'displayName': 'string',
'enableNotification': True|False,
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'environmentVariables': {
'string': 'string'
},
'enableAutoBuild': True|False,
'customDomains': [
'string',
],
'framework': 'string',
'activeJobId': 'string',
'totalNumberOfJobs': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
}
}
Response Structure
(dict) --
The result structure for create branch request.
branch (dict) --
Describes the branch for an Amplify app, which maps to a third-party repository branch.
branchArn (string) --
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branchName (string) --
The name for the branch that is part of an Amplify app.
description (string) --
The description for the branch that is part of an Amplify app.
tags (dict) --
The tag for the branch of an Amplify app.
stage (string) --
The current stage for the branch that is part of an Amplify app.
displayName (string) --
The display name for the branch. This is used as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch that is part of an Amplify app.
createTime (datetime) --
The creation date and time for a branch that is part of an Amplify app.
updateTime (datetime) --
The last updated date and time for a branch that is part of an Amplify app.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (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.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (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 .
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.LimitExceededExceptionAmplify.Client.exceptions.DependentServiceFailureExceptioncreate_deployment(**kwargs)¶Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
See also: AWS API Documentation
Request Syntax
response = client.create_deployment(
appId='string',
branchName='string',
fileMap={
'string': 'string'
}
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for the branch, for the job.
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.
dict
Response Syntax
{
'jobId': 'string',
'fileUploadUrls': {
'string': 'string'
},
'zipUploadUrl': 'string'
}
Response Structure
(dict) --
The result structure for the create a new deployment request.
jobId (string) --
The job ID for this deployment. will supply to start deployment api.
fileUploadUrls (dict) --
When the fileMap argument is provided in the request, fileUploadUrls will contain a map of file names to upload URLs.
zipUploadUrl (string) --
When the fileMap argument is not provided in the request, this zipUploadUrl is returned.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.LimitExceededExceptioncreate_domain_association(**kwargs)¶Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
See also: AWS API Documentation
Request Syntax
response = client.create_domain_association(
appId='string',
domainName='string',
enableAutoSubDomain=True|False,
subDomainSettings=[
{
'prefix': 'string',
'branchName': 'string'
},
],
autoSubDomainCreationPatterns=[
'string',
],
autoSubDomainIAMRole='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The domain name for the domain association.
[REQUIRED]
The setting for the subdomain.
Describes the settings for the subdomain.
The prefix setting for the subdomain.
The branch name setting for the subdomain.
Sets the branch patterns for automatic subdomain creation.
dict
Response Syntax
{
'domainAssociation': {
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'autoSubDomainCreationPatterns': [
'string',
],
'autoSubDomainIAMRole': 'string',
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
}
}
Response Structure
(dict) --
The result structure for the create domain association request.
domainAssociation (dict) --
Describes the structure of a domain association, which associates a custom domain with an Amplify app.
domainAssociationArn (string) --
The Amazon Resource Name (ARN) for the domain association.
domainName (string) --
The name of the domain.
enableAutoSubDomain (boolean) --
Enables the automated creation of subdomains for branches.
autoSubDomainCreationPatterns (list) --
Sets branch patterns for automatic subdomain creation.
autoSubDomainIAMRole (string) --
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
domainStatus (string) --
The current status of the domain association.
statusReason (string) --
The reason for the current status of the domain association.
certificateVerificationDNSRecord (string) --
The DNS record for certificate verification.
subDomains (list) --
The subdomains for the domain association.
(dict) --
The subdomain for the domain association.
subDomainSetting (dict) --
Describes the settings for the subdomain.
prefix (string) --
The prefix setting for the subdomain.
branchName (string) --
The branch name setting for the subdomain.
verified (boolean) --
The verified status of the subdomain
dnsRecord (string) --
The DNS record for the subdomain.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.LimitExceededExceptionAmplify.Client.exceptions.DependentServiceFailureExceptioncreate_webhook(**kwargs)¶Creates a new webhook on an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.create_webhook(
appId='string',
branchName='string',
description='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for a branch that is part of an Amplify app.
dict
Response Syntax
{
'webhook': {
'webhookArn': 'string',
'webhookId': 'string',
'webhookUrl': 'string',
'branchName': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
The result structure for the create webhook request.
webhook (dict) --
Describes a webhook that connects repository events to an Amplify app.
webhookArn (string) --
The Amazon Resource Name (ARN) for the webhook.
webhookId (string) --
The ID of the webhook.
webhookUrl (string) --
The URL of the webhook.
branchName (string) --
The name for a branch that is part of an Amplify app.
description (string) --
The description for a webhook.
createTime (datetime) --
The create date and time for a webhook.
updateTime (datetime) --
Updates the date and time for a webhook.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.LimitExceededExceptionAmplify.Client.exceptions.DependentServiceFailureExceptiondelete_app(**kwargs)¶Deletes an existing Amplify app specified by an app ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_app(
appId='string'
)
[REQUIRED]
The unique ID for an Amplify app.
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBranchAutoDeletion': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'customHeaders': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
}
}
Response Structure
The result structure for the delete app request.
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
The unique ID of the Amplify app.
The Amazon Resource Name (ARN) of the Amplify app.
The name for the Amplify app.
The tag for the Amplify app.
The description for the Amplify app.
The Git repository for the Amplify app.
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 .
Creates a date and time for the Amplify app.
Updates the date and time for the Amplify app.
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
The environment variables for the Amplify app.
The default domain for the Amplify app.
Enables the auto-building of branches for the Amplify app.
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
Enables basic authorization for the Amplify app's branches.
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 .
Describes the custom redirect and rewrite rules for the Amplify app.
Describes a custom rewrite or redirect rule.
The source pattern for a URL rewrite or redirect rule.
The target pattern for a URL rewrite or redirect rule.
The status code for a URL rewrite or redirect rule.
200
Represents a 200 rewrite rule.
301
Represents a 301 (moved pemanently) 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.
The condition for a URL rewrite or redirect rule, such as a country code.
Describes the information about a production branch of the Amplify app.
The last deploy time of the production branch.
The status of the production branch.
The thumbnail URL for the production branch.
The branch name for the production branch.
Describes the content of the build specification (build spec) for the Amplify app.
Describes the custom HTTP headers for the Amplify app.
Enables automated branch creation for the Amplify app.
Describes the automated branch creation glob patterns for the Amplify app.
Describes the automated branch creation configuration for the Amplify app.
Describes the current stage for the autocreated branch.
The framework for the autocreated branch.
Enables auto building for the autocreated branch.
The environment variables for the autocreated branch.
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password .
Enables basic authorization for the autocreated branch.
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.
The build specification (build spec) for the autocreated branch.
Enables pull request previews for the autocreated branch.
The Amplify environment name for the pull request.
Note
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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.DependentServiceFailureExceptiondelete_backend_environment(**kwargs)¶Deletes a backend environment for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.delete_backend_environment(
appId='string',
environmentName='string'
)
[REQUIRED]
The unique ID of an Amplify app.
[REQUIRED]
The name of a backend environment of an Amplify app.
dict
Response Syntax
{
'backendEnvironment': {
'backendEnvironmentArn': 'string',
'environmentName': 'string',
'stackName': 'string',
'deploymentArtifacts': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
The result structure of the delete backend environment result.
backendEnvironment (dict) --
Describes the backend environment for an Amplify app.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
environmentName (string) --
The name for a backend environment that is part of an Amplify app.
stackName (string) --
The AWS CloudFormation stack name of a backend environment.
deploymentArtifacts (string) --
The name of deployment artifacts.
createTime (datetime) --
The creation date and time for a backend environment that is part of an Amplify app.
updateTime (datetime) --
The last updated date and time for a backend environment that is part of an Amplify app.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.DependentServiceFailureExceptiondelete_branch(**kwargs)¶Deletes a branch for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.delete_branch(
appId='string',
branchName='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for the branch.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'displayName': 'string',
'enableNotification': True|False,
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'environmentVariables': {
'string': 'string'
},
'enableAutoBuild': True|False,
'customDomains': [
'string',
],
'framework': 'string',
'activeJobId': 'string',
'totalNumberOfJobs': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
}
}
Response Structure
(dict) --
The result structure for the delete branch request.
branch (dict) --
The branch for an Amplify app, which maps to a third-party repository branch.
branchArn (string) --
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branchName (string) --
The name for the branch that is part of an Amplify app.
description (string) --
The description for the branch that is part of an Amplify app.
tags (dict) --
The tag for the branch of an Amplify app.
stage (string) --
The current stage for the branch that is part of an Amplify app.
displayName (string) --
The display name for the branch. This is used as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch that is part of an Amplify app.
createTime (datetime) --
The creation date and time for a branch that is part of an Amplify app.
updateTime (datetime) --
The last updated date and time for a branch that is part of an Amplify app.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (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.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (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 .
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.DependentServiceFailureExceptiondelete_domain_association(**kwargs)¶Deletes a domain association for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.delete_domain_association(
appId='string',
domainName='string'
)
[REQUIRED]
The unique id for an Amplify app.
[REQUIRED]
The name of the domain.
dict
Response Syntax
{
'domainAssociation': {
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'autoSubDomainCreationPatterns': [
'string',
],
'autoSubDomainIAMRole': 'string',
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
}
}
Response Structure
(dict) --
domainAssociation (dict) --
Describes a domain association that associates a custom domain with an Amplify app.
domainAssociationArn (string) --
The Amazon Resource Name (ARN) for the domain association.
domainName (string) --
The name of the domain.
enableAutoSubDomain (boolean) --
Enables the automated creation of subdomains for branches.
autoSubDomainCreationPatterns (list) --
Sets branch patterns for automatic subdomain creation.
autoSubDomainIAMRole (string) --
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
domainStatus (string) --
The current status of the domain association.
statusReason (string) --
The reason for the current status of the domain association.
certificateVerificationDNSRecord (string) --
The DNS record for certificate verification.
subDomains (list) --
The subdomains for the domain association.
(dict) --
The subdomain for the domain association.
subDomainSetting (dict) --
Describes the settings for the subdomain.
prefix (string) --
The prefix setting for the subdomain.
branchName (string) --
The branch name setting for the subdomain.
verified (boolean) --
The verified status of the subdomain
dnsRecord (string) --
The DNS record for the subdomain.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.DependentServiceFailureExceptiondelete_job(**kwargs)¶Deletes a job for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.delete_job(
appId='string',
branchName='string',
jobId='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for the branch, for the job.
[REQUIRED]
The unique ID for the job.
dict
Response Syntax
{
'jobSummary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
}
}
Response Structure
(dict) --
The result structure for the delete job request.
jobSummary (dict) --
Describes the summary for an execution job for an Amplify app.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.LimitExceededExceptiondelete_webhook(**kwargs)¶Deletes a webhook.
See also: AWS API Documentation
Request Syntax
response = client.delete_webhook(
webhookId='string'
)
[REQUIRED]
The unique ID for a webhook.
{
'webhook': {
'webhookArn': 'string',
'webhookId': 'string',
'webhookUrl': 'string',
'branchName': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
The result structure for the delete webhook request.
Describes a webhook that connects repository events to an Amplify app.
The Amazon Resource Name (ARN) for the webhook.
The ID of the webhook.
The URL of the webhook.
The name for a branch that is part of an Amplify app.
The description for a webhook.
The create date and time for a webhook.
Updates the date and time for a webhook.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.LimitExceededExceptiongenerate_access_logs(**kwargs)¶Returns the website access logs for a specific time range using a presigned URL.
See also: AWS API Documentation
Request Syntax
response = client.generate_access_logs(
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
domainName='string',
appId='string'
)
[REQUIRED]
The name of the domain.
[REQUIRED]
The unique ID for an Amplify app.
dict
Response Syntax
{
'logUrl': 'string'
}
Response Structure
(dict) --
The result structure for the generate access logs request.
logUrl (string) --
The pre-signed URL for the requested access logs.
Exceptions
Amplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionget_app(**kwargs)¶Returns an existing Amplify app by appID.
See also: AWS API Documentation
Request Syntax
response = client.get_app(
appId='string'
)
[REQUIRED]
The unique ID for an Amplify app.
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBranchAutoDeletion': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'customHeaders': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
}
}
Response Structure
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
The unique ID of the Amplify app.
The Amazon Resource Name (ARN) of the Amplify app.
The name for the Amplify app.
The tag for the Amplify app.
The description for the Amplify app.
The Git repository for the Amplify app.
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 .
Creates a date and time for the Amplify app.
Updates the date and time for the Amplify app.
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
The environment variables for the Amplify app.
The default domain for the Amplify app.
Enables the auto-building of branches for the Amplify app.
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
Enables basic authorization for the Amplify app's branches.
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 .
Describes the custom redirect and rewrite rules for the Amplify app.
Describes a custom rewrite or redirect rule.
The source pattern for a URL rewrite or redirect rule.
The target pattern for a URL rewrite or redirect rule.
The status code for a URL rewrite or redirect rule.
200
Represents a 200 rewrite rule.
301
Represents a 301 (moved pemanently) 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.
The condition for a URL rewrite or redirect rule, such as a country code.
Describes the information about a production branch of the Amplify app.
The last deploy time of the production branch.
The status of the production branch.
The thumbnail URL for the production branch.
The branch name for the production branch.
Describes the content of the build specification (build spec) for the Amplify app.
Describes the custom HTTP headers for the Amplify app.
Enables automated branch creation for the Amplify app.
Describes the automated branch creation glob patterns for the Amplify app.
Describes the automated branch creation configuration for the Amplify app.
Describes the current stage for the autocreated branch.
The framework for the autocreated branch.
Enables auto building for the autocreated branch.
The environment variables for the autocreated branch.
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password .
Enables basic authorization for the autocreated branch.
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.
The build specification (build spec) for the autocreated branch.
Enables pull request previews for the autocreated branch.
The Amplify environment name for the pull request.
Note
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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionget_artifact_url(**kwargs)¶Returns the artifact info that corresponds to an artifact id.
See also: AWS API Documentation
Request Syntax
response = client.get_artifact_url(
artifactId='string'
)
[REQUIRED]
The unique ID for an artifact.
{
'artifactId': 'string',
'artifactUrl': 'string'
}
Response Structure
Returns the result structure for the get artifact request.
The unique ID for an artifact.
The presigned URL for the artifact.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.LimitExceededExceptionget_backend_environment(**kwargs)¶Returns a backend environment for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.get_backend_environment(
appId='string',
environmentName='string'
)
[REQUIRED]
The unique id for an Amplify app.
[REQUIRED]
The name for the backend environment.
dict
Response Syntax
{
'backendEnvironment': {
'backendEnvironmentArn': 'string',
'environmentName': 'string',
'stackName': 'string',
'deploymentArtifacts': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
The result structure for the get backend environment result.
backendEnvironment (dict) --
Describes the backend environment for an Amplify app.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
environmentName (string) --
The name for a backend environment that is part of an Amplify app.
stackName (string) --
The AWS CloudFormation stack name of a backend environment.
deploymentArtifacts (string) --
The name of deployment artifacts.
createTime (datetime) --
The creation date and time for a backend environment that is part of an Amplify app.
updateTime (datetime) --
The last updated date and time for a backend environment that is part of an Amplify app.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionget_branch(**kwargs)¶Returns a branch for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.get_branch(
appId='string',
branchName='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for the branch.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'displayName': 'string',
'enableNotification': True|False,
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'environmentVariables': {
'string': 'string'
},
'enableAutoBuild': True|False,
'customDomains': [
'string',
],
'framework': 'string',
'activeJobId': 'string',
'totalNumberOfJobs': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
}
}
Response Structure
(dict) --
branch (dict) --
The branch for an Amplify app, which maps to a third-party repository branch.
branchArn (string) --
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branchName (string) --
The name for the branch that is part of an Amplify app.
description (string) --
The description for the branch that is part of an Amplify app.
tags (dict) --
The tag for the branch of an Amplify app.
stage (string) --
The current stage for the branch that is part of an Amplify app.
displayName (string) --
The display name for the branch. This is used as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch that is part of an Amplify app.
createTime (datetime) --
The creation date and time for a branch that is part of an Amplify app.
updateTime (datetime) --
The last updated date and time for a branch that is part of an Amplify app.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (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.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (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 .
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionget_domain_association(**kwargs)¶Returns the domain information for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.get_domain_association(
appId='string',
domainName='string'
)
[REQUIRED]
The unique id for an Amplify app.
[REQUIRED]
The name of the domain.
dict
Response Syntax
{
'domainAssociation': {
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'autoSubDomainCreationPatterns': [
'string',
],
'autoSubDomainIAMRole': 'string',
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
}
}
Response Structure
(dict) --
The result structure for the get domain association request.
domainAssociation (dict) --
Describes the structure of a domain association, which associates a custom domain with an Amplify app.
domainAssociationArn (string) --
The Amazon Resource Name (ARN) for the domain association.
domainName (string) --
The name of the domain.
enableAutoSubDomain (boolean) --
Enables the automated creation of subdomains for branches.
autoSubDomainCreationPatterns (list) --
Sets branch patterns for automatic subdomain creation.
autoSubDomainIAMRole (string) --
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
domainStatus (string) --
The current status of the domain association.
statusReason (string) --
The reason for the current status of the domain association.
certificateVerificationDNSRecord (string) --
The DNS record for certificate verification.
subDomains (list) --
The subdomains for the domain association.
(dict) --
The subdomain for the domain association.
subDomainSetting (dict) --
Describes the settings for the subdomain.
prefix (string) --
The prefix setting for the subdomain.
branchName (string) --
The branch name setting for the subdomain.
verified (boolean) --
The verified status of the subdomain
dnsRecord (string) --
The DNS record for the subdomain.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionget_job(**kwargs)¶Returns a job for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.get_job(
appId='string',
branchName='string',
jobId='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The branch name for the job.
[REQUIRED]
The unique ID for the job.
dict
Response Syntax
{
'job': {
'summary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
},
'steps': [
{
'stepName': 'string',
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'logUrl': 'string',
'artifactsUrl': 'string',
'testArtifactsUrl': 'string',
'testConfigUrl': 'string',
'screenshots': {
'string': 'string'
},
'statusReason': 'string',
'context': 'string'
},
]
}
}
Response Structure
(dict) --
job (dict) --
Describes an execution job for an Amplify app.
summary (dict) --
Describes the summary for an execution job for an Amplify app.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (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.
steps (list) --
The execution steps for an execution job, for an Amplify app.
(dict) --
Describes an execution step, for an execution job, for an Amplify app.
stepName (string) --
The name of the execution step.
startTime (datetime) --
The start date and time of the execution step.
status (string) --
The status of the execution step.
endTime (datetime) --
The end date and time of the execution step.
logUrl (string) --
The URL to the logs for the execution step.
artifactsUrl (string) --
The URL to the artifact for the execution step.
testArtifactsUrl (string) --
The URL to the test artifact for the execution step.
testConfigUrl (string) --
The URL to the test configuration for the execution step.
screenshots (dict) --
The list of screenshot URLs for the execution step, if relevant.
statusReason (string) --
The reason for the current step status.
context (string) --
The context for the current step. Includes a build image if the step is build.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.LimitExceededExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
get_webhook(**kwargs)¶Returns the webhook information that corresponds to a specified webhook ID.
See also: AWS API Documentation
Request Syntax
response = client.get_webhook(
webhookId='string'
)
[REQUIRED]
The unique ID for a webhook.
{
'webhook': {
'webhookArn': 'string',
'webhookId': 'string',
'webhookUrl': 'string',
'branchName': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
The result structure for the get webhook request.
Describes the structure of a webhook.
The Amazon Resource Name (ARN) for the webhook.
The ID of the webhook.
The URL of the webhook.
The name for a branch that is part of an Amplify app.
The description for a webhook.
The create date and time for a webhook.
Updates the date and time for a webhook.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.LimitExceededExceptionlist_apps(**kwargs)¶Returns a list of the existing Amplify apps.
See also: AWS API Documentation
Request Syntax
response = client.list_apps(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'apps': [
{
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBranchAutoDeletion': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'customHeaders': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The result structure for an Amplify app list request.
apps (list) --
A list of Amplify apps.
(dict) --
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
appId (string) --
The unique ID of the Amplify app.
appArn (string) --
The Amazon Resource Name (ARN) of the Amplify app.
name (string) --
The name for the Amplify app.
tags (dict) --
The tag for the Amplify app.
description (string) --
The description for the Amplify app.
repository (string) --
The Git repository for the Amplify app.
platform (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 .
createTime (datetime) --
Creates a date and time for the Amplify app.
updateTime (datetime) --
Updates the date and time for the Amplify app.
iamServiceRoleArn (string) --
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
defaultDomain (string) --
The default domain for the Amplify app.
enableBranchAutoBuild (boolean) --
Enables the auto-building of branches for the Amplify app.
enableBranchAutoDeletion (boolean) --
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
enableBasicAuth (boolean) --
Enables basic authorization for the Amplify app's branches.
basicAuthCredentials (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 .
customRules (list) --
Describes the custom redirect and rewrite rules for the Amplify app.
(dict) --
Describes a custom rewrite or redirect rule.
source (string) --
The source pattern for a URL rewrite or redirect rule.
target (string) --
The target pattern for a URL rewrite or redirect rule.
status (string) --
The status code for a URL rewrite or redirect rule.
200
Represents a 200 rewrite rule.
301
Represents a 301 (moved pemanently) 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.
condition (string) --
The condition for a URL rewrite or redirect rule, such as a country code.
productionBranch (dict) --
Describes the information about a production branch of the Amplify app.
lastDeployTime (datetime) --
The last deploy time of the production branch.
status (string) --
The status of the production branch.
thumbnailUrl (string) --
The thumbnail URL for the production branch.
branchName (string) --
The branch name for the production branch.
buildSpec (string) --
Describes the content of the build specification (build spec) for the Amplify app.
customHeaders (string) --
Describes the custom HTTP headers for the Amplify app.
enableAutoBranchCreation (boolean) --
Enables automated branch creation for the Amplify app.
autoBranchCreationPatterns (list) --
Describes the automated branch creation glob patterns for the Amplify app.
autoBranchCreationConfig (dict) --
Describes the automated branch creation configuration for the Amplify app.
stage (string) --
Describes the current stage for the autocreated branch.
framework (string) --
The framework for the autocreated branch.
enableAutoBuild (boolean) --
Enables auto building for the autocreated branch.
environmentVariables (dict) --
The environment variables for the autocreated branch.
basicAuthCredentials (string) --
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password .
enableBasicAuth (boolean) --
Enables basic authorization for the autocreated branch.
enablePerformanceMode (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.
buildSpec (string) --
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
repositoryCloneMethod (string) --
Note
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.
nextToken (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionlist_artifacts(**kwargs)¶Returns a list of artifacts for a specified app, branch, and job.
See also: AWS API Documentation
Request Syntax
response = client.list_artifacts(
appId='string',
branchName='string',
jobId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name of a branch that is part of an Amplify app.
[REQUIRED]
The unique ID for a job.
dict
Response Syntax
{
'artifacts': [
{
'artifactFileName': 'string',
'artifactId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The result structure for the list artifacts request.
artifacts (list) --
A list of artifacts.
(dict) --
Describes an artifact.
artifactFileName (string) --
The file name for the artifact.
artifactId (string) --
The unique ID for the artifact.
nextToken (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.LimitExceededExceptionlist_backend_environments(**kwargs)¶Lists the backend environments for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.list_backend_environments(
appId='string',
environmentName='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The unique ID for an Amplify app.
dict
Response Syntax
{
'backendEnvironments': [
{
'backendEnvironmentArn': 'string',
'environmentName': 'string',
'stackName': 'string',
'deploymentArtifacts': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The result structure for the list backend environments result.
backendEnvironments (list) --
The list of backend environments for an Amplify app.
(dict) --
Describes the backend environment for an Amplify app.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
environmentName (string) --
The name for a backend environment that is part of an Amplify app.
stackName (string) --
The AWS CloudFormation stack name of a backend environment.
deploymentArtifacts (string) --
The name of deployment artifacts.
createTime (datetime) --
The creation date and time for a backend environment that is part of an Amplify app.
updateTime (datetime) --
The last updated date and time for a backend environment that is part of an Amplify app.
nextToken (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionlist_branches(**kwargs)¶Lists the branches of an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.list_branches(
appId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The unique ID for an Amplify app.
dict
Response Syntax
{
'branches': [
{
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'displayName': 'string',
'enableNotification': True|False,
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'environmentVariables': {
'string': 'string'
},
'enableAutoBuild': True|False,
'customDomains': [
'string',
],
'framework': 'string',
'activeJobId': 'string',
'totalNumberOfJobs': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The result structure for the list branches request.
branches (list) --
A list of branches for an Amplify app.
(dict) --
The branch for an Amplify app, which maps to a third-party repository branch.
branchArn (string) --
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branchName (string) --
The name for the branch that is part of an Amplify app.
description (string) --
The description for the branch that is part of an Amplify app.
tags (dict) --
The tag for the branch of an Amplify app.
stage (string) --
The current stage for the branch that is part of an Amplify app.
displayName (string) --
The display name for the branch. This is used as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch that is part of an Amplify app.
createTime (datetime) --
The creation date and time for a branch that is part of an Amplify app.
updateTime (datetime) --
The last updated date and time for a branch that is part of an Amplify app.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (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.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (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 .
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
nextToken (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionlist_domain_associations(**kwargs)¶Returns the domain associations for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.list_domain_associations(
appId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The unique ID for an Amplify app.
dict
Response Syntax
{
'domainAssociations': [
{
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'autoSubDomainCreationPatterns': [
'string',
],
'autoSubDomainIAMRole': 'string',
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The result structure for the list domain association request.
domainAssociations (list) --
A list of domain associations.
(dict) --
Describes a domain association that associates a custom domain with an Amplify app.
domainAssociationArn (string) --
The Amazon Resource Name (ARN) for the domain association.
domainName (string) --
The name of the domain.
enableAutoSubDomain (boolean) --
Enables the automated creation of subdomains for branches.
autoSubDomainCreationPatterns (list) --
Sets branch patterns for automatic subdomain creation.
autoSubDomainIAMRole (string) --
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
domainStatus (string) --
The current status of the domain association.
statusReason (string) --
The reason for the current status of the domain association.
certificateVerificationDNSRecord (string) --
The DNS record for certificate verification.
subDomains (list) --
The subdomains for the domain association.
(dict) --
The subdomain for the domain association.
subDomainSetting (dict) --
Describes the settings for the subdomain.
prefix (string) --
The prefix setting for the subdomain.
branchName (string) --
The branch name setting for the subdomain.
verified (boolean) --
The verified status of the subdomain
dnsRecord (string) --
The DNS record for the subdomain.
nextToken (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionlist_jobs(**kwargs)¶Lists the jobs for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.list_jobs(
appId='string',
branchName='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for a branch.
dict
Response Syntax
{
'jobSummaries': [
{
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The maximum number of records to list in a single response.
jobSummaries (list) --
The result structure for the list job result request.
(dict) --
Describes the summary for an execution job for an Amplify app.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (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.
nextToken (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.LimitExceededExceptionReturns a list of tags for a specified Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) to use to list tags.
{
'tags': {
'string': 'string'
}
}
Response Structure
The response for the list tags for resource request.
A list of tags for the specified The Amazon Resource Name (ARN).
Exceptions
Amplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.ResourceNotFoundExceptionlist_webhooks(**kwargs)¶Returns a list of webhooks for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.list_webhooks(
appId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The unique ID for an Amplify app.
dict
Response Syntax
{
'webhooks': [
{
'webhookArn': 'string',
'webhookId': 'string',
'webhookUrl': 'string',
'branchName': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The result structure for the list webhooks request.
webhooks (list) --
A list of webhooks.
(dict) --
Describes a webhook that connects repository events to an Amplify app.
webhookArn (string) --
The Amazon Resource Name (ARN) for the webhook.
webhookId (string) --
The ID of the webhook.
webhookUrl (string) --
The URL of the webhook.
branchName (string) --
The name for a branch that is part of an Amplify app.
description (string) --
The description for a webhook.
createTime (datetime) --
The create date and time for a webhook.
updateTime (datetime) --
Updates the date and time for a webhook.
nextToken (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.LimitExceededExceptionstart_deployment(**kwargs)¶Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
See also: AWS API Documentation
Request Syntax
response = client.start_deployment(
appId='string',
branchName='string',
jobId='string',
sourceUrl='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for the branch, for the job.
dict
Response Syntax
{
'jobSummary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
}
}
Response Structure
(dict) --
The result structure for the start a deployment request.
jobSummary (dict) --
The summary for the job.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.LimitExceededExceptionstart_job(**kwargs)¶Starts a new job for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.start_job(
appId='string',
branchName='string',
jobId='string',
jobType='RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK',
jobReason='string',
commitId='string',
commitMessage='string',
commitTime=datetime(2015, 1, 1)
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The branch name for the job.
jobType is RETRY .[REQUIRED]
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.
dict
Response Syntax
{
'jobSummary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
}
}
Response Structure
(dict) --
The result structure for the run job request.
jobSummary (dict) --
The summary for the job.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.LimitExceededExceptionstop_job(**kwargs)¶Stops a job that is in progress for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.stop_job(
appId='string',
branchName='string',
jobId='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for the branch, for the job.
[REQUIRED]
The unique id for the job.
dict
Response Syntax
{
'jobSummary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
}
}
Response Structure
(dict) --
The result structure for the stop job request.
jobSummary (dict) --
The summary for the job.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.LimitExceededExceptiontag_resource(**kwargs)¶Tags the resource with a tag key and value.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) to use to tag a resource.
[REQUIRED]
The tags used to tag the resource.
dict
Response Syntax
{}
Response Structure
(dict) --
The response for the tag resource request.
Exceptions
Amplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Untags a resource with a specified Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) to use to untag a resource.
[REQUIRED]
The tag keys to use to untag a resource.
dict
Response Syntax
{}
Response Structure
(dict) --
The response for the untag resource request.
Exceptions
Amplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.ResourceNotFoundExceptionupdate_app(**kwargs)¶Updates an existing Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.update_app(
appId='string',
name='string',
description='string',
platform='WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
iamServiceRoleArn='string',
environmentVariables={
'string': 'string'
},
enableBranchAutoBuild=True|False,
enableBranchAutoDeletion=True|False,
enableBasicAuth=True|False,
basicAuthCredentials='string',
customRules=[
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
buildSpec='string',
customHeaders='string',
enableAutoBranchCreation=True|False,
autoBranchCreationPatterns=[
'string',
],
autoBranchCreationConfig={
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
},
repository='string',
oauthToken='string',
accessToken='string'
)
[REQUIRED]
The unique ID for an Amplify app.
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 .The environment variables for an Amplify app.
user:password .The custom redirect and rewrite rules for an Amplify app.
Describes a custom rewrite or redirect rule.
The source pattern for a URL rewrite or redirect rule.
The target pattern for a URL rewrite or redirect rule.
The status code for a URL rewrite or redirect rule.
200
Represents a 200 rewrite rule.
301
Represents a 301 (moved pemanently) 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.
The condition for a URL rewrite or redirect rule, such as a country code.
Describes the automated branch creation glob patterns for an Amplify app.
The automated branch creation configuration for an Amplify app.
Describes the current stage for the autocreated branch.
The framework for the autocreated branch.
Enables auto building for the autocreated branch.
The environment variables for the autocreated branch.
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password .
Enables basic authorization for the autocreated branch.
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.
The build specification (build spec) for the autocreated branch.
Enables pull request previews for the autocreated branch.
The Amplify environment name for the pull request.
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 .
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 .
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBranchAutoDeletion': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'customHeaders': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
}
}
Response Structure
(dict) --
The result structure for an Amplify app update request.
app (dict) --
Represents the updated Amplify app.
appId (string) --
The unique ID of the Amplify app.
appArn (string) --
The Amazon Resource Name (ARN) of the Amplify app.
name (string) --
The name for the Amplify app.
tags (dict) --
The tag for the Amplify app.
description (string) --
The description for the Amplify app.
repository (string) --
The Git repository for the Amplify app.
platform (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 .
createTime (datetime) --
Creates a date and time for the Amplify app.
updateTime (datetime) --
Updates the date and time for the Amplify app.
iamServiceRoleArn (string) --
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
defaultDomain (string) --
The default domain for the Amplify app.
enableBranchAutoBuild (boolean) --
Enables the auto-building of branches for the Amplify app.
enableBranchAutoDeletion (boolean) --
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
enableBasicAuth (boolean) --
Enables basic authorization for the Amplify app's branches.
basicAuthCredentials (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 .
customRules (list) --
Describes the custom redirect and rewrite rules for the Amplify app.
(dict) --
Describes a custom rewrite or redirect rule.
source (string) --
The source pattern for a URL rewrite or redirect rule.
target (string) --
The target pattern for a URL rewrite or redirect rule.
status (string) --
The status code for a URL rewrite or redirect rule.
200
Represents a 200 rewrite rule.
301
Represents a 301 (moved pemanently) 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.
condition (string) --
The condition for a URL rewrite or redirect rule, such as a country code.
productionBranch (dict) --
Describes the information about a production branch of the Amplify app.
lastDeployTime (datetime) --
The last deploy time of the production branch.
status (string) --
The status of the production branch.
thumbnailUrl (string) --
The thumbnail URL for the production branch.
branchName (string) --
The branch name for the production branch.
buildSpec (string) --
Describes the content of the build specification (build spec) for the Amplify app.
customHeaders (string) --
Describes the custom HTTP headers for the Amplify app.
enableAutoBranchCreation (boolean) --
Enables automated branch creation for the Amplify app.
autoBranchCreationPatterns (list) --
Describes the automated branch creation glob patterns for the Amplify app.
autoBranchCreationConfig (dict) --
Describes the automated branch creation configuration for the Amplify app.
stage (string) --
Describes the current stage for the autocreated branch.
framework (string) --
The framework for the autocreated branch.
enableAutoBuild (boolean) --
Enables auto building for the autocreated branch.
environmentVariables (dict) --
The environment variables for the autocreated branch.
basicAuthCredentials (string) --
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password .
enableBasicAuth (boolean) --
Enables basic authorization for the autocreated branch.
enablePerformanceMode (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.
buildSpec (string) --
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
repositoryCloneMethod (string) --
Note
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.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.InternalFailureExceptionupdate_branch(**kwargs)¶Updates a branch for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.update_branch(
appId='string',
branchName='string',
description='string',
framework='string',
stage='PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
enableNotification=True|False,
enableAutoBuild=True|False,
environmentVariables={
'string': 'string'
},
basicAuthCredentials='string',
enableBasicAuth=True|False,
enablePerformanceMode=True|False,
buildSpec='string',
ttl='string',
displayName='string',
enablePullRequestPreview=True|False,
pullRequestEnvironmentName='string',
backendEnvironmentArn='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for the branch.
The environment variables for the branch.
user:password .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.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'displayName': 'string',
'enableNotification': True|False,
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'environmentVariables': {
'string': 'string'
},
'enableAutoBuild': True|False,
'customDomains': [
'string',
],
'framework': 'string',
'activeJobId': 'string',
'totalNumberOfJobs': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
}
}
Response Structure
(dict) --
The result structure for the update branch request.
branch (dict) --
The branch for an Amplify app, which maps to a third-party repository branch.
branchArn (string) --
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branchName (string) --
The name for the branch that is part of an Amplify app.
description (string) --
The description for the branch that is part of an Amplify app.
tags (dict) --
The tag for the branch of an Amplify app.
stage (string) --
The current stage for the branch that is part of an Amplify app.
displayName (string) --
The display name for the branch. This is used as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch that is part of an Amplify app.
createTime (datetime) --
The creation date and time for a branch that is part of an Amplify app.
updateTime (datetime) --
The last updated date and time for a branch that is part of an Amplify app.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (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.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (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 .
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.DependentServiceFailureExceptionupdate_domain_association(**kwargs)¶Creates a new domain association for an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.update_domain_association(
appId='string',
domainName='string',
enableAutoSubDomain=True|False,
subDomainSettings=[
{
'prefix': 'string',
'branchName': 'string'
},
],
autoSubDomainCreationPatterns=[
'string',
],
autoSubDomainIAMRole='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name of the domain.
Describes the settings for the subdomain.
Describes the settings for the subdomain.
The prefix setting for the subdomain.
The branch name setting for the subdomain.
Sets the branch patterns for automatic subdomain creation.
dict
Response Syntax
{
'domainAssociation': {
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'autoSubDomainCreationPatterns': [
'string',
],
'autoSubDomainIAMRole': 'string',
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
}
}
Response Structure
(dict) --
The result structure for the update domain association request.
domainAssociation (dict) --
Describes a domain association, which associates a custom domain with an Amplify app.
domainAssociationArn (string) --
The Amazon Resource Name (ARN) for the domain association.
domainName (string) --
The name of the domain.
enableAutoSubDomain (boolean) --
Enables the automated creation of subdomains for branches.
autoSubDomainCreationPatterns (list) --
Sets branch patterns for automatic subdomain creation.
autoSubDomainIAMRole (string) --
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
domainStatus (string) --
The current status of the domain association.
statusReason (string) --
The reason for the current status of the domain association.
certificateVerificationDNSRecord (string) --
The DNS record for certificate verification.
subDomains (list) --
The subdomains for the domain association.
(dict) --
The subdomain for the domain association.
subDomainSetting (dict) --
Describes the settings for the subdomain.
prefix (string) --
The prefix setting for the subdomain.
branchName (string) --
The branch name setting for the subdomain.
verified (boolean) --
The verified status of the subdomain
dnsRecord (string) --
The DNS record for the subdomain.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.DependentServiceFailureExceptionupdate_webhook(**kwargs)¶Updates a webhook.
See also: AWS API Documentation
Request Syntax
response = client.update_webhook(
webhookId='string',
branchName='string',
description='string'
)
[REQUIRED]
The unique ID for a webhook.
dict
Response Syntax
{
'webhook': {
'webhookArn': 'string',
'webhookId': 'string',
'webhookUrl': 'string',
'branchName': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
The result structure for the update webhook request.
webhook (dict) --
Describes a webhook that connects repository events to an Amplify app.
webhookArn (string) --
The Amazon Resource Name (ARN) for the webhook.
webhookId (string) --
The ID of the webhook.
webhookUrl (string) --
The URL of the webhook.
branchName (string) --
The name for a branch that is part of an Amplify app.
description (string) --
The description for a webhook.
createTime (datetime) --
The create date and time for a webhook.
updateTime (datetime) --
Updates the date and time for a webhook.
Exceptions
Amplify.Client.exceptions.BadRequestExceptionAmplify.Client.exceptions.UnauthorizedExceptionAmplify.Client.exceptions.NotFoundExceptionAmplify.Client.exceptions.InternalFailureExceptionAmplify.Client.exceptions.DependentServiceFailureExceptionThe available paginators are:
Amplify.Paginator.ListAppsAmplify.Paginator.ListBranchesAmplify.Paginator.ListDomainAssociationsAmplify.Paginator.ListJobsAmplify.Paginator.ListApps¶paginator = client.get_paginator('list_apps')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Amplify.Client.list_apps().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'apps': [
{
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBranchAutoDeletion': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'customHeaders': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
},
],
'NextToken': 'string'
}
Response Structure
The result structure for an Amplify app list request.
A list of Amplify apps.
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
The unique ID of the Amplify app.
The Amazon Resource Name (ARN) of the Amplify app.
The name for the Amplify app.
The tag for the Amplify app.
The description for the Amplify app.
The Git repository for the Amplify app.
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 .
Creates a date and time for the Amplify app.
Updates the date and time for the Amplify app.
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
The environment variables for the Amplify app.
The default domain for the Amplify app.
Enables the auto-building of branches for the Amplify app.
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
Enables basic authorization for the Amplify app's branches.
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 .
Describes the custom redirect and rewrite rules for the Amplify app.
Describes a custom rewrite or redirect rule.
The source pattern for a URL rewrite or redirect rule.
The target pattern for a URL rewrite or redirect rule.
The status code for a URL rewrite or redirect rule.
200
Represents a 200 rewrite rule.
301
Represents a 301 (moved pemanently) 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.
The condition for a URL rewrite or redirect rule, such as a country code.
Describes the information about a production branch of the Amplify app.
The last deploy time of the production branch.
The status of the production branch.
The thumbnail URL for the production branch.
The branch name for the production branch.
Describes the content of the build specification (build spec) for the Amplify app.
Describes the custom HTTP headers for the Amplify app.
Enables automated branch creation for the Amplify app.
Describes the automated branch creation glob patterns for the Amplify app.
Describes the automated branch creation configuration for the Amplify app.
Describes the current stage for the autocreated branch.
The framework for the autocreated branch.
Enables auto building for the autocreated branch.
The environment variables for the autocreated branch.
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password .
Enables basic authorization for the autocreated branch.
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.
The build specification (build spec) for the autocreated branch.
Enables pull request previews for the autocreated branch.
The Amplify environment name for the pull request.
Note
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.
A token to resume pagination.
Amplify.Paginator.ListBranches¶paginator = client.get_paginator('list_branches')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Amplify.Client.list_branches().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
appId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The unique ID for an Amplify app.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'branches': [
{
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'displayName': 'string',
'enableNotification': True|False,
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'environmentVariables': {
'string': 'string'
},
'enableAutoBuild': True|False,
'customDomains': [
'string',
],
'framework': 'string',
'activeJobId': 'string',
'totalNumberOfJobs': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The result structure for the list branches request.
branches (list) --
A list of branches for an Amplify app.
(dict) --
The branch for an Amplify app, which maps to a third-party repository branch.
branchArn (string) --
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branchName (string) --
The name for the branch that is part of an Amplify app.
description (string) --
The description for the branch that is part of an Amplify app.
tags (dict) --
The tag for the branch of an Amplify app.
stage (string) --
The current stage for the branch that is part of an Amplify app.
displayName (string) --
The display name for the branch. This is used as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch that is part of an Amplify app.
createTime (datetime) --
The creation date and time for a branch that is part of an Amplify app.
updateTime (datetime) --
The last updated date and time for a branch that is part of an Amplify app.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (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.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (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 .
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
NextToken (string) --
A token to resume pagination.
Amplify.Paginator.ListDomainAssociations¶paginator = client.get_paginator('list_domain_associations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Amplify.Client.list_domain_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
appId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The unique ID for an Amplify app.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'domainAssociations': [
{
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'autoSubDomainCreationPatterns': [
'string',
],
'autoSubDomainIAMRole': 'string',
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The result structure for the list domain association request.
domainAssociations (list) --
A list of domain associations.
(dict) --
Describes a domain association that associates a custom domain with an Amplify app.
domainAssociationArn (string) --
The Amazon Resource Name (ARN) for the domain association.
domainName (string) --
The name of the domain.
enableAutoSubDomain (boolean) --
Enables the automated creation of subdomains for branches.
autoSubDomainCreationPatterns (list) --
Sets branch patterns for automatic subdomain creation.
autoSubDomainIAMRole (string) --
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
domainStatus (string) --
The current status of the domain association.
statusReason (string) --
The reason for the current status of the domain association.
certificateVerificationDNSRecord (string) --
The DNS record for certificate verification.
subDomains (list) --
The subdomains for the domain association.
(dict) --
The subdomain for the domain association.
subDomainSetting (dict) --
Describes the settings for the subdomain.
prefix (string) --
The prefix setting for the subdomain.
branchName (string) --
The branch name setting for the subdomain.
verified (boolean) --
The verified status of the subdomain
dnsRecord (string) --
The DNS record for the subdomain.
NextToken (string) --
A token to resume pagination.
Amplify.Paginator.ListJobs¶paginator = client.get_paginator('list_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Amplify.Client.list_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
appId='string',
branchName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for a branch.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'jobSummaries': [
{
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The maximum number of records to list in a single response.
jobSummaries (list) --
The result structure for the list job result request.
(dict) --
Describes the summary for an execution job for an Amplify app.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (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.
NextToken (string) --
A token to resume pagination.