Skip to content

Amplify Classes

App

appId

  • Type:
  • Required: Yes

appArn

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

repository

  • Type:
  • Required: Yes

platform

  • Type: typing.Literal['WEB', 'WEB_COMPUTE', 'WEB_DYNAMIC']
  • Required: Yes

createTime

  • Type:
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

environmentVariables

  • Type: typing.Dict[str, str]
  • Required: Yes

defaultDomain

  • Type:
  • Required: Yes

enableBranchAutoBuild

  • Type:
  • Required: Yes

enableBasicAuth

  • Type:
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

computeRoleArn

  • Type: typing.Optional[str]

iamServiceRoleArn

  • Type: typing.Optional[str]

enableBranchAutoDeletion

  • Type: typing.Optional[bool]

basicAuthCredentials

  • Type: typing.Optional[str]

customRules

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.CustomRule]]

productionBranch

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.ProductionBranch]

buildSpec

  • Type: typing.Optional[str]

customHeaders

  • Type: typing.Optional[str]

enableAutoBranchCreation

  • Type: typing.Optional[bool]

autoBranchCreationPatterns

  • Type: typing.Optional[typing.List[str]]

autoBranchCreationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.AutoBranchCreationConfigOutput]

repositoryCloneMethod

  • Type: typing.Optional[typing.Literal['SIGV4', 'SSH', 'TOKEN']]

cacheConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.CacheConfig]

webhookCreateTime

  • Type: typing.Optional[datetime.datetime]

wafConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.WafConfiguration]

Artifact

artifactFileName

  • Type:
  • Required: Yes

artifactId

  • Type:
  • Required: Yes

AutoBranchCreationConfig

stage

  • Type: typing.Optional[typing.Literal['BETA', 'DEVELOPMENT', 'EXPERIMENTAL', 'PRODUCTION', 'PULL_REQUEST']]

framework

  • Type: typing.Optional[str]

enableAutoBuild

  • Type: typing.Optional[bool]

environmentVariables

  • Type: typing.Optional[typing.Dict[str, str]]

basicAuthCredentials

  • Type: typing.Optional[str]

enableBasicAuth

  • Type: typing.Optional[bool]

enablePerformanceMode

  • Type: typing.Optional[bool]

buildSpec

  • Type: typing.Optional[str]

enablePullRequestPreview

  • Type: typing.Optional[bool]

pullRequestEnvironmentName

  • Type: typing.Optional[str]

AutoBranchCreationConfigOutput

stage

  • Type: typing.Optional[typing.Literal['BETA', 'DEVELOPMENT', 'EXPERIMENTAL', 'PRODUCTION', 'PULL_REQUEST']]

framework

  • Type: typing.Optional[str]

enableAutoBuild

  • Type: typing.Optional[bool]

environmentVariables

  • Type: typing.Optional[typing.Dict[str, str]]

basicAuthCredentials

  • Type: typing.Optional[str]

enableBasicAuth

  • Type: typing.Optional[bool]

enablePerformanceMode

  • Type: typing.Optional[bool]

buildSpec

  • Type: typing.Optional[str]

enablePullRequestPreview

  • Type: typing.Optional[bool]

pullRequestEnvironmentName

  • Type: typing.Optional[str]

Backend

stackArn

  • Type: typing.Optional[str]

BackendEnvironment

backendEnvironmentArn

  • Type:
  • Required: Yes

environmentName

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

stackName

  • Type: typing.Optional[str]

deploymentArtifacts

  • Type: typing.Optional[str]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

Branch

branchArn

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

stage

  • Type: typing.Literal['BETA', 'DEVELOPMENT', 'EXPERIMENTAL', 'PRODUCTION', 'PULL_REQUEST']
  • Required: Yes

displayName

  • Type:
  • Required: Yes

enableNotification

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

environmentVariables

  • Type: typing.Dict[str, str]
  • Required: Yes

enableAutoBuild

  • Type:
  • Required: Yes

customDomains

  • Type: typing.List[str]
  • Required: Yes

framework

  • Type:
  • Required: Yes

