Amplify Classes

AppTypeDef

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

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_classes.CustomRuleTypeDef]]

productionBranch

• Type: typing.Optional[aws_resource_validator.pydantic_models.amplify_classes.ProductionBranchTypeDef]

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_classes.AutoBranchCreationConfigOutputTypeDef]

repositoryCloneMethod

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

ArtifactTypeDef

artifactFileName

• Type:
• Required: Yes

artifactId

• Type:
• Required: Yes

AutoBranchCreationConfigExtraOutputTypeDef

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]

AutoBranchCreationConfigOutputTypeDef

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]

AutoBranchCreationConfigTypeDef

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.Mapping[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]

BackendEnvironmentTypeDef

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]

BackendTypeDef

stackArn

• Type: typing.Optional[str]

BaseValidatorModel

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

BranchTypeDef

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_classes.BackendTypeDef]

CertificateSettingsTypeDef

type

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

customCertificateArn

• Type: typing.Optional[str]

CertificateTypeDef

type

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

customCertificateArn

• Type: typing.Optional[str]

certificateVerificationDNSRecord

• Type: typing.Optional[str]

CreateAppRequestRequestTypeDef

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']]

iamServiceRoleArn

• Type: typing.Optional[str]

oauthToken

• Type: typing.Optional[str]

accessToken

• Type: typing.Optional[str]

environmentVariables

• Type: typing.Optional[typing.Mapping[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.Sequence[aws_resource_validator.pydantic_models.amplify_classes.CustomRuleTypeDef]]

tags

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

buildSpec

• Type: typing.Optional[str]

customHeaders

• Type: typing.Optional[str]

enableAutoBranchCreation

• Type: typing.Optional[bool]

autoBranchCreationPatterns

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

autoBranchCreationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.amplify_classes.AutoBranchCreationConfigTypeDef]

CreateAppResultTypeDef

app

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateBackendEnvironmentRequestRequestTypeDef

appId

• Type:
• Required: Yes

environmentName

• Type:
• Required: Yes

stackName

• Type: typing.Optional[str]

deploymentArtifacts

• Type: typing.Optional[str]

CreateBackendEnvironmentResultTypeDef

backendEnvironment

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateBranchRequestRequestTypeDef

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.Mapping[str, str]]

basicAuthCredentials

• Type: typing.Optional[str]

enableBasicAuth

• Type: typing.Optional[bool]

enablePerformanceMode

• Type: typing.Optional[bool]

tags

• Type: typing.Optional[typing.Mapping[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_classes.BackendTypeDef]

CreateBranchResultTypeDef

branch

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateDeploymentRequestRequestTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

fileMap

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

CreateDeploymentResultTypeDef

jobId

• Type:
• Required: Yes

fileUploadUrls

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

zipUploadUrl

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateDomainAssociationRequestRequestTypeDef

appId

• Type:
• Required: Yes

domainName

• Type:
• Required: Yes

subDomainSettings

• Type: typing.Sequence[aws_resource_validator.pydantic_models.amplify_classes.SubDomainSettingTypeDef]
• Required: Yes

enableAutoSubDomain

• Type: typing.Optional[bool]

autoSubDomainCreationPatterns

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

autoSubDomainIAMRole

• Type: typing.Optional[str]

certificateSettings

• Type: typing.Optional[aws_resource_validator.pydantic_models.amplify_classes.CertificateSettingsTypeDef]

CreateDomainAssociationResultTypeDef

domainAssociation

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateWebhookRequestRequestTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

description

• Type: typing.Optional[str]

CreateWebhookResultTypeDef

webhook

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CustomRuleTypeDef

source

• Type:
• Required: Yes

target

• Type:
• Required: Yes

status

• Type: typing.Optional[str]

condition

• Type: typing.Optional[str]

DeleteAppRequestRequestTypeDef

appId

• Type:
• Required: Yes

DeleteAppResultTypeDef

app

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DeleteBackendEnvironmentRequestRequestTypeDef

appId

• Type:
• Required: Yes

environmentName

• Type:
• Required: Yes

DeleteBackendEnvironmentResultTypeDef

backendEnvironment

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DeleteBranchRequestRequestTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

DeleteBranchResultTypeDef

branch

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DeleteDomainAssociationRequestRequestTypeDef

appId

• Type:
• Required: Yes

domainName

• Type:
• Required: Yes

DeleteDomainAssociationResultTypeDef

domainAssociation

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DeleteJobRequestRequestTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

jobId

• Type:
• Required: Yes

DeleteJobResultTypeDef

jobSummary

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DeleteWebhookRequestRequestTypeDef

webhookId

• Type:
• Required: Yes

DeleteWebhookResultTypeDef

webhook

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DomainAssociationTypeDef

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_classes.SubDomainTypeDef]
• 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_classes.CertificateTypeDef]

