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

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.

Usage example

client = boto3.client("mgn")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.UninitializedAccountException,
    client.ValidationException,
) as e:
    print(e)

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

Method definition

def archive_application(
    self,
    *,
    applicationID: str,
) -> ApplicationResponseMetadataTypeDef:  # (1)
    ...

1. See ApplicationResponseMetadataTypeDef

Usage example with kwargs

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

Method definition

def archive_wave(
    self,
    *,
    waveID: str,
) -> WaveResponseMetadataTypeDef:  # (1)
    ...

1. See WaveResponseMetadataTypeDef

Usage example with kwargs

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

Method definition

def associate_applications(
    self,
    *,
    applicationIDs: Sequence[str],
    waveID: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def associate_source_servers(
    self,
    *,
    applicationID: str,
    sourceServerIDs: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

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

Method definition

def change_server_life_cycle_state(
    self,
    *,
    lifeCycle: ChangeServerLifeCycleStateSourceServerLifecycleTypeDef,  # (1)
    sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef:  # (2)
    ...

1. See ChangeServerLifeCycleStateSourceServerLifecycleTypeDef
2. See SourceServerResponseMetadataTypeDef

Usage example with kwargs

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

Method definition

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

create_application

Create application.

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

Method definition

def create_application(
    self,
    *,
    name: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> ApplicationResponseMetadataTypeDef:  # (1)
    ...

1. See ApplicationResponseMetadataTypeDef

Usage example with kwargs

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

parent.create_application(**kwargs)

1. See CreateApplicationRequestRequestTypeDef

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

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)
) -> LaunchConfigurationTemplateResponseMetadataTypeDef:  # (8)
    ...

1. See BootModeType
2. See LaunchTemplateDiskConfTypeDef
3. See LaunchDispositionType
4. See LicensingTypeDef
5. See PostLaunchActionsTypeDef
6. See LaunchTemplateDiskConfTypeDef
7. See TargetInstanceTypeRightSizingMethodType
8. See LaunchConfigurationTemplateResponseMetadataTypeDef

Usage example with kwargs

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

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] = ...,
) -> ReplicationConfigurationTemplateResponseMetadataTypeDef:  # (4)
    ...

1. See ReplicationConfigurationDataPlaneRoutingType
2. See ReplicationConfigurationDefaultLargeStagingDiskTypeType
3. See ReplicationConfigurationEbsEncryptionType
4. See ReplicationConfigurationTemplateResponseMetadataTypeDef

Usage example with kwargs

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

Method definition

