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

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

CacheConfigTypeDef#

# CacheConfigTypeDef definition

class CacheConfigTypeDef(TypedDict):
    type: CacheConfigTypeType,  # (1)
  1. See CacheConfigTypeType

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

WafConfigurationTypeDef#

# WafConfigurationTypeDef definition

class WafConfigurationTypeDef(TypedDict):
    webAclArn: NotRequired[str],
    wafStatus: NotRequired[WafStatusType],  # (1)
    statusReason: NotRequired[str],
  1. See WafStatusType

ArtifactTypeDef#

# ArtifactTypeDef definition

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

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],
    sourceUrl: NotRequired[str],
    sourceUrlType: NotRequired[SourceUrlTypeType],  # (3)
  1. See JobStatusType
  2. See JobTypeType
  3. See SourceUrlTypeType

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],
    sourceUrlType: NotRequired[SourceUrlTypeType],  # (1)
  1. See SourceUrlTypeType

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)
    cacheConfig: NotRequired[CacheConfigTypeDef],  # (6)
    webhookCreateTime: NotRequired[datetime],
    wafConfiguration: NotRequired[WafConfigurationTypeDef],  # (7)
  1. See PlatformType
  2. See CustomRuleTypeDef
  3. See ProductionBranchTypeDef
  4. See AutoBranchCreationConfigOutputTypeDef
  5. See RepositoryCloneMethodType
  6. See CacheConfigTypeDef
  7. See WafConfigurationTypeDef

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)
    cacheConfig: NotRequired[CacheConfigTypeDef],  # (4)
  1. See PlatformType
  2. See CustomRuleTypeDef
  3. See AutoBranchCreationConfigTypeDef
  4. See CacheConfigTypeDef

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],
    cacheConfig: NotRequired[CacheConfigTypeDef],  # (4)
  1. See PlatformType
  2. See CustomRuleTypeDef
  3. See AutoBranchCreationConfigTypeDef
  4. See CacheConfigTypeDef

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

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],
    backend: NotRequired[BackendTypeDef],  # (2)
  1. See StageType
  2. See BackendTypeDef

UpdateBranchRequestRequestTypeDef#

# 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],
    backend: NotRequired[BackendTypeDef],  # (2)
  1. See StageType
  2. See BackendTypeDef

CreateBackendEnvironmentResultTypeDef#

# CreateBackendEnvironmentResultTypeDef definition

class CreateBackendEnvironmentResultTypeDef(TypedDict):
    backendEnvironment: BackendEnvironmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackendEnvironmentTypeDef
  2. See ResponseMetadataTypeDef

CreateDeploymentResultTypeDef#

# CreateDeploymentResultTypeDef definition

class CreateDeploymentResultTypeDef(TypedDict):
    jobId: str,
    fileUploadUrls: dict[str, str],
    zipUploadUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBackendEnvironmentResultTypeDef#

# DeleteBackendEnvironmentResultTypeDef definition

class DeleteBackendEnvironmentResultTypeDef(TypedDict):
    backendEnvironment: BackendEnvironmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackendEnvironmentTypeDef
  2. See ResponseMetadataTypeDef

GenerateAccessLogsResultTypeDef#

# GenerateAccessLogsResultTypeDef definition

class GenerateAccessLogsResultTypeDef(TypedDict):
    logUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetArtifactUrlResultTypeDef#

# GetArtifactUrlResultTypeDef definition

class GetArtifactUrlResultTypeDef(TypedDict):
    artifactId: str,
    artifactUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetBackendEnvironmentResultTypeDef#

# GetBackendEnvironmentResultTypeDef definition

class GetBackendEnvironmentResultTypeDef(TypedDict):
    backendEnvironment: BackendEnvironmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackendEnvironmentTypeDef
  2. See ResponseMetadataTypeDef

ListArtifactsResultTypeDef#

# ListArtifactsResultTypeDef definition

