Skip to content

Type definitions#

Index > SMS > Type definitions

Auto-generated documentation for SMS type annotations stubs module mypy-boto3-sms.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ServerGroupUnionTypeDef#

# ServerGroupUnionTypeDef definition

ServerGroupUnionTypeDef = Union[
    ServerGroupTypeDef,  # (1)
    ServerGroupOutputTypeDef,  # (2)
]
  1. See ServerGroupTypeDef
  2. See ServerGroupOutputTypeDef

ServerGroupLaunchConfigurationUnionTypeDef#

# ServerGroupLaunchConfigurationUnionTypeDef definition

ServerGroupLaunchConfigurationUnionTypeDef = Union[
    ServerGroupLaunchConfigurationTypeDef,  # (1)
    ServerGroupLaunchConfigurationOutputTypeDef,  # (2)
]
  1. See ServerGroupLaunchConfigurationTypeDef
  2. See ServerGroupLaunchConfigurationOutputTypeDef

ServerGroupReplicationConfigurationUnionTypeDef#

# ServerGroupReplicationConfigurationUnionTypeDef definition

ServerGroupReplicationConfigurationUnionTypeDef = Union[
    ServerGroupReplicationConfigurationTypeDef,  # (1)
    ServerGroupReplicationConfigurationOutputTypeDef,  # (2)
]
  1. See ServerGroupReplicationConfigurationTypeDef
  2. See ServerGroupReplicationConfigurationOutputTypeDef

ServerGroupValidationConfigurationUnionTypeDef#

# ServerGroupValidationConfigurationUnionTypeDef definition

ServerGroupValidationConfigurationUnionTypeDef = Union[
    ServerGroupValidationConfigurationTypeDef,  # (1)
    ServerGroupValidationConfigurationOutputTypeDef,  # (2)
]
  1. See ServerGroupValidationConfigurationTypeDef
  2. See ServerGroupValidationConfigurationOutputTypeDef

LaunchDetailsTypeDef#

# LaunchDetailsTypeDef definition

class LaunchDetailsTypeDef(TypedDict):
    latestLaunchTime: NotRequired[datetime],
    stackName: NotRequired[str],
    stackId: NotRequired[str],

ConnectorTypeDef#

# ConnectorTypeDef definition

class ConnectorTypeDef(TypedDict):
    connectorId: NotRequired[str],
    version: NotRequired[str],
    status: NotRequired[ConnectorStatusType],  # (1)
    capabilityList: NotRequired[List[ConnectorCapabilityType]],  # (2)
    vmManagerName: NotRequired[str],
    vmManagerType: NotRequired[VmManagerTypeType],  # (3)
    vmManagerId: NotRequired[str],
    ipAddress: NotRequired[str],
    macAddress: NotRequired[str],
    associatedOn: NotRequired[datetime],
  1. See ConnectorStatusType
  2. See ConnectorCapabilityType
  3. See VmManagerTypeType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: NotRequired[str],
    value: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DeleteAppLaunchConfigurationRequestRequestTypeDef#

# DeleteAppLaunchConfigurationRequestRequestTypeDef definition

class DeleteAppLaunchConfigurationRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],

DeleteAppReplicationConfigurationRequestRequestTypeDef#

# DeleteAppReplicationConfigurationRequestRequestTypeDef definition

class DeleteAppReplicationConfigurationRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],

DeleteAppRequestRequestTypeDef#

# DeleteAppRequestRequestTypeDef definition

class DeleteAppRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],
    forceStopAppReplication: NotRequired[bool],
    forceTerminateApp: NotRequired[bool],

DeleteAppValidationConfigurationRequestRequestTypeDef#

# DeleteAppValidationConfigurationRequestRequestTypeDef definition

class DeleteAppValidationConfigurationRequestRequestTypeDef(TypedDict):
    appId: str,

DeleteReplicationJobRequestRequestTypeDef#

# DeleteReplicationJobRequestRequestTypeDef definition

class DeleteReplicationJobRequestRequestTypeDef(TypedDict):
    replicationJobId: str,

DisassociateConnectorRequestRequestTypeDef#

# DisassociateConnectorRequestRequestTypeDef definition

class DisassociateConnectorRequestRequestTypeDef(TypedDict):
    connectorId: str,

GenerateChangeSetRequestRequestTypeDef#

# GenerateChangeSetRequestRequestTypeDef definition

class GenerateChangeSetRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],
    changesetFormat: NotRequired[OutputFormatType],  # (1)
  1. See OutputFormatType

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    bucket: NotRequired[str],
    key: NotRequired[str],

GenerateTemplateRequestRequestTypeDef#

# GenerateTemplateRequestRequestTypeDef definition

class GenerateTemplateRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],
    templateFormat: NotRequired[OutputFormatType],  # (1)
  1. See OutputFormatType

GetAppLaunchConfigurationRequestRequestTypeDef#

# GetAppLaunchConfigurationRequestRequestTypeDef definition

class GetAppLaunchConfigurationRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],

GetAppReplicationConfigurationRequestRequestTypeDef#

# GetAppReplicationConfigurationRequestRequestTypeDef definition

class GetAppReplicationConfigurationRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],

GetAppRequestRequestTypeDef#

# GetAppRequestRequestTypeDef definition

class GetAppRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],

GetAppValidationConfigurationRequestRequestTypeDef#

# GetAppValidationConfigurationRequestRequestTypeDef definition

class GetAppValidationConfigurationRequestRequestTypeDef(TypedDict):
    appId: str,

GetAppValidationOutputRequestRequestTypeDef#

# GetAppValidationOutputRequestRequestTypeDef definition

class GetAppValidationOutputRequestRequestTypeDef(TypedDict):
    appId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