activeJobId

  • Type:
  • Required: Yes

totalNumberOfJobs

  • Type:
  • Required: Yes

enableBasicAuth

  • Type:
  • Required: Yes

ttl

  • Type:
  • Required: Yes

enablePullRequestPreview

  • Type:
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

enablePerformanceMode

  • Type: typing.Optional[bool]

thumbnailUrl

  • Type: typing.Optional[str]

basicAuthCredentials

  • Type: typing.Optional[str]

buildSpec

  • Type: typing.Optional[str]

associatedResources

  • Type: typing.Optional[typing.List[str]]

pullRequestEnvironmentName

  • Type: typing.Optional[str]

destinationBranch

  • Type: typing.Optional[str]

sourceBranch

  • Type: typing.Optional[str]

backendEnvironmentArn

  • Type: typing.Optional[str]

backend

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.Backend]

computeRoleArn

  • Type: typing.Optional[str]

CacheConfig

type

  • Type: typing.Literal['AMPLIFY_MANAGED', 'AMPLIFY_MANAGED_NO_COOKIES']
  • Required: Yes

Certificate

type

  • Type: typing.Literal['AMPLIFY_MANAGED', 'CUSTOM']
  • Required: Yes

customCertificateArn

  • Type: typing.Optional[str]

certificateVerificationDNSRecord

  • Type: typing.Optional[str]

CertificateSettings

type

  • Type: typing.Literal['AMPLIFY_MANAGED', 'CUSTOM']
  • Required: Yes

customCertificateArn

  • Type: typing.Optional[str]

CreateAppRequest

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

repository

  • Type: typing.Optional[str]

platform

  • Type: typing.Optional[typing.Literal['WEB', 'WEB_COMPUTE', 'WEB_DYNAMIC']]

computeRoleArn

  • Type: typing.Optional[str]

iamServiceRoleArn

  • Type: typing.Optional[str]

oauthToken

  • Type: typing.Optional[str]

accessToken

  • Type: typing.Optional[str]

environmentVariables

  • Type: typing.Optional[typing.Dict[str, str]]

enableBranchAutoBuild

  • Type: typing.Optional[bool]

enableBranchAutoDeletion

  • Type: typing.Optional[bool]

enableBasicAuth

  • Type: typing.Optional[bool]

basicAuthCredentials

  • Type: typing.Optional[str]

customRules

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.CustomRule]]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

buildSpec

  • Type: typing.Optional[str]

customHeaders

  • Type: typing.Optional[str]

enableAutoBranchCreation

  • Type: typing.Optional[bool]

autoBranchCreationPatterns

  • Type: typing.Optional[typing.List[str]]

autoBranchCreationConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.amplify.amplify_classes.AutoBranchCreationConfig, aws_resource_validator.pydantic_models.amplify.amplify_classes.AutoBranchCreationConfigOutput, NoneType]

cacheConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.CacheConfig]

CreateAppResult

app

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateBackendEnvironmentRequest

appId

  • Type:
  • Required: Yes

environmentName

  • Type:
  • Required: Yes

stackName

  • Type: typing.Optional[str]

deploymentArtifacts

  • Type: typing.Optional[str]

CreateBackendEnvironmentResult

backendEnvironment

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateBranchRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

stage

  • Type: typing.Optional[typing.Literal['BETA', 'DEVELOPMENT', 'EXPERIMENTAL', 'PRODUCTION', 'PULL_REQUEST']]

framework

  • Type: typing.Optional[str]

enableNotification

  • Type: typing.Optional[bool]

enableAutoBuild

  • Type: typing.Optional[bool]

environmentVariables

  • Type: typing.Optional[typing.Dict[str, str]]

basicAuthCredentials

  • Type: typing.Optional[str]

enableBasicAuth

  • Type: typing.Optional[bool]

enablePerformanceMode

  • Type: typing.Optional[bool]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

buildSpec

  • Type: typing.Optional[str]

ttl

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

enablePullRequestPreview

  • Type: typing.Optional[bool]