class ListArtifactsResultTypeDef(TypedDict):
    artifacts: list[ArtifactTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ArtifactTypeDef
  2. See ResponseMetadataTypeDef

ListBackendEnvironmentsResultTypeDef#

# ListBackendEnvironmentsResultTypeDef definition

class ListBackendEnvironmentsResultTypeDef(TypedDict):
    backendEnvironments: list[BackendEnvironmentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See BackendEnvironmentTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDomainAssociationRequestRequestTypeDef#

# CreateDomainAssociationRequestRequestTypeDef definition

class CreateDomainAssociationRequestRequestTypeDef(TypedDict):
    appId: str,
    domainName: str,
    subDomainSettings: Sequence[SubDomainSettingTypeDef],  # (1)
    enableAutoSubDomain: NotRequired[bool],
    autoSubDomainCreationPatterns: NotRequired[Sequence[str]],
    autoSubDomainIAMRole: NotRequired[str],
    certificateSettings: NotRequired[CertificateSettingsTypeDef],  # (2)
  1. See SubDomainSettingTypeDef
  2. See CertificateSettingsTypeDef

SubDomainTypeDef#

# SubDomainTypeDef definition

class SubDomainTypeDef(TypedDict):
    subDomainSetting: SubDomainSettingTypeDef,  # (1)
    verified: bool,
    dnsRecord: str,
  1. See SubDomainSettingTypeDef

UpdateDomainAssociationRequestRequestTypeDef#

# UpdateDomainAssociationRequestRequestTypeDef definition

class UpdateDomainAssociationRequestRequestTypeDef(TypedDict):
    appId: str,
    domainName: str,
    enableAutoSubDomain: NotRequired[bool],
    subDomainSettings: NotRequired[Sequence[SubDomainSettingTypeDef]],  # (1)
    autoSubDomainCreationPatterns: NotRequired[Sequence[str]],
    autoSubDomainIAMRole: NotRequired[str],
    certificateSettings: NotRequired[CertificateSettingsTypeDef],  # (2)
  1. See SubDomainSettingTypeDef
  2. See CertificateSettingsTypeDef

CreateWebhookResultTypeDef#

# CreateWebhookResultTypeDef definition

class CreateWebhookResultTypeDef(TypedDict):
    webhook: WebhookTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WebhookTypeDef
  2. See ResponseMetadataTypeDef

DeleteWebhookResultTypeDef#

# DeleteWebhookResultTypeDef definition

class DeleteWebhookResultTypeDef(TypedDict):
    webhook: WebhookTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WebhookTypeDef
  2. See ResponseMetadataTypeDef

GetWebhookResultTypeDef#

# GetWebhookResultTypeDef definition

class GetWebhookResultTypeDef(TypedDict):
    webhook: WebhookTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WebhookTypeDef
  2. See ResponseMetadataTypeDef

ListWebhooksResultTypeDef#

# ListWebhooksResultTypeDef definition

class ListWebhooksResultTypeDef(TypedDict):
    webhooks: list[WebhookTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See WebhookTypeDef
  2. See ResponseMetadataTypeDef

UpdateWebhookResultTypeDef#

# UpdateWebhookResultTypeDef definition

class UpdateWebhookResultTypeDef(TypedDict):
    webhook: WebhookTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WebhookTypeDef
  2. See ResponseMetadataTypeDef

DeleteJobResultTypeDef#

# DeleteJobResultTypeDef definition

class DeleteJobResultTypeDef(TypedDict):
    jobSummary: JobSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListJobsResultTypeDef#

# ListJobsResultTypeDef definition

class ListJobsResultTypeDef(TypedDict):
    jobSummaries: list[JobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

StartDeploymentResultTypeDef#

# StartDeploymentResultTypeDef definition

class StartDeploymentResultTypeDef(TypedDict):
    jobSummary: JobSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

StartJobResultTypeDef#

# StartJobResultTypeDef definition

class StartJobResultTypeDef(TypedDict):
    jobSummary: JobSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

StopJobResultTypeDef#

# StopJobResultTypeDef definition

class StopJobResultTypeDef(TypedDict):
    jobSummary: JobSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

GenerateAccessLogsRequestRequestTypeDef#

# GenerateAccessLogsRequestRequestTypeDef definition

class GenerateAccessLogsRequestRequestTypeDef(TypedDict):
    domainName: str,
    appId: str,
    startTime: NotRequired[TimestampTypeDef],
    endTime: NotRequired[TimestampTypeDef],

StartJobRequestRequestTypeDef#

# 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[TimestampTypeDef],
  1. See JobTypeType

JobTypeDef#

# JobTypeDef definition

class JobTypeDef(TypedDict):
    summary: JobSummaryTypeDef,  # (1)
    steps: list[StepTypeDef],  # (2)
  1. See JobSummaryTypeDef
  2. See StepTypeDef

ListAppsRequestPaginateTypeDef#

# ListAppsRequestPaginateTypeDef definition

class ListAppsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListBranchesRequestPaginateTypeDef#

# ListBranchesRequestPaginateTypeDef definition

class ListBranchesRequestPaginateTypeDef(TypedDict):
    appId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDomainAssociationsRequestPaginateTypeDef#

# ListDomainAssociationsRequestPaginateTypeDef definition

class ListDomainAssociationsRequestPaginateTypeDef(TypedDict):
    appId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListJobsRequestPaginateTypeDef#

# ListJobsRequestPaginateTypeDef definition

class ListJobsRequestPaginateTypeDef(TypedDict):
    appId: str,
    branchName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

CreateAppResultTypeDef#

# CreateAppResultTypeDef definition

class CreateAppResultTypeDef(TypedDict):
    app: AppTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppTypeDef
  2. See ResponseMetadataTypeDef

DeleteAppResultTypeDef#

# DeleteAppResultTypeDef definition

class DeleteAppResultTypeDef(TypedDict):
    app: AppTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppTypeDef
  2. See ResponseMetadataTypeDef

GetAppResultTypeDef#

# GetAppResultTypeDef definition

class GetAppResultTypeDef(TypedDict):
    app: AppTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppTypeDef
  2. See ResponseMetadataTypeDef

ListAppsResultTypeDef#

# ListAppsResultTypeDef definition

class ListAppsResultTypeDef(TypedDict):
    apps: list[AppTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AppTypeDef
  2. See ResponseMetadataTypeDef

UpdateAppResultTypeDef#

# UpdateAppResultTypeDef definition

class UpdateAppResultTypeDef(TypedDict):
    app: AppTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppTypeDef
  2. See ResponseMetadataTypeDef

CreateBranchResultTypeDef#

# CreateBranchResultTypeDef definition

class CreateBranchResultTypeDef(TypedDict):
    branch: BranchTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BranchTypeDef
  2. See ResponseMetadataTypeDef

DeleteBranchResultTypeDef#

# DeleteBranchResultTypeDef definition

class DeleteBranchResultTypeDef(TypedDict):
    branch: BranchTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BranchTypeDef
  2. See ResponseMetadataTypeDef

GetBranchResultTypeDef#

# GetBranchResultTypeDef definition

class GetBranchResultTypeDef(TypedDict):
    branch: BranchTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BranchTypeDef
  2. See ResponseMetadataTypeDef

ListBranchesResultTypeDef#

# ListBranchesResultTypeDef definition

class ListBranchesResultTypeDef(TypedDict):
    branches: list[BranchTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See BranchTypeDef
  2. See ResponseMetadataTypeDef

UpdateBranchResultTypeDef#

# UpdateBranchResultTypeDef definition

class UpdateBranchResultTypeDef(TypedDict):
    branch: BranchTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BranchTypeDef
  2. See ResponseMetadataTypeDef

DomainAssociationTypeDef#

# 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)
  1. See DomainStatusType
  2. See UpdateStatusType
  3. See SubDomainTypeDef
  4. See CertificateTypeDef

GetJobResultTypeDef#

# GetJobResultTypeDef definition

class GetJobResultTypeDef(TypedDict):
    job: JobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobTypeDef
  2. See ResponseMetadataTypeDef

CreateDomainAssociationResultTypeDef#

# CreateDomainAssociationResultTypeDef definition

class CreateDomainAssociationResultTypeDef(TypedDict):
    domainAssociation: DomainAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainAssociationTypeDef
  2. See ResponseMetadataTypeDef

DeleteDomainAssociationResultTypeDef#

# DeleteDomainAssociationResultTypeDef definition

class DeleteDomainAssociationResultTypeDef(TypedDict):
    domainAssociation: DomainAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainAssociationTypeDef
  2. See ResponseMetadataTypeDef

GetDomainAssociationResultTypeDef#

# GetDomainAssociationResultTypeDef definition

class GetDomainAssociationResultTypeDef(TypedDict):
    domainAssociation: DomainAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainAssociationTypeDef
  2. See ResponseMetadataTypeDef

ListDomainAssociationsResultTypeDef#

# ListDomainAssociationsResultTypeDef definition

class ListDomainAssociationsResultTypeDef(TypedDict):
    domainAssociations: list[DomainAssociationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DomainAssociationTypeDef
  2. See ResponseMetadataTypeDef

UpdateDomainAssociationResultTypeDef#

# UpdateDomainAssociationResultTypeDef definition

class UpdateDomainAssociationResultTypeDef(TypedDict):
    domainAssociation: DomainAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainAssociationTypeDef
  2. See ResponseMetadataTypeDef