Amplify enables developers to develop and deploy cloud-powered mobile and web apps. Amplify Hosting provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Hosting 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.
", "operations": { "CreateApp": "Creates a new Amplify app.
", "CreateBackendEnvironment": "Creates a new backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
", "CreateBranch": "Creates a new branch for an Amplify app.
", "CreateDeployment": "Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a Git repository.
The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
", "CreateWebhook": "Creates a new webhook on an Amplify app.
", "DeleteApp": "Deletes an existing Amplify app specified by an app ID.
", "DeleteBackendEnvironment": "Deletes a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
", "DeleteBranch": "Deletes a branch for an Amplify app.
", "DeleteDomainAssociation": "Deletes a domain association for an Amplify app.
", "DeleteJob": "Deletes a job for a branch of an Amplify app.
", "DeleteWebhook": "Deletes a webhook.
", "GenerateAccessLogs": "Returns the website access logs for a specific time range using a presigned URL.
", "GetApp": "Returns an existing Amplify app specified by an app ID.
", "GetArtifactUrl": "Returns the artifact info that corresponds to an artifact id.
", "GetBackendEnvironment": "Returns a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
", "GetBranch": "Returns a branch for an Amplify app.
", "GetDomainAssociation": "Returns the domain information for an Amplify app.
", "GetJob": "Returns a job for a branch of an Amplify app.
", "GetWebhook": "Returns the webhook information that corresponds to a specified webhook ID.
", "ListApps": "Returns a list of the existing Amplify apps.
", "ListArtifacts": "Returns a list of end-to-end testing artifacts for a specified app, branch, and job.
To return the build artifacts, use the GetJob API.
For more information about Amplify testing support, see Setting up end-to-end Cypress tests for your Amplify application in the Amplify Hosting User Guide.
", "ListBackendEnvironments": "Lists the backend environments for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
", "ListBranches": "Lists the branches of an Amplify app.
", "ListDomainAssociations": "Returns the domain associations for an Amplify app.
", "ListJobs": "Lists the jobs for a branch of an Amplify app.
", "ListTagsForResource": "Returns a list of tags for a specified Amazon Resource Name (ARN).
", "ListWebhooks": "Returns a list of webhooks for an Amplify app.
", "StartDeployment": "Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository.
The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.
Starts a new job for a branch of an Amplify app.
", "StopJob": "Stops a job that is in progress for a branch of an Amplify app.
", "TagResource": "Tags the resource with a tag key and value.
", "UntagResource": "Untags a resource with a specified Amazon Resource Name (ARN).
", "UpdateApp": "Updates an existing Amplify app.
", "UpdateBranch": "Updates a branch for an Amplify app.
", "UpdateDomainAssociation": "Creates a new domain association for an Amplify app.
", "UpdateWebhook": "Updates a webhook.
" }, "shapes": { "AccessToken": { "base": null, "refs": { "CreateAppRequest$accessToken": "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 .
", "UpdateAppRequest$accessToken": "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 .
" } }, "ActiveJobId": { "base": null, "refs": { "Branch$activeJobId": "The ID of the active job for a branch of an Amplify app.
" } }, "App": { "base": "Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
", "refs": { "Apps$member": null, "CreateAppResult$app": null, "DeleteAppResult$app": null, "GetAppResult$app": null, "UpdateAppResult$app": "Represents the updated Amplify app.
" } }, "AppArn": { "base": null, "refs": { "App$appArn": "The Amazon Resource Name (ARN) of the Amplify app.
" } }, "AppId": { "base": null, "refs": { "App$appId": "The unique ID of the Amplify app.
", "CreateBackendEnvironmentRequest$appId": "The unique ID for an Amplify app.
", "CreateBranchRequest$appId": "The unique ID for an Amplify app.
", "CreateDeploymentRequest$appId": "The unique ID for an Amplify app.
", "CreateDomainAssociationRequest$appId": "The unique ID for an Amplify app.
", "CreateWebhookRequest$appId": "The unique ID for an Amplify app.
", "DeleteAppRequest$appId": "The unique ID for an Amplify app.
", "DeleteBackendEnvironmentRequest$appId": "The unique ID of an Amplify app.
", "DeleteBranchRequest$appId": "The unique ID for an Amplify app.
", "DeleteDomainAssociationRequest$appId": "The unique id for an Amplify app.
", "DeleteJobRequest$appId": "The unique ID for an Amplify app.
", "GenerateAccessLogsRequest$appId": "The unique ID for an Amplify app.
", "GetAppRequest$appId": "The unique ID for an Amplify app.
", "GetBackendEnvironmentRequest$appId": "The unique id for an Amplify app.
", "GetBranchRequest$appId": "The unique ID for an Amplify app.
", "GetDomainAssociationRequest$appId": "The unique id for an Amplify app.
", "GetJobRequest$appId": "The unique ID for an Amplify app.
", "ListArtifactsRequest$appId": "The unique ID for an Amplify app.
", "ListBackendEnvironmentsRequest$appId": "The unique ID for an Amplify app.
", "ListBranchesRequest$appId": "The unique ID for an Amplify app.
", "ListDomainAssociationsRequest$appId": "The unique ID for an Amplify app.
", "ListJobsRequest$appId": "The unique ID for an Amplify app.
", "ListWebhooksRequest$appId": "The unique ID for an Amplify app.
", "StartDeploymentRequest$appId": "The unique ID for an Amplify app.
", "StartJobRequest$appId": "The unique ID for an Amplify app.
", "StopJobRequest$appId": "The unique ID for an Amplify app.
", "UpdateAppRequest$appId": "The unique ID for an Amplify app.
", "UpdateBranchRequest$appId": "The unique ID for an Amplify app.
", "UpdateDomainAssociationRequest$appId": "The unique ID for an Amplify app.
", "Webhook$appId": "The unique ID of an Amplify app.
" } }, "Apps": { "base": null, "refs": { "ListAppsResult$apps": "A list of Amplify apps.
" } }, "Artifact": { "base": "Describes an artifact.
", "refs": { "Artifacts$member": null } }, "ArtifactFileName": { "base": null, "refs": { "Artifact$artifactFileName": "The file name for the artifact.
" } }, "ArtifactId": { "base": null, "refs": { "Artifact$artifactId": "The unique ID for the artifact.
", "GetArtifactUrlRequest$artifactId": "The unique ID for an artifact.
", "GetArtifactUrlResult$artifactId": "The unique ID for an artifact.
" } }, "ArtifactUrl": { "base": null, "refs": { "GetArtifactUrlResult$artifactUrl": "The presigned URL for the artifact.
" } }, "Artifacts": { "base": null, "refs": { "ListArtifactsResult$artifacts": "A list of artifacts.
" } }, "ArtifactsUrl": { "base": null, "refs": { "Step$artifactsUrl": "The URL to the build artifact for the execution step.
" } }, "AssociatedResource": { "base": null, "refs": { "AssociatedResources$member": null } }, "AssociatedResources": { "base": null, "refs": { "Branch$associatedResources": "A list of custom resources that are linked to this branch.
" } }, "AutoBranchCreationConfig": { "base": "Describes the automated branch creation configuration.
", "refs": { "App$autoBranchCreationConfig": "Describes the automated branch creation configuration for the Amplify app.
", "CreateAppRequest$autoBranchCreationConfig": "The automated branch creation configuration for an Amplify app.
", "UpdateAppRequest$autoBranchCreationConfig": "The automated branch creation configuration for an Amplify app.
" } }, "AutoBranchCreationPattern": { "base": null, "refs": { "AutoBranchCreationPatterns$member": null } }, "AutoBranchCreationPatterns": { "base": null, "refs": { "App$autoBranchCreationPatterns": "Describes the automated branch creation glob patterns for the Amplify app.
", "CreateAppRequest$autoBranchCreationPatterns": "The automated branch creation glob patterns for an Amplify app.
", "UpdateAppRequest$autoBranchCreationPatterns": "Describes the automated branch creation glob patterns for an Amplify app.
" } }, "AutoSubDomainCreationPattern": { "base": null, "refs": { "AutoSubDomainCreationPatterns$member": null } }, "AutoSubDomainCreationPatterns": { "base": null, "refs": { "CreateDomainAssociationRequest$autoSubDomainCreationPatterns": "Sets the branch patterns for automatic subdomain creation.
", "DomainAssociation$autoSubDomainCreationPatterns": "Sets branch patterns for automatic subdomain creation.
", "UpdateDomainAssociationRequest$autoSubDomainCreationPatterns": "Sets the branch patterns for automatic subdomain creation.
" } }, "AutoSubDomainIAMRole": { "base": null, "refs": { "CreateDomainAssociationRequest$autoSubDomainIAMRole": "The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
", "DomainAssociation$autoSubDomainIAMRole": "The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
", "UpdateDomainAssociationRequest$autoSubDomainIAMRole": "The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
" } }, "Backend": { "base": "Describes the backend associated with an Amplify Branch.
This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
", "refs": { "Branch$backend": null, "CreateBranchRequest$backend": "The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
", "UpdateBranchRequest$backend": "The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
" } }, "BackendEnvironment": { "base": "Describes the backend environment associated with a Branch of a Gen 1 Amplify app. Amplify Gen 1 applications are created using Amplify Studio or the Amplify command line interface (CLI).
Describes the backend environment for an Amplify app.
", "DeleteBackendEnvironmentResult$backendEnvironment": "Describes the backend environment for an Amplify app.
", "GetBackendEnvironmentResult$backendEnvironment": "Describes the backend environment for an Amplify app.
" } }, "BackendEnvironmentArn": { "base": null, "refs": { "BackendEnvironment$backendEnvironmentArn": "The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
", "Branch$backendEnvironmentArn": "The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
", "CreateBranchRequest$backendEnvironmentArn": "The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
", "UpdateBranchRequest$backendEnvironmentArn": "The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
" } }, "BackendEnvironments": { "base": null, "refs": { "ListBackendEnvironmentsResult$backendEnvironments": "The list of backend environments for an Amplify app.
" } }, "BadRequestException": { "base": "A request contains unexpected data.
", "refs": {} }, "BasicAuthCredentials": { "base": null, "refs": { "App$basicAuthCredentials": "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.
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password.
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.
The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
The branch for an Amplify app, which maps to a third-party repository branch.
", "refs": { "Branches$member": null, "CreateBranchResult$branch": "Describes the branch for an Amplify app, which maps to a third-party repository branch.
", "DeleteBranchResult$branch": "The branch for an Amplify app, which maps to a third-party repository branch.
", "GetBranchResult$branch": null, "UpdateBranchResult$branch": "The branch for an Amplify app, which maps to a third-party repository branch.
" } }, "BranchArn": { "base": null, "refs": { "Branch$branchArn": "The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
" } }, "BranchName": { "base": null, "refs": { "Branch$branchName": "The name for the branch that is part of an Amplify app.
", "Branch$destinationBranch": "The destination branch if the branch is a pull request branch.
", "Branch$sourceBranch": "The source branch if the branch is a pull request branch.
", "CreateBranchRequest$branchName": "The name for the branch.
", "CreateDeploymentRequest$branchName": "The name of the branch to use for the job.
", "CreateWebhookRequest$branchName": "The name for a branch that is part of an Amplify app.
", "DeleteBranchRequest$branchName": "The name of the branch.
", "DeleteJobRequest$branchName": "The name of the branch to use for the job.
", "GetBranchRequest$branchName": "The name of the branch.
", "GetJobRequest$branchName": "The name of the branch to use for the job.
", "ListArtifactsRequest$branchName": "The name of a branch that is part of an Amplify app.
", "ListJobsRequest$branchName": "The name of the branch to use for the request.
", "ProductionBranch$branchName": "The branch name for the production branch.
", "StartDeploymentRequest$branchName": "The name of the branch to use for the deployment job.
", "StartJobRequest$branchName": "The name of the branch to use for the job.
", "StopJobRequest$branchName": "The name of the branch to use for the stop job request.
", "SubDomainSetting$branchName": "The branch name setting for the subdomain.
", "UpdateBranchRequest$branchName": "The name of the branch.
", "UpdateWebhookRequest$branchName": "The name for a branch that is part of an Amplify app.
", "Webhook$branchName": "The name for a branch that is part of an Amplify app.
" } }, "Branches": { "base": null, "refs": { "ListBranchesResult$branches": "A list of branches for an Amplify app.
" } }, "BuildComputeType": { "base": null, "refs": { "JobConfig$buildComputeType": "Specifies the size of the build instance. Amplify supports three instance sizes: STANDARD_8GB, LARGE_16GB, and XLARGE_72GB. If you don't specify a value, Amplify uses the STANDARD_8GB default.
The following list describes the CPU, memory, and storage capacity for each build instance type:
vCPUs: 4
Memory: 8 GiB
Disk space: 128 GB
vCPUs: 8
Memory: 16 GiB
Disk space: 128 GB
vCPUs: 36
Memory: 72 GiB
Disk space: 256 GB
The build specification (build spec) file for an Amplify app build.
", "refs": { "App$buildSpec": "Describes the content of the build specification (build spec) for the Amplify app.
", "AutoBranchCreationConfig$buildSpec": "The build specification (build spec) for the autocreated branch.
", "Branch$buildSpec": "The build specification (build spec) content for the branch of an Amplify app.
", "CreateAppRequest$buildSpec": "The build specification (build spec) for an Amplify app.
", "CreateBranchRequest$buildSpec": "The build specification (build spec) for the branch.
", "UpdateAppRequest$buildSpec": "The build specification (build spec) for an Amplify app.
", "UpdateBranchRequest$buildSpec": "The build specification (build spec) for the branch.
" } }, "CacheConfig": { "base": "Describes the cache configuration for an Amplify app.
For more information about how Amplify applies an optimal cache configuration for your app based on the type of content that is being served, see Managing cache configuration in the Amplify User guide.
", "refs": { "App$cacheConfig": "The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.
The cache configuration for the Amplify app.
", "UpdateAppRequest$cacheConfig": "The cache configuration for the Amplify app.
" } }, "CacheConfigType": { "base": null, "refs": { "CacheConfig$type": "The type of cache configuration to use for an Amplify app.
The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules.
The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key. This is the default setting.
Describes the current SSL/TLS certificate that is in use for the domain. If you are using CreateDomainAssociation to create a new domain association, Certificate describes the new certificate that you are creating.
Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.
If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.
The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.
This field is required only when the certificate type is CUSTOM.
The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.
This field is required only when the certificate type is CUSTOM.
The type of SSL/TLS certificate to use for your custom domain. If a certificate type isn't specified, Amplify uses the default AMPLIFY_MANAGED certificate.
The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.
", "UpdateDomainAssociationRequest$certificateSettings": "The type of SSL/TLS certificate to use for your custom domain.
" } }, "CertificateType": { "base": null, "refs": { "Certificate$type": "The type of SSL/TLS certificate that you want to use.
Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.
Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide.
The certificate type.
Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.
Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide.
The DNS record for certificate verification.
", "DomainAssociation$certificateVerificationDNSRecord": "The DNS record for certificate verification.
" } }, "Code": { "base": null, "refs": { "ResourceNotFoundException$code": null } }, "CommitId": { "base": null, "refs": { "JobSummary$commitId": "The commit ID from a third-party repository provider for the job.
", "StartJobRequest$commitId": "The commit ID from a third-party repository provider for the job.
" } }, "CommitMessage": { "base": null, "refs": { "JobSummary$commitMessage": "The commit message from a third-party repository provider for the job.
", "StartJobRequest$commitMessage": "The commit message from a third-party repository provider for the job.
" } }, "CommitTime": { "base": null, "refs": { "JobSummary$commitTime": "The commit date and time for the job.
", "StartJobRequest$commitTime": "The commit date and time for the job.
" } }, "ComputeRoleArn": { "base": null, "refs": { "App$computeRoleArn": "The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
", "Branch$computeRoleArn": "The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
", "CreateAppRequest$computeRoleArn": "The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
", "CreateBranchRequest$computeRoleArn": "The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
", "UpdateAppRequest$computeRoleArn": "The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
", "UpdateBranchRequest$computeRoleArn": "The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
" } }, "Condition": { "base": null, "refs": { "CustomRule$condition": "The condition for a URL rewrite or redirect rule, such as a country code.
" } }, "Context": { "base": null, "refs": { "Step$context": "The context for the current step. Includes a build image if the step is build.
" } }, "CreateAppRequest": { "base": "The request structure used to create apps in Amplify.
", "refs": {} }, "CreateAppResult": { "base": null, "refs": {} }, "CreateBackendEnvironmentRequest": { "base": "The request structure for the backend environment create request.
", "refs": {} }, "CreateBackendEnvironmentResult": { "base": "The result structure for the create backend environment request.
", "refs": {} }, "CreateBranchRequest": { "base": "The request structure for the create branch request.
", "refs": {} }, "CreateBranchResult": { "base": "The result structure for create branch request.
", "refs": {} }, "CreateDeploymentRequest": { "base": "The request structure for the create a new deployment request.
", "refs": {} }, "CreateDeploymentResult": { "base": "The result structure for the create a new deployment request.
", "refs": {} }, "CreateDomainAssociationRequest": { "base": "The request structure for the create domain association request.
", "refs": {} }, "CreateDomainAssociationResult": { "base": "The result structure for the create domain association request.
", "refs": {} }, "CreateTime": { "base": null, "refs": { "App$createTime": "A timestamp of when Amplify created the application.
", "BackendEnvironment$createTime": "The creation date and time for a backend environment that is part of an Amplify app.
", "Branch$createTime": "A timestamp of when Amplify created the branch.
", "Webhook$createTime": "A timestamp of when Amplify created the webhook in your Git repository.
" } }, "CreateWebhookRequest": { "base": "The request structure for the create webhook request.
", "refs": {} }, "CreateWebhookResult": { "base": "The result structure for the create webhook request.
", "refs": {} }, "CustomDomain": { "base": null, "refs": { "CustomDomains$member": null } }, "CustomDomains": { "base": null, "refs": { "Branch$customDomains": "The custom domains for a branch of an Amplify app.
" } }, "CustomHeaders": { "base": null, "refs": { "App$customHeaders": "Describes the custom HTTP headers for the Amplify app.
", "CreateAppRequest$customHeaders": "The custom HTTP headers for an Amplify app.
", "UpdateAppRequest$customHeaders": "The custom HTTP headers for an Amplify app.
" } }, "CustomRule": { "base": "Describes a custom rewrite or redirect rule.
", "refs": { "CustomRules$member": null } }, "CustomRules": { "base": null, "refs": { "App$customRules": "Describes the custom redirect and rewrite rules for the Amplify app.
", "CreateAppRequest$customRules": "The custom rewrite and redirect rules for an Amplify app.
", "UpdateAppRequest$customRules": "The custom redirect and rewrite rules for an Amplify app.
" } }, "DNSRecord": { "base": null, "refs": { "SubDomain$dnsRecord": "The DNS record for the subdomain.
" } }, "DefaultDomain": { "base": null, "refs": { "App$defaultDomain": "The default domain for the Amplify app.
" } }, "DeleteAppRequest": { "base": "Describes the request structure for the delete app request.
", "refs": {} }, "DeleteAppResult": { "base": "The result structure for the delete app request.
", "refs": {} }, "DeleteBackendEnvironmentRequest": { "base": "The request structure for the delete backend environment request.
", "refs": {} }, "DeleteBackendEnvironmentResult": { "base": "The result structure of the delete backend environment result.
", "refs": {} }, "DeleteBranchRequest": { "base": "The request structure for the delete branch request.
", "refs": {} }, "DeleteBranchResult": { "base": "The result structure for the delete branch request.
", "refs": {} }, "DeleteDomainAssociationRequest": { "base": "The request structure for the delete domain association request.
", "refs": {} }, "DeleteDomainAssociationResult": { "base": null, "refs": {} }, "DeleteJobRequest": { "base": "The request structure for the delete job request.
", "refs": {} }, "DeleteJobResult": { "base": "The result structure for the delete job request.
", "refs": {} }, "DeleteWebhookRequest": { "base": "The request structure for the delete webhook request.
", "refs": {} }, "DeleteWebhookResult": { "base": "The result structure for the delete webhook request.
", "refs": {} }, "DependentServiceFailureException": { "base": "An operation failed because a dependent service threw an exception.
", "refs": {} }, "DeploymentArtifacts": { "base": null, "refs": { "BackendEnvironment$deploymentArtifacts": "The name of deployment artifacts.
", "CreateBackendEnvironmentRequest$deploymentArtifacts": "The name of deployment artifacts.
" } }, "Description": { "base": null, "refs": { "App$description": "The description for the Amplify app.
", "Branch$description": "The description for the branch that is part of an Amplify app.
", "CreateAppRequest$description": "The description of the Amplify app.
", "CreateBranchRequest$description": "The description for the branch.
", "CreateWebhookRequest$description": "The description for a webhook.
", "UpdateAppRequest$description": "The description for an Amplify app.
", "UpdateBranchRequest$description": "The description for the branch.
", "UpdateWebhookRequest$description": "The description for a webhook.
", "Webhook$description": "The description for a webhook.
" } }, "DisplayName": { "base": null, "refs": { "Branch$displayName": "The display name for the branch. This is used as the default domain prefix.
", "CreateBranchRequest$displayName": "The display name for a branch. This is used as the default domain prefix.
", "UpdateBranchRequest$displayName": "The display name for a branch. This is used as the default domain prefix.
" } }, "DomainAssociation": { "base": "Describes the association between a custom domain and an Amplify app.
", "refs": { "CreateDomainAssociationResult$domainAssociation": "Describes the structure of a domain association, which associates a custom domain with an Amplify app.
", "DeleteDomainAssociationResult$domainAssociation": null, "DomainAssociations$member": null, "GetDomainAssociationResult$domainAssociation": "Describes the structure of a domain association, which associates a custom domain with an Amplify app.
", "UpdateDomainAssociationResult$domainAssociation": "Describes a domain association, which associates a custom domain with an Amplify app.
" } }, "DomainAssociationArn": { "base": null, "refs": { "DomainAssociation$domainAssociationArn": "The Amazon Resource Name (ARN) for the domain association.
" } }, "DomainAssociations": { "base": null, "refs": { "ListDomainAssociationsResult$domainAssociations": "A list of domain associations.
" } }, "DomainName": { "base": null, "refs": { "CreateDomainAssociationRequest$domainName": "The domain name for the domain association.
", "DeleteDomainAssociationRequest$domainName": "The name of the domain.
", "DomainAssociation$domainName": "The name of the domain.
", "GenerateAccessLogsRequest$domainName": "The name of the domain.
", "GetDomainAssociationRequest$domainName": "The name of the domain.
", "UpdateDomainAssociationRequest$domainName": "The name of the domain.
" } }, "DomainPrefix": { "base": null, "refs": { "SubDomainSetting$prefix": "The prefix setting for the subdomain.
" } }, "DomainStatus": { "base": null, "refs": { "DomainAssociation$domainStatus": "The current status of the domain association.
" } }, "EnableAutoBranchCreation": { "base": null, "refs": { "App$enableAutoBranchCreation": "Enables automated branch creation for the Amplify app.
", "CreateAppRequest$enableAutoBranchCreation": "Enables automated branch creation for an Amplify app.
", "UpdateAppRequest$enableAutoBranchCreation": "Enables automated branch creation for an Amplify app.
" } }, "EnableAutoBuild": { "base": null, "refs": { "AutoBranchCreationConfig$enableAutoBuild": "Enables auto building for the autocreated branch.
", "Branch$enableAutoBuild": "Enables auto-building on push for a branch of an Amplify app.
", "CreateBranchRequest$enableAutoBuild": "Enables auto building for the branch.
", "UpdateAppRequest$enableBranchAutoBuild": "Enables branch auto-building for an Amplify app.
", "UpdateBranchRequest$enableAutoBuild": "Enables auto building for the branch.
" } }, "EnableAutoSubDomain": { "base": null, "refs": { "CreateDomainAssociationRequest$enableAutoSubDomain": "Enables the automated creation of subdomains for branches.
", "DomainAssociation$enableAutoSubDomain": "Enables the automated creation of subdomains for branches.
", "UpdateDomainAssociationRequest$enableAutoSubDomain": "Enables the automated creation of subdomains for branches.
" } }, "EnableBasicAuth": { "base": null, "refs": { "App$enableBasicAuth": "Enables basic authorization for the Amplify app's branches.
", "AutoBranchCreationConfig$enableBasicAuth": "Enables basic authorization for the autocreated branch.
", "Branch$enableBasicAuth": "Enables basic authorization for a branch of an Amplify app.
", "CreateAppRequest$enableBasicAuth": "Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
", "CreateBranchRequest$enableBasicAuth": "Enables basic authorization for the branch.
", "UpdateAppRequest$enableBasicAuth": "Enables basic authorization for an Amplify app.
", "UpdateBranchRequest$enableBasicAuth": "Enables basic authorization for the branch.
" } }, "EnableBranchAutoBuild": { "base": null, "refs": { "App$enableBranchAutoBuild": "Enables the auto-building of branches for the Amplify app.
", "CreateAppRequest$enableBranchAutoBuild": "Enables the auto building of branches for an Amplify app.
" } }, "EnableBranchAutoDeletion": { "base": null, "refs": { "App$enableBranchAutoDeletion": "Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.
", "CreateAppRequest$enableBranchAutoDeletion": "Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
", "UpdateAppRequest$enableBranchAutoDeletion": "Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
" } }, "EnableNotification": { "base": null, "refs": { "Branch$enableNotification": "Enables notifications for a branch that is part of an Amplify app.
", "CreateBranchRequest$enableNotification": "Enables notifications for the branch.
", "UpdateBranchRequest$enableNotification": "Enables notifications for the branch.
" } }, "EnablePerformanceMode": { "base": null, "refs": { "AutoBranchCreationConfig$enablePerformanceMode": "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.
", "Branch$enablePerformanceMode": "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.
", "CreateBranchRequest$enablePerformanceMode": "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.
", "UpdateBranchRequest$enablePerformanceMode": "Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
" } }, "EnablePullRequestPreview": { "base": null, "refs": { "AutoBranchCreationConfig$enablePullRequestPreview": "Enables pull request previews for the autocreated branch.
", "Branch$enablePullRequestPreview": "Enables pull request previews for the branch.
", "CreateBranchRequest$enablePullRequestPreview": "Enables pull request previews for this branch.
", "UpdateBranchRequest$enablePullRequestPreview": "Enables pull request previews for this branch.
" } }, "EnableSkewProtection": { "base": null, "refs": { "Branch$enableSkewProtection": "Specifies whether the skew protection feature is enabled for the branch.
Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.
", "CreateBranchRequest$enableSkewProtection": "Specifies whether the skew protection feature is enabled for the branch.
Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.
", "UpdateBranchRequest$enableSkewProtection": "Specifies whether the skew protection feature is enabled for the branch.
Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.
" } }, "EndTime": { "base": null, "refs": { "GenerateAccessLogsRequest$endTime": "The time at which the logs should end. The time range specified is inclusive of the end time.
", "JobSummary$endTime": "The end date and time for the job.
", "Step$endTime": "The end date and time of the execution step.
" } }, "EnvKey": { "base": null, "refs": { "EnvironmentVariables$key": null } }, "EnvValue": { "base": null, "refs": { "EnvironmentVariables$value": null } }, "EnvironmentName": { "base": null, "refs": { "BackendEnvironment$environmentName": "The name for a backend environment that is part of an Amplify app.
", "CreateBackendEnvironmentRequest$environmentName": "The name for the backend environment.
", "DeleteBackendEnvironmentRequest$environmentName": "The name of a backend environment of an Amplify app.
", "GetBackendEnvironmentRequest$environmentName": "The name for the backend environment.
", "ListBackendEnvironmentsRequest$environmentName": "The name of the backend environment
" } }, "EnvironmentVariables": { "base": null, "refs": { "App$environmentVariables": "The environment variables for the Amplify app.
For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
", "AutoBranchCreationConfig$environmentVariables": "The environment variables for the autocreated branch.
", "Branch$environmentVariables": "The environment variables specific to a branch of an Amplify app.
", "CreateAppRequest$environmentVariables": "The environment variables map for an Amplify app.
For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
", "CreateBranchRequest$environmentVariables": "The environment variables for the branch.
", "UpdateAppRequest$environmentVariables": "The environment variables for an Amplify app.
", "UpdateBranchRequest$environmentVariables": "The environment variables for the branch.
" } }, "ErrorMessage": { "base": null, "refs": { "BadRequestException$message": null, "DependentServiceFailureException$message": null, "InternalFailureException$message": null, "LimitExceededException$message": null, "NotFoundException$message": null, "ResourceNotFoundException$message": null, "UnauthorizedException$message": null } }, "FileMap": { "base": null, "refs": { "CreateDeploymentRequest$fileMap": "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.
" } }, "FileName": { "base": null, "refs": { "FileMap$key": null, "FileUploadUrls$key": null } }, "FileUploadUrls": { "base": null, "refs": { "CreateDeploymentResult$fileUploadUrls": " When the fileMap argument is provided in the request, fileUploadUrls will contain a map of file names to upload URLs.
The framework for the autocreated branch.
", "Branch$framework": "The framework for a branch of an Amplify app.
", "CreateBranchRequest$framework": "The framework for the branch.
", "UpdateBranchRequest$framework": "The framework for the branch.
" } }, "GenerateAccessLogsRequest": { "base": "The request structure for the generate access logs request.
", "refs": {} }, "GenerateAccessLogsResult": { "base": "The result structure for the generate access logs request.
", "refs": {} }, "GetAppRequest": { "base": "The request structure for the get app request.
", "refs": {} }, "GetAppResult": { "base": null, "refs": {} }, "GetArtifactUrlRequest": { "base": "Returns the request structure for the get artifact request.
", "refs": {} }, "GetArtifactUrlResult": { "base": "Returns the result structure for the get artifact request.
", "refs": {} }, "GetBackendEnvironmentRequest": { "base": "The request structure for the get backend environment request.
", "refs": {} }, "GetBackendEnvironmentResult": { "base": "The result structure for the get backend environment result.
", "refs": {} }, "GetBranchRequest": { "base": "The request structure for the get branch request.
", "refs": {} }, "GetBranchResult": { "base": null, "refs": {} }, "GetDomainAssociationRequest": { "base": "The request structure for the get domain association request.
", "refs": {} }, "GetDomainAssociationResult": { "base": "The result structure for the get domain association request.
", "refs": {} }, "GetJobRequest": { "base": "The request structure for the get job request.
", "refs": {} }, "GetJobResult": { "base": null, "refs": {} }, "GetWebhookRequest": { "base": "The request structure for the get webhook request.
", "refs": {} }, "GetWebhookResult": { "base": "The result structure for the get webhook request.
", "refs": {} }, "InternalFailureException": { "base": "The service failed to perform an operation due to an internal issue.
", "refs": {} }, "Job": { "base": "Describes an execution job for an Amplify app.
", "refs": { "GetJobResult$job": null } }, "JobArn": { "base": null, "refs": { "JobSummary$jobArn": "The Amazon Resource Name (ARN) for the job.
" } }, "JobConfig": { "base": "Describes the configuration details that apply to the jobs for an Amplify app.
Use JobConfig to apply configuration to jobs, such as customizing the build instance size when you create or update an Amplify app. For more information about customizable build instances, see Custom build instances in the Amplify User Guide.
The configuration details that apply to the jobs for an Amplify app.
", "CreateAppRequest$jobConfig": "Describes the configuration details that apply to the jobs for an Amplify app.
", "UpdateAppRequest$jobConfig": "Describes the configuration details that apply to the jobs for an Amplify app.
" } }, "JobId": { "base": null, "refs": { "CreateDeploymentResult$jobId": "The job ID for this deployment. will supply to start deployment api.
", "DeleteJobRequest$jobId": "The unique ID for the job.
", "GetJobRequest$jobId": "The unique ID for the job.
", "JobSummary$jobId": "The unique ID for the job.
", "ListArtifactsRequest$jobId": "The unique ID for a job.
", "StartDeploymentRequest$jobId": "The job ID for this deployment that is generated by the CreateDeployment request.
The unique ID for an existing job. This is required if the value of jobType is RETRY.
The unique id for the job.
" } }, "JobReason": { "base": null, "refs": { "StartJobRequest$jobReason": "A descriptive reason for starting the job.
" } }, "JobStatus": { "base": null, "refs": { "JobSummary$status": "The current status for the job.
", "Step$status": "The status of the execution step.
" } }, "JobSummaries": { "base": null, "refs": { "ListJobsResult$jobSummaries": "The result structure for the list job result request.
" } }, "JobSummary": { "base": "Describes the summary for an execution job for an Amplify app.
", "refs": { "DeleteJobResult$jobSummary": null, "Job$summary": "Describes the summary for an execution job for an Amplify app.
", "JobSummaries$member": null, "StartDeploymentResult$jobSummary": "The summary for the job.
", "StartJobResult$jobSummary": "The summary for the job.
", "StopJobResult$jobSummary": "The summary for the job.
" } }, "JobType": { "base": null, "refs": { "JobSummary$jobType": " The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.
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. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.
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.
The last deploy time of the production branch.
" } }, "LimitExceededException": { "base": "A resource could not be created because service quotas were exceeded.
", "refs": {} }, "ListAppsRequest": { "base": "The request structure for the list apps request.
", "refs": {} }, "ListAppsResult": { "base": "The result structure for an Amplify app list request.
", "refs": {} }, "ListArtifactsRequest": { "base": "Describes the request structure for the list artifacts request.
", "refs": {} }, "ListArtifactsResult": { "base": "The result structure for the list artifacts request.
", "refs": {} }, "ListBackendEnvironmentsRequest": { "base": "The request structure for the list backend environments request.
", "refs": {} }, "ListBackendEnvironmentsResult": { "base": "The result structure for the list backend environments result.
", "refs": {} }, "ListBranchesRequest": { "base": "The request structure for the list branches request.
", "refs": {} }, "ListBranchesResult": { "base": "The result structure for the list branches request.
", "refs": {} }, "ListDomainAssociationsRequest": { "base": "The request structure for the list domain associations request.
", "refs": {} }, "ListDomainAssociationsResult": { "base": "The result structure for the list domain association request.
", "refs": {} }, "ListJobsRequest": { "base": "The request structure for the list jobs request.
", "refs": {} }, "ListJobsResult": { "base": "The maximum number of records to list in a single response.
", "refs": {} }, "ListTagsForResourceRequest": { "base": "The request structure to use to list tags for a resource.
", "refs": {} }, "ListTagsForResourceResponse": { "base": "The response for the list tags for resource request.
", "refs": {} }, "ListWebhooksRequest": { "base": "The request structure for the list webhooks request.
", "refs": {} }, "ListWebhooksResult": { "base": "The result structure for the list webhooks request.
", "refs": {} }, "LogUrl": { "base": null, "refs": { "GenerateAccessLogsResult$logUrl": "The pre-signed URL for the requested access logs.
", "Step$logUrl": "The URL to the logs for the execution step.
" } }, "MD5Hash": { "base": null, "refs": { "FileMap$value": null } }, "MaxResults": { "base": null, "refs": { "ListArtifactsRequest$maxResults": "The maximum number of records to list in a single response.
", "ListBackendEnvironmentsRequest$maxResults": "The maximum number of records to list in a single response.
", "ListBranchesRequest$maxResults": "The maximum number of records to list in a single response.
", "ListDomainAssociationsRequest$maxResults": "The maximum number of records to list in a single response.
", "ListJobsRequest$maxResults": "The maximum number of records to list in a single response.
", "ListWebhooksRequest$maxResults": "The maximum number of records to list in a single response.
" } }, "MaxResultsForListApps": { "base": null, "refs": { "ListAppsRequest$maxResults": "The maximum number of records to list in a single response.
" } }, "Name": { "base": null, "refs": { "App$name": "The name for the Amplify app.
", "CreateAppRequest$name": "The name of the Amplify app.
", "UpdateAppRequest$name": "The name for an Amplify app.
" } }, "NextToken": { "base": null, "refs": { "ListAppsRequest$nextToken": "A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
", "ListAppsResult$nextToken": "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.
", "ListArtifactsRequest$nextToken": "A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.
", "ListArtifactsResult$nextToken": "A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
", "ListBackendEnvironmentsRequest$nextToken": "A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.
", "ListBackendEnvironmentsResult$nextToken": "A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
", "ListBranchesRequest$nextToken": "A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.
", "ListBranchesResult$nextToken": "A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
", "ListDomainAssociationsRequest$nextToken": "A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects.
", "ListDomainAssociationsResult$nextToken": "A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries.
", "ListJobsRequest$nextToken": "A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.
", "ListJobsResult$nextToken": "A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
", "ListWebhooksRequest$nextToken": "A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks.
", "ListWebhooksResult$nextToken": "A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
" } }, "NotFoundException": { "base": "An entity was not found during an operation.
", "refs": {} }, "OauthToken": { "base": null, "refs": { "CreateAppRequest$oauthToken": "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 .
", "UpdateAppRequest$oauthToken": "The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.
Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit.
To authorize access to GitHub as your repository provider, use accessToken.
You must specify either oauthToken or accessToken when you update an app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
" } }, "Platform": { "base": null, "refs": { "App$platform": "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.
If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.
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.
If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide.
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.
If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE.
Describes the information about a production branch for an Amplify app.
", "refs": { "App$productionBranch": "Describes the information about a production branch of the Amplify app.
" } }, "PullRequestEnvironmentName": { "base": null, "refs": { "AutoBranchCreationConfig$pullRequestEnvironmentName": "The Amplify environment name for the pull request.
", "Branch$pullRequestEnvironmentName": "The Amplify environment name for the pull request.
", "CreateBranchRequest$pullRequestEnvironmentName": "The Amplify environment name for the pull request.
", "UpdateBranchRequest$pullRequestEnvironmentName": "The Amplify environment name for the pull request.
" } }, "Repository": { "base": null, "refs": { "App$repository": "The Git repository for the Amplify app.
", "CreateAppRequest$repository": "The Git repository for the Amplify app.
", "UpdateAppRequest$repository": "The name of the Git repository for an Amplify app.
" } }, "RepositoryCloneMethod": { "base": null, "refs": { "App$repositoryCloneMethod": "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.
The Amazon Resource Name (ARN) to use to list tags.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) to use to tag a resource.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) to use to untag a resource.
" } }, "ResourceNotFoundException": { "base": "An operation failed due to a non-existent resource.
", "refs": {} }, "Screenshots": { "base": null, "refs": { "Step$screenshots": "The list of screenshot URLs for the execution step, if relevant.
" } }, "ServiceRoleArn": { "base": null, "refs": { "App$iamServiceRoleArn": "The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
", "CreateAppRequest$iamServiceRoleArn": "The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
", "UpdateAppRequest$iamServiceRoleArn": "The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
" } }, "Source": { "base": null, "refs": { "CustomRule$source": "The source pattern for a URL rewrite or redirect rule.
" } }, "SourceUrl": { "base": null, "refs": { "JobSummary$sourceUrl": "The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
", "StartDeploymentRequest$sourceUrl": "The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
The Amazon Resource Name (ARN) for the CloudFormation stack.
" } }, "StackName": { "base": null, "refs": { "BackendEnvironment$stackName": "The AWS CloudFormation stack name of a backend environment.
", "CreateBackendEnvironmentRequest$stackName": "The AWS CloudFormation stack name of a backend environment.
" } }, "Stage": { "base": null, "refs": { "AutoBranchCreationConfig$stage": "Describes the current stage for the autocreated branch.
", "Branch$stage": "The current stage for the branch that is part of an Amplify app.
", "CreateBranchRequest$stage": "Describes the current stage for the branch.
", "UpdateBranchRequest$stage": "Describes the current stage for the branch.
" } }, "StartDeploymentRequest": { "base": "The request structure for the start a deployment request.
", "refs": {} }, "StartDeploymentResult": { "base": "The result structure for the start a deployment request.
", "refs": {} }, "StartJobRequest": { "base": "The request structure for the start job request.
", "refs": {} }, "StartJobResult": { "base": "The result structure for the run job request.
", "refs": {} }, "StartTime": { "base": null, "refs": { "GenerateAccessLogsRequest$startTime": "The time at which the logs should start. The time range specified is inclusive of the start time.
", "JobSummary$startTime": "The start date and time for the job.
", "Step$startTime": "The start date and time of the execution step.
" } }, "Status": { "base": null, "refs": { "CustomRule$status": "The status code for a URL rewrite or redirect rule.
Represents a 200 rewrite rule.
Represents a 301 (moved permanently) redirect rule. This and all future requests should be directed to the target URL.
Represents a 302 temporary redirect rule.
Represents a 404 redirect rule.
Represents a 404 rewrite rule.
The status of the production branch.
" } }, "StatusReason": { "base": null, "refs": { "DomainAssociation$statusReason": "Additional information that describes why the domain association is in the current state.
", "Step$statusReason": "The reason for the current step status.
", "WafConfiguration$statusReason": "The reason for the current status of the Firewall configuration.
" } }, "Step": { "base": "Describes an execution step, for an execution job, for an Amplify app.
", "refs": { "Steps$member": null } }, "StepName": { "base": null, "refs": { "Step$stepName": "The name of the execution step.
" } }, "Steps": { "base": null, "refs": { "Job$steps": "The execution steps for an execution job, for an Amplify app.
" } }, "StopJobRequest": { "base": "The request structure for the stop job request.
", "refs": {} }, "StopJobResult": { "base": "The result structure for the stop job request.
", "refs": {} }, "SubDomain": { "base": "The subdomain for the domain association.
", "refs": { "SubDomains$member": null } }, "SubDomainSetting": { "base": "Describes the settings for the subdomain.
", "refs": { "SubDomain$subDomainSetting": "Describes the settings for the subdomain.
", "SubDomainSettings$member": null } }, "SubDomainSettings": { "base": null, "refs": { "CreateDomainAssociationRequest$subDomainSettings": "The setting for the subdomain.
", "UpdateDomainAssociationRequest$subDomainSettings": "Describes the settings for the subdomain.
" } }, "SubDomains": { "base": null, "refs": { "DomainAssociation$subDomains": "The subdomains for the domain association.
" } }, "TTL": { "base": "The content Time to Live (TTL) for the website in seconds.
", "refs": { "Branch$ttl": "The content Time to Live (TTL) for the website in seconds.
", "CreateBranchRequest$ttl": "The content Time To Live (TTL) for the website in seconds.
", "UpdateBranchRequest$ttl": "The content Time to Live (TTL) for the website in seconds.
" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The tag keys to use to untag a resource.
" } }, "TagMap": { "base": null, "refs": { "App$tags": "The tag for the Amplify app.
", "Branch$tags": "The tag for the branch of an Amplify app.
", "CreateAppRequest$tags": "The tag for an Amplify app.
", "CreateBranchRequest$tags": "The tag for the branch.
", "ListTagsForResourceResponse$tags": "A list of tags for the specified The Amazon Resource Name (ARN).
", "TagResourceRequest$tags": "The tags used to tag the resource.
" } }, "TagResourceRequest": { "base": "The request structure to tag a resource with a tag key and value.
", "refs": {} }, "TagResourceResponse": { "base": "The response for the tag resource request.
", "refs": {} }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "Target": { "base": null, "refs": { "CustomRule$target": "The target pattern for a URL rewrite or redirect rule.
" } }, "TestArtifactsUrl": { "base": null, "refs": { "Step$testArtifactsUrl": "The URL to the test artifact for the execution step.
" } }, "TestConfigUrl": { "base": null, "refs": { "Step$testConfigUrl": "The URL to the test configuration for the execution step.
" } }, "ThumbnailName": { "base": null, "refs": { "Screenshots$key": null } }, "ThumbnailUrl": { "base": null, "refs": { "Branch$thumbnailUrl": "The thumbnail URL for the branch of an Amplify app.
", "ProductionBranch$thumbnailUrl": "The thumbnail URL for the production branch.
", "Screenshots$value": null } }, "TotalNumberOfJobs": { "base": null, "refs": { "Branch$totalNumberOfJobs": "The total number of jobs that are part of an Amplify app.
" } }, "UnauthorizedException": { "base": "An operation failed due to a lack of access.
", "refs": {} }, "UntagResourceRequest": { "base": "The request structure for the untag resource request.
", "refs": {} }, "UntagResourceResponse": { "base": "The response for the untag resource request.
", "refs": {} }, "UpdateAppRequest": { "base": "The request structure for the update app request.
", "refs": {} }, "UpdateAppResult": { "base": "The result structure for an Amplify app update request.
", "refs": {} }, "UpdateBranchRequest": { "base": "The request structure for the update branch request.
", "refs": {} }, "UpdateBranchResult": { "base": "The result structure for the update branch request.
", "refs": {} }, "UpdateDomainAssociationRequest": { "base": "The request structure for the update domain association request.
", "refs": {} }, "UpdateDomainAssociationResult": { "base": "The result structure for the update domain association request.
", "refs": {} }, "UpdateStatus": { "base": null, "refs": { "DomainAssociation$updateStatus": "The status of the domain update operation that is currently in progress. The following list describes the valid update states.
The certificate is in the process of being updated.
Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
Indicates that the subdomain or certificate changes are being propagated.
Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.
The certificate has been associated with a domain.
The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
A timestamp of when Amplify updated the application.
", "BackendEnvironment$updateTime": "The last updated date and time for a backend environment that is part of an Amplify app.
", "Branch$updateTime": "A timestamp for the last updated time for a branch.
", "Webhook$updateTime": "A timestamp of when Amplify updated the webhook in your Git repository.
" } }, "UpdateWebhookRequest": { "base": "The request structure for the update webhook request.
", "refs": {} }, "UpdateWebhookResult": { "base": "The result structure for the update webhook request.
", "refs": {} }, "UploadUrl": { "base": null, "refs": { "CreateDeploymentResult$zipUploadUrl": " When the fileMap argument is not provided in the request, this zipUploadUrl is returned.
The verified status of the subdomain
" } }, "WafConfiguration": { "base": "Describes the Firewall configuration for a hosted Amplify application. Firewall support enables you to protect your web applications with a direct integration with WAF. For more information about using WAF protections for an Amplify application, see Firewall support for hosted sites in the Amplify User Guide.
", "refs": { "App$wafConfiguration": "Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.
" } }, "WafStatus": { "base": null, "refs": { "WafConfiguration$wafStatus": "The status of the process to associate or disassociate a web ACL to an Amplify app.
" } }, "WebAclArn": { "base": null, "refs": { "WafConfiguration$webAclArn": "The Amazon Resource Name (ARN) for the web ACL associated with an Amplify app.
" } }, "Webhook": { "base": "Describes a webhook that connects repository events to an Amplify app.
", "refs": { "CreateWebhookResult$webhook": "Describes a webhook that connects repository events to an Amplify app.
", "DeleteWebhookResult$webhook": "Describes a webhook that connects repository events to an Amplify app.
", "GetWebhookResult$webhook": "Describes the structure of a webhook.
", "UpdateWebhookResult$webhook": "Describes a webhook that connects repository events to an Amplify app.
", "Webhooks$member": null } }, "WebhookArn": { "base": null, "refs": { "Webhook$webhookArn": "The Amazon Resource Name (ARN) for the webhook.
" } }, "WebhookId": { "base": null, "refs": { "DeleteWebhookRequest$webhookId": "The unique ID for a webhook.
", "GetWebhookRequest$webhookId": "The unique ID for a webhook.
", "UpdateWebhookRequest$webhookId": "The unique ID for a webhook.
", "Webhook$webhookId": "The ID of the webhook.
" } }, "WebhookUrl": { "base": null, "refs": { "Webhook$webhookUrl": "The URL of the webhook.
" } }, "Webhooks": { "base": null, "refs": { "ListWebhooksResult$webhooks": "A list of webhooks.
" } }, "webhookCreateTime": { "base": null, "refs": { "App$webhookCreateTime": "A timestamp of when Amplify created the webhook in your Git repository.
" } } } }