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

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

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 CreateBackendEnvironmentReques