pullRequestEnvironmentName

  • Type: typing.Optional[str]

backendEnvironmentArn

  • Type: typing.Optional[str]

backend

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.Backend]

computeRoleArn

  • Type: typing.Optional[str]

CreateBranchResult

branch

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDeploymentRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

fileMap

  • Type: typing.Optional[typing.Dict[str, str]]

CreateDeploymentResult

jobId

  • Type:
  • Required: Yes

fileUploadUrls

  • Type: typing.Dict[str, str]
  • Required: Yes

zipUploadUrl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDomainAssociationRequest

appId

  • Type:
  • Required: Yes

domainName

  • Type:
  • Required: Yes

subDomainSettings

  • Type: typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.SubDomainSetting]
  • Required: Yes

enableAutoSubDomain

  • Type: typing.Optional[bool]

autoSubDomainCreationPatterns

  • Type: typing.Optional[typing.List[str]]

autoSubDomainIAMRole

  • Type: typing.Optional[str]

certificateSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.CertificateSettings]

CreateDomainAssociationResult

domainAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateWebhookRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

CreateWebhookResult

webhook

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CustomRule

source

  • Type:
  • Required: Yes

target

  • Type:
  • Required: Yes

status

  • Type: typing.Optional[str]

condition

  • Type: typing.Optional[str]

DeleteAppRequest

appId

  • Type:
  • Required: Yes

DeleteAppResult

app

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteBackendEnvironmentRequest

appId

  • Type:
  • Required: Yes

environmentName

  • Type:
  • Required: Yes

DeleteBackendEnvironmentResult

backendEnvironment

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteBranchRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

DeleteBranchResult

branch

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteDomainAssociationRequest

appId

  • Type:
  • Required: Yes

domainName

  • Type:
  • Required: Yes

DeleteDomainAssociationResult

domainAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteJobRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

jobId

  • Type:
  • Required: Yes

DeleteJobResult

jobSummary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteWebhookRequest

webhookId

  • Type:
  • Required: Yes

DeleteWebhookResult

webhook

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DomainAssociation

domainAssociationArn

  • Type:
  • Required: Yes

domainName

  • Type:
  • Required: Yes

enableAutoSubDomain

  • Type:
  • Required: Yes

domainStatus

  • Type: typing.Literal['AVAILABLE', 'AWAITING_APP_CNAME', 'CREATING', 'FAILED', 'IMPORTING_CUSTOM_CERTIFICATE', 'IN_PROGRESS', 'PENDING_DEPLOYMENT', 'PENDING_VERIFICATION', 'REQUESTING_CERTIFICATE', 'UPDATING']
  • Required: Yes

statusReason

  • Type:
  • Required: Yes

subDomains

  • Type: typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.SubDomain]
  • Required: Yes

autoSubDomainCreationPatterns

  • Type: typing.Optional[typing.List[str]]

autoSubDomainIAMRole

  • Type: typing.Optional[str]

updateStatus

  • Type: typing.Optional[typing.Literal['AWAITING_APP_CNAME', 'IMPORTING_CUSTOM_CERTIFICATE', 'PENDING_DEPLOYMENT', 'PENDING_VERIFICATION', 'REQUESTING_CERTIFICATE', 'UPDATE_COMPLETE', 'UPDATE_FAILED']]

certificateVerificationDNSRecord

  • Type: typing.Optional[str]

certificate

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.Certificate]

GenerateAccessLogsRequest

domainName

  • Type:
  • Required: Yes

appId

  • Type:
  • Required: Yes

startTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

endTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

GenerateAccessLogsResult

logUrl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAppRequest

appId

  • Type:
  • Required: Yes

GetAppResult

app

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetArtifactUrlRequest

artifactId

  • Type:
  • Required: Yes

GetArtifactUrlResult

artifactId

  • Type:
  • Required: Yes

artifactUrl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetBackendEnvironmentRequest

appId

  • Type:
  • Required: Yes

environmentName

  • Type:
  • Required: Yes

GetBackendEnvironmentResult

backendEnvironment

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetBranchRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