GetConnectorsRequestRequestTypeDef#

# GetConnectorsRequestRequestTypeDef definition

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

GetReplicationJobsRequestRequestTypeDef#

# GetReplicationJobsRequestRequestTypeDef definition

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

GetReplicationRunsRequestRequestTypeDef#

# GetReplicationRunsRequestRequestTypeDef definition

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

VmServerAddressTypeDef#

# VmServerAddressTypeDef definition

class VmServerAddressTypeDef(TypedDict):
    vmManagerId: NotRequired[str],
    vmId: NotRequired[str],

ImportAppCatalogRequestRequestTypeDef#

# ImportAppCatalogRequestRequestTypeDef definition

class ImportAppCatalogRequestRequestTypeDef(TypedDict):
    roleName: NotRequired[str],

LaunchAppRequestRequestTypeDef#

# LaunchAppRequestRequestTypeDef definition

class LaunchAppRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],

ListAppsRequestRequestTypeDef#

# ListAppsRequestRequestTypeDef definition

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

NotificationContextTypeDef#

# NotificationContextTypeDef definition

class NotificationContextTypeDef(TypedDict):
    validationId: NotRequired[str],
    status: NotRequired[ValidationStatusType],  # (1)
    statusMessage: NotRequired[str],
  1. See ValidationStatusType

ReplicationRunStageDetailsTypeDef#

# ReplicationRunStageDetailsTypeDef definition

class ReplicationRunStageDetailsTypeDef(TypedDict):
    stage: NotRequired[str],
    stageProgress: NotRequired[str],

ServerReplicationParametersOutputTypeDef#

# ServerReplicationParametersOutputTypeDef definition

class ServerReplicationParametersOutputTypeDef(TypedDict):
    seedTime: NotRequired[datetime],
    frequency: NotRequired[int],
    runOnce: NotRequired[bool],
    licenseType: NotRequired[LicenseTypeType],  # (1)
    numberOfRecentAmisToKeep: NotRequired[int],
    encrypted: NotRequired[bool],
    kmsKeyId: NotRequired[str],
  1. See LicenseTypeType

StartAppReplicationRequestRequestTypeDef#

# StartAppReplicationRequestRequestTypeDef definition

class StartAppReplicationRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],

StartOnDemandAppReplicationRequestRequestTypeDef#

# StartOnDemandAppReplicationRequestRequestTypeDef definition

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

StartOnDemandReplicationRunRequestRequestTypeDef#

# StartOnDemandReplicationRunRequestRequestTypeDef definition

class StartOnDemandReplicationRunRequestRequestTypeDef(TypedDict):
    replicationJobId: str,
    description: NotRequired[str],

StopAppReplicationRequestRequestTypeDef#

# StopAppReplicationRequestRequestTypeDef definition

class StopAppReplicationRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],

TerminateAppRequestRequestTypeDef#

# TerminateAppRequestRequestTypeDef definition

class TerminateAppRequestRequestTypeDef(TypedDict):
    appId: NotRequired[str],

AppSummaryTypeDef#

# AppSummaryTypeDef definition

class AppSummaryTypeDef(TypedDict):
    appId: NotRequired[str],
    importedAppId: NotRequired[str],
    name: NotRequired[str],
    description: NotRequired[str],
    status: NotRequired[AppStatusType],  # (1)
    statusMessage: NotRequired[str],
    replicationConfigurationStatus: NotRequired[AppReplicationConfigurationStatusType],  # (2)
    replicationStatus: NotRequired[AppReplicationStatusType],  # (3)
    replicationStatusMessage: NotRequired[str],
    latestReplicationTime: NotRequired[datetime],
    launchConfigurationStatus: NotRequired[AppLaunchConfigurationStatusType],  # (4)
    launchStatus: NotRequired[AppLaunchStatusType],  # (5)
    launchStatusMessage: NotRequired[str],
    launchDetails: NotRequired[LaunchDetailsTypeDef],  # (6)
    creationTime: NotRequired[datetime],
    lastModified: NotRequired[datetime],
    roleName: NotRequired[str],
    totalServerGroups: NotRequired[int],
    totalServers: NotRequired[int],
  1. See AppStatusType
  2. See AppReplicationConfigurationStatusType
  3. See AppReplicationStatusType
  4. See AppLaunchConfigurationStatusType
  5. See AppLaunchStatusType
  6. See LaunchDetailsTypeDef

CreateReplicationJobResponseTypeDef#

# CreateReplicationJobResponseTypeDef definition

class CreateReplicationJobResponseTypeDef(TypedDict):
    replicationJobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetConnectorsResponseTypeDef#

# GetConnectorsResponseTypeDef definition

class GetConnectorsResponseTypeDef(TypedDict):
    connectorList: List[ConnectorTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectorTypeDef
  2. See ResponseMetadataTypeDef

StartOnDemandReplicationRunResponseTypeDef#

# StartOnDemandReplicationRunResponseTypeDef definition

class StartOnDemandReplicationRunResponseTypeDef(TypedDict):
    replicationRunId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateReplicationJobRequestRequestTypeDef#

# CreateReplicationJobRequestRequestTypeDef definition

class CreateReplicationJobRequestRequestTypeDef(TypedDict):
    serverId: str,
    seedReplicationTime: Union[datetime, str],
    frequency: NotRequired[int],
    runOnce: NotRequired[bool],
    licenseType: NotRequired[LicenseTypeType],  # (1)
    roleName: NotRequired[str],
    description: NotRequired[str],
    numberOfRecentAmisToKeep: NotRequired[int],
    encrypted: NotRequired[bool],
    kmsKeyId: NotRequired[str],
  1. See