Skip to content

Type definitions#

Index > Amplify > Type definitions

Auto-generated documentation for Amplify type annotations stubs module mypy-boto3-amplify.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AutoBranchCreationConfigUnionTypeDef#

# AutoBranchCreationConfigUnionTypeDef definition

AutoBranchCreationConfigUnionTypeDef = Union[
    AutoBranchCreationConfigTypeDef,  # (1)
    AutoBranchCreationConfigExtraOutputTypeDef,  # (2)
]
  1. See AutoBranchCreationConfigTypeDef
  2. See AutoBranchCreationConfigExtraOutputTypeDef

AutoBranchCreationConfigOutputTypeDef#

# 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],
  1. See StageType

CustomRuleTypeDef#

# CustomRuleTypeDef definition

class CustomRuleTypeDef(TypedDict):
    source: str,
    target: str,
    status: NotRequired[str],
    condition: NotRequired[str],

ProductionBranchTypeDef#

# ProductionBranchTypeDef definition

class ProductionBranchTypeDef(TypedDict):
    lastDeployTime: NotRequired[datetime],
    status: NotRequired[str],
    thumbnailUrl: NotRequired[str],
    branchName: NotRequired[str],

ArtifactTypeDef#

# ArtifactTypeDef definition

class ArtifactTypeDef(TypedDict):
    artifactFileName: str,
    artifactId: str,

AutoBranchCreationConfigExtraOutputTypeDef#

# AutoBranchCreationConfigExtraOutputTypeDef definition

class AutoBranchCreationConfigExtraOutputTypeDef(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],
  1. See StageType

AutoBranchCreationConfigTypeDef#

# 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],
  1. See StageType

BackendEnvironmentTypeDef#

# BackendEnvironmentTypeDef definition

class BackendEnvironmentTypeDef(TypedDict):
    backendEnvironmentArn: str,
    environmentName: str,
    createTime: datetime,
    updateTime: datetime,
    stackName: NotRequired[str],
    deploymentArtifacts: NotRequired[str],

BackendTypeDef#

# BackendTypeDef definition

class BackendTypeDef(TypedDict):
    stackArn: NotRequired[str],

CertificateSettingsTypeDef#

# CertificateSettingsTypeDef definition

class CertificateSettingsTypeDef(TypedDict):
    type: CertificateTypeType,  # (1)
    customCertificateArn: NotRequired[str],
  1. See CertificateTypeType

CertificateTypeDef#

# CertificateTypeDef definition

class CertificateTypeDef(TypedDict):
    type: CertificateTypeType,  # (1)
    customCertificateArn: NotRequired[str],
    certificateVerificationDNSRecord: NotRequired[str],
  1. See CertificateTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateBackendEnvironmentRequestRequestTypeDef#

# CreateBackendEnvironmentRequestRequestTypeDef definition

class CreateBackendEnvironmentRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    stackName: NotRequired[str],
    deploymentArtifacts: NotRequired[str],

CreateDeploymentRequestRequestTypeDef#

# CreateDeploymentRequestRequestTypeDef definition

class CreateDeploymentRequestRequestTypeDef(TypedDict):
    appId: str,
    branchName: str,
    fileMap: NotRequired[Mapping[str, str]],

SubDomainSettingTypeDef#

# SubDomainSettingTypeDef definition

class SubDomainSettingTypeDef(TypedDict):
    prefix: str,
    branchName: str,

CreateWebhookRequestRequestTypeDef#

# CreateWebhookRequestRequestTypeDef definition

class CreateWebhookRequestRequestTypeDef(TypedDict):
    appId: str,
    branchName: str,
    description: NotRequired[str],

WebhookTypeDef#

# WebhookTypeDef definition

class WebhookTypeDef(TypedDict):
    webhookArn: str,
    webhookId: str,
    webhookUrl: str,
    branchName: str,
    description: str,
    createTime: datetime,
    updateTime: datetime,

DeleteAppRequestRequestTypeDef#

# DeleteAppRequestRequestTypeDef definition

class DeleteAppRequestRequestTypeDef(TypedDict):
    appId: str,

DeleteBackendEnvironmentRequestRequestTypeDef#

# DeleteBackendEnvironmentRequestRequestTypeDef definition

class DeleteBackendEnvironmentRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,

DeleteBranchRequestRequestTypeDef#

# DeleteBranchRequestRequestTypeDef definition

class DeleteBranchRequestRequestTypeDef(TypedDict):
    appId: str,
    branchName: str,

DeleteDomainAssociationRequestRequestTypeDef#

# DeleteDomainAssociationRequestRequestTypeDef definition

class DeleteDomainAssociationRequestRequestTypeDef(TypedDict):
    appId: str,
    domainName: str,

DeleteJobRequestRequestTypeDef#

# DeleteJobRequestRequestTypeDef definition

