Type definitions#
Auto-generated documentation for Amplify type annotations stubs module types-boto3-amplify.
TimestampTypeDef#
# TimestampTypeDef Union usage example
from types_boto3_amplify.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AutoBranchCreationConfigUnionTypeDef#
# AutoBranchCreationConfigUnionTypeDef Union usage example
from types_boto3_amplify.type_defs import AutoBranchCreationConfigUnionTypeDef
def get_value() -> AutoBranchCreationConfigUnionTypeDef:
return ...
# AutoBranchCreationConfigUnionTypeDef definition
AutoBranchCreationConfigUnionTypeDef = Union[
AutoBranchCreationConfigTypeDef, # (1)
AutoBranchCreationConfigOutputTypeDef, # (2)
]
AutoBranchCreationConfigOutputTypeDef#
# AutoBranchCreationConfigOutputTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import AutoBranchCreationConfigOutputTypeDef
def get_value() -> AutoBranchCreationConfigOutputTypeDef:
return {
"stage": ...,
}
# AutoBranchCreationConfigOutputTypeDef definition
class AutoBranchCreationConfigOutputTypeDef(TypedDict):
stage: NotRequired[StageType], # (1)
framework: NotRequired[str],
enableAutoBuild: NotRequired[bool],
environmentVariables: NotRequired[Dict[str, str]],
basicAuthCredentials: NotRequired[str],
enableBasicAuth: NotRequired[bool],
enablePerformanceMode: NotRequired[bool],
buildSpec: NotRequired[str],
enablePullRequestPreview: NotRequired[bool],
pullRequestEnvironmentName: NotRequired[str],
- See StageType
CacheConfigTypeDef#
# CacheConfigTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CacheConfigTypeDef
def get_value() -> CacheConfigTypeDef:
return {
"type": ...,
}
# CacheConfigTypeDef definition
class CacheConfigTypeDef(TypedDict):
type: CacheConfigTypeType, # (1)
CustomRuleTypeDef#
# CustomRuleTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CustomRuleTypeDef
def get_value() -> CustomRuleTypeDef:
return {
"source": ...,
}
# CustomRuleTypeDef definition
class CustomRuleTypeDef(TypedDict):
source: str,
target: str,
status: NotRequired[str],
condition: NotRequired[str],
ProductionBranchTypeDef#
# ProductionBranchTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ProductionBranchTypeDef
def get_value() -> ProductionBranchTypeDef:
return {
"lastDeployTime": ...,
}
# ProductionBranchTypeDef definition
class ProductionBranchTypeDef(TypedDict):
lastDeployTime: NotRequired[datetime],
status: NotRequired[str],
thumbnailUrl: NotRequired[str],
branchName: NotRequired[str],
WafConfigurationTypeDef#
# WafConfigurationTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import WafConfigurationTypeDef
def get_value() -> WafConfigurationTypeDef:
return {
"webAclArn": ...,
}
# WafConfigurationTypeDef definition
class WafConfigurationTypeDef(TypedDict):
webAclArn: NotRequired[str],
wafStatus: NotRequired[WafStatusType], # (1)
statusReason: NotRequired[str],
- See WafStatusType
ArtifactTypeDef#
# ArtifactTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ArtifactTypeDef
def get_value() -> ArtifactTypeDef:
return {
"artifactFileName": ...,
}
# ArtifactTypeDef definition
class ArtifactTypeDef(TypedDict):
artifactFileName: str,
artifactId: str,
AutoBranchCreationConfigTypeDef#
# AutoBranchCreationConfigTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import AutoBranchCreationConfigTypeDef
def get_value() -> AutoBranchCreationConfigTypeDef:
return {
"stage": ...,
}
# AutoBranchCreationConfigTypeDef definition
class AutoBranchCreationConfigTypeDef(TypedDict):
stage: NotRequired[StageType], # (1)
framework: NotRequired[str],
enableAutoBuild: NotRequired[bool],
environmentVariables: NotRequired[Mapping[str, str]],
basicAuthCredentials: NotRequired[str],
enableBasicAuth: NotRequired[bool],
enablePerformanceMode: NotRequired[bool],
buildSpec: NotRequired[str],
enablePullRequestPreview: NotRequired[bool],
pullRequestEnvironmentName: NotRequired[str],
- See StageType
BackendEnvironmentTypeDef#
# BackendEnvironmentTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import BackendEnvironmentTypeDef
def get_value() -> BackendEnvironmentTypeDef:
return {
"backendEnvironmentArn": ...,
}
# BackendEnvironmentTypeDef definition
class BackendEnvironmentTypeDef(TypedDict):
backendEnvironmentArn: str,
environmentName: str,
createTime: datetime,
updateTime: datetime,
stackName: NotRequired[str],
deploymentArtifacts: NotRequired[str],
BackendTypeDef#
# BackendTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import BackendTypeDef
def get_value() -> BackendTypeDef:
return {
"stackArn": ...,
}
# BackendTypeDef definition
class BackendTypeDef(TypedDict):
stackArn: NotRequired[str],
CertificateSettingsTypeDef#
# CertificateSettingsTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CertificateSettingsTypeDef
def get_value() -> CertificateSettingsTypeDef:
return {
"type": ...,
}
# CertificateSettingsTypeDef definition
class CertificateSettingsTypeDef(TypedDict):
type: CertificateTypeType, # (1)
customCertificateArn: NotRequired[str],
CertificateTypeDef#
# CertificateTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CertificateTypeDef
def get_value() -> CertificateTypeDef:
return {
"type": ...,
}
# CertificateTypeDef definition
class CertificateTypeDef(TypedDict):
type: CertificateTypeType, # (1)
customCertificateArn: NotRequired[str],
certificateVerificationDNSRecord: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
CreateBackendEnvironmentRequestTypeDef#
# CreateBackendEnvironmentRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateBackendEnvironmentRequestTypeDef
def get_value() -> CreateBackendEnvironmentRequestTypeDef:
return {
"appId": ...,
}
# CreateBackendEnvironmentRequestTypeDef definition
class CreateBackendEnvironmentRequestTypeDef(TypedDict):
appId: str,
environmentName: str,
stackName: NotRequired[str],
deploymentArtifacts: NotRequired[str],
CreateDeploymentRequestTypeDef#
# CreateDeploymentRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateDeploymentRequestTypeDef
def get_value() -> CreateDeploymentRequestTypeDef:
return {
"appId": ...,
}
# CreateDeploymentRequestTypeDef definition
class CreateDeploymentRequestTypeDef(TypedDict):
appId: str,
branchName: str,
fileMap: NotRequired[Mapping[str, str]],
SubDomainSettingTypeDef#
# SubDomainSettingTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import SubDomainSettingTypeDef
def get_value() -> SubDomainSettingTypeDef:
return {
"prefix": ...,
}
# SubDomainSettingTypeDef definition
class SubDomainSettingTypeDef(TypedDict):
prefix: str,
branchName: str,
CreateWebhookRequestTypeDef#
# CreateWebhookRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateWebhookRequestTypeDef
def get_value() -> CreateWebhookRequestTypeDef:
return {
"appId": ...,
}
# CreateWebhookRequestTypeDef definition
class CreateWebhookRequestTypeDef(TypedDict):
appId: str,
branchName: str,
description: NotRequired[str],
WebhookTypeDef#
# WebhookTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import WebhookTypeDef
def get_value() -> WebhookTypeDef:
return {
"webhookArn": ...,
}
# WebhookTypeDef definition
class WebhookTypeDef(TypedDict):
webhookArn: str,
webhookId: str,
webhookUrl: str,
branchName: str,
description: str,
createTime: datetime,
updateTime: datetime,
DeleteAppRequestTypeDef#
# DeleteAppRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteAppRequestTypeDef
def get_value() -> DeleteAppRequestTypeDef:
return {
"appId": ...,
}
# DeleteAppRequestTypeDef definition
class DeleteAppRequestTypeDef(TypedDict):
appId: str,
DeleteBackendEnvironmentRequestTypeDef#
# DeleteBackendEnvironmentRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteBackendEnvironmentRequestTypeDef
def get_value() -> DeleteBackendEnvironmentRequestTypeDef:
return {
"appId": ...,
}
# DeleteBackendEnvironmentRequestTypeDef definition
class DeleteBackendEnvironmentRequestTypeDef(TypedDict):
appId: str,
environmentName: str,
DeleteBranchRequestTypeDef#
# DeleteBranchRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteBranchRequestTypeDef
def get_value() -> DeleteBranchRequestTypeDef:
return {
"appId": ...,
}
# DeleteBranchRequestTypeDef definition
class DeleteBranchRequestTypeDef(TypedDict):
appId: str,
branchName: str,
DeleteDomainAssociationRequestTypeDef#
# DeleteDomainAssociationRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteDomainAssociationRequestTypeDef
def get_value() -> DeleteDomainAssociationRequestTypeDef:
return {
"appId": ...,
}
# DeleteDomainAssociationRequestTypeDef definition
class DeleteDomainAssociationRequestTypeDef(TypedDict):
appId: str,
domainName: str,
DeleteJobRequestTypeDef#
# DeleteJobRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteJobRequestTypeDef
def get_value() -> DeleteJobRequestTypeDef:
return {
"appId": ...,
}
# DeleteJobRequestTypeDef definition
class DeleteJobRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobId: str,
JobSummaryTypeDef#
# JobSummaryTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import JobSummaryTypeDef
def get_value() -> JobSummaryTypeDef:
return {
"jobArn": ...,
}
# JobSummaryTypeDef definition
class JobSummaryTypeDef(TypedDict):
jobArn: str,
jobId: str,
commitId: str,
commitMessage: str,
commitTime: datetime,
startTime: datetime,
status: JobStatusType, # (1)
jobType: JobTypeType, # (2)
endTime: NotRequired[datetime],
sourceUrl: NotRequired[str],
sourceUrlType: NotRequired[SourceUrlTypeType], # (3)
- See JobStatusType
- See JobTypeType
- See SourceUrlTypeType
DeleteWebhookRequestTypeDef#
# DeleteWebhookRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteWebhookRequestTypeDef
def get_value() -> DeleteWebhookRequestTypeDef:
return {
"webhookId": ...,
}
# DeleteWebhookRequestTypeDef definition
class DeleteWebhookRequestTypeDef(TypedDict):
webhookId: str,
GetAppRequestTypeDef#
# GetAppRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetAppRequestTypeDef
def get_value() -> GetAppRequestTypeDef:
return {
"appId": ...,
}
# GetAppRequestTypeDef definition
class GetAppRequestTypeDef(TypedDict):
appId: str,
GetArtifactUrlRequestTypeDef#
# GetArtifactUrlRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetArtifactUrlRequestTypeDef
def get_value() -> GetArtifactUrlRequestTypeDef:
return {
"artifactId": ...,
}
# GetArtifactUrlRequestTypeDef definition
class GetArtifactUrlRequestTypeDef(TypedDict):
artifactId: str,
GetBackendEnvironmentRequestTypeDef#
# GetBackendEnvironmentRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetBackendEnvironmentRequestTypeDef
def get_value() -> GetBackendEnvironmentRequestTypeDef:
return {
"appId": ...,
}
# GetBackendEnvironmentRequestTypeDef definition
class GetBackendEnvironmentRequestTypeDef(TypedDict):
appId: str,
environmentName: str,
GetBranchRequestTypeDef#
# GetBranchRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetBranchRequestTypeDef
def get_value() -> GetBranchRequestTypeDef:
return {
"appId": ...,
}
# GetBranchRequestTypeDef definition
class GetBranchRequestTypeDef(TypedDict):
appId: str,
branchName: str,
GetDomainAssociationRequestTypeDef#
# GetDomainAssociationRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetDomainAssociationRequestTypeDef
def get_value() -> GetDomainAssociationRequestTypeDef:
return {
"appId": ...,
}
# GetDomainAssociationRequestTypeDef definition
class GetDomainAssociationRequestTypeDef(TypedDict):
appId: str,
domainName: str,
GetJobRequestTypeDef#
# GetJobRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetJobRequestTypeDef
def get_value() -> GetJobRequestTypeDef:
return {
"appId": ...,
}
# GetJobRequestTypeDef definition
class GetJobRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobId: str,
GetWebhookRequestTypeDef#
# GetWebhookRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetWebhookRequestTypeDef
def get_value() -> GetWebhookRequestTypeDef:
return {
"webhookId": ...,
}
# GetWebhookRequestTypeDef definition
class GetWebhookRequestTypeDef(TypedDict):
webhookId: str,
StepTypeDef#
# StepTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import StepTypeDef
def get_value() -> StepTypeDef:
return {
"stepName": ...,
}
# StepTypeDef definition
class StepTypeDef(TypedDict):
stepName: str,
startTime: datetime,
status: JobStatusType, # (1)
endTime: datetime,
logUrl: NotRequired[str],
artifactsUrl: NotRequired[str],
testArtifactsUrl: NotRequired[str],
testConfigUrl: NotRequired[str],
screenshots: NotRequired[Dict[str, str]],
statusReason: NotRequired[str],
context: NotRequired[str],
- See JobStatusType
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListAppsRequestTypeDef#
# ListAppsRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListAppsRequestTypeDef
def get_value() -> ListAppsRequestTypeDef:
return {
"nextToken": ...,
}
# ListAppsRequestTypeDef definition
class ListAppsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListArtifactsRequestTypeDef#
# ListArtifactsRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListArtifactsRequestTypeDef
def get_value() -> ListArtifactsRequestTypeDef:
return {
"appId": ...,
}
# ListArtifactsRequestTypeDef definition
class ListArtifactsRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListBackendEnvironmentsRequestTypeDef#
# ListBackendEnvironmentsRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListBackendEnvironmentsRequestTypeDef
def get_value() -> ListBackendEnvironmentsRequestTypeDef:
return {
"appId": ...,
}
# ListBackendEnvironmentsRequestTypeDef definition
class ListBackendEnvironmentsRequestTypeDef(TypedDict):
appId: str,
environmentName: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListBranchesRequestTypeDef#
# ListBranchesRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListBranchesRequestTypeDef
def get_value() -> ListBranchesRequestTypeDef:
return {
"appId": ...,
}
# ListBranchesRequestTypeDef definition
class ListBranchesRequestTypeDef(TypedDict):
appId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDomainAssociationsRequestTypeDef#
# ListDomainAssociationsRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListDomainAssociationsRequestTypeDef
def get_value() -> ListDomainAssociationsRequestTypeDef:
return {
"appId": ...,
}
# ListDomainAssociationsRequestTypeDef definition
class ListDomainAssociationsRequestTypeDef(TypedDict):
appId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListJobsRequestTypeDef#
# ListJobsRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListJobsRequestTypeDef
def get_value() -> ListJobsRequestTypeDef:
return {
"appId": ...,
}
# ListJobsRequestTypeDef definition
class ListJobsRequestTypeDef(TypedDict):
appId: str,
branchName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
resourceArn: str,
ListWebhooksRequestTypeDef#
# ListWebhooksRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListWebhooksRequestTypeDef
def get_value() -> ListWebhooksRequestTypeDef:
return {
"appId": ...,
}
# ListWebhooksRequestTypeDef definition
class ListWebhooksRequestTypeDef(TypedDict):
appId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
StartDeploymentRequestTypeDef#
# StartDeploymentRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import StartDeploymentRequestTypeDef
def get_value() -> StartDeploymentRequestTypeDef:
return {
"appId": ...,
}
# StartDeploymentRequestTypeDef definition
class StartDeploymentRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobId: NotRequired[str],
sourceUrl: NotRequired[str],
sourceUrlType: NotRequired[SourceUrlTypeType], # (1)
StopJobRequestTypeDef#
# StopJobRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import StopJobRequestTypeDef
def get_value() -> StopJobRequestTypeDef:
return {
"appId": ...,
}
# StopJobRequestTypeDef definition
class StopJobRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobId: str,
TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateWebhookRequestTypeDef#
# UpdateWebhookRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import UpdateWebhookRequestTypeDef
def get_value() -> UpdateWebhookRequestTypeDef:
return {
"webhookId": ...,
}
# UpdateWebhookRequestTypeDef definition
class UpdateWebhookRequestTypeDef(TypedDict):
webhookId: str,
branchName: NotRequired[str],
description: NotRequired[str],
AppTypeDef#
# AppTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import AppTypeDef
def get_value() -> AppTypeDef:
return {
"appId": ...,
}
# AppTypeDef definition
class AppTypeDef(TypedDict):
appId: str,
appArn: str,
name: str,
description: str,
repository: str,
platform: PlatformType, # (1)
createTime: datetime,
updateTime: datetime,
environmentVariables: Dict[str, str],
defaultDomain: str,
enableBranchAutoBuild: bool,
enableBasicAuth: bool,
tags: NotRequired[Dict[str, str]],
computeRoleArn: NotRequired[str],
iamServiceRoleArn: NotRequired[str],
enableBranchAutoDeletion: NotRequired[bool],
basicAuthCredentials: NotRequired[str],
customRules: NotRequired[List[CustomRuleTypeDef]], # (2)
productionBranch: NotRequired[ProductionBranchTypeDef], # (3)
buildSpec: NotRequired[str],
customHeaders: NotRequired[str],
enableAutoBranchCreation: NotRequired[bool],
autoBranchCreationPatterns: NotRequired[List[str]],
autoBranchCreationConfig: NotRequired[AutoBranchCreationConfigOutputTypeDef], # (4)
repositoryCloneMethod: NotRequired[RepositoryCloneMethodType], # (5)
cacheConfig: NotRequired[CacheConfigTypeDef], # (6)
webhookCreateTime: NotRequired[datetime],
wafConfiguration: NotRequired[WafConfigurationTypeDef], # (7)
- See PlatformType
- See CustomRuleTypeDef
- See ProductionBranchTypeDef
- See AutoBranchCreationConfigOutputTypeDef
- See RepositoryCloneMethodType
- See CacheConfigTypeDef
- See WafConfigurationTypeDef
BranchTypeDef#
# BranchTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import BranchTypeDef
def get_value() -> BranchTypeDef:
return {
"branchArn": ...,
}
# BranchTypeDef definition
class BranchTypeDef(TypedDict):
branchArn: str,
branchName: str,
description: str,
stage: StageType, # (1)
displayName: str,
enableNotification: bool,
createTime: datetime,
updateTime: datetime,
environmentVariables: Dict[str, str],
enableAutoBuild: bool,
customDomains: List[str],
framework: str,
activeJobId: str,
totalNumberOfJobs: str,
enableBasicAuth: bool,
ttl: str,
enablePullRequestPreview: bool,
tags: NotRequired[Dict[str, str]],
enablePerformanceMode: NotRequired[bool],
thumbnailUrl: NotRequired[str],
basicAuthCredentials: NotRequired[str],
buildSpec: NotRequired[str],
associatedResources: NotRequired[List[str]],
pullRequestEnvironmentName: NotRequired[str],
destinationBranch: NotRequired[str],
sourceBranch: NotRequired[str],
backendEnvironmentArn: NotRequired[str],
backend: NotRequired[BackendTypeDef], # (2)
computeRoleArn: NotRequired[str],
- See StageType
- See BackendTypeDef
CreateBranchRequestTypeDef#
# CreateBranchRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateBranchRequestTypeDef
def get_value() -> CreateBranchRequestTypeDef:
return {
"appId": ...,
}
# CreateBranchRequestTypeDef definition
class CreateBranchRequestTypeDef(TypedDict):
appId: str,
branchName: str,
description: NotRequired[str],
stage: NotRequired[StageType], # (1)
framework: NotRequired[str],
enableNotification: NotRequired[bool],
enableAutoBuild: NotRequired[bool],
environmentVariables: NotRequired[Mapping[str, str]],
basicAuthCredentials: NotRequired[str],
enableBasicAuth: NotRequired[bool],
enablePerformanceMode: NotRequired[bool],
tags: NotRequired[Mapping[str, str]],
buildSpec: NotRequired[str],
ttl: NotRequired[str],
displayName: NotRequired[str],
enablePullRequestPreview: NotRequired[bool],
pullRequestEnvironmentName: NotRequired[str],
backendEnvironmentArn: NotRequired[str],
backend: NotRequired[BackendTypeDef], # (2)
computeRoleArn: NotRequired[str],
- See StageType
- See BackendTypeDef
UpdateBranchRequestTypeDef#
# UpdateBranchRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import UpdateBranchRequestTypeDef
def get_value() -> UpdateBranchRequestTypeDef:
return {
"appId": ...,
}
# UpdateBranchRequestTypeDef definition
class UpdateBranchRequestTypeDef(TypedDict):
appId: str,
branchName: str,
description: NotRequired[str],
framework: NotRequired[str],
stage: NotRequired[StageType], # (1)
enableNotification: NotRequired[bool],
enableAutoBuild: NotRequired[bool],
environmentVariables: NotRequired[Mapping[str, str]],
basicAuthCredentials: NotRequired[str],
enableBasicAuth: NotRequired[bool],
enablePerformanceMode: NotRequired[bool],
buildSpec: NotRequired[str],
ttl: NotRequired[str],
displayName: NotRequired[str],
enablePullRequestPreview: NotRequired[bool],
pullRequestEnvironmentName: NotRequired[str],
backendEnvironmentArn: NotRequired[str],
backend: NotRequired[BackendTypeDef], # (2)
computeRoleArn: NotRequired[str],
- See StageType
- See BackendTypeDef
CreateBackendEnvironmentResultTypeDef#
# CreateBackendEnvironmentResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateBackendEnvironmentResultTypeDef
def get_value() -> CreateBackendEnvironmentResultTypeDef:
return {
"backendEnvironment": ...,
}
# CreateBackendEnvironmentResultTypeDef definition
class CreateBackendEnvironmentResultTypeDef(TypedDict):
backendEnvironment: BackendEnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDeploymentResultTypeDef#
# CreateDeploymentResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateDeploymentResultTypeDef
def get_value() -> CreateDeploymentResultTypeDef:
return {
"jobId": ...,
}
# CreateDeploymentResultTypeDef definition
class CreateDeploymentResultTypeDef(TypedDict):
jobId: str,
fileUploadUrls: Dict[str, str],
zipUploadUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackendEnvironmentResultTypeDef#
# DeleteBackendEnvironmentResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteBackendEnvironmentResultTypeDef
def get_value() -> DeleteBackendEnvironmentResultTypeDef:
return {
"backendEnvironment": ...,
}
# DeleteBackendEnvironmentResultTypeDef definition
class DeleteBackendEnvironmentResultTypeDef(TypedDict):
backendEnvironment: BackendEnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GenerateAccessLogsResultTypeDef#
# GenerateAccessLogsResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GenerateAccessLogsResultTypeDef
def get_value() -> GenerateAccessLogsResultTypeDef:
return {
"logUrl": ...,
}
# GenerateAccessLogsResultTypeDef definition
class GenerateAccessLogsResultTypeDef(TypedDict):
logUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetArtifactUrlResultTypeDef#
# GetArtifactUrlResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetArtifactUrlResultTypeDef
def get_value() -> GetArtifactUrlResultTypeDef:
return {
"artifactId": ...,
}
# GetArtifactUrlResultTypeDef definition
class GetArtifactUrlResultTypeDef(TypedDict):
artifactId: str,
artifactUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetBackendEnvironmentResultTypeDef#
# GetBackendEnvironmentResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetBackendEnvironmentResultTypeDef
def get_value() -> GetBackendEnvironmentResultTypeDef:
return {
"backendEnvironment": ...,
}
# GetBackendEnvironmentResultTypeDef definition
class GetBackendEnvironmentResultTypeDef(TypedDict):
backendEnvironment: BackendEnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListArtifactsResultTypeDef#
# ListArtifactsResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListArtifactsResultTypeDef
def get_value() -> ListArtifactsResultTypeDef:
return {
"artifacts": ...,
}
# ListArtifactsResultTypeDef definition
class ListArtifactsResultTypeDef(TypedDict):
artifacts: List[ArtifactTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListBackendEnvironmentsResultTypeDef#
# ListBackendEnvironmentsResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListBackendEnvironmentsResultTypeDef
def get_value() -> ListBackendEnvironmentsResultTypeDef:
return {
"backendEnvironments": ...,
}
# ListBackendEnvironmentsResultTypeDef definition
class ListBackendEnvironmentsResultTypeDef(TypedDict):
backendEnvironments: List[BackendEnvironmentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDomainAssociationRequestTypeDef#
# CreateDomainAssociationRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateDomainAssociationRequestTypeDef
def get_value() -> CreateDomainAssociationRequestTypeDef:
return {
"appId": ...,
}
# CreateDomainAssociationRequestTypeDef definition
class CreateDomainAssociationRequestTypeDef(TypedDict):
appId: str,
domainName: str,
subDomainSettings: Sequence[SubDomainSettingTypeDef], # (1)
enableAutoSubDomain: NotRequired[bool],
autoSubDomainCreationPatterns: NotRequired[Sequence[str]],
autoSubDomainIAMRole: NotRequired[str],
certificateSettings: NotRequired[CertificateSettingsTypeDef], # (2)
SubDomainTypeDef#
# SubDomainTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import SubDomainTypeDef
def get_value() -> SubDomainTypeDef:
return {
"subDomainSetting": ...,
}
# SubDomainTypeDef definition
class SubDomainTypeDef(TypedDict):
subDomainSetting: SubDomainSettingTypeDef, # (1)
verified: bool,
dnsRecord: str,
UpdateDomainAssociationRequestTypeDef#
# UpdateDomainAssociationRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import UpdateDomainAssociationRequestTypeDef
def get_value() -> UpdateDomainAssociationRequestTypeDef:
return {
"appId": ...,
}
# UpdateDomainAssociationRequestTypeDef definition
class UpdateDomainAssociationRequestTypeDef(TypedDict):
appId: str,
domainName: str,
enableAutoSubDomain: NotRequired[bool],
subDomainSettings: NotRequired[Sequence[SubDomainSettingTypeDef]], # (1)
autoSubDomainCreationPatterns: NotRequired[Sequence[str]],
autoSubDomainIAMRole: NotRequired[str],
certificateSettings: NotRequired[CertificateSettingsTypeDef], # (2)
CreateWebhookResultTypeDef#
# CreateWebhookResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateWebhookResultTypeDef
def get_value() -> CreateWebhookResultTypeDef:
return {
"webhook": ...,
}
# CreateWebhookResultTypeDef definition
class CreateWebhookResultTypeDef(TypedDict):
webhook: WebhookTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteWebhookResultTypeDef#
# DeleteWebhookResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteWebhookResultTypeDef
def get_value() -> DeleteWebhookResultTypeDef:
return {
"webhook": ...,
}
# DeleteWebhookResultTypeDef definition
class DeleteWebhookResultTypeDef(TypedDict):
webhook: WebhookTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetWebhookResultTypeDef#
# GetWebhookResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetWebhookResultTypeDef
def get_value() -> GetWebhookResultTypeDef:
return {
"webhook": ...,
}
# GetWebhookResultTypeDef definition
class GetWebhookResultTypeDef(TypedDict):
webhook: WebhookTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListWebhooksResultTypeDef#
# ListWebhooksResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListWebhooksResultTypeDef
def get_value() -> ListWebhooksResultTypeDef:
return {
"webhooks": ...,
}
# ListWebhooksResultTypeDef definition
class ListWebhooksResultTypeDef(TypedDict):
webhooks: List[WebhookTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
UpdateWebhookResultTypeDef#
# UpdateWebhookResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import UpdateWebhookResultTypeDef
def get_value() -> UpdateWebhookResultTypeDef:
return {
"webhook": ...,
}
# UpdateWebhookResultTypeDef definition
class UpdateWebhookResultTypeDef(TypedDict):
webhook: WebhookTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteJobResultTypeDef#
# DeleteJobResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteJobResultTypeDef
def get_value() -> DeleteJobResultTypeDef:
return {
"jobSummary": ...,
}
# DeleteJobResultTypeDef definition
class DeleteJobResultTypeDef(TypedDict):
jobSummary: JobSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListJobsResultTypeDef#
# ListJobsResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListJobsResultTypeDef
def get_value() -> ListJobsResultTypeDef:
return {
"jobSummaries": ...,
}
# ListJobsResultTypeDef definition
class ListJobsResultTypeDef(TypedDict):
jobSummaries: List[JobSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
StartDeploymentResultTypeDef#
# StartDeploymentResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import StartDeploymentResultTypeDef
def get_value() -> StartDeploymentResultTypeDef:
return {
"jobSummary": ...,
}
# StartDeploymentResultTypeDef definition
class StartDeploymentResultTypeDef(TypedDict):
jobSummary: JobSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartJobResultTypeDef#
# StartJobResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import StartJobResultTypeDef
def get_value() -> StartJobResultTypeDef:
return {
"jobSummary": ...,
}
# StartJobResultTypeDef definition
class StartJobResultTypeDef(TypedDict):
jobSummary: JobSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopJobResultTypeDef#
# StopJobResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import StopJobResultTypeDef
def get_value() -> StopJobResultTypeDef:
return {
"jobSummary": ...,
}
# StopJobResultTypeDef definition
class StopJobResultTypeDef(TypedDict):
jobSummary: JobSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GenerateAccessLogsRequestTypeDef#
# GenerateAccessLogsRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GenerateAccessLogsRequestTypeDef
def get_value() -> GenerateAccessLogsRequestTypeDef:
return {
"domainName": ...,
}
# GenerateAccessLogsRequestTypeDef definition
class GenerateAccessLogsRequestTypeDef(TypedDict):
domainName: str,
appId: str,
startTime: NotRequired[TimestampTypeDef],
endTime: NotRequired[TimestampTypeDef],
StartJobRequestTypeDef#
# StartJobRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import StartJobRequestTypeDef
def get_value() -> StartJobRequestTypeDef:
return {
"appId": ...,
}
# StartJobRequestTypeDef definition
class StartJobRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobType: JobTypeType, # (1)
jobId: NotRequired[str],
jobReason: NotRequired[str],
commitId: NotRequired[str],
commitMessage: NotRequired[str],
commitTime: NotRequired[TimestampTypeDef],
- See JobTypeType
JobTypeDef#
# JobTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import JobTypeDef
def get_value() -> JobTypeDef:
return {
"summary": ...,
}
# JobTypeDef definition
class JobTypeDef(TypedDict):
summary: JobSummaryTypeDef, # (1)
steps: List[StepTypeDef], # (2)
- See JobSummaryTypeDef
- See StepTypeDef
ListAppsRequestPaginateTypeDef#
# ListAppsRequestPaginateTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListAppsRequestPaginateTypeDef
def get_value() -> ListAppsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListAppsRequestPaginateTypeDef definition
class ListAppsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListBranchesRequestPaginateTypeDef#
# ListBranchesRequestPaginateTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListBranchesRequestPaginateTypeDef
def get_value() -> ListBranchesRequestPaginateTypeDef:
return {
"appId": ...,
}
# ListBranchesRequestPaginateTypeDef definition
class ListBranchesRequestPaginateTypeDef(TypedDict):
appId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDomainAssociationsRequestPaginateTypeDef#
# ListDomainAssociationsRequestPaginateTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListDomainAssociationsRequestPaginateTypeDef
def get_value() -> ListDomainAssociationsRequestPaginateTypeDef:
return {
"appId": ...,
}
# ListDomainAssociationsRequestPaginateTypeDef definition
class ListDomainAssociationsRequestPaginateTypeDef(TypedDict):
appId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListJobsRequestPaginateTypeDef#
# ListJobsRequestPaginateTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListJobsRequestPaginateTypeDef
def get_value() -> ListJobsRequestPaginateTypeDef:
return {
"appId": ...,
}
# ListJobsRequestPaginateTypeDef definition
class ListJobsRequestPaginateTypeDef(TypedDict):
appId: str,
branchName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
CreateAppResultTypeDef#
# CreateAppResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateAppResultTypeDef
def get_value() -> CreateAppResultTypeDef:
return {
"app": ...,
}
# CreateAppResultTypeDef definition
class CreateAppResultTypeDef(TypedDict):
app: AppTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AppTypeDef
- See ResponseMetadataTypeDef
DeleteAppResultTypeDef#
# DeleteAppResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteAppResultTypeDef
def get_value() -> DeleteAppResultTypeDef:
return {
"app": ...,
}
# DeleteAppResultTypeDef definition
class DeleteAppResultTypeDef(TypedDict):
app: AppTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AppTypeDef
- See ResponseMetadataTypeDef
GetAppResultTypeDef#
# GetAppResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetAppResultTypeDef
def get_value() -> GetAppResultTypeDef:
return {
"app": ...,
}
# GetAppResultTypeDef definition
class GetAppResultTypeDef(TypedDict):
app: AppTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AppTypeDef
- See ResponseMetadataTypeDef
ListAppsResultTypeDef#
# ListAppsResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListAppsResultTypeDef
def get_value() -> ListAppsResultTypeDef:
return {
"apps": ...,
}
# ListAppsResultTypeDef definition
class ListAppsResultTypeDef(TypedDict):
apps: List[AppTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See AppTypeDef
- See ResponseMetadataTypeDef
UpdateAppResultTypeDef#
# UpdateAppResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import UpdateAppResultTypeDef
def get_value() -> UpdateAppResultTypeDef:
return {
"app": ...,
}
# UpdateAppResultTypeDef definition
class UpdateAppResultTypeDef(TypedDict):
app: AppTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AppTypeDef
- See ResponseMetadataTypeDef
CreateAppRequestTypeDef#
# CreateAppRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateAppRequestTypeDef
def get_value() -> CreateAppRequestTypeDef:
return {
"name": ...,
}
# CreateAppRequestTypeDef definition
class CreateAppRequestTypeDef(TypedDict):
name: str,
description: NotRequired[str],
repository: NotRequired[str],
platform: NotRequired[PlatformType], # (1)
computeRoleArn: NotRequired[str],
iamServiceRoleArn: NotRequired[str],
oauthToken: NotRequired[str],
accessToken: NotRequired[str],
environmentVariables: NotRequired[Mapping[str, str]],
enableBranchAutoBuild: NotRequired[bool],
enableBranchAutoDeletion: NotRequired[bool],
enableBasicAuth: NotRequired[bool],
basicAuthCredentials: NotRequired[str],
customRules: NotRequired[Sequence[CustomRuleTypeDef]], # (2)
tags: NotRequired[Mapping[str, str]],
buildSpec: NotRequired[str],
customHeaders: NotRequired[str],
enableAutoBranchCreation: NotRequired[bool],
autoBranchCreationPatterns: NotRequired[Sequence[str]],
autoBranchCreationConfig: NotRequired[AutoBranchCreationConfigUnionTypeDef], # (3)
cacheConfig: NotRequired[CacheConfigTypeDef], # (4)
- See PlatformType
- See CustomRuleTypeDef
- See AutoBranchCreationConfigTypeDef AutoBranchCreationConfigOutputTypeDef
- See CacheConfigTypeDef
UpdateAppRequestTypeDef#
# UpdateAppRequestTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import UpdateAppRequestTypeDef
def get_value() -> UpdateAppRequestTypeDef:
return {
"appId": ...,
}
# UpdateAppRequestTypeDef definition
class UpdateAppRequestTypeDef(TypedDict):
appId: str,
name: NotRequired[str],
description: NotRequired[str],
platform: NotRequired[PlatformType], # (1)
computeRoleArn: NotRequired[str],
iamServiceRoleArn: NotRequired[str],
environmentVariables: NotRequired[Mapping[str, str]],
enableBranchAutoBuild: NotRequired[bool],
enableBranchAutoDeletion: NotRequired[bool],
enableBasicAuth: NotRequired[bool],
basicAuthCredentials: NotRequired[str],
customRules: NotRequired[Sequence[CustomRuleTypeDef]], # (2)
buildSpec: NotRequired[str],
customHeaders: NotRequired[str],
enableAutoBranchCreation: NotRequired[bool],
autoBranchCreationPatterns: NotRequired[Sequence[str]],
autoBranchCreationConfig: NotRequired[AutoBranchCreationConfigUnionTypeDef], # (3)
repository: NotRequired[str],
oauthToken: NotRequired[str],
accessToken: NotRequired[str],
cacheConfig: NotRequired[CacheConfigTypeDef], # (4)
- See PlatformType
- See CustomRuleTypeDef
- See AutoBranchCreationConfigTypeDef AutoBranchCreationConfigOutputTypeDef
- See CacheConfigTypeDef
CreateBranchResultTypeDef#
# CreateBranchResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateBranchResultTypeDef
def get_value() -> CreateBranchResultTypeDef:
return {
"branch": ...,
}
# CreateBranchResultTypeDef definition
class CreateBranchResultTypeDef(TypedDict):
branch: BranchTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BranchTypeDef
- See ResponseMetadataTypeDef
DeleteBranchResultTypeDef#
# DeleteBranchResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteBranchResultTypeDef
def get_value() -> DeleteBranchResultTypeDef:
return {
"branch": ...,
}
# DeleteBranchResultTypeDef definition
class DeleteBranchResultTypeDef(TypedDict):
branch: BranchTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BranchTypeDef
- See ResponseMetadataTypeDef
GetBranchResultTypeDef#
# GetBranchResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetBranchResultTypeDef
def get_value() -> GetBranchResultTypeDef:
return {
"branch": ...,
}
# GetBranchResultTypeDef definition
class GetBranchResultTypeDef(TypedDict):
branch: BranchTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BranchTypeDef
- See ResponseMetadataTypeDef
ListBranchesResultTypeDef#
# ListBranchesResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListBranchesResultTypeDef
def get_value() -> ListBranchesResultTypeDef:
return {
"branches": ...,
}
# ListBranchesResultTypeDef definition
class ListBranchesResultTypeDef(TypedDict):
branches: List[BranchTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See BranchTypeDef
- See ResponseMetadataTypeDef
UpdateBranchResultTypeDef#
# UpdateBranchResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import UpdateBranchResultTypeDef
def get_value() -> UpdateBranchResultTypeDef:
return {
"branch": ...,
}
# UpdateBranchResultTypeDef definition
class UpdateBranchResultTypeDef(TypedDict):
branch: BranchTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BranchTypeDef
- See ResponseMetadataTypeDef
DomainAssociationTypeDef#
# DomainAssociationTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DomainAssociationTypeDef
def get_value() -> DomainAssociationTypeDef:
return {
"domainAssociationArn": ...,
}
# DomainAssociationTypeDef definition
class DomainAssociationTypeDef(TypedDict):
domainAssociationArn: str,
domainName: str,
enableAutoSubDomain: bool,
domainStatus: DomainStatusType, # (1)
statusReason: str,
subDomains: List[SubDomainTypeDef], # (3)
autoSubDomainCreationPatterns: NotRequired[List[str]],
autoSubDomainIAMRole: NotRequired[str],
updateStatus: NotRequired[UpdateStatusType], # (2)
certificateVerificationDNSRecord: NotRequired[str],
certificate: NotRequired[CertificateTypeDef], # (4)
- See DomainStatusType
- See UpdateStatusType
- See SubDomainTypeDef
- See CertificateTypeDef
GetJobResultTypeDef#
# GetJobResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetJobResultTypeDef
def get_value() -> GetJobResultTypeDef:
return {
"job": ...,
}
# GetJobResultTypeDef definition
class GetJobResultTypeDef(TypedDict):
job: JobTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobTypeDef
- See ResponseMetadataTypeDef
CreateDomainAssociationResultTypeDef#
# CreateDomainAssociationResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import CreateDomainAssociationResultTypeDef
def get_value() -> CreateDomainAssociationResultTypeDef:
return {
"domainAssociation": ...,
}
# CreateDomainAssociationResultTypeDef definition
class CreateDomainAssociationResultTypeDef(TypedDict):
domainAssociation: DomainAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteDomainAssociationResultTypeDef#
# DeleteDomainAssociationResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import DeleteDomainAssociationResultTypeDef
def get_value() -> DeleteDomainAssociationResultTypeDef:
return {
"domainAssociation": ...,
}
# DeleteDomainAssociationResultTypeDef definition
class DeleteDomainAssociationResultTypeDef(TypedDict):
domainAssociation: DomainAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDomainAssociationResultTypeDef#
# GetDomainAssociationResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import GetDomainAssociationResultTypeDef
def get_value() -> GetDomainAssociationResultTypeDef:
return {
"domainAssociation": ...,
}
# GetDomainAssociationResultTypeDef definition
class GetDomainAssociationResultTypeDef(TypedDict):
domainAssociation: DomainAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDomainAssociationsResultTypeDef#
# ListDomainAssociationsResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import ListDomainAssociationsResultTypeDef
def get_value() -> ListDomainAssociationsResultTypeDef:
return {
"domainAssociations": ...,
}
# ListDomainAssociationsResultTypeDef definition
class ListDomainAssociationsResultTypeDef(TypedDict):
domainAssociations: List[DomainAssociationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
UpdateDomainAssociationResultTypeDef#
# UpdateDomainAssociationResultTypeDef TypedDict usage example
from types_boto3_amplify.type_defs import UpdateDomainAssociationResultTypeDef
def get_value() -> UpdateDomainAssociationResultTypeDef:
return {
"domainAssociation": ...,
}
# UpdateDomainAssociationResultTypeDef definition
class UpdateDomainAssociationResultTypeDef(TypedDict):
domainAssociation: DomainAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)