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

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

ServerReplicationParametersTypeDef#

# ServerReplicationParametersTypeDef definition

class ServerReplicationParametersTypeDef(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 LicenseTypeType

UpdateReplicationJobRequestRequestTypeDef#

# UpdateReplicationJobRequestRequestTypeDef definition

class UpdateReplicationJobRequestRequestTypeDef(TypedDict):
    replicationJobId: str,
    frequency: NotRequired[int],
    nextReplicationRunStartTime: NotRequired[Union[datetime, str]],
    licenseType: NotRequired[LicenseTypeType],  # (1)
    roleName: NotRequired[str],
    description: NotRequired[str],
    numberOfRecentAmisToKeep: NotRequired[int],
    encrypted: NotRequired[bool],
    kmsKeyId: NotRequired[str],
  1. See LicenseTypeType

GenerateChangeSetResponseTypeDef#

# GenerateChangeSetResponseTypeDef definition

class GenerateChangeSetResponseTypeDef(TypedDict):
    s3Location: S3LocationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See S3LocationTypeDef
  2. See ResponseMetadataTypeDef

GenerateTemplateResponseTypeDef#

# GenerateTemplateResponseTypeDef definition

class GenerateTemplateResponseTypeDef(TypedDict):
    s3Location: S3LocationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See S3LocationTypeDef
  2. See ResponseMetadataTypeDef

SSMOutputTypeDef#

# SSMOutputTypeDef definition

class SSMOutputTypeDef(TypedDict):
    s3Location: NotRequired[S3LocationTypeDef],  # (1)
  1. See S3LocationTypeDef

SourceTypeDef#

# SourceTypeDef definition

class SourceTypeDef(TypedDict):
    s3Location: NotRequired[S3LocationTypeDef],  # (1)
  1. See S3LocationTypeDef

UserDataTypeDef#

# UserDataTypeDef definition

class UserDataTypeDef(TypedDict):
    s3Location: NotRequired[S3LocationTypeDef],  # (1)
  1. See S3LocationTypeDef

GetConnectorsRequestGetConnectorsPaginateTypeDef#

# GetConnectorsRequestGetConnectorsPaginateTypeDef definition

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

GetReplicationJobsRequestGetReplicationJobsPaginateTypeDef#

# GetReplicationJobsRequestGetReplicationJobsPaginateTypeDef definition

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

GetReplicationRunsRequestGetReplicationRunsPaginateTypeDef#

# GetReplicationRunsRequestGetReplicationRunsPaginateTypeDef definition

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

ListAppsRequestListAppsPaginateTypeDef#

# ListAppsRequestListAppsPaginateTypeDef definition

class ListAppsRequestListAppsPaginateTypeDef(TypedDict):
    appIds: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetServersRequestGetServersPaginateTypeDef#

# GetServersRequestGetServersPaginateTypeDef definition

class GetServersRequestGetServersPaginateTypeDef(TypedDict):
    vmServerAddressList: NotRequired[Sequence[VmServerAddressTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See VmServerAddressTypeDef
  2. See PaginatorConfigTypeDef

GetServersRequestRequestTypeDef#

# GetServersRequestRequestTypeDef definition

class GetServersRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    vmServerAddressList: NotRequired[Sequence[VmServerAddressTypeDef]],  # (1)
  1. See VmServerAddressTypeDef

VmServerTypeDef#

# VmServerTypeDef definition

class VmServerTypeDef(TypedDict):
    vmServerAddress: NotRequired[VmServerAddressTypeDef],  # (1)
    vmName: NotRequired[str],
    vmManagerName: NotRequired[str],
    vmManagerType: NotRequired[VmManagerTypeType],  # (2)
    vmPath: NotRequired[str],
  1. See VmServerAddressTypeDef
  2. See VmManagerTypeType

NotifyAppValidationOutputRequestRequestTypeDef#

# NotifyAppValidationOutputRequestRequestTypeDef definition

class NotifyAppValidationOutputRequestRequestTypeDef(TypedDict):
    appId: str,
    notificationContext: NotRequired[NotificationContextTypeDef],  # (1)
  1. See NotificationContextTypeDef

ReplicationRunTypeDef#

# ReplicationRunTypeDef definition

class ReplicationRunTypeDef(TypedDict):
    replicationRunId: NotRequired[str],
    state: NotRequired[ReplicationRunStateType],  # (1)
    type: NotRequired[ReplicationRunTypeType],  # (2)
    stageDetails: NotRequired[ReplicationRunStageDetailsTypeDef],  # (3)
    statusMessage: NotRequired[str],
    amiId: NotRequired[str],
    scheduledStartTime: NotRequired[datetime],
    completedTime: NotRequired[datetime],
    description: NotRequired[str],
    encrypted: NotRequired[bool],
    kmsKeyId: NotRequired[str],
  1. See ReplicationRunStateType
  2. See ReplicationRunTypeType
  3. See ReplicationRunStageDetailsTypeDef

ListAppsResponseTypeDef#

# ListAppsResponseTypeDef definition

class ListAppsResponseTypeDef(TypedDict):
    apps: List[AppSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppSummaryTypeDef
  2. See ResponseMetadataTypeDef

AppValidationOutputTypeDef#

# AppValidationOutputTypeDef definition

class AppValidationOutputTypeDef(TypedDict):
    ssmOutput: NotRequired[SSMOutputTypeDef],  # (1)
  1. See SSMOutputTypeDef

SSMValidationParametersTypeDef#

# SSMValidationParametersTypeDef definition

class SSMValidationParametersTypeDef(TypedDict):
    source: NotRequired[SourceTypeDef],  # (1)
    instanceId: NotRequired[str],
    scriptType: NotRequired[ScriptTypeType],  # (2)
    command: NotRequired[str],
    executionTimeoutSeconds: NotRequired[int],
    outputS3BucketName: NotRequired[str],
  1. See SourceTypeDef
  2. See ScriptTypeType

UserDataValidationParametersTypeDef#

# UserDataValidationParametersTypeDef definition

class UserDataValidationParametersTypeDef(TypedDict):
    source: NotRequired[SourceTypeDef],  # (1)
    scriptType: NotRequired[ScriptTypeType],  # (2)
  1. See SourceTypeDef
  2. See ScriptTypeType

ServerTypeDef#

# ServerTypeDef definition

class ServerTypeDef(TypedDict):
    serverId: NotRequired[str],
    serverType: NotRequired[ServerTypeType],  # (1)
    vmServer: NotRequired[VmServerTypeDef],  # (2)
    replicationJobId: NotRequired[str],
    replicationJobTerminated: NotRequired[bool],
  1. See ServerTypeType
  2. See VmServerTypeDef

ReplicationJobTypeDef#

# ReplicationJobTypeDef definition

class ReplicationJobTypeDef(TypedDict):
    replicationJobId: NotRequired[str],
    serverId: NotRequired[str],
    serverType: NotRequired[ServerTypeType],  # (1)
    vmServer: NotRequired[VmServerTypeDef],  # (2)
    seedReplicationTime: NotRequired[datetime],
    frequency: NotRequired[int],
    runOnce: NotRequired[bool],
    nextReplicationRunStartTime: NotRequired[datetime],
    licenseType: NotRequired[LicenseTypeType],  # (3)
    roleName: NotRequired[str],
    latestAmiId: NotRequired[str],
    state: NotRequired[ReplicationJobStateType],  # (4)
    statusMessage: NotRequired[str],
    description: NotRequired[str],
    numberOfRecentAmisToKeep: NotRequired[int],
    encrypted: NotRequired[bool],
    kmsKeyId: NotRequired[str],
    replicationRunList: NotRequired[List[ReplicationRunTypeDef]],  # (5)
  1. See ServerTypeType
  2. See VmServerTypeDef
  3. See LicenseTypeType
  4. See ReplicationJobStateType
  5. See ReplicationRunTypeDef

AppValidationConfigurationTypeDef#

# AppValidationConfigurationTypeDef definition

class AppValidationConfigurationTypeDef(TypedDict):
    validationId: NotRequired[str],
    name: NotRequired[str],
    appValidationStrategy: NotRequired[AppValidationStrategyType],  # (1)
    ssmValidationParameters: NotRequired[SSMValidationParametersTypeDef],  # (2)
  1. See AppValidationStrategyType
  2. See SSMValidationParametersTypeDef

GetServersResponseTypeDef#

# GetServersResponseTypeDef definition

class GetServersResponseTypeDef(TypedDict):
    lastModifiedOn: datetime,
    serverCatalogStatus: ServerCatalogStatusType,  # (1)
    serverList: List[ServerTypeDef],  # (2)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ServerCatalogStatusType
  2. See ServerTypeDef
  3. See