Skip to content

mgnClient#

Index > mgn > mgnClient

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

mgnClient#

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

# mgnClient usage example

from boto3.session import Session
from mypy_boto3_mgn.client import mgnClient

def get_mgn_client() -> mgnClient:
    return Session().client("mgn")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("mgn")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.UninitializedAccountException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_mgn.client import Exceptions

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

Methods#

archive_application#

Archive application.

Type annotations and code completion for boto3.client("mgn").archive_application method. boto3 documentation

# archive_application method definition

def archive_application(
    self,
    *,
    applicationID: str,
    accountID: str = ...,
) -> ApplicationResponseTypeDef:  # (1)
    ...
  1. See ApplicationResponseTypeDef 
# archive_application method usage example with argument unpacking

kwargs: ArchiveApplicationRequestRequestTypeDef = {  # (1)
    "applicationID": ...,
}

parent.archive_application(**kwargs)
  1. See ArchiveApplicationRequestRequestTypeDef

archive_wave#

Archive wave.

Type annotations and code completion for boto3.client("mgn").archive_wave method. boto3 documentation

# archive_wave method definition

def archive_wave(
    self,
    *,
    waveID: str,
    accountID: str = ...,
) -> WaveResponseTypeDef:  # (1)
    ...
  1. See WaveResponseTypeDef 
# archive_wave method usage example with argument unpacking

kwargs: ArchiveWaveRequestRequestTypeDef = {  # (1)
    "waveID": ...,
}

parent.archive_wave(**kwargs)
  1. See ArchiveWaveRequestRequestTypeDef

associate_applications#

Associate applications to wave.

Type annotations and code completion for boto3.client("mgn").associate_applications method. boto3 documentation

# associate_applications method definition

def associate_applications(
    self,
    *,
    applicationIDs: Sequence[str],
    waveID: str,
    accountID: str = ...,
) -> Dict[str, Any]:
    ...
# associate_applications method usage example with argument unpacking

kwargs: AssociateApplicationsRequestRequestTypeDef = {  # (1)
    "applicationIDs": ...,
    "waveID": ...,
}

parent.associate_applications(**kwargs)
  1. See AssociateApplicationsRequestRequestTypeDef

associate_source_servers#

Associate source servers to application.

Type annotations and code completion for boto3.client("mgn").associate_source_servers method. boto3 documentation

# associate_source_servers method definition

def associate_source_servers(
    self,
    *,
    applicationID: str,
    sourceServerIDs: Sequence[str],
    accountID: str = ...,
) -> Dict[str, Any]:
    ...
# associate_source_servers method usage example with argument unpacking

kwargs: AssociateSourceServersRequestRequestTypeDef = {  # (1)
    "applicationID": ...,
    "sourceServerIDs": ...,
}

parent.associate_source_servers(**kwargs)
  1. See AssociateSourceServersRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

change_server_life_cycle_state#

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER.

Type annotations and code completion for boto3.client("mgn").change_server_life_cycle_state method. boto3 documentation

# change_server_life_cycle_state method definition

def change_server_life_cycle_state(
    self,
    *,
    lifeCycle: ChangeServerLifeCycleStateSourceServerLifecycleTypeDef,  # (1)
    sourceServerID: str,
    accountID: str = ...,
) -> SourceServerResponseTypeDef:  # (2)
    ...
  1. See ChangeServerLifeCycleStateSourceServerLifecycleTypeDef
  2. See SourceServerResponseTypeDef 
# change_server_life_cycle_state method usage example with argument unpacking

kwargs: ChangeServerLifeCycleStateRequestRequestTypeDef = {  # (1)
    "lifeCycle": ...,
    "sourceServerID": ...,
}

parent.change_server_life_cycle_state(**kwargs)
  1. See ChangeServerLifeCycleStateRequestRequestTypeDef

close#

Closes underlying endpoint connections.

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

# close method definition

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

create_application#

Create application.

Type annotations and code completion for boto3.client("mgn").create_application method. boto3 documentation

# create_application method definition