GenerateAccessLogsRequestRequestTypeDef

domainName

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

startTime

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

endTime

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

GenerateAccessLogsResultTypeDef

logUrl

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetAppRequestRequestTypeDef

appId

• Type:
• Required: Yes

GetAppResultTypeDef

app

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetArtifactUrlRequestRequestTypeDef

artifactId

• Type:
• Required: Yes

GetArtifactUrlResultTypeDef

artifactId

• Type:
• Required: Yes

artifactUrl

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetBackendEnvironmentRequestRequestTypeDef

appId

• Type:
• Required: Yes

environmentName

• Type:
• Required: Yes

GetBackendEnvironmentResultTypeDef

backendEnvironment

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetBranchRequestRequestTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

GetBranchResultTypeDef

branch

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetDomainAssociationRequestRequestTypeDef

appId

• Type:
• Required: Yes

domainName

• Type:
• Required: Yes

GetDomainAssociationResultTypeDef

domainAssociation

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetJobRequestRequestTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

jobId

• Type:
• Required: Yes

GetJobResultTypeDef

job

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetWebhookRequestRequestTypeDef

webhookId

• Type:
• Required: Yes

GetWebhookResultTypeDef

webhook

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

JobSummaryTypeDef

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', 'FAILED', 'PENDING', 'PROVISIONING', 'RUNNING', 'SUCCEED']
• Required: Yes

jobType

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

endTime

• Type: typing.Optional[datetime.datetime]

JobTypeDef

summary

• Type:
• Required: Yes

steps

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

ListAppsRequestListAppsPaginateTypeDef

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.amplify_classes.PaginatorConfigTypeDef]

ListAppsRequestRequestTypeDef

nextToken

• Type: typing.Optional[str]

maxResults

• Type: typing.Optional[int]

ListAppsResultTypeDef

apps

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

nextToken

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ListArtifactsRequestRequestTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

jobId

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

maxResults

• Type: typing.Optional[int]

ListArtifactsResultTypeDef

artifacts

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

nextToken

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ListBackendEnvironmentsRequestRequestTypeDef

appId

• Type:
• Required: Yes

environmentName

• Type: typing.Optional[str]

nextToken

• Type: typing.Optional[str]

maxResults

• Type: typing.Optional[int]

ListBackendEnvironmentsResultTypeDef

backendEnvironments

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

nextToken

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ListBranchesRequestListBranchesPaginateTypeDef

appId

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.amplify_classes.PaginatorConfigTypeDef]

ListBranchesRequestRequestTypeDef

appId

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

maxResults

• Type: typing.Optional[int]

ListBranchesResultTypeDef

branches

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

nextToken

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ListDomainAssociationsRequestListDomainAssociationsPaginateTypeDef

appId

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.amplify_classes.PaginatorConfigTypeDef]

ListDomainAssociationsRequestRequestTypeDef

appId

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

maxResults

• Type: typing.Optional[int]

ListDomainAssociationsResultTypeDef

domainAssociations

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

nextToken

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ListJobsRequestListJobsPaginateTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.amplify_classes.PaginatorConfigTypeDef]

ListJobsRequestRequestTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

maxResults

• Type: typing.Optional[int]

ListJobsResultTypeDef

jobSummaries

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

nextToken

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ListTagsForResourceRequestRequestTypeDef

resourceArn

• Type:
• Required: Yes

ListTagsForResourceResponseTypeDef

tags

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

ResponseMetadata

• Type:
• Required: Yes

ListWebhooksRequestRequestTypeDef

appId

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

maxResults

• Type: typing.Optional[int]

ListWebhooksResultTypeDef

webhooks

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

nextToken

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

PaginatorConfigTypeDef

MaxItems

• Type: typing.Optional[int]

PageSize

• Type: typing.Optional[int]

StartingToken

• Type: typing.Optional[str]

ProductionBranchTypeDef

lastDeployTime

• Type: typing.Optional[datetime.datetime]

status

• Type: typing.Optional[str]

thumbnailUrl

• Type: typing.Optional[str]

branchName

• Type: typing.Optional[str]

ResponseMetadataTypeDef

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]

StartDeploymentRequestRequestTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

jobId

• Type: typing.Optional[str]

sourceUrl

• Type: typing.Optional[str]

StartDeploymentResultTypeDef

jobSummary

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

StartJobRequestRequestTypeDef

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]

StartJobResultTypeDef

jobSummary

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

StepTypeDef

stepName

• Type:
• Required: Yes

startTime

• Type:
• Required: Yes

status

• Type: typing.Literal['CANCELLED', 'CANCELLING', '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]

StopJobRequestRequestTypeDef

appId

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

jobId

• Type:
• Required: Yes

StopJobResultTypeDef

jobSummary

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

SubDomainSettingTypeDef

prefix

• Type:
• Required: Yes

branchName

• Type:
• Required: Yes

SubDomainTypeDef

subDomainSetting

• Type:
• Required: Yes

verified

• Type:
• Required: Yes

dnsRecord

• Type:
• Required: Yes

TagResourceRequestRequestTypeDef

resourceArn

• Type:
• Required: Yes

tags

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

UntagResourceRequestRequestTypeDef

resourceArn

• Type:
• Required: Yes

tagKeys

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

UpdateAppRequestRequestTypeDef

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']]

iamServiceRoleArn

• Type: typing.Optional[str]

environmentVariables

• Type: typing.Optional[typing.Mapping[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.Sequence[aws_resource_validator.pydantic_models.amplify_classes.CustomRuleTypeDef]]

buildSpec

• Type: typing.Optional[str]

customHeaders

• Type: typing.Optional[str]

enableAutoBranchCreation

• Type: typing.Optional[bool]

autoBranchCreationPatterns

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

autoBranchCreationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.amplify_classes.AutoBranchCreationConfigTypeDef]

repository

• Type: typing.Optional[str]

oauthToken

• Type: typing.Optional[str]

accessToken

• Type: typing.Optional[str]

UpdateAppResultTypeDef

app

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UpdateBranchRequestRequestTypeDef

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.Mapping[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_classes.BackendTypeDef]

UpdateBranchResultTypeDef

branch

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UpdateDomainAssociationRequestRequestTypeDef

appId

• Type:
• Required: Yes

domainName

• Type:
• Required: Yes

enableAutoSubDomain

• Type: typing.Optional[bool]

subDomainSettings

• Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.amplify_classes.SubDomainSettingTypeDef]]

autoSubDomainCreationPatterns

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

autoSubDomainIAMRole

• Type: typing.Optional[str]

certificateSettings

• Type: typing.Optional[aws_resource_validator.pydantic_models.amplify_classes.CertificateSettingsTypeDef]

UpdateDomainAssociationResultTypeDef

domainAssociation

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UpdateWebhookRequestRequestTypeDef

webhookId

• Type:
• Required: Yes

branchName

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

UpdateWebhookResultTypeDef

webhook

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

WebhookTypeDef

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