Typed dictionaries#
Auto-generated documentation for Amplify type annotations stubs module mypy-boto3-amplify.
AutoBranchCreationConfigTypeDef#
# AutoBranchCreationConfigTypeDef usage example
from mypy_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
CustomRuleTypeDef#
# CustomRuleTypeDef usage example
from mypy_boto3_amplify.type_defs import CustomRuleTypeDef
def get_value() -> CustomRuleTypeDef:
return {
"source": ...,
"target": ...,
}
# CustomRuleTypeDef definition
class CustomRuleTypeDef(TypedDict):
source: str,
target: str,
status: NotRequired[str],
condition: NotRequired[str],
ProductionBranchTypeDef#
# ProductionBranchTypeDef usage example
from mypy_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],
ArtifactTypeDef#
# ArtifactTypeDef usage example
from mypy_boto3_amplify.type_defs import ArtifactTypeDef
def get_value() -> ArtifactTypeDef:
return {
"artifactFileName": ...,
"artifactId": ...,
}
# ArtifactTypeDef definition
class ArtifactTypeDef(TypedDict):
artifactFileName: str,
artifactId: str,
BackendEnvironmentTypeDef#
# BackendEnvironmentTypeDef usage example
from mypy_boto3_amplify.type_defs import BackendEnvironmentTypeDef
def get_value() -> BackendEnvironmentTypeDef:
return {
"backendEnvironmentArn": ...,
"environmentName": ...,
"createTime": ...,
"updateTime": ...,
}
# BackendEnvironmentTypeDef definition
class BackendEnvironmentTypeDef(TypedDict):
backendEnvironmentArn: str,
environmentName: str,
createTime: datetime,
updateTime: datetime,
stackName: NotRequired[str],
deploymentArtifacts: NotRequired[str],
BranchTypeDef#
# BranchTypeDef usage example
from mypy_boto3_amplify.type_defs import BranchTypeDef
def get_value() -> BranchTypeDef:
return {
"branchArn": ...,
"branchName": ...,
"description": ...,
"stage": ...,
"displayName": ...,
"enableNotification": ...,
"createTime": ...,
"updateTime": ...,
"environmentVariables": ...,
"enableAutoBuild": ...,
"customDomains": ...,
"framework": ...,
"activeJobId": ...,
"totalNumberOfJobs": ...,
"enableBasicAuth": ...,
"ttl": ...,
"enablePullRequestPreview": ...,
}
# 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],
- See StageType
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_amplify.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CreateBackendEnvironmentRequestRequestTypeDef#
# CreateBackendEnvironmentRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateBackendEnvironmentRequestRequestTypeDef
def get_value() -> CreateBackendEnvironmentRequestRequestTypeDef:
return {
"appId": ...,
"environmentName": ...,
}
# CreateBackendEnvironmentRequestRequestTypeDef definition
class CreateBackendEnvironmentRequestRequestTypeDef(TypedDict):
appId: str,
environmentName: str,
stackName: NotRequired[str],
deploymentArtifacts: NotRequired[str],
CreateBranchRequestRequestTypeDef#
# CreateBranchRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateBranchRequestRequestTypeDef
def get_value() -> CreateBranchRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
}
# CreateBranchRequestRequestTypeDef definition
class CreateBranchRequestRequestTypeDef(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],
- See StageType
CreateDeploymentRequestRequestTypeDef#
# CreateDeploymentRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateDeploymentRequestRequestTypeDef
def get_value() -> CreateDeploymentRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
}
# CreateDeploymentRequestRequestTypeDef definition
class CreateDeploymentRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
fileMap: NotRequired[Mapping[str, str]],
SubDomainSettingTypeDef#
# SubDomainSettingTypeDef usage example
from mypy_boto3_amplify.type_defs import SubDomainSettingTypeDef
def get_value() -> SubDomainSettingTypeDef:
return {
"prefix": ...,
"branchName": ...,
}
# SubDomainSettingTypeDef definition
class SubDomainSettingTypeDef(TypedDict):
prefix: str,
branchName: str,
CreateWebhookRequestRequestTypeDef#
# CreateWebhookRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateWebhookRequestRequestTypeDef
def get_value() -> CreateWebhookRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
}
# CreateWebhookRequestRequestTypeDef definition
class CreateWebhookRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
description: NotRequired[str],
WebhookTypeDef#
# WebhookTypeDef usage example
from mypy_boto3_amplify.type_defs import WebhookTypeDef
def get_value() -> WebhookTypeDef:
return {
"webhookArn": ...,
"webhookId": ...,
"webhookUrl": ...,
"branchName": ...,
"description": ...,
"createTime": ...,
"updateTime": ...,
}
# WebhookTypeDef definition
class WebhookTypeDef(TypedDict):
webhookArn: str,
webhookId: str,
webhookUrl: str,
branchName: str,
description: str,
createTime: datetime,
updateTime: datetime,
DeleteAppRequestRequestTypeDef#
# DeleteAppRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteAppRequestRequestTypeDef
def get_value() -> DeleteAppRequestRequestTypeDef:
return {
"appId": ...,
}
# DeleteAppRequestRequestTypeDef definition
class DeleteAppRequestRequestTypeDef(TypedDict):
appId: str,
DeleteBackendEnvironmentRequestRequestTypeDef#
# DeleteBackendEnvironmentRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteBackendEnvironmentRequestRequestTypeDef
def get_value() -> DeleteBackendEnvironmentRequestRequestTypeDef:
return {
"appId": ...,
"environmentName": ...,
}
# DeleteBackendEnvironmentRequestRequestTypeDef definition
class DeleteBackendEnvironmentRequestRequestTypeDef(TypedDict):
appId: str,
environmentName: str,
DeleteBranchRequestRequestTypeDef#
# DeleteBranchRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteBranchRequestRequestTypeDef
def get_value() -> DeleteBranchRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
}
# DeleteBranchRequestRequestTypeDef definition
class DeleteBranchRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
DeleteDomainAssociationRequestRequestTypeDef#
# DeleteDomainAssociationRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteDomainAssociationRequestRequestTypeDef
def get_value() -> DeleteDomainAssociationRequestRequestTypeDef:
return {
"appId": ...,
"domainName": ...,
}
# DeleteDomainAssociationRequestRequestTypeDef definition
class DeleteDomainAssociationRequestRequestTypeDef(TypedDict):
appId: str,
domainName: str,
DeleteJobRequestRequestTypeDef#
# DeleteJobRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteJobRequestRequestTypeDef
def get_value() -> DeleteJobRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
"jobId": ...,
}
# DeleteJobRequestRequestTypeDef definition
class DeleteJobRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobId: str,
JobSummaryTypeDef#
# JobSummaryTypeDef usage example
from mypy_boto3_amplify.type_defs import JobSummaryTypeDef
def get_value() -> JobSummaryTypeDef:
return {
"jobArn": ...,
"jobId": ...,
"commitId": ...,
"commitMessage": ...,
"commitTime": ...,
"startTime": ...,
"status": ...,
"jobType": ...,
}
# 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],
- See JobStatusType
- See JobTypeType
DeleteWebhookRequestRequestTypeDef#
# DeleteWebhookRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteWebhookRequestRequestTypeDef
def get_value() -> DeleteWebhookRequestRequestTypeDef:
return {
"webhookId": ...,
}
# DeleteWebhookRequestRequestTypeDef definition
class DeleteWebhookRequestRequestTypeDef(TypedDict):
webhookId: str,
GenerateAccessLogsRequestRequestTypeDef#
# GenerateAccessLogsRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import GenerateAccessLogsRequestRequestTypeDef
def get_value() -> GenerateAccessLogsRequestRequestTypeDef:
return {
"domainName": ...,
"appId": ...,
}
# GenerateAccessLogsRequestRequestTypeDef definition
class GenerateAccessLogsRequestRequestTypeDef(TypedDict):
domainName: str,
appId: str,
startTime: NotRequired[Union[datetime, str]],
endTime: NotRequired[Union[datetime, str]],
GetAppRequestRequestTypeDef#
# GetAppRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import GetAppRequestRequestTypeDef
def get_value() -> GetAppRequestRequestTypeDef:
return {
"appId": ...,
}
# GetAppRequestRequestTypeDef definition
class GetAppRequestRequestTypeDef(TypedDict):
appId: str,
GetArtifactUrlRequestRequestTypeDef#
# GetArtifactUrlRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import GetArtifactUrlRequestRequestTypeDef
def get_value() -> GetArtifactUrlRequestRequestTypeDef:
return {
"artifactId": ...,
}
# GetArtifactUrlRequestRequestTypeDef definition
class GetArtifactUrlRequestRequestTypeDef(TypedDict):
artifactId: str,
GetBackendEnvironmentRequestRequestTypeDef#
# GetBackendEnvironmentRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import GetBackendEnvironmentRequestRequestTypeDef
def get_value() -> GetBackendEnvironmentRequestRequestTypeDef:
return {
"appId": ...,
"environmentName": ...,
}
# GetBackendEnvironmentRequestRequestTypeDef definition
class GetBackendEnvironmentRequestRequestTypeDef(TypedDict):
appId: str,
environmentName: str,
GetBranchRequestRequestTypeDef#
# GetBranchRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import GetBranchRequestRequestTypeDef
def get_value() -> GetBranchRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
}
# GetBranchRequestRequestTypeDef definition
class GetBranchRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
GetDomainAssociationRequestRequestTypeDef#
# GetDomainAssociationRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import GetDomainAssociationRequestRequestTypeDef
def get_value() -> GetDomainAssociationRequestRequestTypeDef:
return {
"appId": ...,
"domainName": ...,
}
# GetDomainAssociationRequestRequestTypeDef definition
class GetDomainAssociationRequestRequestTypeDef(TypedDict):
appId: str,
domainName: str,
GetJobRequestRequestTypeDef#
# GetJobRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import GetJobRequestRequestTypeDef
def get_value() -> GetJobRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
"jobId": ...,
}
# GetJobRequestRequestTypeDef definition
class GetJobRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobId: str,
GetWebhookRequestRequestTypeDef#
# GetWebhookRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import GetWebhookRequestRequestTypeDef
def get_value() -> GetWebhookRequestRequestTypeDef:
return {
"webhookId": ...,
}
# GetWebhookRequestRequestTypeDef definition
class GetWebhookRequestRequestTypeDef(TypedDict):
webhookId: str,
StepTypeDef#
# StepTypeDef usage example
from mypy_boto3_amplify.type_defs import StepTypeDef
def get_value() -> StepTypeDef:
return {
"stepName": ...,
"startTime": ...,
"status": ...,
"endTime": ...,
}
# 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 usage example
from mypy_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],
ListAppsRequestRequestTypeDef#
# ListAppsRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import ListAppsRequestRequestTypeDef
def get_value() -> ListAppsRequestRequestTypeDef:
return {
"nextToken": ...,
}
# ListAppsRequestRequestTypeDef definition
class ListAppsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListArtifactsRequestRequestTypeDef#
# ListArtifactsRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import ListArtifactsRequestRequestTypeDef
def get_value() -> ListArtifactsRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
"jobId": ...,
}
# ListArtifactsRequestRequestTypeDef definition
class ListArtifactsRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListBackendEnvironmentsRequestRequestTypeDef#
# ListBackendEnvironmentsRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import ListBackendEnvironmentsRequestRequestTypeDef
def get_value() -> ListBackendEnvironmentsRequestRequestTypeDef:
return {
"appId": ...,
}
# ListBackendEnvironmentsRequestRequestTypeDef definition
class ListBackendEnvironmentsRequestRequestTypeDef(TypedDict):
appId: str,
environmentName: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListBranchesRequestRequestTypeDef#
# ListBranchesRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import ListBranchesRequestRequestTypeDef
def get_value() -> ListBranchesRequestRequestTypeDef:
return {
"appId": ...,
}
# ListBranchesRequestRequestTypeDef definition
class ListBranchesRequestRequestTypeDef(TypedDict):
appId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDomainAssociationsRequestRequestTypeDef#
# ListDomainAssociationsRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import ListDomainAssociationsRequestRequestTypeDef
def get_value() -> ListDomainAssociationsRequestRequestTypeDef:
return {
"appId": ...,
}
# ListDomainAssociationsRequestRequestTypeDef definition
class ListDomainAssociationsRequestRequestTypeDef(TypedDict):
appId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListJobsRequestRequestTypeDef#
# ListJobsRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import ListJobsRequestRequestTypeDef
def get_value() -> ListJobsRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
}
# ListJobsRequestRequestTypeDef definition
class ListJobsRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
ListWebhooksRequestRequestTypeDef#
# ListWebhooksRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import ListWebhooksRequestRequestTypeDef
def get_value() -> ListWebhooksRequestRequestTypeDef:
return {
"appId": ...,
}
# ListWebhooksRequestRequestTypeDef definition
class ListWebhooksRequestRequestTypeDef(TypedDict):
appId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
StartDeploymentRequestRequestTypeDef#
# StartDeploymentRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import StartDeploymentRequestRequestTypeDef
def get_value() -> StartDeploymentRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
}
# StartDeploymentRequestRequestTypeDef definition
class StartDeploymentRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobId: NotRequired[str],
sourceUrl: NotRequired[str],
StartJobRequestRequestTypeDef#
# StartJobRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import StartJobRequestRequestTypeDef
def get_value() -> StartJobRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
"jobType": ...,
}
# StartJobRequestRequestTypeDef definition
class StartJobRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobType: JobTypeType, # (1)
jobId: NotRequired[str],
jobReason: NotRequired[str],
commitId: NotRequired[str],
commitMessage: NotRequired[str],
commitTime: NotRequired[Union[datetime, str]],
- See JobTypeType
StopJobRequestRequestTypeDef#
# StopJobRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import StopJobRequestRequestTypeDef
def get_value() -> StopJobRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
"jobId": ...,
}
# StopJobRequestRequestTypeDef definition
class StopJobRequestRequestTypeDef(TypedDict):
appId: str,
branchName: str,
jobId: str,
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateBranchRequestRequestTypeDef#
# UpdateBranchRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import UpdateBranchRequestRequestTypeDef
def get_value() -> UpdateBranchRequestRequestTypeDef:
return {
"appId": ...,
"branchName": ...,
}
# UpdateBranchRequestRequestTypeDef definition
class UpdateBranchRequestRequestTypeDef(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],
- See StageType
UpdateWebhookRequestRequestTypeDef#
# UpdateWebhookRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import UpdateWebhookRequestRequestTypeDef
def get_value() -> UpdateWebhookRequestRequestTypeDef:
return {
"webhookId": ...,
}
# UpdateWebhookRequestRequestTypeDef definition
class UpdateWebhookRequestRequestTypeDef(TypedDict):
webhookId: str,
branchName: NotRequired[str],
description: NotRequired[str],
CreateAppRequestRequestTypeDef#
# CreateAppRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateAppRequestRequestTypeDef
def get_value() -> CreateAppRequestRequestTypeDef:
return {
"name": ...,
}
# CreateAppRequestRequestTypeDef definition
class CreateAppRequestRequestTypeDef(TypedDict):
name: str,
description: NotRequired[str],
repository: NotRequired[str],
platform: NotRequired[PlatformType], # (1)
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[AutoBranchCreationConfigTypeDef], # (3)
UpdateAppRequestRequestTypeDef#
# UpdateAppRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import UpdateAppRequestRequestTypeDef
def get_value() -> UpdateAppRequestRequestTypeDef:
return {
"appId": ...,
}
# UpdateAppRequestRequestTypeDef definition
class UpdateAppRequestRequestTypeDef(TypedDict):
appId: str,
name: NotRequired[str],
description: NotRequired[str],
platform: NotRequired[PlatformType], # (1)
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[AutoBranchCreationConfigTypeDef], # (3)
repository: NotRequired[str],
oauthToken: NotRequired[str],
accessToken: NotRequired[str],
AppTypeDef#
# AppTypeDef usage example
from mypy_boto3_amplify.type_defs import AppTypeDef
def get_value() -> AppTypeDef:
return {
"appId": ...,
"appArn": ...,
"name": ...,
"description": ...,
"repository": ...,
"platform": ...,
"createTime": ...,
"updateTime": ...,
"environmentVariables": ...,
"defaultDomain": ...,
"enableBranchAutoBuild": ...,
"enableBasicAuth": ...,
}
# 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]],
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[AutoBranchCreationConfigTypeDef], # (4)
repositoryCloneMethod: NotRequired[RepositoryCloneMethodType], # (5)
- See PlatformType
- See CustomRuleTypeDef
- See ProductionBranchTypeDef
- See AutoBranchCreationConfigTypeDef
- See RepositoryCloneMethodType
CreateBackendEnvironmentResultTypeDef#
# CreateBackendEnvironmentResultTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateBackendEnvironmentResultTypeDef
def get_value() -> CreateBackendEnvironmentResultTypeDef:
return {
"backendEnvironment": ...,
"ResponseMetadata": ...,
}
# CreateBackendEnvironmentResultTypeDef definition
class CreateBackendEnvironmentResultTypeDef(TypedDict):
backendEnvironment: BackendEnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateBranchResultTypeDef#
# CreateBranchResultTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateBranchResultTypeDef
def get_value() -> CreateBranchResultTypeDef:
return {
"branch": ...,
"ResponseMetadata": ...,
}
# CreateBranchResultTypeDef definition
class CreateBranchResultTypeDef(TypedDict):
branch: BranchTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BranchTypeDef
- See ResponseMetadataTypeDef
CreateDeploymentResultTypeDef#
# CreateDeploymentResultTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateDeploymentResultTypeDef
def get_value() -> CreateDeploymentResultTypeDef:
return {
"jobId": ...,
"fileUploadUrls": ...,
"zipUploadUrl": ...,
"ResponseMetadata": ...,
}
# CreateDeploymentResultTypeDef definition
class CreateDeploymentResultTypeDef(TypedDict):
jobId: str,
fileUploadUrls: Dict[str, str],
zipUploadUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackendEnvironmentResultTypeDef#
# DeleteBackendEnvironmentResultTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteBackendEnvironmentResultTypeDef
def get_value() -> DeleteBackendEnvironmentResultTypeDef:
return {
"backendEnvironment": ...,
"ResponseMetadata": ...,
}
# DeleteBackendEnvironmentResultTypeDef definition
class DeleteBackendEnvironmentResultTypeDef(TypedDict):
backendEnvironment: BackendEnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteBranchResultTypeDef#
# DeleteBranchResultTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteBranchResultTypeDef
def get_value() -> DeleteBranchResultTypeDef:
return {
"branch": ...,
"ResponseMetadata": ...,
}
# DeleteBranchResultTypeDef definition
class DeleteBranchResultTypeDef(TypedDict):
branch: BranchTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BranchTypeDef
- See ResponseMetadataTypeDef
GenerateAccessLogsResultTypeDef#
# GenerateAccessLogsResultTypeDef usage example
from mypy_boto3_amplify.type_defs import GenerateAccessLogsResultTypeDef
def get_value() -> GenerateAccessLogsResultTypeDef:
return {
"logUrl": ...,
"ResponseMetadata": ...,
}
# GenerateAccessLogsResultTypeDef definition
class GenerateAccessLogsResultTypeDef(TypedDict):
logUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetArtifactUrlResultTypeDef#
# GetArtifactUrlResultTypeDef usage example
from mypy_boto3_amplify.type_defs import GetArtifactUrlResultTypeDef
def get_value() -> GetArtifactUrlResultTypeDef:
return {
"artifactId": ...,
"artifactUrl": ...,
"ResponseMetadata": ...,
}
# GetArtifactUrlResultTypeDef definition
class GetArtifactUrlResultTypeDef(TypedDict):
artifactId: str,
artifactUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetBackendEnvironmentResultTypeDef#
# GetBackendEnvironmentResultTypeDef usage example
from mypy_boto3_amplify.type_defs import GetBackendEnvironmentResultTypeDef
def get_value() -> GetBackendEnvironmentResultTypeDef:
return {
"backendEnvironment": ...,
"ResponseMetadata": ...,
}
# GetBackendEnvironmentResultTypeDef definition
class GetBackendEnvironmentResultTypeDef(TypedDict):
backendEnvironment: BackendEnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetBranchResultTypeDef#
# GetBranchResultTypeDef usage example
from mypy_boto3_amplify.type_defs import GetBranchResultTypeDef
def get_value() -> GetBranchResultTypeDef:
return {
"branch": ...,
"ResponseMetadata": ...,
}
# GetBranchResultTypeDef definition
class GetBranchResultTypeDef(TypedDict):
branch: BranchTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BranchTypeDef
- See ResponseMetadataTypeDef
ListArtifactsResultTypeDef#
# ListArtifactsResultTypeDef usage example
from mypy_boto3_amplify.type_defs import ListArtifactsResultTypeDef
def get_value() -> ListArtifactsResultTypeDef:
return {
"artifacts": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListArtifactsResultTypeDef definition
class ListArtifactsResultTypeDef(TypedDict):
artifacts: List[ArtifactTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBackendEnvironmentsResultTypeDef#
# ListBackendEnvironmentsResultTypeDef usage example
from mypy_boto3_amplify.type_defs import ListBackendEnvironmentsResultTypeDef
def get_value() -> ListBackendEnvironmentsResultTypeDef:
return {
"backendEnvironments": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListBackendEnvironmentsResultTypeDef definition
class ListBackendEnvironmentsResultTypeDef(TypedDict):
backendEnvironments: List[BackendEnvironmentTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBranchesResultTypeDef#
# ListBranchesResultTypeDef usage example
from mypy_boto3_amplify.type_defs import ListBranchesResultTypeDef
def get_value() -> ListBranchesResultTypeDef:
return {
"branches": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListBranchesResultTypeDef definition
class ListBranchesResultTypeDef(TypedDict):
branches: List[BranchTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BranchTypeDef
- See ResponseMetadataTypeDef
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_amplify.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBranchResultTypeDef#
# UpdateBranchResultTypeDef usage example
from mypy_boto3_amplify.type_defs import UpdateBranchResultTypeDef
def get_value() -> UpdateBranchResultTypeDef:
return {
"branch": ...,
"ResponseMetadata": ...,
}
# UpdateBranchResultTypeDef definition
class UpdateBranchResultTypeDef(TypedDict):
branch: BranchTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BranchTypeDef
- See ResponseMetadataTypeDef
CreateDomainAssociationRequestRequestTypeDef#
# CreateDomainAssociationRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateDomainAssociationRequestRequestTypeDef
def get_value() -> CreateDomainAssociationRequestRequestTypeDef:
return {
"appId": ...,
"domainName": ...,
"subDomainSettings": ...,
}
# CreateDomainAssociationRequestRequestTypeDef definition
class CreateDomainAssociationRequestRequestTypeDef(TypedDict):
appId: str,
domainName: str,
subDomainSettings: Sequence[SubDomainSettingTypeDef], # (1)
enableAutoSubDomain: NotRequired[bool],
autoSubDomainCreationPatterns: NotRequired[Sequence[str]],
autoSubDomainIAMRole: NotRequired[str],
SubDomainTypeDef#
# SubDomainTypeDef usage example
from mypy_boto3_amplify.type_defs import SubDomainTypeDef
def get_value() -> SubDomainTypeDef:
return {
"subDomainSetting": ...,
"verified": ...,
"dnsRecord": ...,
}
# SubDomainTypeDef definition
class SubDomainTypeDef(TypedDict):
subDomainSetting: SubDomainSettingTypeDef, # (1)
verified: bool,
dnsRecord: str,
UpdateDomainAssociationRequestRequestTypeDef#
# UpdateDomainAssociationRequestRequestTypeDef usage example
from mypy_boto3_amplify.type_defs import UpdateDomainAssociationRequestRequestTypeDef
def get_value() -> UpdateDomainAssociationRequestRequestTypeDef:
return {
"appId": ...,
"domainName": ...,
}
# UpdateDomainAssociationRequestRequestTypeDef definition
class UpdateDomainAssociationRequestRequestTypeDef(TypedDict):
appId: str,
domainName: str,
enableAutoSubDomain: NotRequired[bool],
subDomainSettings: NotRequired[Sequence[SubDomainSettingTypeDef]], # (1)
autoSubDomainCreationPatterns: NotRequired[Sequence[str]],
autoSubDomainIAMRole: NotRequired[str],
CreateWebhookResultTypeDef#
# CreateWebhookResultTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateWebhookResultTypeDef
def get_value() -> CreateWebhookResultTypeDef:
return {
"webhook": ...,
"ResponseMetadata": ...,
}
# CreateWebhookResultTypeDef definition
class CreateWebhookResultTypeDef(TypedDict):
webhook: WebhookTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteWebhookResultTypeDef#
# DeleteWebhookResultTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteWebhookResultTypeDef
def get_value() -> DeleteWebhookResultTypeDef:
return {
"webhook": ...,
"ResponseMetadata": ...,
}
# DeleteWebhookResultTypeDef definition
class DeleteWebhookResultTypeDef(TypedDict):
webhook: WebhookTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetWebhookResultTypeDef#
# GetWebhookResultTypeDef usage example
from mypy_boto3_amplify.type_defs import GetWebhookResultTypeDef
def get_value() -> GetWebhookResultTypeDef:
return {
"webhook": ...,
"ResponseMetadata": ...,
}
# GetWebhookResultTypeDef definition
class GetWebhookResultTypeDef(TypedDict):
webhook: WebhookTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListWebhooksResultTypeDef#
# ListWebhooksResultTypeDef usage example
from mypy_boto3_amplify.type_defs import ListWebhooksResultTypeDef
def get_value() -> ListWebhooksResultTypeDef:
return {
"webhooks": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListWebhooksResultTypeDef definition
class ListWebhooksResultTypeDef(TypedDict):
webhooks: List[WebhookTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateWebhookResultTypeDef#
# UpdateWebhookResultTypeDef usage example
from mypy_boto3_amplify.type_defs import UpdateWebhookResultTypeDef
def get_value() -> UpdateWebhookResultTypeDef:
return {
"webhook": ...,
"ResponseMetadata": ...,
}
# UpdateWebhookResultTypeDef definition
class UpdateWebhookResultTypeDef(TypedDict):
webhook: WebhookTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteJobResultTypeDef#
# DeleteJobResultTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteJobResultTypeDef
def get_value() -> DeleteJobResultTypeDef:
return {
"jobSummary": ...,
"ResponseMetadata": ...,
}
# DeleteJobResultTypeDef definition
class DeleteJobResultTypeDef(TypedDict):
jobSummary: JobSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListJobsResultTypeDef#
# ListJobsResultTypeDef usage example
from mypy_boto3_amplify.type_defs import ListJobsResultTypeDef
def get_value() -> ListJobsResultTypeDef:
return {
"jobSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListJobsResultTypeDef definition
class ListJobsResultTypeDef(TypedDict):
jobSummaries: List[JobSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartDeploymentResultTypeDef#
# StartDeploymentResultTypeDef usage example
from mypy_boto3_amplify.type_defs import StartDeploymentResultTypeDef
def get_value() -> StartDeploymentResultTypeDef:
return {
"jobSummary": ...,
"ResponseMetadata": ...,
}
# StartDeploymentResultTypeDef definition
class StartDeploymentResultTypeDef(TypedDict):
jobSummary: JobSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartJobResultTypeDef#
# StartJobResultTypeDef usage example
from mypy_boto3_amplify.type_defs import StartJobResultTypeDef
def get_value() -> StartJobResultTypeDef:
return {
"jobSummary": ...,
"ResponseMetadata": ...,
}
# StartJobResultTypeDef definition
class StartJobResultTypeDef(TypedDict):
jobSummary: JobSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopJobResultTypeDef#
# StopJobResultTypeDef usage example
from mypy_boto3_amplify.type_defs import StopJobResultTypeDef
def get_value() -> StopJobResultTypeDef:
return {
"jobSummary": ...,
"ResponseMetadata": ...,
}
# StopJobResultTypeDef definition
class StopJobResultTypeDef(TypedDict):
jobSummary: JobSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
JobTypeDef#
# JobTypeDef usage example
from mypy_boto3_amplify.type_defs import JobTypeDef
def get_value() -> JobTypeDef:
return {
"summary": ...,
"steps": ...,
}
# JobTypeDef definition
class JobTypeDef(TypedDict):
summary: JobSummaryTypeDef, # (1)
steps: List[StepTypeDef], # (2)
- See JobSummaryTypeDef
- See StepTypeDef
ListAppsRequestListAppsPaginateTypeDef#
# ListAppsRequestListAppsPaginateTypeDef usage example
from mypy_boto3_amplify.type_defs import ListAppsRequestListAppsPaginateTypeDef
def get_value() -> ListAppsRequestListAppsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListAppsRequestListAppsPaginateTypeDef definition
class ListAppsRequestListAppsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListBranchesRequestListBranchesPaginateTypeDef#
# ListBranchesRequestListBranchesPaginateTypeDef usage example
from mypy_boto3_amplify.type_defs import ListBranchesRequestListBranchesPaginateTypeDef
def get_value() -> ListBranchesRequestListBranchesPaginateTypeDef:
return {
"appId": ...,
}
# ListBranchesRequestListBranchesPaginateTypeDef definition
class ListBranchesRequestListBranchesPaginateTypeDef(TypedDict):
appId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDomainAssociationsRequestListDomainAssociationsPaginateTypeDef#
# ListDomainAssociationsRequestListDomainAssociationsPaginateTypeDef usage example
from mypy_boto3_amplify.type_defs import ListDomainAssociationsRequestListDomainAssociationsPaginateTypeDef
def get_value() -> ListDomainAssociationsRequestListDomainAssociationsPaginateTypeDef:
return {
"appId": ...,
}
# ListDomainAssociationsRequestListDomainAssociationsPaginateTypeDef definition
class ListDomainAssociationsRequestListDomainAssociationsPaginateTypeDef(TypedDict):
appId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListJobsRequestListJobsPaginateTypeDef#
# ListJobsRequestListJobsPaginateTypeDef usage example
from mypy_boto3_amplify.type_defs import ListJobsRequestListJobsPaginateTypeDef
def get_value() -> ListJobsRequestListJobsPaginateTypeDef:
return {
"appId": ...,
"branchName": ...,
}
# ListJobsRequestListJobsPaginateTypeDef definition
class ListJobsRequestListJobsPaginateTypeDef(TypedDict):
appId: str,
branchName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
CreateAppResultTypeDef#
# CreateAppResultTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateAppResultTypeDef
def get_value() -> CreateAppResultTypeDef:
return {
"app": ...,
"ResponseMetadata": ...,
}
# CreateAppResultTypeDef definition
class CreateAppResultTypeDef(TypedDict):
app: AppTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AppTypeDef
- See ResponseMetadataTypeDef
DeleteAppResultTypeDef#
# DeleteAppResultTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteAppResultTypeDef
def get_value() -> DeleteAppResultTypeDef:
return {
"app": ...,
"ResponseMetadata": ...,
}
# DeleteAppResultTypeDef definition
class DeleteAppResultTypeDef(TypedDict):
app: AppTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AppTypeDef
- See ResponseMetadataTypeDef
GetAppResultTypeDef#
# GetAppResultTypeDef usage example
from mypy_boto3_amplify.type_defs import GetAppResultTypeDef
def get_value() -> GetAppResultTypeDef:
return {
"app": ...,
"ResponseMetadata": ...,
}
# GetAppResultTypeDef definition
class GetAppResultTypeDef(TypedDict):
app: AppTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AppTypeDef
- See ResponseMetadataTypeDef
ListAppsResultTypeDef#
# ListAppsResultTypeDef usage example
from mypy_boto3_amplify.type_defs import ListAppsResultTypeDef
def get_value() -> ListAppsResultTypeDef:
return {
"apps": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListAppsResultTypeDef definition
class ListAppsResultTypeDef(TypedDict):
apps: List[AppTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AppTypeDef
- See ResponseMetadataTypeDef
UpdateAppResultTypeDef#
# UpdateAppResultTypeDef usage example
from mypy_boto3_amplify.type_defs import UpdateAppResultTypeDef
def get_value() -> UpdateAppResultTypeDef:
return {
"app": ...,
"ResponseMetadata": ...,
}
# UpdateAppResultTypeDef definition
class UpdateAppResultTypeDef(TypedDict):
app: AppTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AppTypeDef
- See ResponseMetadataTypeDef
DomainAssociationTypeDef#
# DomainAssociationTypeDef usage example
from mypy_boto3_amplify.type_defs import DomainAssociationTypeDef
def get_value() -> DomainAssociationTypeDef:
return {
"domainAssociationArn": ...,
"domainName": ...,
"enableAutoSubDomain": ...,
"domainStatus": ...,
"statusReason": ...,
"subDomains": ...,
}
# DomainAssociationTypeDef definition
class DomainAssociationTypeDef(TypedDict):
domainAssociationArn: str,
domainName: str,
enableAutoSubDomain: bool,
domainStatus: DomainStatusType, # (1)
statusReason: str,
subDomains: List[SubDomainTypeDef], # (2)
autoSubDomainCreationPatterns: NotRequired[List[str]],
autoSubDomainIAMRole: NotRequired[str],
certificateVerificationDNSRecord: NotRequired[str],
- See DomainStatusType
- See SubDomainTypeDef
GetJobResultTypeDef#
# GetJobResultTypeDef usage example
from mypy_boto3_amplify.type_defs import GetJobResultTypeDef
def get_value() -> GetJobResultTypeDef:
return {
"job": ...,
"ResponseMetadata": ...,
}
# GetJobResultTypeDef definition
class GetJobResultTypeDef(TypedDict):
job: JobTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobTypeDef
- See ResponseMetadataTypeDef
CreateDomainAssociationResultTypeDef#
# CreateDomainAssociationResultTypeDef usage example
from mypy_boto3_amplify.type_defs import CreateDomainAssociationResultTypeDef
def get_value() -> CreateDomainAssociationResultTypeDef:
return {
"domainAssociation": ...,
"ResponseMetadata": ...,
}
# CreateDomainAssociationResultTypeDef definition
class CreateDomainAssociationResultTypeDef(TypedDict):
domainAssociation: DomainAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteDomainAssociationResultTypeDef#
# DeleteDomainAssociationResultTypeDef usage example
from mypy_boto3_amplify.type_defs import DeleteDomainAssociationResultTypeDef
def get_value() -> DeleteDomainAssociationResultTypeDef:
return {
"domainAssociation": ...,
"ResponseMetadata": ...,
}
# DeleteDomainAssociationResultTypeDef definition
class DeleteDomainAssociationResultTypeDef(TypedDict):
domainAssociation: DomainAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDomainAssociationResultTypeDef#
# GetDomainAssociationResultTypeDef usage example
from mypy_boto3_amplify.type_defs import GetDomainAssociationResultTypeDef
def get_value() -> GetDomainAssociationResultTypeDef:
return {
"domainAssociation": ...,
"ResponseMetadata": ...,
}
# GetDomainAssociationResultTypeDef definition
class GetDomainAssociationResultTypeDef(TypedDict):
domainAssociation: DomainAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDomainAssociationsResultTypeDef#
# ListDomainAssociationsResultTypeDef usage example
from mypy_boto3_amplify.type_defs import ListDomainAssociationsResultTypeDef
def get_value() -> ListDomainAssociationsResultTypeDef:
return {
"domainAssociations": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListDomainAssociationsResultTypeDef definition
class ListDomainAssociationsResultTypeDef(TypedDict):
domainAssociations: List[DomainAssociationTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateDomainAssociationResultTypeDef#
# UpdateDomainAssociationResultTypeDef usage example
from mypy_boto3_amplify.type_defs import UpdateDomainAssociationResultTypeDef
def get_value() -> UpdateDomainAssociationResultTypeDef:
return {
"domainAssociation": ...,
"ResponseMetadata": ...,
}
# UpdateDomainAssociationResultTypeDef definition
class UpdateDomainAssociationResultTypeDef(TypedDict):
domainAssociation: DomainAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)