SMSClient

Index > SMS > SMSClient

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

SMSClient

Type annotations and code completion for boto3.client("sms"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_sms.client import SMSClient

def get_sms_client() -> SMSClient:
    return Session().client("sms")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("sms").exceptions structure.

Usage example

client = boto3.client("sms")

try:
    do_something(client)
except (
    client.ClientError,
    client.DryRunOperationException,
    client.InternalError,
    client.InvalidParameterException,
    client.MissingRequiredParameterException,
    client.NoConnectorsAvailableException,
    client.OperationNotPermittedException,
    client.ReplicationJobAlreadyExistsException,
    client.ReplicationJobNotFoundException,
    client.ReplicationRunLimitExceededException,
    client.ServerCannotBeReplicatedException,
    client.TemporarilyUnavailableException,
    client.UnauthorizedOperationException,
) as e:
    print(e)

Type checking example

from mypy_boto3_sms.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("sms").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("sms").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

create_app

Creates an application.

Type annotations and code completion for boto3.client("sms").create_app method. boto3 documentation

Method definition

def create_app(
    self,
    *,
    name: str = ...,
    description: str = ...,
    roleName: str = ...,
    clientToken: str = ...,
    serverGroups: Sequence[ServerGroupTypeDef] = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateAppResponseTypeDef:  # (3)
    ...

1. See ServerGroupTypeDef
2. See TagTypeDef
3. See CreateAppResponseTypeDef

Usage example with kwargs

kwargs: CreateAppRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_app(**kwargs)

1. See CreateAppRequestRequestTypeDef

create_replication_job

Creates a replication job.

Type annotations and code completion for boto3.client("sms").create_replication_job method. boto3 documentation

Method definition

def create_replication_job(
    self,
    *,
    serverId: str,
    seedReplicationTime: Union[datetime, str],
    frequency: int = ...,
    runOnce: bool = ...,
    licenseType: LicenseTypeType = ...,  # (1)
    roleName: str = ...,
    description: str = ...,
    numberOfRecentAmisToKeep: int = ...,
    encrypted: bool = ...,
    kmsKeyId: str = ...,
) -> CreateReplicationJobResponseTypeDef:  # (2)
    ...

1. See LicenseTypeType
2. See CreateReplicationJobResponseTypeDef

Usage example with kwargs

kwargs: CreateReplicationJobRequestRequestTypeDef = {  # (1)
    "serverId": ...,
    "seedReplicationTime": ...,
}

parent.create_replication_job(**kwargs)

1. See CreateReplicationJobRequestRequestTypeDef

delete_app

Deletes the specified application.

Type annotations and code completion for boto3.client("sms").delete_app method. boto3 documentation

Method definition

def delete_app(
    self,
    *,
    appId: str = ...,
    forceStopAppReplication: bool = ...,
    forceTerminateApp: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteAppRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.delete_app(**kwargs)

1. See DeleteAppRequestRequestTypeDef

delete_app_launch_configuration

Deletes the launch configuration for the specified application.

Type annotations and code completion for boto3.client("sms").delete_app_launch_configuration method. boto3 documentation

Method definition

def delete_app_launch_configuration(
    self,
    *,
    appId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteAppLaunchConfigurationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.delete_app_launch_configuration(**kwargs)

1. See DeleteAppLaunchConfigurationRequestRequestTypeDef

delete_app_replication_configuration

Deletes the replication configuration for the specified application.

Type annotations and code completion for boto3.client("sms").delete_app_replication_configuration method. boto3 documentation

Method definition

def delete_app_replication_configuration(
    self,
    *,
    appId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteAppReplicationConfigurationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.delete_app_replication_configuration(**kwargs)

1. See DeleteAppReplicationConfigurationRequestRequestTypeDef

delete_app_validation_configuration

Deletes the validation configuration for the specified application.

Type annotations and code completion for boto3.client("sms").delete_app_validation_configuration method. boto3 documentation

Method definition

def delete_app_validation_configuration(
    self,
    *,
    appId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteAppValidationConfigurationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.delete_app_validation_configuration(**kwargs)

1. See DeleteAppValidationConfigurationRequestRequestTypeDef

delete_replication_job

Deletes the specified replication job.

Type annotations and code completion for boto3.client("sms").delete_replication_job method. boto3 documentation

Method definition

def delete_replication_job(
    self,
    *,
    replicationJobId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteReplicationJobRequestRequestTypeDef = {  # (1)
    "replicationJobId": ...,
}

parent.delete_replication_job(**kwargs)

1. See DeleteReplicationJobRequestRequestTypeDef

delete_server_catalog

Deletes all servers from your server catalog.

Type annotations and code completion for boto3.client("sms").delete_server_catalog method. boto3 documentation

Method definition

def delete_server_catalog(
    self,
) -> Dict[str, Any]:
    ...

disassociate_connector

Disassociates the specified connector from Server Migration Service.

Type annotations and code completion for boto3.client("sms").disassociate_connector method. boto3 documentation

Method definition

def disassociate_connector(
    self,
    *,
    connectorId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DisassociateConnectorRequestRequestTypeDef = {  # (1)
    "connectorId": ...,
}

parent.disassociate_connector(**kwargs)

1. See DisassociateConnectorRequestRequestTypeDef

generate_change_set

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Type annotations and code completion for boto3.client("sms").generate_change_set method. boto3 documentation

Method definition

def generate_change_set(
    self,
    *,
    appId: str = ...,
    changesetFormat: OutputFormatType = ...,  # (1)
) -> GenerateChangeSetResponseTypeDef:  # (2)
    ...

1. See OutputFormatType
2. See GenerateChangeSetResponseTypeDef

Usage example with kwargs

kwargs: GenerateChangeSetRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.generate_change_set(**kwargs)

1. See GenerateChangeSetRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("sms").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

generate_template

Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Type annotations and code completion for boto3.client("sms").generate_template method. boto3 documentation

Method definition

def generate_template(
    self,
    *,
    appId: str = ...,
    templateFormat: OutputFormatType = ...,  # (1)
) -> GenerateTemplateResponseTypeDef:  # (2)
    ...

1. See OutputFormatType
2. See GenerateTemplateResponseTypeDef

Usage example with kwargs

kwargs: GenerateTemplateRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.generate_template(**kwargs)

1. See GenerateTemplateRequestRequestTypeDef

get_app

Retrieve information about the specified application.

Type annotations and code completion for boto3.client("sms").get_app method. boto3 documentation

Method definition

def get_app(
    self,
    *,
    appId: str = ...,
) -> GetAppResponseTypeDef:  # (1)
    ...

1. See GetAppResponseTypeDef

Usage example with kwargs

kwargs: GetAppRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.get_app(**kwargs)

1. See GetAppRequestRequestTypeDef

get_app_launch_configuration

Retrieves the application launch configuration associated with the specified application.

Type annotations and code completion for boto3.client("sms").get_app_launch_configuration method. boto3 documentation

Method definition

def get_app_launch_configuration(
    self,
    *,
    appId: str = ...,
) -> GetAppLaunchConfigurationResponseTypeDef:  # (1)
    ...

1. See GetAppLaunchConfigurationResponseTypeDef

Usage example with kwargs

kwargs: GetAppLaunchConfigurationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.get_app_launch_configuration(**kwargs)

1. See GetAppLaunchConfigurationRequestRequestTypeDef

get_app_replication_configuration

Retrieves the application replication configuration associated with the specified application.

Type annotations and code completion for boto3.client("sms").get_app_replication_configuration method. boto3 documentation

Method definition

def get_app_replication_configuration(
    self,
    *,
    appId: str = ...,
) -> GetAppReplicationConfigurationResponseTypeDef:  # (1)
    ...

1. See GetAppReplicationConfigurationResponseTypeDef

Usage example with kwargs

kwargs: GetAppReplicationConfigurationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.get_app_replication_configuration(**kwargs)

1. See GetAppReplicationConfigurationRequestRequestTypeDef

get_app_validation_configuration

Retrieves information about a configuration for validating an application.

Type annotations and code completion for boto3.client("sms").get_app_validation_configuration method. boto3 documentation

Method definition

def get_app_validation_configuration(
    self,
    *,
    appId: str,
) -> GetAppValidationConfigurationResponseTypeDef:  # (1)
    ...

1. See GetAppValidationConfigurationResponseTypeDef

Usage example with kwargs

kwargs: GetAppValidationConfigurationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.get_app_validation_configuration(**kwargs)

1. See GetAppValidationConfigurationRequestRequestTypeDef

get_app_validation_output

Retrieves output from validating an application.

Type annotations and code completion for boto3.client("sms").get_app_validation_output method. boto3 documentation

Method definition

def get_app_validation_output(
    self,
    *,
    appId: str,
) -> GetAppValidationOutputResponseTypeDef:  # (1)
    ...

1. See GetAppValidationOutputResponseTypeDef

Usage example with kwargs

kwargs: GetAppValidationOutputRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.get_app_validation_output(**kwargs)

1. See GetAppValidationOutputRequestRequestTypeDef

get_connectors

Describes the connectors registered with the Server Migration Service.

Type annotations and code completion for boto3.client("sms").get_connectors method. boto3 documentation

Method definition

def get_connectors(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetConnectorsResponseTypeDef:  # (1)
    ...

1. See GetConnectorsResponseTypeDef

Usage example with kwargs

kwargs: GetConnectorsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.get_connectors(**kwargs)

1. See GetConnectorsRequestRequestTypeDef

get_replication_jobs

Describes the specified replication job or all of your replication jobs.

Type annotations and code completion for boto3.client("sms").get_replication_jobs method. boto3 documentation

Method definition

def get_replication_jobs(
    self,
    *,
    replicationJobId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetReplicationJobsResponseTypeDef:  # (1)
    ...

1. See GetReplicationJobsResponseTypeDef

Usage example with kwargs

kwargs: GetReplicationJobsRequestRequestTypeDef = {  # (1)
    "replicationJobId": ...,
}

parent.get_replication_jobs(**kwargs)

1. See GetReplicationJobsRequestRequestTypeDef

get_replication_runs

Describes the replication runs for the specified replication job.

Type annotations and code completion for boto3.client("sms").get_replication_runs method. boto3 documentation

Method definition

def get_replication_runs(
    self,
    *,
    replicationJobId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetReplicationRunsResponseTypeDef:  # (1)
    ...

1. See GetReplicationRunsResponseTypeDef

Usage example with kwargs

kwargs: GetReplicationRunsRequestRequestTypeDef = {  # (1)
    "replicationJobId": ...,
}

parent.get_replication_runs(**kwargs)

1. See GetReplicationRunsRequestRequestTypeDef

get_servers

Describes the servers in your server catalog.

Type annotations and code completion for boto3.client("sms").get_servers method. boto3 documentation

Method definition

def get_servers(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    vmServerAddressList: Sequence[VmServerAddressTypeDef] = ...,  # (1)
) -> GetServersResponseTypeDef:  # (2)
    ...

1. See VmServerAddressTypeDef
2. See GetServersResponseTypeDef

Usage example with kwargs

kwargs: GetServersRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.get_servers(**kwargs)

1. See GetServersRequestRequestTypeDef

import_app_catalog

Allows application import from Migration Hub.

Type annotations and code completion for boto3.client("sms").import_app_catalog method. boto3 documentation

Method definition

def import_app_catalog(
    self,
    *,
    roleName: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: ImportAppCatalogRequestRequestTypeDef = {  # (1)
    "roleName": ...,
}

parent.import_app_catalog(**kwargs)

1. See ImportAppCatalogRequestRequestTypeDef

import_server_catalog

Gathers a complete list of on-premises servers.

Type annotations and code completion for boto3.client("sms").import_server_catalog method. boto3 documentation

Method definition

def import_server_catalog(
    self,
) -> Dict[str, Any]:
    ...

launch_app

Launches the specified application as a stack in CloudFormation.

Type annotations and code completion for boto3.client("sms").launch_app method. boto3 documentation

Method definition

def launch_app(
    self,
    *,
    appId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: LaunchAppRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.launch_app(**kwargs)

1. See LaunchAppRequestRequestTypeDef

list_apps

Retrieves summaries for all applications.

Type annotations and code completion for boto3.client("sms").list_apps method. boto3 documentation

Method definition

def list_apps(
    self,
    *,
    appIds: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAppsResponseTypeDef:  # (1)
    ...

1. See ListAppsResponseTypeDef

Usage example with kwargs

kwargs: ListAppsRequestRequestTypeDef = {  # (1)
    "appIds": ...,
}

parent.list_apps(**kwargs)

1. See ListAppsRequestRequestTypeDef

notify_app_validation_output

Provides information to Server Migration Service about whether application validation is successful.

Type annotations and code completion for boto3.client("sms").notify_app_validation_output method. boto3 documentation

Method definition

def notify_app_validation_output(
    self,
    *,
    appId: str,
    notificationContext: NotificationContextTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See NotificationContextTypeDef

Usage example with kwargs

kwargs: NotifyAppValidationOutputRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.notify_app_validation_output(**kwargs)

1. See NotifyAppValidationOutputRequestRequestTypeDef

put_app_launch_configuration

Creates or updates the launch configuration for the specified application.

Type annotations and code completion for boto3.client("sms").put_app_launch_configuration method. boto3 documentation

Method definition

def put_app_launch_configuration(
    self,
    *,
    appId: str = ...,
    roleName: str = ...,
    autoLaunch: bool = ...,
    serverGroupLaunchConfigurations: Sequence[ServerGroupLaunchConfigurationTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See ServerGroupLaunchConfigurationTypeDef

Usage example with kwargs

kwargs: PutAppLaunchConfigurationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.put_app_launch_configuration(**kwargs)

1. See PutAppLaunchConfigurationRequestRequestTypeDef

put_app_replication_configuration

Creates or updates the replication configuration for the specified application.

Type annotations and code completion for boto3.client("sms").put_app_replication_configuration method. boto3 documentation

Method definition

def put_app_replication_configuration(
    self,
    *,
    appId: str = ...,
    serverGroupReplicationConfigurations: Sequence[ServerGroupReplicationConfigurationTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See ServerGroupReplicationConfigurationTypeDef

Usage example with kwargs

kwargs: PutAppReplicationConfigurationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.put_app_replication_configuration(**kwargs)

1. See PutAppReplicationConfigurationRequestRequestTypeDef

put_app_validation_configuration

Creates or updates a validation configuration for the specified application.

Type annotations and code completion for boto3.client("sms").put_app_validation_configuration method. boto3 documentation

Method definition

def put_app_validation_configuration(
    self,
    *,
    appId: str,
    appValidationConfigurations: Sequence[AppValidationConfigurationTypeDef] = ...,  # (1)
    serverGroupValidationConfigurations: Sequence[ServerGroupValidationConfigurationTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See AppValidationConfigurationTypeDef
2. See ServerGroupValidationConfigurationTypeDef

Usage example with kwargs

kwargs: PutAppValidationConfigurationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.put_app_validation_configuration(**kwargs)

1. See PutAppValidationConfigurationRequestRequestTypeDef

start_app_replication

Starts replicating the specified application by creating replication jobs for each server in the application.

Type annotations and code completion for boto3.client("sms").start_app_replication method. boto3 documentation

Method definition

def start_app_replication(
    self,
    *,
    appId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: StartAppReplicationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.start_app_replication(**kwargs)

1. See StartAppReplicationRequestRequestTypeDef

start_on_demand_app_replication

Starts an on-demand replication run for the specified application.

Type annotations and code completion for boto3.client("sms").start_on_demand_app_replication method. boto3 documentation

Method definition

def start_on_demand_app_replication(
    self,
    *,
    appId: str,
    description: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: StartOnDemandAppReplicationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.start_on_demand_app_replication(**kwargs)

1. See StartOnDemandAppReplicationRequestRequestTypeDef

start_on_demand_replication_run

Starts an on-demand replication run for the specified replication job.

Type annotations and code completion for boto3.client("sms").start_on_demand_replication_run method. boto3 documentation

Method definition

def start_on_demand_replication_run(
    self,
    *,
    replicationJobId: str,
    description: str = ...,
) -> StartOnDemandReplicationRunResponseTypeDef:  # (1)
    ...

1. See StartOnDemandReplicationRunResponseTypeDef

Usage example with kwargs

kwargs: StartOnDemandReplicationRunRequestRequestTypeDef = {  # (1)
    "replicationJobId": ...,
}

parent.start_on_demand_replication_run(**kwargs)

1. See StartOnDemandReplicationRunRequestRequestTypeDef

stop_app_replication

Stops replicating the specified application by deleting the replication job for each server in the application.

Type annotations and code completion for boto3.client("sms").stop_app_replication method. boto3 documentation

Method definition

def stop_app_replication(
    self,
    *,
    appId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: StopAppReplicationRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.stop_app_replication(**kwargs)

1. See StopAppReplicationRequestRequestTypeDef

terminate_app

Terminates the stack for the specified application.

Type annotations and code completion for boto3.client("sms").terminate_app method. boto3 documentation

Method definition

def terminate_app(
    self,
    *,
    appId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TerminateAppRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.terminate_app(**kwargs)

1. See TerminateAppRequestRequestTypeDef

update_app

Updates the specified application.

Type annotations and code completion for boto3.client("sms").update_app method. boto3 documentation

Method definition

def update_app(
    self,
    *,
    appId: str = ...,
    name: str = ...,
    description: str = ...,
    roleName: str = ...,
    serverGroups: Sequence[ServerGroupTypeDef] = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> UpdateAppResponseTypeDef:  # (3)
    ...

1. See ServerGroupTypeDef
2. See TagTypeDef
3. See UpdateAppResponseTypeDef

Usage example with kwargs

kwargs: UpdateAppRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.update_app(**kwargs)

1. See UpdateAppRequestRequestTypeDef

update_replication_job

Updates the specified settings for the specified replication job.

Type annotations and code completion for boto3.client("sms").update_replication_job method. boto3 documentation

Method definition

def update_replication_job(
    self,
    *,
    replicationJobId: str,
    frequency: int = ...,
    nextReplicationRunStartTime: Union[datetime, str] = ...,
    licenseType: LicenseTypeType = ...,  # (1)
    roleName: str = ...,
    description: str = ...,
    numberOfRecentAmisToKeep: int = ...,
    encrypted: bool = ...,
    kmsKeyId: str = ...,
) -> Dict[str, Any]:
    ...

1. See LicenseTypeType

Usage example with kwargs

kwargs: UpdateReplicationJobRequestRequestTypeDef = {  # (1)
    "replicationJobId": ...,
}

parent.update_replication_job(**kwargs)

1. See UpdateReplicationJobRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("sms").get_paginator method with overloads.

• client.get_paginator("get_connectors") -> GetConnectorsPaginator
• client.get_paginator("get_replication_jobs") -> GetReplicationJobsPaginator
• client.get_paginator("get_replication_runs") -> GetReplicationRunsPaginator
• client.get_paginator("get_servers") -> GetServersPaginator
• client.get_paginator("list_apps") -> ListAppsPaginator