GetBranchResult

branch

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDomainAssociationRequest

appId

  • Type:
  • Required: Yes

domainName

  • Type:
  • Required: Yes

GetDomainAssociationResult

domainAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetJobRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

jobId

  • Type:
  • Required: Yes

GetJobResult

job

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetWebhookRequest

webhookId

  • Type:
  • Required: Yes

GetWebhookResult

webhook

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Job

summary

  • Type:
  • Required: Yes

steps

  • Type: typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.Step]
  • Required: Yes

JobSummary

jobArn

  • Type:
  • Required: Yes

jobId

  • Type:
  • Required: Yes

commitId

  • Type:
  • Required: Yes

commitMessage

  • Type:
  • Required: Yes

commitTime

  • Type:
  • Required: Yes

startTime

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CANCELLED', 'CANCELLING', 'CREATED', 'FAILED', 'PENDING', 'PROVISIONING', 'RUNNING', 'SUCCEED']
  • Required: Yes

jobType

  • Type: typing.Literal['MANUAL', 'RELEASE', 'RETRY', 'WEB_HOOK']
  • Required: Yes

endTime

  • Type: typing.Optional[datetime.datetime]

sourceUrl

  • Type: typing.Optional[str]

sourceUrlType

  • Type: typing.Optional[typing.Literal['BUCKET_PREFIX', 'ZIP']]

ListAppsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListAppsRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.PaginatorConfig]

ListAppsResult

apps

  • Type: typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.App]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListArtifactsRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

jobId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListArtifactsResult

artifacts

  • Type: typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.Artifact]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListBackendEnvironmentsRequest

appId

  • Type:
  • Required: Yes

environmentName

  • Type: typing.Optional[str]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListBackendEnvironmentsResult

backendEnvironments

  • Type: typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.BackendEnvironment]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListBranchesRequest

appId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListBranchesRequestPaginate

appId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.PaginatorConfig]

ListBranchesResult

branches

  • Type: typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.Branch]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDomainAssociationsRequest

appId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDomainAssociationsRequestPaginate

appId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.PaginatorConfig]

ListDomainAssociationsResult

domainAssociations

  • Type: typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.DomainAssociation]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListJobsRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListJobsRequestPaginate

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.PaginatorConfig]

ListJobsResult

jobSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.JobSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListWebhooksRequest

appId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListWebhooksResult

webhooks

  • Type: typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.Webhook]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ProductionBranch

lastDeployTime

  • Type: typing.Optional[datetime.datetime]

status

  • Type: typing.Optional[str]

thumbnailUrl

  • Type: typing.Optional[str]

branchName

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

StartDeploymentRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

jobId

  • Type: typing.Optional[str]

sourceUrl

  • Type: typing.Optional[str]

sourceUrlType

  • Type: typing.Optional[typing.Literal['BUCKET_PREFIX', 'ZIP']]

StartDeploymentResult

jobSummary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartJobRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

jobType

  • Type: typing.Literal['MANUAL', 'RELEASE', 'RETRY', 'WEB_HOOK']
  • Required: Yes

jobId

  • Type: typing.Optional[str]

jobReason

  • Type: typing.Optional[str]

commitId

  • Type: typing.Optional[str]

commitMessage

  • Type: typing.Optional[str]

commitTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

StartJobResult

jobSummary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Step

stepName

  • Type:
  • Required: Yes

startTime

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CANCELLED', 'CANCELLING', 'CREATED', 'FAILED', 'PENDING', 'PROVISIONING', 'RUNNING', 'SUCCEED']
  • Required: Yes

endTime

  • Type:
  • Required: Yes

logUrl

  • Type: typing.Optional[str]

artifactsUrl

  • Type: typing.Optional[str]

testArtifactsUrl

  • Type: typing.Optional[str]

testConfigUrl

  • Type: typing.Optional[str]

screenshots

  • Type: typing.Optional[typing.Dict[str, str]]

statusReason

  • Type: typing.Optional[str]

