SMSClient#
Auto-generated documentation for SMS type annotations stubs module types-aiobotocore-sms.
SMSClient#
Type annotations and code completion for session.client("sms")
boto3 documentation
# SMSClient usage example
from aioboto3.session import Session
from types_aiobotocore_sms.client import SMSClient
session = Session()
async with session.client("sms") as client:
client: SMSClient
Exceptions#
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("sms").exceptions
structure.
# SMSClient.exceptions usage example
async with session.client("sms") as client:
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.DryRunOperationException,
client.exceptions.InternalError,
client.exceptions.InvalidParameterException,
client.exceptions.MissingRequiredParameterException,
client.exceptions.NoConnectorsAvailableException,
client.exceptions.OperationNotPermittedException,
client.exceptions.ReplicationJobAlreadyExistsException,
client.exceptions.ReplicationJobNotFoundException,
client.exceptions.ReplicationRunLimitExceededException,
client.exceptions.ServerCannotBeReplicatedException,
client.exceptions.TemporarilyUnavailableException,
client.exceptions.UnauthorizedOperationException,
) as e:
print(e)
# SMSClient.exceptions type checking example
from types_aiobotocore_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 session.client("sms").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.client("sms").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_app#
Creates an application.
Type annotations and code completion for session.client("sms").create_app
method.
boto3 documentation
# create_app method definition
await def create_app(
self,
*,
name: str = ...,
description: str = ...,
roleName: str = ...,
clientToken: str = ...,
serverGroups: Sequence[ServerGroupTypeDef] = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateAppResponseTypeDef: # (3)
...
- See ServerGroupTypeDef
- See TagTypeDef
- See CreateAppResponseTypeDef
# create_app method usage example with argument unpacking
kwargs: CreateAppRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_app(**kwargs)
create_replication_job#
Creates a replication job.
Type annotations and code completion for session.client("sms").create_replication_job
method.
boto3 documentation
# create_replication_job method definition
await 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)
...
# create_replication_job method usage example with argument unpacking
kwargs: CreateReplicationJobRequestRequestTypeDef = { # (1)
"serverId": ...,
"seedReplicationTime": ...,
}
parent.create_replication_job(**kwargs)
delete_app#
Deletes the specified application.
Type annotations and code completion for session.client("sms").delete_app
method.
boto3 documentation
# delete_app method definition
await def delete_app(
self,
*,
appId: str = ...,
forceStopAppReplication: bool = ...,
forceTerminateApp: bool = ...,
) -> Dict[str, Any]:
...
# delete_app method usage example with argument unpacking
kwargs: DeleteAppRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.delete_app(**kwargs)
delete_app_launch_configuration#
Deletes the launch configuration for the specified application.
Type annotations and code completion for session.client("sms").delete_app_launch_configuration
method.
boto3 documentation
# delete_app_launch_configuration method definition
await def delete_app_launch_configuration(
self,
*,
appId: str = ...,
) -> Dict[str, Any]:
...
# delete_app_launch_configuration method usage example with argument unpacking
kwargs: DeleteAppLaunchConfigurationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.delete_app_launch_configuration(**kwargs)
delete_app_replication_configuration#
Deletes the replication configuration for the specified application.
Type annotations and code completion for session.client("sms").delete_app_replication_configuration
method.
boto3 documentation
# delete_app_replication_configuration method definition
await def delete_app_replication_configuration(
self,
*,
appId: str = ...,
) -> Dict[str, Any]:
...
# delete_app_replication_configuration method usage example with argument unpacking
kwargs: DeleteAppReplicationConfigurationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.delete_app_replication_configuration(**kwargs)
delete_app_validation_configuration#
Deletes the validation configuration for the specified application.
Type annotations and code completion for session.client("sms").delete_app_validation_configuration
method.
boto3 documentation
# delete_app_validation_configuration method definition
await def delete_app_validation_configuration(
self,
*,
appId: str,
) -> Dict[str, Any]:
...
# delete_app_validation_configuration method usage example with argument unpacking
kwargs: DeleteAppValidationConfigurationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.delete_app_validation_configuration(**kwargs)
delete_replication_job#
Deletes the specified replication job.
Type annotations and code completion for session.client("sms").delete_replication_job
method.
boto3 documentation
# delete_replication_job method definition
await def delete_replication_job(
self,
*,
replicationJobId: str,
) -> Dict[str, Any]:
...
# delete_replication_job method usage example with argument unpacking
kwargs: DeleteReplicationJobRequestRequestTypeDef = { # (1)
"replicationJobId": ...,
}
parent.delete_replication_job(**kwargs)
delete_server_catalog#
Deletes all servers from your server catalog.
Type annotations and code completion for session.client("sms").delete_server_catalog
method.
boto3 documentation
# delete_server_catalog method definition
await def delete_server_catalog(
self,
) -> Dict[str, Any]:
...
disassociate_connector#
Disassociates the specified connector from Server Migration Service.
Type annotations and code completion for session.client("sms").disassociate_connector
method.
boto3 documentation
# disassociate_connector method definition
await def disassociate_connector(
self,
*,
connectorId: str,
) -> Dict[str, Any]:
...
# disassociate_connector method usage example with argument unpacking
kwargs: DisassociateConnectorRequestRequestTypeDef = { # (1)
"connectorId": ...,
}
parent.disassociate_connector(**kwargs)
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 session.client("sms").generate_change_set
method.
boto3 documentation
# generate_change_set method definition
await def generate_change_set(
self,
*,
appId: str = ...,
changesetFormat: OutputFormatType = ..., # (1)
) -> GenerateChangeSetResponseTypeDef: # (2)
...
# generate_change_set method usage example with argument unpacking
kwargs: GenerateChangeSetRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.generate_change_set(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("sms").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.client("sms").generate_template
method.
boto3 documentation
# generate_template method definition
await def generate_template(
self,
*,
appId: str = ...,
templateFormat: OutputFormatType = ..., # (1)
) -> GenerateTemplateResponseTypeDef: # (2)
...
# generate_template method usage example with argument unpacking
kwargs: GenerateTemplateRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.generate_template(**kwargs)
get_app#
Retrieve information about the specified application.
Type annotations and code completion for session.client("sms").get_app
method.
boto3 documentation
# get_app method definition
await def get_app(
self,
*,
appId: str = ...,
) -> GetAppResponseTypeDef: # (1)
...
# get_app method usage example with argument unpacking
kwargs: GetAppRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.get_app(**kwargs)
get_app_launch_configuration#
Retrieves the application launch configuration associated with the specified application.
Type annotations and code completion for session.client("sms").get_app_launch_configuration
method.
boto3 documentation
# get_app_launch_configuration method definition
await def get_app_launch_configuration(
self,
*,
appId: str = ...,
) -> GetAppLaunchConfigurationResponseTypeDef: # (1)
...
# get_app_launch_configuration method usage example with argument unpacking
kwargs: GetAppLaunchConfigurationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.get_app_launch_configuration(**kwargs)
get_app_replication_configuration#
Retrieves the application replication configuration associated with the specified application.
Type annotations and code completion for session.client("sms").get_app_replication_configuration
method.
boto3 documentation
# get_app_replication_configuration method definition
await def get_app_replication_configuration(
self,
*,
appId: str = ...,
) -> GetAppReplicationConfigurationResponseTypeDef: # (1)
...
# get_app_replication_configuration method usage example with argument unpacking
kwargs: GetAppReplicationConfigurationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.get_app_replication_configuration(**kwargs)
get_app_validation_configuration#
Retrieves information about a configuration for validating an application.
Type annotations and code completion for session.client("sms").get_app_validation_configuration
method.
boto3 documentation
# get_app_validation_configuration method definition
await def get_app_validation_configuration(
self,
*,
appId: str,
) -> GetAppValidationConfigurationResponseTypeDef: # (1)
...
# get_app_validation_configuration method usage example with argument unpacking
kwargs: GetAppValidationConfigurationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.get_app_validation_configuration(**kwargs)
get_app_validation_output#
Retrieves output from validating an application.
Type annotations and code completion for session.client("sms").get_app_validation_output
method.
boto3 documentation
# get_app_validation_output method definition
await def get_app_validation_output(
self,
*,
appId: str,
) -> GetAppValidationOutputResponseTypeDef: # (1)
...
# get_app_validation_output method usage example with argument unpacking
kwargs: GetAppValidationOutputRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.get_app_validation_output(**kwargs)
get_connectors#
Describes the connectors registered with the Server Migration Service.
Type annotations and code completion for session.client("sms").get_connectors
method.
boto3 documentation
# get_connectors method definition
await def get_connectors(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> GetConnectorsResponseTypeDef: # (1)
...
# get_connectors method usage example with argument unpacking
kwargs: GetConnectorsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.get_connectors(**kwargs)
get_replication_jobs#
Describes the specified replication job or all of your replication jobs.
Type annotations and code completion for session.client("sms").get_replication_jobs
method.
boto3 documentation
# get_replication_jobs method definition
await def get_replication_jobs(
self,
*,
replicationJobId: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetReplicationJobsResponseTypeDef: # (1)
...
# get_replication_jobs method usage example with argument unpacking
kwargs: GetReplicationJobsRequestRequestTypeDef = { # (1)
"replicationJobId": ...,
}
parent.get_replication_jobs(**kwargs)
get_replication_runs#
Describes the replication runs for the specified replication job.
Type annotations and code completion for session.client("sms").get_replication_runs
method.
boto3 documentation
# get_replication_runs method definition
await def get_replication_runs(
self,
*,
replicationJobId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> GetReplicationRunsResponseTypeDef: # (1)
...
# get_replication_runs method usage example with argument unpacking
kwargs: GetReplicationRunsRequestRequestTypeDef = { # (1)
"replicationJobId": ...,
}
parent.get_replication_runs(**kwargs)
get_servers#
Describes the servers in your server catalog.
Type annotations and code completion for session.client("sms").get_servers
method.
boto3 documentation
# get_servers method definition
await def get_servers(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
vmServerAddressList: Sequence[VmServerAddressTypeDef] = ..., # (1)
) -> GetServersResponseTypeDef: # (2)
...
# get_servers method usage example with argument unpacking
kwargs: GetServersRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.get_servers(**kwargs)
import_app_catalog#
Allows application import from Migration Hub.
Type annotations and code completion for session.client("sms").import_app_catalog
method.
boto3 documentation
# import_app_catalog method definition
await def import_app_catalog(
self,
*,
roleName: str = ...,
) -> Dict[str, Any]:
...
# import_app_catalog method usage example with argument unpacking
kwargs: ImportAppCatalogRequestRequestTypeDef = { # (1)
"roleName": ...,
}
parent.import_app_catalog(**kwargs)
import_server_catalog#
Gathers a complete list of on-premises servers.
Type annotations and code completion for session.client("sms").import_server_catalog
method.
boto3 documentation
# import_server_catalog method definition
await 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 session.client("sms").launch_app
method.
boto3 documentation
# launch_app method definition
await def launch_app(
self,
*,
appId: str = ...,
) -> Dict[str, Any]:
...
# launch_app method usage example with argument unpacking
kwargs: LaunchAppRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.launch_app(**kwargs)
list_apps#
Retrieves summaries for all applications.
Type annotations and code completion for session.client("sms").list_apps
method.
boto3 documentation
# list_apps method definition
await def list_apps(
self,
*,
appIds: Sequence[str] = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListAppsResponseTypeDef: # (1)
...
# list_apps method usage example with argument unpacking
kwargs: ListAppsRequestRequestTypeDef = { # (1)
"appIds": ...,
}
parent.list_apps(**kwargs)
notify_app_validation_output#
Provides information to Server Migration Service about whether application validation is successful.
Type annotations and code completion for session.client("sms").notify_app_validation_output
method.
boto3 documentation
# notify_app_validation_output method definition
await def notify_app_validation_output(
self,
*,
appId: str,
notificationContext: NotificationContextTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
# notify_app_validation_output method usage example with argument unpacking
kwargs: NotifyAppValidationOutputRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.notify_app_validation_output(**kwargs)
put_app_launch_configuration#
Creates or updates the launch configuration for the specified application.
Type annotations and code completion for session.client("sms").put_app_launch_configuration
method.
boto3 documentation
# put_app_launch_configuration method definition
await def put_app_launch_configuration(
self,
*,
appId: str = ...,
roleName: str = ...,
autoLaunch: bool = ...,
serverGroupLaunchConfigurations: Sequence[ServerGroupLaunchConfigurationTypeDef] = ..., # (1)
) -> Dict[str, Any]:
...
# put_app_launch_configuration method usage example with argument unpacking
kwargs: PutAppLaunchConfigurationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.put_app_launch_configuration(**kwargs)
put_app_replication_configuration#
Creates or updates the replication configuration for the specified application.
Type annotations and code completion for session.client("sms").put_app_replication_configuration
method.
boto3 documentation
# put_app_replication_configuration method definition
await def put_app_replication_configuration(
self,
*,
appId: str = ...,
serverGroupReplicationConfigurations: Sequence[ServerGroupReplicationConfigurationTypeDef] = ..., # (1)
) -> Dict[str, Any]:
...
# put_app_replication_configuration method usage example with argument unpacking
kwargs: PutAppReplicationConfigurationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.put_app_replication_configuration(**kwargs)
put_app_validation_configuration#
Creates or updates a validation configuration for the specified application.
Type annotations and code completion for session.client("sms").put_app_validation_configuration
method.
boto3 documentation
# put_app_validation_configuration method definition
await def put_app_validation_configuration(
self,
*,
appId: str,
appValidationConfigurations: Sequence[AppValidationConfigurationTypeDef] = ..., # (1)
serverGroupValidationConfigurations: Sequence[ServerGroupValidationConfigurationTypeDef] = ..., # (2)
) -> Dict[str, Any]:
...
# put_app_validation_configuration method usage example with argument unpacking
kwargs: PutAppValidationConfigurationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.put_app_validation_configuration(**kwargs)
start_app_replication#
Starts replicating the specified application by creating replication jobs for each server in the application.
Type annotations and code completion for session.client("sms").start_app_replication
method.
boto3 documentation
# start_app_replication method definition
await def start_app_replication(
self,
*,
appId: str = ...,
) -> Dict[str, Any]:
...
# start_app_replication method usage example with argument unpacking
kwargs: StartAppReplicationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.start_app_replication(**kwargs)
start_on_demand_app_replication#
Starts an on-demand replication run for the specified application.
Type annotations and code completion for session.client("sms").start_on_demand_app_replication
method.
boto3 documentation
# start_on_demand_app_replication method definition
await def start_on_demand_app_replication(
self,
*,
appId: str,
description: str = ...,
) -> Dict[str, Any]:
...
# start_on_demand_app_replication method usage example with argument unpacking
kwargs: StartOnDemandAppReplicationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.start_on_demand_app_replication(**kwargs)
start_on_demand_replication_run#
Starts an on-demand replication run for the specified replication job.
Type annotations and code completion for session.client("sms").start_on_demand_replication_run
method.
boto3 documentation
# start_on_demand_replication_run method definition
await def start_on_demand_replication_run(
self,
*,
replicationJobId: str,
description: str = ...,
) -> StartOnDemandReplicationRunResponseTypeDef: # (1)
...
# start_on_demand_replication_run method usage example with argument unpacking
kwargs: StartOnDemandReplicationRunRequestRequestTypeDef = { # (1)
"replicationJobId": ...,
}
parent.start_on_demand_replication_run(**kwargs)
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 session.client("sms").stop_app_replication
method.
boto3 documentation
# stop_app_replication method definition
await def stop_app_replication(
self,
*,
appId: str = ...,
) -> Dict[str, Any]:
...
# stop_app_replication method usage example with argument unpacking
kwargs: StopAppReplicationRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.stop_app_replication(**kwargs)
terminate_app#
Terminates the stack for the specified application.
Type annotations and code completion for session.client("sms").terminate_app
method.
boto3 documentation
# terminate_app method definition
await def terminate_app(
self,
*,
appId: str = ...,
) -> Dict[str, Any]:
...
# terminate_app method usage example with argument unpacking
kwargs: TerminateAppRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.terminate_app(**kwargs)
update_app#
Updates the specified application.
Type annotations and code completion for session.client("sms").update_app
method.
boto3 documentation
# update_app method definition
await def update_app(
self,
*,
appId: str = ...,
name: str = ...,
description: str = ...,
roleName: str = ...,
serverGroups: Sequence[ServerGroupTypeDef] = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> UpdateAppResponseTypeDef: # (3)
...
- See ServerGroupTypeDef
- See TagTypeDef
- See UpdateAppResponseTypeDef
# update_app method usage example with argument unpacking
kwargs: UpdateAppRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.update_app(**kwargs)
update_replication_job#
Updates the specified settings for the specified replication job.
Type annotations and code completion for session.client("sms").update_replication_job
method.
boto3 documentation
# update_replication_job method definition
await 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]:
...
- See LicenseTypeType
# update_replication_job method usage example with argument unpacking
kwargs: UpdateReplicationJobRequestRequestTypeDef = { # (1)
"replicationJobId": ...,
}
parent.update_replication_job(**kwargs)
__aenter__#
Type annotations and code completion for session.client("sms").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> SMSClient:
...
__aexit__#
Type annotations and code completion for session.client("sms").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.client("sms").get_paginator
method with overloads.
client.get_paginator("get_connectors")
-> GetConnectorsPaginatorclient.get_paginator("get_replication_jobs")
-> GetReplicationJobsPaginatorclient.get_paginator("get_replication_runs")
-> GetReplicationRunsPaginatorclient.get_paginator("get_servers")
-> GetServersPaginatorclient.get_paginator("list_apps")
-> ListAppsPaginator