Skip to content

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

# SMSClient 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.

# Exceptions.exceptions usage example

client = boto3.client("sms")

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)
# Exceptions.exceptions 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

# can_paginate 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

# close 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

# create_app 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
# create_app method usage example with argument unpacking

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

# create_replication_job 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
# create_replication_job method usage example with argument unpacking

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

# delete_app method definition

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)
  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

# delete_app_launch_configuration method definition

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)
  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

# delete_app_replication_configuration method definition

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)
  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

# delete_app_validation_configuration method definition

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)
  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

# delete_replication_job method definition

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)
  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

# delete_server_catalog 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

# disassociate_connector method definition

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)
  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

# generate_change_set method definition

def generate_change_set(
    self,
    *,
    appId: str = ...,
    changesetFormat: OutputFormatType = ...,  # (1)
) -> GenerateChangeSetResponseTypeDef:  # (2)
    ...
  1. See OutputFormatType
  2. See GenerateChangeSetResponseTypeDef
# generate_change_set method usage example with argument unpacking

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

# generate_presigned_url 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

# generate_template method definition

def generate_template(
    self,
    *,
    appId: str = ...,
    templateFormat: OutputFormatType = ...,  # (1)
) -> GenerateTemplateResponseTypeDef:  # (2)
    ...
  1. See OutputFormatType
  2. See GenerateTemplateResponseTypeDef
# generate_template method usage example with argument unpacking

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

parent.generate_template(**kwargs)
  1. See