class DeleteJobRequestRequestTypeDef(TypedDict):
    appId: str,
    branchName: str,
    jobId: str,

JobSummaryTypeDef#

# 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],
  1. See JobStatusType
  2. See JobTypeType

DeleteWebhookRequestRequestTypeDef#

# DeleteWebhookRequestRequestTypeDef definition

class DeleteWebhookRequestRequestTypeDef(TypedDict):
    webhookId: str,

GetAppRequestRequestTypeDef#

# GetAppRequestRequestTypeDef definition

class GetAppRequestRequestTypeDef(TypedDict):
    appId: str,

GetArtifactUrlRequestRequestTypeDef#

# GetArtifactUrlRequestRequestTypeDef definition

class GetArtifactUrlRequestRequestTypeDef(TypedDict):
    artifactId: str,

GetBackendEnvironmentRequestRequestTypeDef#

# GetBackendEnvironmentRequestRequestTypeDef definition

class GetBackendEnvironmentRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,

GetBranchRequestRequestTypeDef#

# GetBranchRequestRequestTypeDef definition

class GetBranchRequestRequestTypeDef(TypedDict):
    appId: str,
    branchName: str,

GetDomainAssociationRequestRequestTypeDef#

# GetDomainAssociationRequestRequestTypeDef definition

class GetDomainAssociationRequestRequestTypeDef(TypedDict):
    appId: str,
    domainName: str,

GetJobRequestRequestTypeDef#

# GetJobRequestRequestTypeDef definition

class GetJobRequestRequestTypeDef(TypedDict):
    appId: str,
    branchName: str,
    jobId: str,

GetWebhookRequestRequestTypeDef#

# GetWebhookRequestRequestTypeDef definition

class GetWebhookRequestRequestTypeDef(TypedDict):
    webhookId: str,

StepTypeDef#

# 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],
  1. See JobStatusType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAppsRequestRequestTypeDef#

# ListAppsRequestRequestTypeDef definition

class ListAppsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListArtifactsRequestRequestTypeDef#

# ListArtifactsRequestRequestTypeDef definition

class ListArtifactsRequestRequestTypeDef(TypedDict):
    appId: str,
    branchName: str,
    jobId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListBackendEnvironmentsRequestRequestTypeDef#

# ListBackendEnvironmentsRequestRequestTypeDef definition

class ListBackendEnvironmentsRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListBranchesRequestRequestTypeDef#

# ListBranchesRequestRequestTypeDef definition

class ListBranchesRequestRequestTypeDef(TypedDict):
    appId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDomainAssociationsRequestRequestTypeDef#

# ListDomainAssociationsRequestRequestTypeDef definition

class ListDomainAssociationsRequestRequestTypeDef(TypedDict):
    appId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListJobsRequestRequestTypeDef#

# ListJobsRequestRequestTypeDef definition

class ListJobsRequestRequestTypeDef(TypedDict):
    appId: str,
    branchName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListWebhooksRequestRequestTypeDef#

# ListWebhooksRequestRequestTypeDef definition

class ListWebhooksRequestRequestTypeDef(TypedDict):
    appId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

StartDeploymentRequestRequestTypeDef#

# StartDeploymentRequestRequestTypeDef definition

class StartDeploymentRequestRequestTypeDef(TypedDict):
    appId: str,
    branchName: str,
    jobId: NotRequired[str],
    sourceUrl: NotRequired[str],

StopJobRequestRequestTypeDef#

# StopJobRequestRequestTypeDef definition

class StopJobRequestRequestTypeDef(TypedDict):
    appId: str,
    branchName: str,
    jobId: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateWebhookRequestRequestTypeDef#

# UpdateWebhookRequestRequestTypeDef definition

class UpdateWebhookRequestRequestTypeDef(TypedDict):
    webhookId: str,
    branchName: NotRequired[str],
    description: NotRequired[str],

AppTypeDef#

# 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[AutoBranchCreationConfigOutputTypeDef],  # (4)
    repositoryCloneMethod: NotRequired[RepositoryCloneMethodType],  # (5)
  1. See PlatformType
  2. See CustomRuleTypeDef
  3. See ProductionBranchTypeDef
  4. See AutoBranchCreationConfigOutputTypeDef
  5. See RepositoryCloneMethodType

CreateAppRequestRequestTypeDef#

# 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)
  1. See PlatformType
  2. See CustomRuleTypeDef
  3. See AutoBranchCreationConfigTypeDef

UpdateAppRequestRequestTypeDef#

# 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],
  1. See PlatformType
  2. See CustomRuleTypeDef
  3. See AutoBranchCreationConfigTypeDef

BranchTypeDef#

# 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)
  1. See StageType
  2. See BackendTypeDef

CreateBranchRequestRequestTypeDef#

# CreateBranchRequestRequestTypeDef definition