def create_application(
    self,
    *,
    name: str,
    accountID: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> ApplicationResponseTypeDef:  # (1)
    ...
  1. See ApplicationResponseTypeDef 
# create_application method usage example with argument unpacking

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

parent.create_application(**kwargs)
  1. See CreateApplicationRequestRequestTypeDef

create_connector#

Create Connector.

Type annotations and code completion for boto3.client("mgn").create_connector method. boto3 documentation

# create_connector method definition

def create_connector(
    self,
    *,
    name: str,
    ssmInstanceID: str,
    ssmCommandConfig: ConnectorSsmCommandConfigTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> ConnectorResponseTypeDef:  # (2)
    ...
  1. See ConnectorSsmCommandConfigTypeDef
  2. See ConnectorResponseTypeDef 
# create_connector method usage example with argument unpacking

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

parent.create_connector(**kwargs)
  1. See CreateConnectorRequestRequestTypeDef

create_launch_configuration_template#

Creates a new Launch Configuration Template.

Type annotations and code completion for boto3.client("mgn").create_launch_configuration_template method. boto3 documentation

# create_launch_configuration_template method definition

def create_launch_configuration_template(
    self,
    *,
    associatePublicIpAddress: bool = ...,
    bootMode: BootModeType = ...,  # (1)
    copyPrivateIp: bool = ...,
    copyTags: bool = ...,
    enableMapAutoTagging: bool = ...,
    largeVolumeConf: LaunchTemplateDiskConfTypeDef = ...,  # (2)
    launchDisposition: LaunchDispositionType = ...,  # (3)
    licensing: LicensingTypeDef = ...,  # (4)
    mapAutoTaggingMpeID: str = ...,
    postLaunchActions: PostLaunchActionsTypeDef = ...,  # (5)
    smallVolumeConf: LaunchTemplateDiskConfTypeDef = ...,  # (2)
    smallVolumeMaxSize: int = ...,
    tags: Mapping[str, str] = ...,
    targetInstanceTypeRightSizingMethod: TargetInstanceTypeRightSizingMethodType = ...,  # (7)
) -> LaunchConfigurationTemplateResponseTypeDef:  # (8)
    ...
  1. See BootModeType
  2. See LaunchTemplateDiskConfTypeDef
  3. See LaunchDispositionType
  4. See LicensingTypeDef
  5. See PostLaunchActionsTypeDef
  6. See LaunchTemplateDiskConfTypeDef
  7. See TargetInstanceTypeRightSizingMethodType
  8. See LaunchConfigurationTemplateResponseTypeDef 
# create_launch_configuration_template method usage example with argument unpacking

kwargs: CreateLaunchConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "associatePublicIpAddress": ...,
}

parent.create_launch_configuration_template(**kwargs)
  1. See CreateLaunchConfigurationTemplateRequestRequestTypeDef

create_replication_configuration_template#

Creates a new ReplicationConfigurationTemplate.

Type annotations and code completion for boto3.client("mgn").create_replication_configuration_template method. boto3 documentation

# create_replication_configuration_template method definition

def create_replication_configuration_template(
    self,
    *,
    associateDefaultSecurityGroup: bool,
    bandwidthThrottling: int,
    createPublicIP: bool,
    dataPlaneRouting: ReplicationConfigurationDataPlaneRoutingType,  # (1)
    defaultLargeStagingDiskType: ReplicationConfigurationDefaultLargeStagingDiskTypeType,  # (2)
    ebsEncryption: ReplicationConfigurationEbsEncryptionType,  # (3)
    replicationServerInstanceType: str,
    replicationServersSecurityGroupsIDs: Sequence[str],
    stagingAreaSubnetId: str,
    stagingAreaTags: Mapping[str, str],
    useDedicatedReplicationServer: bool,
    ebsEncryptionKeyArn: str = ...,
    tags: Mapping[str, str] = ...,
    useFipsEndpoint: bool = ...,
) -> ReplicationConfigurationTemplateResponseTypeDef:  # (4)
    ...
  1. See ReplicationConfigurationDataPlaneRoutingType
  2. See ReplicationConfigurationDefaultLargeStagingDiskTypeType
  3. See ReplicationConfigurationEbsEncryptionType
  4. See ReplicationConfigurationTemplateResponseTypeDef 
# create_replication_configuration_template method usage example with argument unpacking

kwargs: CreateReplicationConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "associateDefaultSecurityGroup": ...,
    "bandwidthThrottling": ...,
    "createPublicIP": ...,
    "dataPlaneRouting": ...,
    "defaultLargeStagingDiskType": ...,
    "ebsEncryption": ...,
    "replicationServerInstanceType": ...,
    "replicationServersSecurityGroupsIDs": ...,
    "stagingAreaSubnetId": ...,
    "stagingAreaTags": ...,
    "useDedicatedReplicationServer": ...,
}

parent.create_replication_configuration_template(**kwargs)
  1. See CreateReplicationConfigurationTemplateRequestRequestTypeDef

create_wave#

Create wave.

Type annotations and code completion for boto3.client("mgn").create_wave method. boto3 documentation

# create_wave method definition

def create_wave(
    self,
    *,
    name: str,
    accountID: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> WaveResponseTypeDef:  # (1)
    ...
  1. See WaveResponseTypeDef 
# create_wave method usage example with argument unpacking

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

parent.create_wave(**kwargs)
  1. See CreateWaveRequestRequestTypeDef

delete_application#

Delete application.

Type annotations and code completion for boto3.client("mgn").delete_application method.