context

  • Type: typing.Optional[str]

StopJobRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

jobId

  • Type:
  • Required: Yes

StopJobResult

jobSummary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SubDomain

subDomainSetting

  • Type:
  • Required: Yes

verified

  • Type:
  • Required: Yes

dnsRecord

  • Type:
  • Required: Yes

SubDomainSetting

prefix

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateAppRequest

appId

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

platform

  • Type: typing.Optional[typing.Literal['WEB', 'WEB_COMPUTE', 'WEB_DYNAMIC']]

computeRoleArn

  • Type: typing.Optional[str]

iamServiceRoleArn

  • Type: typing.Optional[str]

environmentVariables

  • Type: typing.Optional[typing.Dict[str, str]]

enableBranchAutoBuild

  • Type: typing.Optional[bool]

enableBranchAutoDeletion

  • Type: typing.Optional[bool]

enableBasicAuth

  • Type: typing.Optional[bool]

basicAuthCredentials

  • Type: typing.Optional[str]

customRules

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.CustomRule]]

buildSpec

  • Type: typing.Optional[str]

customHeaders

  • Type: typing.Optional[str]

enableAutoBranchCreation

  • Type: typing.Optional[bool]

autoBranchCreationPatterns

  • Type: typing.Optional[typing.List[str]]

autoBranchCreationConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.amplify.amplify_classes.AutoBranchCreationConfig, aws_resource_validator.pydantic_models.amplify.amplify_classes.AutoBranchCreationConfigOutput, NoneType]

repository

  • Type: typing.Optional[str]

oauthToken

  • Type: typing.Optional[str]

accessToken

  • Type: typing.Optional[str]

cacheConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.CacheConfig]

UpdateAppResult

app

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateBranchRequest

appId

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

framework

  • Type: typing.Optional[str]

stage

  • Type: typing.Optional[typing.Literal['BETA', 'DEVELOPMENT', 'EXPERIMENTAL', 'PRODUCTION', 'PULL_REQUEST']]

enableNotification

  • Type: typing.Optional[bool]

enableAutoBuild

  • Type: typing.Optional[bool]

environmentVariables

  • Type: typing.Optional[typing.Dict[str, str]]

basicAuthCredentials

  • Type: typing.Optional[str]

enableBasicAuth

  • Type: typing.Optional[bool]

enablePerformanceMode

  • Type: typing.Optional[bool]

buildSpec

  • Type: typing.Optional[str]

ttl

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

enablePullRequestPreview

  • Type: typing.Optional[bool]

pullRequestEnvironmentName

  • Type: typing.Optional[str]

backendEnvironmentArn

  • Type: typing.Optional[str]

backend

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.Backend]

computeRoleArn

  • Type: typing.Optional[str]

UpdateBranchResult

branch

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDomainAssociationRequest

appId

  • Type:
  • Required: Yes

domainName

  • Type:
  • Required: Yes

enableAutoSubDomain

  • Type: typing.Optional[bool]

subDomainSettings

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.amplify.amplify_classes.SubDomainSetting]]

autoSubDomainCreationPatterns

  • Type: typing.Optional[typing.List[str]]

autoSubDomainIAMRole

  • Type: typing.Optional[str]

certificateSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplify.amplify_classes.CertificateSettings]

UpdateDomainAssociationResult

domainAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateWebhookRequest

webhookId

  • Type:
  • Required: Yes

branchName

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

UpdateWebhookResult

webhook

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

WafConfiguration

webAclArn

  • Type: typing.Optional[str]

wafStatus

  • Type: typing.Optional[typing.Literal['ASSOCIATING', 'ASSOCIATION_FAILED', 'ASSOCIATION_SUCCESS', 'DISASSOCIATING', 'DISASSOCIATION_FAILED']]

statusReason

  • Type: typing.Optional[str]

Webhook

webhookArn

  • Type:
  • Required: Yes

webhookId

  • Type:
  • Required: Yes

webhookUrl

  • Type:
  • Required: Yes

branchName

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

updateTime

  • Type:
  • Required: Yes