Skip to content

Type definitions#

Index > AmplifyBackend > Type definitions

Auto-generated documentation for AmplifyBackend type annotations stubs module mypy-boto3-amplifybackend.

BackendAPIResourceConfigUnionTypeDef#

# BackendAPIResourceConfigUnionTypeDef definition

BackendAPIResourceConfigUnionTypeDef = Union[
    BackendAPIResourceConfigTypeDef,  # (1)
    BackendAPIResourceConfigOutputTypeDef,  # (2)
]
  1. See BackendAPIResourceConfigTypeDef
  2. See BackendAPIResourceConfigOutputTypeDef

CreateBackendAuthResourceConfigUnionTypeDef#

# CreateBackendAuthResourceConfigUnionTypeDef definition

CreateBackendAuthResourceConfigUnionTypeDef = Union[
    CreateBackendAuthResourceConfigTypeDef,  # (1)
    CreateBackendAuthResourceConfigOutputTypeDef,  # (2)
]
  1. See CreateBackendAuthResourceConfigTypeDef
  2. See CreateBackendAuthResourceConfigOutputTypeDef

BackendAPIAppSyncAuthSettingsTypeDef#

# BackendAPIAppSyncAuthSettingsTypeDef definition

class BackendAPIAppSyncAuthSettingsTypeDef(TypedDict):
    CognitoUserPoolId: NotRequired[str],
    Description: NotRequired[str],
    ExpirationTime: NotRequired[float],
    OpenIDAuthTTL: NotRequired[str],
    OpenIDClientId: NotRequired[str],
    OpenIDIatTTL: NotRequired[str],
    OpenIDIssueURL: NotRequired[str],
    OpenIDProviderName: NotRequired[str],

BackendAPIConflictResolutionTypeDef#

# BackendAPIConflictResolutionTypeDef definition

class BackendAPIConflictResolutionTypeDef(TypedDict):
    ResolutionStrategy: NotRequired[ResolutionStrategyType],  # (1)
  1. See ResolutionStrategyType

BackendAuthAppleProviderConfigTypeDef#

# BackendAuthAppleProviderConfigTypeDef definition

class BackendAuthAppleProviderConfigTypeDef(TypedDict):
    ClientId: NotRequired[str],
    KeyId: NotRequired[str],
    PrivateKey: NotRequired[str],
    TeamId: NotRequired[str],

BackendAuthSocialProviderConfigTypeDef#

# BackendAuthSocialProviderConfigTypeDef definition

class BackendAuthSocialProviderConfigTypeDef(TypedDict):
    ClientId: NotRequired[str],
    ClientSecret: NotRequired[str],

BackendJobRespObjTypeDef#

# BackendJobRespObjTypeDef definition

class BackendJobRespObjTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    CreateTime: NotRequired[str],
    Error: NotRequired[str],
    JobId: NotRequired[str],
    Operation: NotRequired[str],
    Status: NotRequired[str],
    UpdateTime: NotRequired[str],

BackendStoragePermissionsOutputTypeDef#

# BackendStoragePermissionsOutputTypeDef definition

class BackendStoragePermissionsOutputTypeDef(TypedDict):
    Authenticated: List[AuthenticatedElementType],  # (1)
    UnAuthenticated: NotRequired[List[UnAuthenticatedElementType]],  # (2)
  1. See AuthenticatedElementType
  2. See UnAuthenticatedElementType

BackendStoragePermissionsTypeDef#

# BackendStoragePermissionsTypeDef definition

class BackendStoragePermissionsTypeDef(TypedDict):
    Authenticated: Sequence[AuthenticatedElementType],  # (1)
    UnAuthenticated: NotRequired[Sequence[UnAuthenticatedElementType]],  # (2)
  1. See AuthenticatedElementType
  2. See UnAuthenticatedElementType

CloneBackendRequestRequestTypeDef#

# CloneBackendRequestRequestTypeDef definition

class CloneBackendRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    TargetEnvironmentName: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

EmailSettingsTypeDef#

# EmailSettingsTypeDef definition

class EmailSettingsTypeDef(TypedDict):
    EmailMessage: NotRequired[str],
    EmailSubject: NotRequired[str],

SmsSettingsTypeDef#

# SmsSettingsTypeDef definition

class SmsSettingsTypeDef(TypedDict):
    SmsMessage: NotRequired[str],

CreateBackendAuthIdentityPoolConfigTypeDef#

# CreateBackendAuthIdentityPoolConfigTypeDef definition

class CreateBackendAuthIdentityPoolConfigTypeDef(TypedDict):
    IdentityPoolName: str,
    UnauthenticatedLogin: bool,

SettingsOutputTypeDef#

# SettingsOutputTypeDef definition