def create_wave(
    self,
    *,
    name: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> WaveResponseMetadataTypeDef:  # (1)
    ...

1. See WaveResponseMetadataTypeDef

Usage example with kwargs

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. boto3 documentation

Method definition

def delete_application(
    self,
    *,
    applicationID: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_application(**kwargs)

1. See DeleteApplicationRequestRequestTypeDef

delete_job

Deletes a single Job by ID.

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

Method definition

def delete_job(
    self,
    *,
    jobID: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteJobRequestRequestTypeDef = {  # (1)
    "jobID": ...,
}

parent.delete_job(**kwargs)

1. See DeleteJobRequestRequestTypeDef

delete_launch_configuration_template

Deletes a single Launch Configuration Template by ID.

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

Method definition

def delete_launch_configuration_template(
    self,
    *,
    launchConfigurationTemplateID: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteLaunchConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "launchConfigurationTemplateID": ...,
}

parent.delete_launch_configuration_template(**kwargs)

1. See DeleteLaunchConfigurationTemplateRequestRequestTypeDef

delete_replication_configuration_template

Deletes a single Replication Configuration Template by ID See also: AWS API Documentation.

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

Method definition

def delete_replication_configuration_template(
    self,
    *,
    replicationConfigurationTemplateID: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteReplicationConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "replicationConfigurationTemplateID": ...,
}

parent.delete_replication_configuration_template(**kwargs)

1. See DeleteReplicationConfigurationTemplateRequestRequestTypeDef

delete_source_server

Deletes a single source server by ID.

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

Method definition

def delete_source_server(
    self,
    *,
    sourceServerID: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_source_server(**kwargs)

1. See DeleteSourceServerRequestRequestTypeDef

delete_vcenter_client

Deletes a given vCenter client by ID.

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

Method definition

def delete_vcenter_client(
    self,
    *,
    vcenterClientID: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteVcenterClientRequestRequestTypeDef = {  # (1)
    "vcenterClientID": ...,
}

parent.delete_vcenter_client(**kwargs)

1. See DeleteVcenterClientRequestRequestTypeDef

delete_wave

Delete wave.

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

Method definition

def delete_wave(
    self,
    *,
    waveID: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_wave(**kwargs)

1. See DeleteWaveRequestRequestTypeDef

describe_job_log_items

Retrieves detailed job log items with paging.

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

Method definition

def describe_job_log_items(
    self,
    *,
    jobID: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeJobLogItemsResponseTypeDef:  # (1)
    ...

1. See DescribeJobLogItemsResponseTypeDef

Usage example with kwargs

kwargs: DescribeJobLogItemsRequestRequestTypeDef = {  # (1)
    "jobID": ...,
}

parent.describe_job_log_items(**kwargs)

1. See DescribeJobLogItemsRequestRequestTypeDef

describe_jobs

Returns a list of Jobs.

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

Method definition

def describe_jobs(
    self,
    *,
    filters: DescribeJobsRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeJobsResponseTypeDef:  # (2)
    ...

1. See DescribeJobsRequestFiltersTypeDef
2. See DescribeJobsResponseTypeDef

Usage example with kwargs

kwargs: DescribeJobsRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.describe_jobs(**kwargs)

1. See DescribeJobsRequestRequestTypeDef

describe_launch_configuration_templates

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs See also: AWS API Documentation.

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

Method definition

def describe_launch_configuration_templates(
    self,
    *,
    launchConfigurationTemplateIDs: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeLaunchConfigurationTemplatesResponseTypeDef:  # (1)
    ...

1. See DescribeLaunchConfigurationTemplatesResponseTypeDef

Usage example with kwargs

kwargs: DescribeLaunchConfigurationTemplatesRequestRequestTypeDef = {  # (1)
    "launchConfigurationTemplateIDs": ...,
}

parent.describe_launch_configuration_templates(**kwargs)

1. See DescribeLaunchConfigurationTemplatesRequestRequestTypeDef

describe_replication_configuration_templates

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

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

Method definition

def describe_replication_configuration_templates(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    replicationConfigurationTemplateIDs: Sequence[str] = ...,
) -> DescribeReplicationConfigurationTemplatesResponseTypeDef:  # (1)
    ...

1. See DescribeReplicationConfigurationTemplatesResponseTypeDef

Usage example with kwargs

kwargs: DescribeReplicationConfigurationTemplatesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.describe_replication_configuration_templates(**kwargs)

1. See DescribeReplicationConfigurationTemplatesRequestRequestTypeDef

describe_source_servers

Retrieves all SourceServers or multiple SourceServers by ID.

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

Method definition

def describe_source_servers(
    self,
    *,
    filters: DescribeSourceServersRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeSourceServersResponseTypeDef:  # (2)
    ...

1. See DescribeSourceServersRequestFiltersTypeDef
2. See DescribeSourceServersResponseTypeDef

Usage example with kwargs

kwargs: DescribeSourceServersRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.describe_source_servers(**kwargs)

1. See DescribeSourceServersRequestRequestTypeDef

describe_vcenter_clients

Returns a list of the installed vCenter clients.

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

Method definition

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

1. See DescribeVcenterClientsResponseTypeDef

Usage example with kwargs

kwargs: DescribeVcenterClientsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.describe_vcenter_clients(**kwargs)

1. See DescribeVcenterClientsRequestRequestTypeDef

disassociate_applications

Disassociate applications from wave.

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

Method definition

def disassociate_applications(
    self,
    *,
    applicationIDs: Sequence[str],
    waveID: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_applications(**kwargs)

1. See DisassociateApplicationsRequestRequestTypeDef

disassociate_source_servers

Disassociate source servers from application.

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

Method definition

def disassociate_source_servers(
    self,
    *,
    applicationID: str,
    sourceServerIDs: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_source_servers(**kwargs)

1. See DisassociateSourceServersRequestRequestTypeDef

disconnect_from_service

Disconnects specific Source Servers from Application Migration Service.

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

Method definition

def disconnect_from_service(
    self,
    *,
    sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef:  # (1)
    ...

1. See SourceServerResponseMetadataTypeDef

Usage example with kwargs

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

parent.disconnect_from_service(**kwargs)

1. See DisconnectFromServiceRequestRequestTypeDef

finalize_cutover

Finalizes the cutover immediately for specific Source Servers.

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

Method definition

def finalize_cutover(
    self,
    *,
    sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef:  # (1)
    ...

1. See SourceServerResponseMetadataTypeDef

Usage example with kwargs

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

parent.finalize_cutover(**kwargs)

1. See FinalizeCutoverRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("mgn").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:
    ...

get_launch_configuration

Lists all LaunchConfigurations available, filtered by Source Server IDs.

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

Method definition

def get_launch_configuration(
    self,
    *,
    sourceServerID: str,
) -> LaunchConfigurationTypeDef:  # (1)
    ...

1. See LaunchConfigurationTypeDef

Usage example with kwargs

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

parent.get_launch_configuration(**kwargs)

1. See GetLaunchConfigurationRequestRequestTypeDef

get_replication_configuration

Lists all ReplicationConfigurations, filtered by Source Server ID.

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

Method definition

def get_replication_configuration(
    self,
    *,
    sourceServerID: str,
) -> ReplicationConfigurationTypeDef:  # (1)
    ...

1. See ReplicationConfigurationTypeDef

Usage example with kwargs

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

parent.get_replication_configuration(**kwargs)

1. See GetReplicationConfigurationRequestRequestTypeDef

initialize_service

Initialize Application Migration Service.

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

Method definition

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

list_applications

Retrieves all applications or multiple applications by ID.

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

Method definition

def list_applications(
    self,
    *,
    filters: ListApplicationsRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListApplicationsResponseTypeDef:  # (2)
    ...

1. See ListApplicationsRequestFiltersTypeDef
2. See ListApplicationsResponseTypeDef

Usage example with kwargs

kwargs: ListApplicationsRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_applications(**kwargs)

1. See ListApplicationsRequestRequestTypeDef

list_source_server_actions

List source server post migration custom actions.

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

Method definition

def list_source_server_actions(
    self,
    *,
    sourceServerID: str,
    filters: SourceServerActionsRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSourceServerActionsResponseTypeDef:  # (2)
    ...

1. See SourceServerActionsRequestFiltersTypeDef
2. See ListSourceServerActionsResponseTypeDef

Usage example with kwargs

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

parent.list_source_server_actions(**kwargs)

1. See ListSourceServerActionsRequestRequestTypeDef

list_tags_for_resource

List all tags for your Application Migration Service resources.

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

Method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_template_actions

List template post migration custom actions.

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

Method definition

def list_template_actions(
    self,
    *,
    launchConfigurationTemplateID: str,
    filters: TemplateActionsRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTemplateActionsResponseTypeDef:  # (2)
    ...

1. See TemplateActionsRequestFiltersTypeDef
2. See ListTemplateActionsResponseTypeDef

Usage example with kwargs

kwargs: ListTemplateActionsRequestRequestTypeDef = {  # (1)
    "launchConfigurationTemplateID": ...,
}

parent.list_template_actions(**kwargs)

1. See ListTemplateActionsRequestRequestTypeDef

list_waves

Retrieves all waves or multiple waves by ID.

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

Method definition

def list_waves(
    self,
    *,
    filters: ListWavesRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWavesResponseTypeDef:  # (2)
    ...

1. See ListWavesRequestFiltersTypeDef
2. See ListWavesResponseTypeDef

Usage example with kwargs

kwargs: ListWavesRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_waves(**kwargs)

1. See ListWavesRequestRequestTypeDef

mark_as_archived

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID.

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

Method definition

def mark_as_archived(
    self,
    *,
    sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef:  # (1)
    ...

1. See SourceServerResponseMetadataTypeDef

Usage example with kwargs

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

parent.mark_as_archived(**kwargs)

1. See MarkAsArchivedRequestRequestTypeDef

put_source_server_action

Put source server post migration custom action.

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

Method definition

def put_source_server_action(
    self,
    *,
    actionID: str,
    actionName: str,
    documentIdentifier: str,
    order: int,
    sourceServerID: str,
    active: bool = ...,
    documentVersion: str = ...,
    mustSucceedForCutover: bool = ...,
    parameters: Mapping[str, Sequence[SsmParameterStoreParameterTypeDef]] = ...,  # (1)
    timeoutSeconds: int = ...,
) -> SourceServerActionDocumentResponseMetadataTypeDef:  # (2)
    ...

1. See SsmParameterStoreParameterTypeDef
2. See SourceServerActionDocumentResponseMetadataTypeDef

Usage example with kwargs

kwargs: PutSourceServerActionRequestRequestTypeDef = {  # (1)
    "actionID": ...,
    "actionName": ...,
    "documentIdentifier": ...,
    "order": ...,
    "sourceServerID": ...,
}

parent.put_source_server_action(**kwargs)

1. See PutSourceServerActionRequestRequestTypeDef

put_template_action

Put template post migration custom action.

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

Method definition

def put_template_action(
    self,
    *,
    actionID: str,
    actionName: str,
    documentIdentifier: str,
    launchConfigurationTemplateID: str,
    order: int,
    active: bool = ...,
    documentVersion: str = ...,
    mustSucceedForCutover: bool = ...,
    operatingSystem: str = ...,
    parameters: Mapping[str, Sequence[SsmParameterStoreParameterTypeDef]] = ...,  # (1)
    timeoutSeconds: int = ...,
) -> TemplateActionDocumentResponseMetadataTypeDef:  # (2)
    ...

1. See SsmParameterStoreParameterTypeDef
2. See TemplateActionDocumentResponseMetadataTypeDef

Usage example with kwargs

kwargs: PutTemplateActionRequestRequestTypeDef = {  # (1)
    "actionID": ...,
    "actionName": ...,
    "documentIdentifier": ...,
    "launchConfigurationTemplateID": ...,
    "order": ...,
}

parent.put_template_action(**kwargs)

1. See PutTemplateActionRequestRequestTypeDef

remove_source_server_action

Remove source server post migration custom action.

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

Method definition

def remove_source_server_action(
    self,
    *,
    actionID: str,
    sourceServerID: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: RemoveSourceServerActionRequestRequestTypeDef = {  # (1)
    "actionID": ...,
    "sourceServerID": ...,
}

parent.remove_source_server_action(**kwargs)

1. See RemoveSourceServerActionRequestRequestTypeDef

remove_template_action

Remove template post migration custom action.

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

Method definition

def remove_template_action(
    self,
    *,
    actionID: str,
    launchConfigurationTemplateID: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: RemoveTemplateActionRequestRequestTypeDef = {  # (1)
    "actionID": ...,
    "launchConfigurationTemplateID": ...,
}

parent.remove_template_action(**kwargs)

1. See RemoveTemplateActionRequestRequestTypeDef

retry_data_replication

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started.

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

Method definition

def retry_data_replication(
    self,
    *,
    sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef:  # (1)
    ...

1. See SourceServerResponseMetadataTypeDef

Usage example with kwargs

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

parent.retry_data_replication(**kwargs)

1. See RetryDataReplicationRequestRequestTypeDef

start_cutover

Launches a Cutover Instance for specific Source Servers.

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

Method definition

def start_cutover(
    self,
    *,
    sourceServerIDs: Sequence[str],
    tags: Mapping[str, str] = ...,
) -> StartCutoverResponseTypeDef:  # (1)
    ...

1. See StartCutoverResponseTypeDef

Usage example with kwargs

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

parent.start_cutover(**kwargs)

1. See StartCutoverRequestRequestTypeDef

start_replication

Starts replication for SNAPSHOT_SHIPPING agents.

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

Method definition

def start_replication(
    self,
    *,
    sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef:  # (1)
    ...

1. See SourceServerResponseMetadataTypeDef

Usage example with kwargs

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

parent.start_replication(**kwargs)

1. See StartReplicationRequestRequestTypeDef

start_test

Launches a Test Instance for specific Source Servers.

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

Method definition

def start_test(
    self,
    *,
    sourceServerIDs: Sequence[str],
    tags: Mapping[str, str] = ...,
) -> StartTestResponseTypeDef:  # (1)
    ...

1. See StartTestResponseTypeDef

Usage example with kwargs

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

parent.start_test(**kwargs)

1. See StartTestRequestRequestTypeDef

tag_resource

Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources.

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

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

terminate_target_instances

Starts a job that terminates specific launched EC2 Test and Cutover instances.

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

Method definition

def terminate_target_instances(
    self,
    *,
    sourceServerIDs: Sequence[str],
    tags: Mapping[str, str] = ...,
) -> TerminateTargetInstancesResponseTypeDef:  # (1)
    ...

1. See TerminateTargetInstancesResponseTypeDef

Usage example with kwargs

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

parent.terminate_target_instances(**kwargs)

1. See TerminateTargetInstancesRequestRequestTypeDef

unarchive_application

Unarchive application.

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

Method definition

def unarchive_application(
    self,
    *,
    applicationID: str,
) -> ApplicationResponseMetadataTypeDef:  # (1)
    ...

1. See ApplicationResponseMetadataTypeDef

Usage example with kwargs

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

parent.unarchive_application(**kwargs)

1. See UnarchiveApplicationRequestRequestTypeDef

unarchive_wave

Unarchive wave.

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

Method definition

def unarchive_wave(
    self,
    *,
    waveID: str,
) -> WaveResponseMetadataTypeDef:  # (1)
    ...

1. See WaveResponseMetadataTypeDef

Usage example with kwargs

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

parent.unarchive_wave(**kwargs)

1. See UnarchiveWaveRequestRequestTypeDef

untag_resource

Deletes the specified set of tags from the specified set of Application Migration Service resources.

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

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_application

Update application.

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

Method definition

def update_application(
    self,
    *,
    applicationID: str,
    description: str = ...,
    name: str = ...,
) -> ApplicationResponseMetadataTypeDef:  # (1)
    ...

1. See ApplicationResponseMetadataTypeDef

Usage example with kwargs

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

parent.update_application(**kwargs)

1. See UpdateApplicationRequestRequestTypeDef

update_launch_configuration

Updates multiple LaunchConfigurations by Source Server ID.

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

Method definition

def update_launch_configuration(
    self,
    *,
    sourceServerID: str,
    bootMode: BootModeType = ...,  # (1)
    copyPrivateIp: bool = ...,
    copyTags: bool = ...,
    enableMapAutoTagging: bool = ...,
    launchDisposition: LaunchDispositionType = ...,  # (2)
    licensing: LicensingTypeDef = ...,  # (3)
    mapAutoTaggingMpeID: str = ...,
    name: str = ...,
    postLaunchActions: PostLaunchActionsTypeDef = ...,  # (4)
    targetInstanceTypeRightSizingMethod: TargetInstanceTypeRightSizingMethodType = ...,  # (5)
) -> LaunchConfigurationTypeDef:  # (6)
    ...

1. See BootModeType
2. See LaunchDispositionType
3. See LicensingTypeDef
4. See PostLaunchActionsTypeDef
5. See TargetInstanceTypeRightSizingMethodType
6. See LaunchConfigurationTypeDef

Usage example with kwargs

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

parent.update_launch_configuration(**kwargs)

1. See UpdateLaunchConfigurationRequestRequestTypeDef

update_launch_configuration_template

Updates an existing Launch Configuration Template by ID.

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

Method definition

def update_launch_configuration_template(
    self,
    *,
    launchConfigurationTemplateID: str,
    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 = ...,
    targetInstanceTypeRightSizingMethod: TargetInstanceTypeRightSizingMethodType = ...,  # (7)
) -> LaunchConfigurationTemplateResponseMetadataTypeDef:  # (8)
    ...

1. See BootModeType
2. See LaunchTemplateDiskConfTypeDef
3. See LaunchDispositionType
4. See LicensingTypeDef
5. See PostLaunchActionsTypeDef
6. See LaunchTemplateDiskConfTypeDef
7. See TargetInstanceTypeRightSizingMethodType
8. See LaunchConfigurationTemplateResponseMetadataTypeDef

Usage example with kwargs

kwargs: UpdateLaunchConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "launchConfigurationTemplateID": ...,
}

parent.update_launch_configuration_template(**kwargs)

1. See UpdateLaunchConfigurationTemplateRequestRequestTypeDef

update_replication_configuration

Allows you to update multiple ReplicationConfigurations by Source Server ID.

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

Method definition

def update_replication_configuration(
    self,
    *,
    sourceServerID: str,
    associateDefaultSecurityGroup: bool = ...,
    bandwidthThrottling: int = ...,
    createPublicIP: bool = ...,
    dataPlaneRouting: ReplicationConfigurationDataPlaneRoutingType = ...,  # (1)
    defaultLargeStagingDiskType: ReplicationConfigurationDefaultLargeStagingDiskTypeType = ...,  # (2)
    ebsEncryption: ReplicationConfigurationEbsEncryptionType = ...,  # (3)
    ebsEncryptionKeyArn: str = ...,
    name: str = ...,
    replicatedDisks: Sequence[ReplicationConfigurationReplicatedDiskTypeDef] = ...,  # (4)
    replicationServerInstanceType: str = ...,
    replicationServersSecurityGroupsIDs: Sequence[str] = ...,
    stagingAreaSubnetId: str = ...,
    stagingAreaTags: Mapping[str, str] = ...,
    useDedicatedReplicationServer: bool = ...,
) -> ReplicationConfigurationTypeDef:  # (5)
    ...

1. See ReplicationConfigurationDataPlaneRoutingType
2. See ReplicationConfigurationDefaultLargeStagingDiskTypeType
3. See ReplicationConfigurationEbsEncryptionType
4. See ReplicationConfigurationReplicatedDiskTypeDef
5. See ReplicationConfigurationTypeDef

Usage example with kwargs

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

parent.update_replication_configuration(**kwargs)

1. See UpdateReplicationConfigurationRequestRequestTypeDef

update_replication_configuration_template

Updates multiple ReplicationConfigurationTemplates by ID.

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

Method definition

def update_replication_configuration_template(
    self,
    *,
    replicationConfigurationTemplateID: str,
    arn: str = ...,
    associateDefaultSecurityGroup: bool = ...,
    bandwidthThrottling: int = ...,
    createPublicIP: bool = ...,
    dataPlaneRouting: ReplicationConfigurationDataPlaneRoutingType = ...,  # (1)
    defaultLargeStagingDiskType: ReplicationConfigurationDefaultLargeStagingDiskTypeType = ...,  # (2)
    ebsEncryption: ReplicationConfigurationEbsEncryptionType = ...,  # (3)
    ebsEncryptionKeyArn: str = ...,
    replicationServerInstanceType: str = ...,
    replicationServersSecurityGroupsIDs: Sequence[str] = ...,
    stagingAreaSubnetId: str = ...,
    stagingAreaTags: Mapping[str, str] = ...,
    useDedicatedReplicationServer: bool = ...,
) -> ReplicationConfigurationTemplateResponseMetadataTypeDef:  # (4)
    ...

1. See ReplicationConfigurationDataPlaneRoutingType
2. See ReplicationConfigurationDefaultLargeStagingDiskTypeType
3. See ReplicationConfigurationEbsEncryptionType
4. See ReplicationConfigurationTemplateResponseMetadataTypeDef

Usage example with kwargs

kwargs: UpdateReplicationConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "replicationConfigurationTemplateID": ...,
}

parent.update_replication_configuration_template(**kwargs)

1. See UpdateReplicationConfigurationTemplateRequestRequestTypeDef

update_source_server_replication_type

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

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

Method definition

def update_source_server_replication_type(
    self,
    *,
    replicationType: ReplicationTypeType,  # (1)
    sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef:  # (2)
    ...

1. See ReplicationTypeType
2. See SourceServerResponseMetadataTypeDef

Usage example with kwargs

kwargs: UpdateSourceServerReplicationTypeRequestRequestTypeDef = {  # (1)
    "replicationType": ...,
    "sourceServerID": ...,
}

parent.update_source_server_replication_type(**kwargs)

1. See UpdateSourceServerReplicationTypeRequestRequestTypeDef

update_wave

Update wave.

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

Method definition

def update_wave(
    self,
    *,
    waveID: str,
    description: str = ...,
    name: str = ...,
) -> WaveResponseMetadataTypeDef:  # (1)
    ...

1. See WaveResponseMetadataTypeDef

Usage example with kwargs

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

parent.update_wave(**kwargs)

1. See UpdateWaveRequestRequestTypeDef

get_paginator

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

• client.get_paginator("describe_job_log_items") -> DescribeJobLogItemsPaginator
• client.get_paginator("describe_jobs") -> DescribeJobsPaginator
• client.get_paginator("describe_launch_configuration_templates") -> DescribeLaunchConfigurationTemplatesPaginator
• client.get_paginator("describe_replication_configuration_templates") -> DescribeReplicationConfigurationTemplatesPaginator
• client.get_paginator("describe_source_servers") -> DescribeSourceServersPaginator
• client.get_paginator("describe_vcenter_clients") -> DescribeVcenterClientsPaginator
• client.get_paginator("list_applications") -> ListApplicationsPaginator
• client.get_paginator("list_source_server_actions") -> ListSourceServerActionsPaginator
• client.get_paginator("list_template_actions") -> ListTemplateActionsPaginator
• client.get_paginator("list_waves") -> ListWavesPaginator