class SettingsOutputTypeDef(TypedDict):
    MfaTypes: NotRequired[List[MfaTypesElementType]],  # (1)
    SmsMessage: NotRequired[str],
  1. See MfaTypesElementType

SettingsTypeDef#

# SettingsTypeDef definition

class SettingsTypeDef(TypedDict):
    MfaTypes: NotRequired[Sequence[MfaTypesElementType]],  # (1)
    SmsMessage: NotRequired[str],
  1. See MfaTypesElementType

CreateBackendAuthPasswordPolicyConfigOutputTypeDef#

# CreateBackendAuthPasswordPolicyConfigOutputTypeDef definition

class CreateBackendAuthPasswordPolicyConfigOutputTypeDef(TypedDict):
    MinimumLength: float,
    AdditionalConstraints: NotRequired[List[AdditionalConstraintsElementType]],  # (1)
  1. See AdditionalConstraintsElementType

CreateBackendAuthPasswordPolicyConfigTypeDef#

# CreateBackendAuthPasswordPolicyConfigTypeDef definition

class CreateBackendAuthPasswordPolicyConfigTypeDef(TypedDict):
    MinimumLength: float,
    AdditionalConstraints: NotRequired[Sequence[AdditionalConstraintsElementType]],  # (1)
  1. See AdditionalConstraintsElementType

CreateBackendConfigRequestRequestTypeDef#

# CreateBackendConfigRequestRequestTypeDef definition

class CreateBackendConfigRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendManagerAppId: NotRequired[str],

CreateBackendRequestRequestTypeDef#

# CreateBackendRequestRequestTypeDef definition

class CreateBackendRequestRequestTypeDef(TypedDict):
    AppId: str,
    AppName: str,
    BackendEnvironmentName: str,
    ResourceConfig: NotRequired[Mapping[str, Any]],
    ResourceName: NotRequired[str],

CreateTokenRequestRequestTypeDef#

# CreateTokenRequestRequestTypeDef definition

class CreateTokenRequestRequestTypeDef(TypedDict):
    AppId: str,

DeleteBackendAuthRequestRequestTypeDef#

# DeleteBackendAuthRequestRequestTypeDef definition

class DeleteBackendAuthRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,

DeleteBackendRequestRequestTypeDef#

# DeleteBackendRequestRequestTypeDef definition

class DeleteBackendRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,

DeleteBackendStorageRequestRequestTypeDef#

# DeleteBackendStorageRequestRequestTypeDef definition

class DeleteBackendStorageRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ServiceName: ServiceNameType,  # (1)
  1. See ServiceNameType

DeleteTokenRequestRequestTypeDef#

# DeleteTokenRequestRequestTypeDef definition

class DeleteTokenRequestRequestTypeDef(TypedDict):
    AppId: str,
    SessionId: str,

GenerateBackendAPIModelsRequestRequestTypeDef#

# GenerateBackendAPIModelsRequestRequestTypeDef definition

class GenerateBackendAPIModelsRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,

GetBackendAPIModelsRequestRequestTypeDef#

# GetBackendAPIModelsRequestRequestTypeDef definition

class GetBackendAPIModelsRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,

GetBackendAuthRequestRequestTypeDef#

# GetBackendAuthRequestRequestTypeDef definition

class GetBackendAuthRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,

GetBackendJobRequestRequestTypeDef#

# GetBackendJobRequestRequestTypeDef definition

class GetBackendJobRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,

GetBackendRequestRequestTypeDef#

# GetBackendRequestRequestTypeDef definition

class GetBackendRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: NotRequired[str],

GetBackendStorageRequestRequestTypeDef#

# GetBackendStorageRequestRequestTypeDef definition

class GetBackendStorageRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,

GetTokenRequestRequestTypeDef#

# GetTokenRequestRequestTypeDef definition

class GetTokenRequestRequestTypeDef(TypedDict):
    AppId: str,
    SessionId: str,

ImportBackendAuthRequestRequestTypeDef#

# ImportBackendAuthRequestRequestTypeDef definition

class ImportBackendAuthRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    NativeClientId: str,
    UserPoolId: str,
    WebClientId: str,
    IdentityPoolId: NotRequired[str],

ImportBackendStorageRequestRequestTypeDef#

# ImportBackendStorageRequestRequestTypeDef definition

class ImportBackendStorageRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ServiceName: ServiceNameType,  # (1)
    BucketName: NotRequired[str],
  1. See ServiceNameType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListBackendJobsRequestRequestTypeDef#

# ListBackendJobsRequestRequestTypeDef definition

class ListBackendJobsRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Operation: NotRequired[str],
    Status: NotRequired[str],

ListS3BucketsRequestRequestTypeDef#

# ListS3Bu