mgn *** Client ====== class mgn.Client A low-level client representing Application Migration Service (mgn) The Application Migration Service service. import boto3 client = boto3.client('mgn') These are the available methods: * archive_application * archive_wave * associate_applications * associate_source_servers * can_paginate * change_server_life_cycle_state * close * create_application * create_connector * create_launch_configuration_template * create_replication_configuration_template * create_wave * delete_application * delete_connector * delete_job * delete_launch_configuration_template * delete_replication_configuration_template * delete_source_server * delete_vcenter_client * delete_wave * describe_job_log_items * describe_jobs * describe_launch_configuration_templates * describe_replication_configuration_templates * describe_source_servers * describe_vcenter_clients * disassociate_applications * disassociate_source_servers * disconnect_from_service * finalize_cutover * get_launch_configuration * get_paginator * get_replication_configuration * get_waiter * initialize_service * list_applications * list_connectors * list_export_errors * list_exports * list_import_errors * list_imports * list_managed_accounts * list_source_server_actions * list_tags_for_resource * list_template_actions * list_waves * mark_as_archived * pause_replication * put_source_server_action * put_template_action * remove_source_server_action * remove_template_action * resume_replication * retry_data_replication * start_cutover * start_export * start_import * start_replication * start_test * stop_replication * tag_resource * terminate_target_instances * unarchive_application * unarchive_wave * untag_resource * update_application * update_connector * update_launch_configuration * update_launch_configuration_template * update_replication_configuration * update_replication_configuration_template * update_source_server * update_source_server_replication_type * update_wave Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * DescribeJobLogItems * DescribeJobs * DescribeLaunchConfigurationTemplates * DescribeReplicationConfigurationTemplates * DescribeSourceServers * DescribeVcenterClients * ListApplications * ListConnectors * ListExportErrors * ListExports * ListImportErrors * ListImports * ListManagedAccounts * ListSourceServerActions * ListTemplateActions * ListWaves mgn / Paginator / DescribeLaunchConfigurationTemplates DescribeLaunchConfigurationTemplates ************************************ class mgn.Paginator.DescribeLaunchConfigurationTemplates paginator = client.get_paginator('describe_launch_configuration_templates') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.describe_launch_configuration_templates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( launchConfigurationTemplateIDs=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **launchConfigurationTemplateIDs** (*list*) -- Request to filter Launch Configuration Templates list by Launch Configuration Template ID. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'associatePublicIpAddress': True|False, 'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE', 'copyPrivateIp': True|False, 'copyTags': True|False, 'ec2LaunchTemplateID': 'string', 'enableMapAutoTagging': True|False, 'largeVolumeConf': { 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, 'launchConfigurationTemplateID': 'string', 'launchDisposition': 'STOPPED'|'STARTED', 'licensing': { 'osByol': True|False }, 'mapAutoTaggingMpeID': 'string', 'postLaunchActions': { 'cloudWatchLogGroupName': 'string', 'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY', 's3LogBucket': 'string', 's3OutputKeyPrefix': 'string', 'ssmDocuments': [ { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, ] }, 'smallVolumeConf': { 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, 'smallVolumeMaxSize': 123, 'tags': { 'string': 'string' }, 'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* List of items returned by DescribeLaunchConfigurationTemplates. * *(dict) --* * **arn** *(string) --* ARN of the Launch Configuration Template. * **associatePublicIpAddress** *(boolean) --* Associate public Ip address. * **bootMode** *(string) --* Launch configuration template boot mode. * **copyPrivateIp** *(boolean) --* Copy private Ip. * **copyTags** *(boolean) --* Copy tags. * **ec2LaunchTemplateID** *(string) --* EC2 launch template ID. * **enableMapAutoTagging** *(boolean) --* Enable map auto tagging. * **largeVolumeConf** *(dict) --* Large volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **launchConfigurationTemplateID** *(string) --* ID of the Launch Configuration Template. * **launchDisposition** *(string) --* Launch disposition. * **licensing** *(dict) --* Configure Licensing. * **osByol** *(boolean) --* Configure BYOL OS licensing. * **mapAutoTaggingMpeID** *(string) --* Launch configuration template map auto tagging MPE ID. * **postLaunchActions** *(dict) --* Post Launch Actions of the Launch Configuration Template. * **cloudWatchLogGroupName** *(string) --* AWS Systems Manager Command's CloudWatch log group name. * **deployment** *(string) --* Deployment type in which AWS Systems Manager Documents will be executed. * **s3LogBucket** *(string) --* AWS Systems Manager Command's logs S3 log bucket. * **s3OutputKeyPrefix** *(string) --* AWS Systems Manager Command's logs S3 output key prefix. * **ssmDocuments** *(list) --* AWS Systems Manager Documents. * *(dict) --* AWS Systems Manager Document. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **smallVolumeConf** *(dict) --* Small volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **smallVolumeMaxSize** *(integer) --* Small volume maximum size. * **tags** *(dict) --* Tags of the Launch Configuration Template. * *(string) --* * *(string) --* * **targetInstanceTypeRightSizingMethod** *(string) --* Target instance type right-sizing method. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / DescribeVcenterClients DescribeVcenterClients ********************** class mgn.Paginator.DescribeVcenterClients paginator = client.get_paginator('describe_vcenter_clients') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.describe_vcenter_clients()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'datacenterName': 'string', 'hostname': 'string', 'lastSeenDatetime': 'string', 'sourceServerTags': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'vcenterClientID': 'string', 'vcenterUUID': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* List of items returned by DescribeVcenterClients. * *(dict) --* vCenter client. * **arn** *(string) --* Arn of vCenter client. * **datacenterName** *(string) --* Datacenter name of vCenter client. * **hostname** *(string) --* Hostname of vCenter client . * **lastSeenDatetime** *(string) --* Last seen time of vCenter client. * **sourceServerTags** *(dict) --* Tags for Source Server of vCenter client. * *(string) --* * *(string) --* * **tags** *(dict) --* Tags for vCenter client. * *(string) --* * *(string) --* * **vcenterClientID** *(string) --* ID of vCenter client. * **vcenterUUID** *(string) --* Vcenter UUID of vCenter client. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / ListTemplateActions ListTemplateActions ******************* class mgn.Paginator.ListTemplateActions paginator = client.get_paginator('list_template_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.list_template_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters={ 'actionIDs': [ 'string', ] }, launchConfigurationTemplateID='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*dict*) -- Filters to apply when listing template post migration custom actions. * **actionIDs** *(list) --* Action IDs to filter template post migration custom actions by. * *(string) --* * **launchConfigurationTemplateID** (*string*) -- **[REQUIRED]** Launch configuration template ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'actionID': 'string', 'actionName': 'string', 'active': True|False, 'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER', 'description': 'string', 'documentIdentifier': 'string', 'documentVersion': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'operatingSystem': 'string', 'order': 123, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'timeoutSeconds': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* List of template post migration custom actions. * *(dict) --* * **actionID** *(string) --* Template post migration custom action ID. * **actionName** *(string) --* Template post migration custom action name. * **active** *(boolean) --* Template post migration custom action active status. * **category** *(string) --* Template post migration custom action category. * **description** *(string) --* Template post migration custom action description. * **documentIdentifier** *(string) --* Template post migration custom action document identifier. * **documentVersion** *(string) --* Template post migration custom action document version. * **externalParameters** *(dict) --* Template post migration custom action external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* Template post migration custom action must succeed for cutover. * **operatingSystem** *(string) --* Operating system eligible for this template post migration custom action. * **order** *(integer) --* Template post migration custom action order. * **parameters** *(dict) --* Template post migration custom action parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **timeoutSeconds** *(integer) --* Template post migration custom action timeout in seconds. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / ListManagedAccounts ListManagedAccounts ******************* class mgn.Paginator.ListManagedAccounts paginator = client.get_paginator('list_managed_accounts') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.list_managed_accounts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'accountId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* List managed accounts response. * **items** *(list) --* List managed accounts response items. * *(dict) --* Managed account. * **accountId** *(string) --* Managed account, account ID. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / ListImports ListImports *********** class mgn.Paginator.ListImports paginator = client.get_paginator('list_imports') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.list_imports()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters={ 'importIDs': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*dict*) -- List imports request filters. * **importIDs** *(list) --* List imports request filters import IDs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'creationDateTime': 'string', 'endDateTime': 'string', 'importID': 'string', 'progressPercentage': ..., 's3BucketSource': { 's3Bucket': 'string', 's3BucketOwner': 'string', 's3Key': 'string' }, 'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED', 'summary': { 'applications': { 'createdCount': 123, 'modifiedCount': 123 }, 'servers': { 'createdCount': 123, 'modifiedCount': 123 }, 'waves': { 'createdCount': 123, 'modifiedCount': 123 } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* List import response. * **items** *(list) --* List import response items. * *(dict) --* Import task. * **creationDateTime** *(string) --* Import task creation datetime. * **endDateTime** *(string) --* Import task end datetime. * **importID** *(string) --* Import task id. * **progressPercentage** *(float) --* Import task progress percentage. * **s3BucketSource** *(dict) --* Import task s3 bucket source. * **s3Bucket** *(string) --* S3 bucket source s3 bucket. * **s3BucketOwner** *(string) --* S3 bucket source s3 bucket owner. * **s3Key** *(string) --* S3 bucket source s3 key. * **status** *(string) --* Import task status. * **summary** *(dict) --* Import task summary. * **applications** *(dict) --* Import task summary applications. * **createdCount** *(integer) --* Import task summary applications created count. * **modifiedCount** *(integer) --* Import task summary applications modified count. * **servers** *(dict) --* Import task summary servers. * **createdCount** *(integer) --* Import task summary servers created count. * **modifiedCount** *(integer) --* Import task summary servers modified count. * **waves** *(dict) --* Import task summary waves. * **createdCount** *(integer) --* Import task summery waves created count. * **modifiedCount** *(integer) --* Import task summery waves modified count. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / ListExports ListExports *********** class mgn.Paginator.ListExports paginator = client.get_paginator('list_exports') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.list_exports()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters={ 'exportIDs': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*dict*) -- List exports request filters. * **exportIDs** *(list) --* List exports request filters export ids. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'creationDateTime': 'string', 'endDateTime': 'string', 'exportID': 'string', 'progressPercentage': ..., 's3Bucket': 'string', 's3BucketOwner': 'string', 's3Key': 'string', 'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED', 'summary': { 'applicationsCount': 123, 'serversCount': 123, 'wavesCount': 123 } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* List export response. * **items** *(list) --* List export response items. * *(dict) --* Export task. * **creationDateTime** *(string) --* Export task creation datetime. * **endDateTime** *(string) --* Export task end datetime. * **exportID** *(string) --* Export task id. * **progressPercentage** *(float) --* Export task progress percentage. * **s3Bucket** *(string) --* Export task s3 bucket. * **s3BucketOwner** *(string) --* Export task s3 bucket owner. * **s3Key** *(string) --* Export task s3 key. * **status** *(string) --* Export task status. * **summary** *(dict) --* Export task summary. * **applicationsCount** *(integer) --* Export task summary applications count. * **serversCount** *(integer) --* Export task summary servers count. * **wavesCount** *(integer) --* Export task summary waves count. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / DescribeSourceServers DescribeSourceServers ********************* class mgn.Paginator.DescribeSourceServers paginator = client.get_paginator('describe_source_servers') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.describe_source_servers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( accountID='string', filters={ 'applicationIDs': [ 'string', ], 'isArchived': True|False, 'lifeCycleStates': [ 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION', ], 'replicationTypes': [ 'AGENT_BASED'|'SNAPSHOT_SHIPPING', ], 'sourceServerIDs': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **accountID** (*string*) -- Request to filter Source Servers list by Accoun ID. * **filters** (*dict*) -- Request to filter Source Servers list. * **applicationIDs** *(list) --* Request to filter Source Servers list by application IDs. * *(string) --* * **isArchived** *(boolean) --* Request to filter Source Servers list by archived. * **lifeCycleStates** *(list) --* Request to filter Source Servers list by life cycle states. * *(string) --* * **replicationTypes** *(list) --* Request to filter Source Servers list by replication type. * *(string) --* * **sourceServerIDs** *(list) --* Request to filter Source Servers list by Source Server ID. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Request to filter Source Servers list by item. * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / ListWaves ListWaves ********* class mgn.Paginator.ListWaves paginator = client.get_paginator('list_waves') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.list_waves()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( accountID='string', filters={ 'isArchived': True|False, 'waveIDs': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **accountID** (*string*) -- Request account ID. * **filters** (*dict*) -- Waves list filters. * **isArchived** *(boolean) --* Filter waves list by archival status. * **waveIDs** *(list) --* Filter waves list by wave ID. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'replicationStartedDateTime': 'string', 'totalApplications': 123 }, 'waveID': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Waves list. * *(dict) --* * **arn** *(string) --* Wave ARN. * **creationDateTime** *(string) --* Wave creation dateTime. * **description** *(string) --* Wave description. * **isArchived** *(boolean) --* Wave archival status. * **lastModifiedDateTime** *(string) --* Wave last modified dateTime. * **name** *(string) --* Wave name. * **tags** *(dict) --* Wave tags. * *(string) --* * *(string) --* * **waveAggregatedStatus** *(dict) --* Wave aggregated status. * **healthStatus** *(string) --* Wave aggregated status health status. * **lastUpdateDateTime** *(string) --* Wave aggregated status last update dateTime. * **progressStatus** *(string) --* Wave aggregated status progress status. * **replicationStartedDateTime** *(string) --* DateTime marking when the first source server in the wave started replication. * **totalApplications** *(integer) --* Wave aggregated status total applications amount. * **waveID** *(string) --* Wave ID. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / DescribeJobLogItems DescribeJobLogItems ******************* class mgn.Paginator.DescribeJobLogItems paginator = client.get_paginator('describe_job_log_items') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.describe_job_log_items()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( accountID='string', jobID='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **accountID** (*string*) -- Request to describe Job log Account ID. * **jobID** (*string*) -- **[REQUIRED]** Request to describe Job log job ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'event': 'JOB_START'|'SERVER_SKIPPED'|'CLEANUP_START'|'CLEANUP_END'|'CLEANUP_FAIL'|'SNAPSHOT_START'|'SNAPSHOT_END'|'SNAPSHOT_FAIL'|'USING_PREVIOUS_SNAPSHOT'|'CONVERSION_START'|'CONVERSION_END'|'CONVERSION_FAIL'|'LAUNCH_START'|'LAUNCH_FAILED'|'JOB_CANCEL'|'JOB_END', 'eventData': { 'conversionServerID': 'string', 'rawError': 'string', 'sourceServerID': 'string', 'targetInstanceID': 'string' }, 'logDateTime': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Request to describe Job log response items. * *(dict) --* Job log. * **event** *(string) --* Job log event. * **eventData** *(dict) --* Job event data * **conversionServerID** *(string) --* Job Event conversion Server ID. * **rawError** *(string) --* Job error. * **sourceServerID** *(string) --* Job Event Source Server ID. * **targetInstanceID** *(string) --* Job Event Target instance ID. * **logDateTime** *(string) --* Job log event date and time. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / ListExportErrors ListExportErrors **************** class mgn.Paginator.ListExportErrors paginator = client.get_paginator('list_export_errors') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.list_export_errors()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( exportID='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **exportID** (*string*) -- **[REQUIRED]** List export errors request export id. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'errorData': { 'rawError': 'string' }, 'errorDateTime': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* List export errors response. * **items** *(list) --* List export errors response items. * *(dict) --* Export task error. * **errorData** *(dict) --* Export task error data. * **rawError** *(string) --* Export errors data raw error. * **errorDateTime** *(string) --* Export task error datetime. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / DescribeReplicationConfigurationTemplates DescribeReplicationConfigurationTemplates ***************************************** class mgn.Paginator.DescribeReplicationConfigurationTemplates paginator = client.get_paginator('describe_replication_configuration_templates') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.describe_replication_configuration_templates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( replicationConfigurationTemplateIDs=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **replicationConfigurationTemplateIDs** (*list*) -- Request to describe Replication Configuration template by template IDs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'associateDefaultSecurityGroup': True|False, 'bandwidthThrottling': 123, 'createPublicIP': True|False, 'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP', 'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3', 'ebsEncryption': 'DEFAULT'|'CUSTOM', 'ebsEncryptionKeyArn': 'string', 'replicationConfigurationTemplateID': 'string', 'replicationServerInstanceType': 'string', 'replicationServersSecurityGroupsIDs': [ 'string', ], 'stagingAreaSubnetId': 'string', 'stagingAreaTags': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'useDedicatedReplicationServer': True|False, 'useFipsEndpoint': True|False }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Request to describe Replication Configuration template by items. * *(dict) --* * **arn** *(string) --* Replication Configuration template ARN. * **associateDefaultSecurityGroup** *(boolean) --* Replication Configuration template associate default Application Migration Service Security group. * **bandwidthThrottling** *(integer) --* Replication Configuration template bandwidth throttling. * **createPublicIP** *(boolean) --* Replication Configuration template create Public IP. * **dataPlaneRouting** *(string) --* Replication Configuration template data plane routing. * **defaultLargeStagingDiskType** *(string) --* Replication Configuration template use default large Staging Disk type. * **ebsEncryption** *(string) --* Replication Configuration template EBS encryption. * **ebsEncryptionKeyArn** *(string) --* Replication Configuration template EBS encryption key ARN. * **replicationConfigurationTemplateID** *(string) --* Replication Configuration template ID. * **replicationServerInstanceType** *(string) --* Replication Configuration template server instance type. * **replicationServersSecurityGroupsIDs** *(list) --* Replication Configuration template server Security Groups IDs. * *(string) --* * **stagingAreaSubnetId** *(string) --* Replication Configuration template Staging Area subnet ID. * **stagingAreaTags** *(dict) --* Replication Configuration template Staging Area Tags. * *(string) --* * *(string) --* * **tags** *(dict) --* Replication Configuration template Tags. * *(string) --* * *(string) --* * **useDedicatedReplicationServer** *(boolean) --* Replication Configuration template use Dedicated Replication Server. * **useFipsEndpoint** *(boolean) --* Replication Configuration template use Fips Endpoint. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / ListImportErrors ListImportErrors **************** class mgn.Paginator.ListImportErrors paginator = client.get_paginator('list_import_errors') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.list_import_errors()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( importID='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **importID** (*string*) -- **[REQUIRED]** List import errors request import id. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'errorData': { 'accountID': 'string', 'applicationID': 'string', 'ec2LaunchTemplateID': 'string', 'rawError': 'string', 'rowNumber': 123, 'sourceServerID': 'string', 'waveID': 'string' }, 'errorDateTime': 'string', 'errorType': 'VALIDATION_ERROR'|'PROCESSING_ERROR' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* List imports errors response. * **items** *(list) --* List imports errors response items. * *(dict) --* Import task error. * **errorData** *(dict) --* Import task error data. * **accountID** *(string) --* Import error data source account ID. * **applicationID** *(string) --* Import error data application ID. * **ec2LaunchTemplateID** *(string) --* Import error data ec2 LaunchTemplate ID. * **rawError** *(string) --* Import error data raw error. * **rowNumber** *(integer) --* Import error data row number. * **sourceServerID** *(string) --* Import error data source server ID. * **waveID** *(string) --* Import error data wave id. * **errorDateTime** *(string) --* Import task error datetime. * **errorType** *(string) --* Import task error type. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / ListConnectors ListConnectors ************** class mgn.Paginator.ListConnectors paginator = client.get_paginator('list_connectors') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.list_connectors()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters={ 'connectorIDs': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*dict*) -- List Connectors Request filters. * **connectorIDs** *(list) --* List Connectors Request Filters connector IDs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'connectorID': 'string', 'name': 'string', 'ssmCommandConfig': { 'cloudWatchLogGroupName': 'string', 'cloudWatchOutputEnabled': True|False, 'outputS3BucketName': 'string', 's3OutputEnabled': True|False }, 'ssmInstanceID': 'string', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* List connectors response items. * *(dict) --* * **arn** *(string) --* Connector arn. * **connectorID** *(string) --* Connector ID. * **name** *(string) --* Connector name. * **ssmCommandConfig** *(dict) --* Connector SSM command config. * **cloudWatchLogGroupName** *(string) --* Connector SSM command config CloudWatch log group name. * **cloudWatchOutputEnabled** *(boolean) --* Connector SSM command config CloudWatch output enabled. * **outputS3BucketName** *(string) --* Connector SSM command config output S3 bucket name. * **s3OutputEnabled** *(boolean) --* Connector SSM command config S3 output enabled. * **ssmInstanceID** *(string) --* Connector SSM instance ID. * **tags** *(dict) --* Connector tags. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / ListSourceServerActions ListSourceServerActions *********************** class mgn.Paginator.ListSourceServerActions paginator = client.get_paginator('list_source_server_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.list_source_server_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( accountID='string', filters={ 'actionIDs': [ 'string', ] }, sourceServerID='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **accountID** (*string*) -- Account ID to return when listing source server post migration custom actions. * **filters** (*dict*) -- Filters to apply when listing source server post migration custom actions. * **actionIDs** *(list) --* Action IDs to filter source server post migration custom actions by. * *(string) --* * **sourceServerID** (*string*) -- **[REQUIRED]** Source server ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'actionID': 'string', 'actionName': 'string', 'active': True|False, 'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER', 'description': 'string', 'documentIdentifier': 'string', 'documentVersion': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'order': 123, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'timeoutSeconds': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* List of source server post migration custom actions. * *(dict) --* * **actionID** *(string) --* Source server post migration custom action ID. * **actionName** *(string) --* Source server post migration custom action name. * **active** *(boolean) --* Source server post migration custom action active status. * **category** *(string) --* Source server post migration custom action category. * **description** *(string) --* Source server post migration custom action description. * **documentIdentifier** *(string) --* Source server post migration custom action document identifier. * **documentVersion** *(string) --* Source server post migration custom action document version. * **externalParameters** *(dict) --* Source server post migration custom action external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* Source server post migration custom action must succeed for cutover. * **order** *(integer) --* Source server post migration custom action order. * **parameters** *(dict) --* Source server post migration custom action parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **timeoutSeconds** *(integer) --* Source server post migration custom action timeout in seconds. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / ListApplications ListApplications **************** class mgn.Paginator.ListApplications paginator = client.get_paginator('list_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.list_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( accountID='string', filters={ 'applicationIDs': [ 'string', ], 'isArchived': True|False, 'waveIDs': [ 'string', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **accountID** (*string*) -- Applications list Account ID. * **filters** (*dict*) -- Applications list filters. * **applicationIDs** *(list) --* Filter applications list by application ID. * *(string) --* * **isArchived** *(boolean) --* Filter applications list by archival status. * **waveIDs** *(list) --* Filter applications list by wave ID. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'applicationAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'totalSourceServers': 123 }, 'applicationID': 'string', 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveID': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Applications list. * *(dict) --* * **applicationAggregatedStatus** *(dict) --* Application aggregated status. * **healthStatus** *(string) --* Application aggregated status health status. * **lastUpdateDateTime** *(string) --* Application aggregated status last update dateTime. * **progressStatus** *(string) --* Application aggregated status progress status. * **totalSourceServers** *(integer) --* Application aggregated status total source servers amount. * **applicationID** *(string) --* Application ID. * **arn** *(string) --* Application ARN. * **creationDateTime** *(string) --* Application creation dateTime. * **description** *(string) --* Application description. * **isArchived** *(boolean) --* Application archival status. * **lastModifiedDateTime** *(string) --* Application last modified dateTime. * **name** *(string) --* Application name. * **tags** *(dict) --* Application tags. * *(string) --* * *(string) --* * **waveID** *(string) --* Application wave ID. * **NextToken** *(string) --* A token to resume pagination. mgn / Paginator / DescribeJobs DescribeJobs ************ class mgn.Paginator.DescribeJobs paginator = client.get_paginator('describe_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "mgn.Client.describe_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( accountID='string', filters={ 'fromDate': 'string', 'jobIDs': [ 'string', ], 'toDate': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **accountID** (*string*) -- Request to describe job log items by Account ID. * **filters** (*dict*) -- Request to describe Job log filters. * **fromDate** *(string) --* Request to describe Job log filters by date. * **jobIDs** *(list) --* Request to describe Job log filters by job ID. * *(string) --* * **toDate** *(string) --* Request to describe job log items by last date. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'creationDateTime': 'string', 'endDateTime': 'string', 'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE', 'jobID': 'string', 'participatingServers': [ { 'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED', 'launchedEc2InstanceID': 'string', 'postLaunchActionsStatus': { 'postLaunchActionsLaunchStatusList': [ { 'executionID': 'string', 'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED', 'failureReason': 'string', 'ssmDocument': { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, 'ssmDocumentType': 'AUTOMATION'|'COMMAND' }, ], 'ssmAgentDiscoveryDatetime': 'string' }, 'sourceServerID': 'string' }, ], 'status': 'PENDING'|'STARTED'|'COMPLETED', 'tags': { 'string': 'string' }, 'type': 'LAUNCH'|'TERMINATE' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Request to describe Job log items. * *(dict) --* Job. * **arn** *(string) --* the ARN of the specific Job. * **creationDateTime** *(string) --* Job creation time. * **endDateTime** *(string) --* Job end time. * **initiatedBy** *(string) --* Job initiated by field. * **jobID** *(string) --* Job ID. * **participatingServers** *(list) --* Servers participating in a specific Job. * *(dict) --* Server participating in Job. * **launchStatus** *(string) --* Participating server launch status. * **launchedEc2InstanceID** *(string) --* Participating server's launched ec2 instance ID. * **postLaunchActionsStatus** *(dict) --* Participating server's Post Launch Actions Status. * **postLaunchActionsLaunchStatusList** *(list) --* List of Post Launch Action status. * *(dict) --* Launch Status of the Job Post Launch Actions. * **executionID** *(string) --* AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions. * **executionStatus** *(string) --* AWS Systems Manager Document's execution status. * **failureReason** *(string) --* AWS Systems Manager Document's failure reason. * **ssmDocument** *(dict) --* AWS Systems Manager's Document of the of the Job Post Launch Actions. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **ssmDocumentType** *(string) --* AWS Systems Manager Document type. * **ssmAgentDiscoveryDatetime** *(string) --* Time where the AWS Systems Manager was detected as running on the Test or Cutover instance. * **sourceServerID** *(string) --* Participating server Source Server ID. * **status** *(string) --* Job status. * **tags** *(dict) --* Tags associated with specific Job. * *(string) --* * *(string) --* * **type** *(string) --* Job type. * **NextToken** *(string) --* A token to resume pagination. mgn / Client / delete_job delete_job ********** mgn.Client.delete_job(**kwargs) Deletes a single Job by ID. See also: AWS API Documentation **Request Syntax** response = client.delete_job( accountID='string', jobID='string' ) Parameters: * **accountID** (*string*) -- Request to delete Job from service by Account ID. * **jobID** (*string*) -- **[REQUIRED]** Request to delete Job from service by Job ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / terminate_target_instances terminate_target_instances ************************** mgn.Client.terminate_target_instances(**kwargs) Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER. See also: AWS API Documentation **Request Syntax** response = client.terminate_target_instances( accountID='string', sourceServerIDs=[ 'string', ], tags={ 'string': 'string' } ) Parameters: * **accountID** (*string*) -- Terminate Target instance by Account ID * **sourceServerIDs** (*list*) -- **[REQUIRED]** Terminate Target instance by Source Server IDs. * *(string) --* * **tags** (*dict*) -- Terminate Target instance by Tags. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'job': { 'arn': 'string', 'creationDateTime': 'string', 'endDateTime': 'string', 'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE', 'jobID': 'string', 'participatingServers': [ { 'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED', 'launchedEc2InstanceID': 'string', 'postLaunchActionsStatus': { 'postLaunchActionsLaunchStatusList': [ { 'executionID': 'string', 'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED', 'failureReason': 'string', 'ssmDocument': { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, 'ssmDocumentType': 'AUTOMATION'|'COMMAND' }, ], 'ssmAgentDiscoveryDatetime': 'string' }, 'sourceServerID': 'string' }, ], 'status': 'PENDING'|'STARTED'|'COMPLETED', 'tags': { 'string': 'string' }, 'type': 'LAUNCH'|'TERMINATE' } } **Response Structure** * *(dict) --* * **job** *(dict) --* Terminate Target instance Job response. * **arn** *(string) --* the ARN of the specific Job. * **creationDateTime** *(string) --* Job creation time. * **endDateTime** *(string) --* Job end time. * **initiatedBy** *(string) --* Job initiated by field. * **jobID** *(string) --* Job ID. * **participatingServers** *(list) --* Servers participating in a specific Job. * *(dict) --* Server participating in Job. * **launchStatus** *(string) --* Participating server launch status. * **launchedEc2InstanceID** *(string) --* Participating server's launched ec2 instance ID. * **postLaunchActionsStatus** *(dict) --* Participating server's Post Launch Actions Status. * **postLaunchActionsLaunchStatusList** *(list) --* List of Post Launch Action status. * *(dict) --* Launch Status of the Job Post Launch Actions. * **executionID** *(string) --* AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions. * **executionStatus** *(string) --* AWS Systems Manager Document's execution status. * **failureReason** *(string) --* AWS Systems Manager Document's failure reason. * **ssmDocument** *(dict) --* AWS Systems Manager's Document of the of the Job Post Launch Actions. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **ssmDocumentType** *(string) --* AWS Systems Manager Document type. * **ssmAgentDiscoveryDatetime** *(string) --* Time where the AWS Systems Manager was detected as running on the Test or Cutover instance. * **sourceServerID** *(string) --* Participating server Source Server ID. * **status** *(string) --* Job status. * **tags** *(dict) --* Tags associated with specific Job. * *(string) --* * *(string) --* * **type** *(string) --* Job type. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ConflictException" mgn / Client / list_applications list_applications ***************** mgn.Client.list_applications(**kwargs) Retrieves all applications or multiple applications by ID. See also: AWS API Documentation **Request Syntax** response = client.list_applications( accountID='string', filters={ 'applicationIDs': [ 'string', ], 'isArchived': True|False, 'waveIDs': [ 'string', ] }, maxResults=123, nextToken='string' ) Parameters: * **accountID** (*string*) -- Applications list Account ID. * **filters** (*dict*) -- Applications list filters. * **applicationIDs** *(list) --* Filter applications list by application ID. * *(string) --* * **isArchived** *(boolean) --* Filter applications list by archival status. * **waveIDs** *(list) --* Filter applications list by wave ID. * *(string) --* * **maxResults** (*integer*) -- Maximum results to return when listing applications. * **nextToken** (*string*) -- Request next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'applicationAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'totalSourceServers': 123 }, 'applicationID': 'string', 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveID': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Applications list. * *(dict) --* * **applicationAggregatedStatus** *(dict) --* Application aggregated status. * **healthStatus** *(string) --* Application aggregated status health status. * **lastUpdateDateTime** *(string) --* Application aggregated status last update dateTime. * **progressStatus** *(string) --* Application aggregated status progress status. * **totalSourceServers** *(integer) --* Application aggregated status total source servers amount. * **applicationID** *(string) --* Application ID. * **arn** *(string) --* Application ARN. * **creationDateTime** *(string) --* Application creation dateTime. * **description** *(string) --* Application description. * **isArchived** *(boolean) --* Application archival status. * **lastModifiedDateTime** *(string) --* Application last modified dateTime. * **name** *(string) --* Application name. * **tags** *(dict) --* Application tags. * *(string) --* * *(string) --* * **waveID** *(string) --* Application wave ID. * **nextToken** *(string) --* Response next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" mgn / Client / get_paginator get_paginator ************* mgn.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. mgn / Client / create_replication_configuration_template create_replication_configuration_template ***************************************** mgn.Client.create_replication_configuration_template(**kwargs) Creates a new ReplicationConfigurationTemplate. See also: AWS API Documentation **Request Syntax** response = client.create_replication_configuration_template( associateDefaultSecurityGroup=True|False, bandwidthThrottling=123, createPublicIP=True|False, dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP', defaultLargeStagingDiskType='GP2'|'ST1'|'GP3', ebsEncryption='DEFAULT'|'CUSTOM', ebsEncryptionKeyArn='string', replicationServerInstanceType='string', replicationServersSecurityGroupsIDs=[ 'string', ], stagingAreaSubnetId='string', stagingAreaTags={ 'string': 'string' }, tags={ 'string': 'string' }, useDedicatedReplicationServer=True|False, useFipsEndpoint=True|False ) Parameters: * **associateDefaultSecurityGroup** (*boolean*) -- **[REQUIRED]** Request to associate the default Application Migration Service Security group with the Replication Settings template. * **bandwidthThrottling** (*integer*) -- **[REQUIRED]** Request to configure bandwidth throttling during Replication Settings template creation. * **createPublicIP** (*boolean*) -- **[REQUIRED]** Request to create Public IP during Replication Settings template creation. * **dataPlaneRouting** (*string*) -- **[REQUIRED]** Request to configure data plane routing during Replication Settings template creation. * **defaultLargeStagingDiskType** (*string*) -- **[REQUIRED]** Request to configure the default large staging disk EBS volume type during Replication Settings template creation. * **ebsEncryption** (*string*) -- **[REQUIRED]** Request to configure EBS encryption during Replication Settings template creation. * **ebsEncryptionKeyArn** (*string*) -- Request to configure an EBS encryption key during Replication Settings template creation. * **replicationServerInstanceType** (*string*) -- **[REQUIRED]** Request to configure the Replication Server instance type during Replication Settings template creation. * **replicationServersSecurityGroupsIDs** (*list*) -- **[REQUIRED]** Request to configure the Replication Server Security group ID during Replication Settings template creation. * *(string) --* * **stagingAreaSubnetId** (*string*) -- **[REQUIRED]** Request to configure the Staging Area subnet ID during Replication Settings template creation. * **stagingAreaTags** (*dict*) -- **[REQUIRED]** Request to configure Staging Area tags during Replication Settings template creation. * *(string) --* * *(string) --* * **tags** (*dict*) -- Request to configure tags during Replication Settings template creation. * *(string) --* * *(string) --* * **useDedicatedReplicationServer** (*boolean*) -- **[REQUIRED]** Request to use Dedicated Replication Servers during Replication Settings template creation. * **useFipsEndpoint** (*boolean*) -- Request to use Fips Endpoint during Replication Settings template creation. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'associateDefaultSecurityGroup': True|False, 'bandwidthThrottling': 123, 'createPublicIP': True|False, 'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP', 'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3', 'ebsEncryption': 'DEFAULT'|'CUSTOM', 'ebsEncryptionKeyArn': 'string', 'replicationConfigurationTemplateID': 'string', 'replicationServerInstanceType': 'string', 'replicationServersSecurityGroupsIDs': [ 'string', ], 'stagingAreaSubnetId': 'string', 'stagingAreaTags': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'useDedicatedReplicationServer': True|False, 'useFipsEndpoint': True|False } **Response Structure** * *(dict) --* * **arn** *(string) --* Replication Configuration template ARN. * **associateDefaultSecurityGroup** *(boolean) --* Replication Configuration template associate default Application Migration Service Security group. * **bandwidthThrottling** *(integer) --* Replication Configuration template bandwidth throttling. * **createPublicIP** *(boolean) --* Replication Configuration template create Public IP. * **dataPlaneRouting** *(string) --* Replication Configuration template data plane routing. * **defaultLargeStagingDiskType** *(string) --* Replication Configuration template use default large Staging Disk type. * **ebsEncryption** *(string) --* Replication Configuration template EBS encryption. * **ebsEncryptionKeyArn** *(string) --* Replication Configuration template EBS encryption key ARN. * **replicationConfigurationTemplateID** *(string) --* Replication Configuration template ID. * **replicationServerInstanceType** *(string) --* Replication Configuration template server instance type. * **replicationServersSecurityGroupsIDs** *(list) --* Replication Configuration template server Security Groups IDs. * *(string) --* * **stagingAreaSubnetId** *(string) --* Replication Configuration template Staging Area subnet ID. * **stagingAreaTags** *(dict) --* Replication Configuration template Staging Area Tags. * *(string) --* * *(string) --* * **tags** *(dict) --* Replication Configuration template Tags. * *(string) --* * *(string) --* * **useDedicatedReplicationServer** *(boolean) --* Replication Configuration template use Dedicated Replication Server. * **useFipsEndpoint** *(boolean) --* Replication Configuration template use Fips Endpoint. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.AccessDeniedException" mgn / Client / start_test start_test ********** mgn.Client.start_test(**kwargs) Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING. See also: AWS API Documentation **Request Syntax** response = client.start_test( accountID='string', sourceServerIDs=[ 'string', ], tags={ 'string': 'string' } ) Parameters: * **accountID** (*string*) -- Start Test for Account ID. * **sourceServerIDs** (*list*) -- **[REQUIRED]** Start Test for Source Server IDs. * *(string) --* * **tags** (*dict*) -- Start Test by Tags. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'job': { 'arn': 'string', 'creationDateTime': 'string', 'endDateTime': 'string', 'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE', 'jobID': 'string', 'participatingServers': [ { 'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED', 'launchedEc2InstanceID': 'string', 'postLaunchActionsStatus': { 'postLaunchActionsLaunchStatusList': [ { 'executionID': 'string', 'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED', 'failureReason': 'string', 'ssmDocument': { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, 'ssmDocumentType': 'AUTOMATION'|'COMMAND' }, ], 'ssmAgentDiscoveryDatetime': 'string' }, 'sourceServerID': 'string' }, ], 'status': 'PENDING'|'STARTED'|'COMPLETED', 'tags': { 'string': 'string' }, 'type': 'LAUNCH'|'TERMINATE' } } **Response Structure** * *(dict) --* * **job** *(dict) --* Start Test Job response. * **arn** *(string) --* the ARN of the specific Job. * **creationDateTime** *(string) --* Job creation time. * **endDateTime** *(string) --* Job end time. * **initiatedBy** *(string) --* Job initiated by field. * **jobID** *(string) --* Job ID. * **participatingServers** *(list) --* Servers participating in a specific Job. * *(dict) --* Server participating in Job. * **launchStatus** *(string) --* Participating server launch status. * **launchedEc2InstanceID** *(string) --* Participating server's launched ec2 instance ID. * **postLaunchActionsStatus** *(dict) --* Participating server's Post Launch Actions Status. * **postLaunchActionsLaunchStatusList** *(list) --* List of Post Launch Action status. * *(dict) --* Launch Status of the Job Post Launch Actions. * **executionID** *(string) --* AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions. * **executionStatus** *(string) --* AWS Systems Manager Document's execution status. * **failureReason** *(string) --* AWS Systems Manager Document's failure reason. * **ssmDocument** *(dict) --* AWS Systems Manager's Document of the of the Job Post Launch Actions. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **ssmDocumentType** *(string) --* AWS Systems Manager Document type. * **ssmAgentDiscoveryDatetime** *(string) --* Time where the AWS Systems Manager was detected as running on the Test or Cutover instance. * **sourceServerID** *(string) --* Participating server Source Server ID. * **status** *(string) --* Job status. * **tags** *(dict) --* Tags associated with specific Job. * *(string) --* * *(string) --* * **type** *(string) --* Job type. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ConflictException" mgn / Client / describe_job_log_items describe_job_log_items ********************** mgn.Client.describe_job_log_items(**kwargs) Retrieves detailed job log items with paging. See also: AWS API Documentation **Request Syntax** response = client.describe_job_log_items( accountID='string', jobID='string', maxResults=123, nextToken='string' ) Parameters: * **accountID** (*string*) -- Request to describe Job log Account ID. * **jobID** (*string*) -- **[REQUIRED]** Request to describe Job log job ID. * **maxResults** (*integer*) -- Request to describe Job log item maximum results. * **nextToken** (*string*) -- Request to describe Job log next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'event': 'JOB_START'|'SERVER_SKIPPED'|'CLEANUP_START'|'CLEANUP_END'|'CLEANUP_FAIL'|'SNAPSHOT_START'|'SNAPSHOT_END'|'SNAPSHOT_FAIL'|'USING_PREVIOUS_SNAPSHOT'|'CONVERSION_START'|'CONVERSION_END'|'CONVERSION_FAIL'|'LAUNCH_START'|'LAUNCH_FAILED'|'JOB_CANCEL'|'JOB_END', 'eventData': { 'conversionServerID': 'string', 'rawError': 'string', 'sourceServerID': 'string', 'targetInstanceID': 'string' }, 'logDateTime': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Request to describe Job log response items. * *(dict) --* Job log. * **event** *(string) --* Job log event. * **eventData** *(dict) --* Job event data * **conversionServerID** *(string) --* Job Event conversion Server ID. * **rawError** *(string) --* Job error. * **sourceServerID** *(string) --* Job Event Source Server ID. * **targetInstanceID** *(string) --* Job Event Target instance ID. * **logDateTime** *(string) --* Job log event date and time. * **nextToken** *(string) --* Request to describe Job log response next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" mgn / Client / start_cutover start_cutover ************* mgn.Client.start_cutover(**kwargs) Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER. See also: AWS API Documentation **Request Syntax** response = client.start_cutover( accountID='string', sourceServerIDs=[ 'string', ], tags={ 'string': 'string' } ) Parameters: * **accountID** (*string*) -- Start Cutover by Account IDs * **sourceServerIDs** (*list*) -- **[REQUIRED]** Start Cutover by Source Server IDs. * *(string) --* * **tags** (*dict*) -- Start Cutover by Tags. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'job': { 'arn': 'string', 'creationDateTime': 'string', 'endDateTime': 'string', 'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE', 'jobID': 'string', 'participatingServers': [ { 'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED', 'launchedEc2InstanceID': 'string', 'postLaunchActionsStatus': { 'postLaunchActionsLaunchStatusList': [ { 'executionID': 'string', 'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED', 'failureReason': 'string', 'ssmDocument': { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, 'ssmDocumentType': 'AUTOMATION'|'COMMAND' }, ], 'ssmAgentDiscoveryDatetime': 'string' }, 'sourceServerID': 'string' }, ], 'status': 'PENDING'|'STARTED'|'COMPLETED', 'tags': { 'string': 'string' }, 'type': 'LAUNCH'|'TERMINATE' } } **Response Structure** * *(dict) --* * **job** *(dict) --* Start Cutover Job response. * **arn** *(string) --* the ARN of the specific Job. * **creationDateTime** *(string) --* Job creation time. * **endDateTime** *(string) --* Job end time. * **initiatedBy** *(string) --* Job initiated by field. * **jobID** *(string) --* Job ID. * **participatingServers** *(list) --* Servers participating in a specific Job. * *(dict) --* Server participating in Job. * **launchStatus** *(string) --* Participating server launch status. * **launchedEc2InstanceID** *(string) --* Participating server's launched ec2 instance ID. * **postLaunchActionsStatus** *(dict) --* Participating server's Post Launch Actions Status. * **postLaunchActionsLaunchStatusList** *(list) --* List of Post Launch Action status. * *(dict) --* Launch Status of the Job Post Launch Actions. * **executionID** *(string) --* AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions. * **executionStatus** *(string) --* AWS Systems Manager Document's execution status. * **failureReason** *(string) --* AWS Systems Manager Document's failure reason. * **ssmDocument** *(dict) --* AWS Systems Manager's Document of the of the Job Post Launch Actions. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **ssmDocumentType** *(string) --* AWS Systems Manager Document type. * **ssmAgentDiscoveryDatetime** *(string) --* Time where the AWS Systems Manager was detected as running on the Test or Cutover instance. * **sourceServerID** *(string) --* Participating server Source Server ID. * **status** *(string) --* Job status. * **tags** *(dict) --* Tags associated with specific Job. * *(string) --* * *(string) --* * **type** *(string) --* Job type. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ConflictException" mgn / Client / initialize_service initialize_service ****************** mgn.Client.initialize_service() Initialize Application Migration Service. See also: AWS API Documentation **Request Syntax** response = client.initialize_service() Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.AccessDeniedException" mgn / Client / finalize_cutover finalize_cutover **************** mgn.Client.finalize_cutover(**kwargs) Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified. See also: AWS API Documentation **Request Syntax** response = client.finalize_cutover( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Request to finalize Cutover by Source Account ID. * **sourceServerID** (*string*) -- **[REQUIRED]** Request to finalize Cutover by Source Server ID. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ConflictException" mgn / Client / update_launch_configuration_template update_launch_configuration_template ************************************ mgn.Client.update_launch_configuration_template(**kwargs) Updates an existing Launch Configuration Template by ID. See also: AWS API Documentation **Request Syntax** response = client.update_launch_configuration_template( associatePublicIpAddress=True|False, bootMode='LEGACY_BIOS'|'UEFI'|'USE_SOURCE', copyPrivateIp=True|False, copyTags=True|False, enableMapAutoTagging=True|False, largeVolumeConf={ 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, launchConfigurationTemplateID='string', launchDisposition='STOPPED'|'STARTED', licensing={ 'osByol': True|False }, mapAutoTaggingMpeID='string', postLaunchActions={ 'cloudWatchLogGroupName': 'string', 'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY', 's3LogBucket': 'string', 's3OutputKeyPrefix': 'string', 'ssmDocuments': [ { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, ] }, smallVolumeConf={ 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, smallVolumeMaxSize=123, targetInstanceTypeRightSizingMethod='NONE'|'BASIC' ) Parameters: * **associatePublicIpAddress** (*boolean*) -- Associate public Ip address. * **bootMode** (*string*) -- Launch configuration template boot mode. * **copyPrivateIp** (*boolean*) -- Copy private Ip. * **copyTags** (*boolean*) -- Copy tags. * **enableMapAutoTagging** (*boolean*) -- Enable map auto tagging. * **largeVolumeConf** (*dict*) -- Large volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **launchConfigurationTemplateID** (*string*) -- **[REQUIRED]** Launch Configuration Template ID. * **launchDisposition** (*string*) -- Launch disposition. * **licensing** (*dict*) -- Configure Licensing. * **osByol** *(boolean) --* Configure BYOL OS licensing. * **mapAutoTaggingMpeID** (*string*) -- Launch configuration template map auto tagging MPE ID. * **postLaunchActions** (*dict*) -- Post Launch Action to execute on the Test or Cutover instance. * **cloudWatchLogGroupName** *(string) --* AWS Systems Manager Command's CloudWatch log group name. * **deployment** *(string) --* Deployment type in which AWS Systems Manager Documents will be executed. * **s3LogBucket** *(string) --* AWS Systems Manager Command's logs S3 log bucket. * **s3OutputKeyPrefix** *(string) --* AWS Systems Manager Command's logs S3 output key prefix. * **ssmDocuments** *(list) --* AWS Systems Manager Documents. * *(dict) --* AWS Systems Manager Document. * **actionName** *(string) --* **[REQUIRED]** User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "dynamicPath". * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* **[REQUIRED]** AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* **[REQUIRED]** AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* **[REQUIRED]** AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **smallVolumeConf** (*dict*) -- Small volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **smallVolumeMaxSize** (*integer*) -- Small volume maximum size. * **targetInstanceTypeRightSizingMethod** (*string*) -- Target instance type right-sizing method. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'associatePublicIpAddress': True|False, 'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE', 'copyPrivateIp': True|False, 'copyTags': True|False, 'ec2LaunchTemplateID': 'string', 'enableMapAutoTagging': True|False, 'largeVolumeConf': { 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, 'launchConfigurationTemplateID': 'string', 'launchDisposition': 'STOPPED'|'STARTED', 'licensing': { 'osByol': True|False }, 'mapAutoTaggingMpeID': 'string', 'postLaunchActions': { 'cloudWatchLogGroupName': 'string', 'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY', 's3LogBucket': 'string', 's3OutputKeyPrefix': 'string', 'ssmDocuments': [ { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, ] }, 'smallVolumeConf': { 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, 'smallVolumeMaxSize': 123, 'tags': { 'string': 'string' }, 'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC' } **Response Structure** * *(dict) --* * **arn** *(string) --* ARN of the Launch Configuration Template. * **associatePublicIpAddress** *(boolean) --* Associate public Ip address. * **bootMode** *(string) --* Launch configuration template boot mode. * **copyPrivateIp** *(boolean) --* Copy private Ip. * **copyTags** *(boolean) --* Copy tags. * **ec2LaunchTemplateID** *(string) --* EC2 launch template ID. * **enableMapAutoTagging** *(boolean) --* Enable map auto tagging. * **largeVolumeConf** *(dict) --* Large volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **launchConfigurationTemplateID** *(string) --* ID of the Launch Configuration Template. * **launchDisposition** *(string) --* Launch disposition. * **licensing** *(dict) --* Configure Licensing. * **osByol** *(boolean) --* Configure BYOL OS licensing. * **mapAutoTaggingMpeID** *(string) --* Launch configuration template map auto tagging MPE ID. * **postLaunchActions** *(dict) --* Post Launch Actions of the Launch Configuration Template. * **cloudWatchLogGroupName** *(string) --* AWS Systems Manager Command's CloudWatch log group name. * **deployment** *(string) --* Deployment type in which AWS Systems Manager Documents will be executed. * **s3LogBucket** *(string) --* AWS Systems Manager Command's logs S3 log bucket. * **s3OutputKeyPrefix** *(string) --* AWS Systems Manager Command's logs S3 output key prefix. * **ssmDocuments** *(list) --* AWS Systems Manager Documents. * *(dict) --* AWS Systems Manager Document. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **smallVolumeConf** *(dict) --* Small volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **smallVolumeMaxSize** *(integer) --* Small volume maximum size. * **tags** *(dict) --* Tags of the Launch Configuration Template. * *(string) --* * *(string) --* * **targetInstanceTypeRightSizingMethod** *(string) --* Target instance type right-sizing method. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.AccessDeniedException" mgn / Client / get_launch_configuration get_launch_configuration ************************ mgn.Client.get_launch_configuration(**kwargs) Lists all LaunchConfigurations available, filtered by Source Server IDs. See also: AWS API Documentation **Request Syntax** response = client.get_launch_configuration( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Request to get Launch Configuration information by Account ID. * **sourceServerID** (*string*) -- **[REQUIRED]** Request to get Launch Configuration information by Source Server ID. Return type: dict Returns: **Response Syntax** { 'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE', 'copyPrivateIp': True|False, 'copyTags': True|False, 'ec2LaunchTemplateID': 'string', 'enableMapAutoTagging': True|False, 'launchDisposition': 'STOPPED'|'STARTED', 'licensing': { 'osByol': True|False }, 'mapAutoTaggingMpeID': 'string', 'name': 'string', 'postLaunchActions': { 'cloudWatchLogGroupName': 'string', 'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY', 's3LogBucket': 'string', 's3OutputKeyPrefix': 'string', 'ssmDocuments': [ { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, ] }, 'sourceServerID': 'string', 'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC' } **Response Structure** * *(dict) --* * **bootMode** *(string) --* Launch configuration boot mode. * **copyPrivateIp** *(boolean) --* Copy Private IP during Launch Configuration. * **copyTags** *(boolean) --* Copy Tags during Launch Configuration. * **ec2LaunchTemplateID** *(string) --* Launch configuration EC2 Launch template ID. * **enableMapAutoTagging** *(boolean) --* Enable map auto tagging. * **launchDisposition** *(string) --* Launch disposition for launch configuration. * **licensing** *(dict) --* Launch configuration OS licensing. * **osByol** *(boolean) --* Configure BYOL OS licensing. * **mapAutoTaggingMpeID** *(string) --* Map auto tagging MPE ID. * **name** *(string) --* Launch configuration name. * **postLaunchActions** *(dict) --* Post Launch Actions to executed on the Test or Cutover instance. * **cloudWatchLogGroupName** *(string) --* AWS Systems Manager Command's CloudWatch log group name. * **deployment** *(string) --* Deployment type in which AWS Systems Manager Documents will be executed. * **s3LogBucket** *(string) --* AWS Systems Manager Command's logs S3 log bucket. * **s3OutputKeyPrefix** *(string) --* AWS Systems Manager Command's logs S3 output key prefix. * **ssmDocuments** *(list) --* AWS Systems Manager Documents. * *(dict) --* AWS Systems Manager Document. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **sourceServerID** *(string) --* Launch configuration Source Server ID. * **targetInstanceTypeRightSizingMethod** *(string) --* Launch configuration Target instance type right sizing method. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" mgn / Client / can_paginate can_paginate ************ mgn.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. mgn / Client / get_replication_configuration get_replication_configuration ***************************** mgn.Client.get_replication_configuration(**kwargs) Lists all ReplicationConfigurations, filtered by Source Server ID. See also: AWS API Documentation **Request Syntax** response = client.get_replication_configuration( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Request to get Replication Configuration by Account ID. * **sourceServerID** (*string*) -- **[REQUIRED]** Request to get Replication Configuration by Source Server ID. Return type: dict Returns: **Response Syntax** { 'associateDefaultSecurityGroup': True|False, 'bandwidthThrottling': 123, 'createPublicIP': True|False, 'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP', 'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3', 'ebsEncryption': 'DEFAULT'|'CUSTOM', 'ebsEncryptionKeyArn': 'string', 'name': 'string', 'replicatedDisks': [ { 'deviceName': 'string', 'iops': 123, 'isBootDisk': True|False, 'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2', 'throughput': 123 }, ], 'replicationServerInstanceType': 'string', 'replicationServersSecurityGroupsIDs': [ 'string', ], 'sourceServerID': 'string', 'stagingAreaSubnetId': 'string', 'stagingAreaTags': { 'string': 'string' }, 'useDedicatedReplicationServer': True|False, 'useFipsEndpoint': True|False } **Response Structure** * *(dict) --* * **associateDefaultSecurityGroup** *(boolean) --* Replication Configuration associate default Application Migration Service Security Group. * **bandwidthThrottling** *(integer) --* Replication Configuration set bandwidth throttling. * **createPublicIP** *(boolean) --* Replication Configuration create Public IP. * **dataPlaneRouting** *(string) --* Replication Configuration data plane routing. * **defaultLargeStagingDiskType** *(string) --* Replication Configuration use default large Staging Disks. * **ebsEncryption** *(string) --* Replication Configuration EBS encryption. * **ebsEncryptionKeyArn** *(string) --* Replication Configuration EBS encryption key ARN. * **name** *(string) --* Replication Configuration name. * **replicatedDisks** *(list) --* Replication Configuration replicated disks. * *(dict) --* Replication Configuration replicated disk. * **deviceName** *(string) --* Replication Configuration replicated disk device name. * **iops** *(integer) --* Replication Configuration replicated disk IOPs. * **isBootDisk** *(boolean) --* Replication Configuration replicated disk boot disk. * **stagingDiskType** *(string) --* Replication Configuration replicated disk staging disk type. * **throughput** *(integer) --* Replication Configuration replicated disk throughput. * **replicationServerInstanceType** *(string) --* Replication Configuration Replication Server instance type. * **replicationServersSecurityGroupsIDs** *(list) --* Replication Configuration Replication Server Security Group IDs. * *(string) --* * **sourceServerID** *(string) --* Replication Configuration Source Server ID. * **stagingAreaSubnetId** *(string) --* Replication Configuration Staging Area subnet ID. * **stagingAreaTags** *(dict) --* Replication Configuration Staging Area tags. * *(string) --* * *(string) --* * **useDedicatedReplicationServer** *(boolean) --* Replication Configuration use Dedicated Replication Server. * **useFipsEndpoint** *(boolean) --* Replication Configuration use Fips Endpoint. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" mgn / Client / unarchive_application unarchive_application ********************* mgn.Client.unarchive_application(**kwargs) Unarchive application. See also: AWS API Documentation **Request Syntax** response = client.unarchive_application( accountID='string', applicationID='string' ) Parameters: * **accountID** (*string*) -- Account ID. * **applicationID** (*string*) -- **[REQUIRED]** Application ID. Return type: dict Returns: **Response Syntax** { 'applicationAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'totalSourceServers': 123 }, 'applicationID': 'string', 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveID': 'string' } **Response Structure** * *(dict) --* * **applicationAggregatedStatus** *(dict) --* Application aggregated status. * **healthStatus** *(string) --* Application aggregated status health status. * **lastUpdateDateTime** *(string) --* Application aggregated status last update dateTime. * **progressStatus** *(string) --* Application aggregated status progress status. * **totalSourceServers** *(integer) --* Application aggregated status total source servers amount. * **applicationID** *(string) --* Application ID. * **arn** *(string) --* Application ARN. * **creationDateTime** *(string) --* Application creation dateTime. * **description** *(string) --* Application description. * **isArchived** *(boolean) --* Application archival status. * **lastModifiedDateTime** *(string) --* Application last modified dateTime. * **name** *(string) --* Application name. * **tags** *(dict) --* Application tags. * *(string) --* * *(string) --* * **waveID** *(string) --* Application wave ID. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ServiceQuotaExceededException" mgn / Client / pause_replication pause_replication ***************** mgn.Client.pause_replication(**kwargs) Pause Replication. See also: AWS API Documentation **Request Syntax** response = client.pause_replication( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Pause Replication Request account ID. * **sourceServerID** (*string*) -- **[REQUIRED]** Pause Replication Request source server ID. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / list_source_server_actions list_source_server_actions ************************** mgn.Client.list_source_server_actions(**kwargs) List source server post migration custom actions. See also: AWS API Documentation **Request Syntax** response = client.list_source_server_actions( accountID='string', filters={ 'actionIDs': [ 'string', ] }, maxResults=123, nextToken='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Account ID to return when listing source server post migration custom actions. * **filters** (*dict*) -- Filters to apply when listing source server post migration custom actions. * **actionIDs** *(list) --* Action IDs to filter source server post migration custom actions by. * *(string) --* * **maxResults** (*integer*) -- Maximum amount of items to return when listing source server post migration custom actions. * **nextToken** (*string*) -- Next token to use when listing source server post migration custom actions. * **sourceServerID** (*string*) -- **[REQUIRED]** Source server ID. Return type: dict Returns: **Response Syntax** { 'items': [ { 'actionID': 'string', 'actionName': 'string', 'active': True|False, 'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER', 'description': 'string', 'documentIdentifier': 'string', 'documentVersion': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'order': 123, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'timeoutSeconds': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* List of source server post migration custom actions. * *(dict) --* * **actionID** *(string) --* Source server post migration custom action ID. * **actionName** *(string) --* Source server post migration custom action name. * **active** *(boolean) --* Source server post migration custom action active status. * **category** *(string) --* Source server post migration custom action category. * **description** *(string) --* Source server post migration custom action description. * **documentIdentifier** *(string) --* Source server post migration custom action document identifier. * **documentVersion** *(string) --* Source server post migration custom action document version. * **externalParameters** *(dict) --* Source server post migration custom action external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* Source server post migration custom action must succeed for cutover. * **order** *(integer) --* Source server post migration custom action order. * **parameters** *(dict) --* Source server post migration custom action parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **timeoutSeconds** *(integer) --* Source server post migration custom action timeout in seconds. * **nextToken** *(string) --* Next token returned when listing source server post migration custom actions. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" mgn / Client / update_replication_configuration update_replication_configuration ******************************** mgn.Client.update_replication_configuration(**kwargs) Allows you to update multiple ReplicationConfigurations by Source Server ID. See also: AWS API Documentation **Request Syntax** response = client.update_replication_configuration( accountID='string', associateDefaultSecurityGroup=True|False, bandwidthThrottling=123, createPublicIP=True|False, dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP', defaultLargeStagingDiskType='GP2'|'ST1'|'GP3', ebsEncryption='DEFAULT'|'CUSTOM', ebsEncryptionKeyArn='string', name='string', replicatedDisks=[ { 'deviceName': 'string', 'iops': 123, 'isBootDisk': True|False, 'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2', 'throughput': 123 }, ], replicationServerInstanceType='string', replicationServersSecurityGroupsIDs=[ 'string', ], sourceServerID='string', stagingAreaSubnetId='string', stagingAreaTags={ 'string': 'string' }, useDedicatedReplicationServer=True|False, useFipsEndpoint=True|False ) Parameters: * **accountID** (*string*) -- Update replication configuration Account ID request. * **associateDefaultSecurityGroup** (*boolean*) -- Update replication configuration associate default Application Migration Service Security group request. * **bandwidthThrottling** (*integer*) -- Update replication configuration bandwidth throttling request. * **createPublicIP** (*boolean*) -- Update replication configuration create Public IP request. * **dataPlaneRouting** (*string*) -- Update replication configuration data plane routing request. * **defaultLargeStagingDiskType** (*string*) -- Update replication configuration use default large Staging Disk type request. * **ebsEncryption** (*string*) -- Update replication configuration EBS encryption request. * **ebsEncryptionKeyArn** (*string*) -- Update replication configuration EBS encryption key ARN request. * **name** (*string*) -- Update replication configuration name request. * **replicatedDisks** (*list*) -- Update replication configuration replicated disks request. * *(dict) --* Replication Configuration replicated disk. * **deviceName** *(string) --* Replication Configuration replicated disk device name. * **iops** *(integer) --* Replication Configuration replicated disk IOPs. * **isBootDisk** *(boolean) --* Replication Configuration replicated disk boot disk. * **stagingDiskType** *(string) --* Replication Configuration replicated disk staging disk type. * **throughput** *(integer) --* Replication Configuration replicated disk throughput. * **replicationServerInstanceType** (*string*) -- Update replication configuration Replication Server instance type request. * **replicationServersSecurityGroupsIDs** (*list*) -- Update replication configuration Replication Server Security Groups IDs request. * *(string) --* * **sourceServerID** (*string*) -- **[REQUIRED]** Update replication configuration Source Server ID request. * **stagingAreaSubnetId** (*string*) -- Update replication configuration Staging Area subnet request. * **stagingAreaTags** (*dict*) -- Update replication configuration Staging Area Tags request. * *(string) --* * *(string) --* * **useDedicatedReplicationServer** (*boolean*) -- Update replication configuration use dedicated Replication Server request. * **useFipsEndpoint** (*boolean*) -- Update replication configuration use Fips Endpoint. Return type: dict Returns: **Response Syntax** { 'associateDefaultSecurityGroup': True|False, 'bandwidthThrottling': 123, 'createPublicIP': True|False, 'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP', 'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3', 'ebsEncryption': 'DEFAULT'|'CUSTOM', 'ebsEncryptionKeyArn': 'string', 'name': 'string', 'replicatedDisks': [ { 'deviceName': 'string', 'iops': 123, 'isBootDisk': True|False, 'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2', 'throughput': 123 }, ], 'replicationServerInstanceType': 'string', 'replicationServersSecurityGroupsIDs': [ 'string', ], 'sourceServerID': 'string', 'stagingAreaSubnetId': 'string', 'stagingAreaTags': { 'string': 'string' }, 'useDedicatedReplicationServer': True|False, 'useFipsEndpoint': True|False } **Response Structure** * *(dict) --* * **associateDefaultSecurityGroup** *(boolean) --* Replication Configuration associate default Application Migration Service Security Group. * **bandwidthThrottling** *(integer) --* Replication Configuration set bandwidth throttling. * **createPublicIP** *(boolean) --* Replication Configuration create Public IP. * **dataPlaneRouting** *(string) --* Replication Configuration data plane routing. * **defaultLargeStagingDiskType** *(string) --* Replication Configuration use default large Staging Disks. * **ebsEncryption** *(string) --* Replication Configuration EBS encryption. * **ebsEncryptionKeyArn** *(string) --* Replication Configuration EBS encryption key ARN. * **name** *(string) --* Replication Configuration name. * **replicatedDisks** *(list) --* Replication Configuration replicated disks. * *(dict) --* Replication Configuration replicated disk. * **deviceName** *(string) --* Replication Configuration replicated disk device name. * **iops** *(integer) --* Replication Configuration replicated disk IOPs. * **isBootDisk** *(boolean) --* Replication Configuration replicated disk boot disk. * **stagingDiskType** *(string) --* Replication Configuration replicated disk staging disk type. * **throughput** *(integer) --* Replication Configuration replicated disk throughput. * **replicationServerInstanceType** *(string) --* Replication Configuration Replication Server instance type. * **replicationServersSecurityGroupsIDs** *(list) --* Replication Configuration Replication Server Security Group IDs. * *(string) --* * **sourceServerID** *(string) --* Replication Configuration Source Server ID. * **stagingAreaSubnetId** *(string) --* Replication Configuration Staging Area subnet ID. * **stagingAreaTags** *(dict) --* Replication Configuration Staging Area tags. * *(string) --* * *(string) --* * **useDedicatedReplicationServer** *(boolean) --* Replication Configuration use Dedicated Replication Server. * **useFipsEndpoint** *(boolean) --* Replication Configuration use Fips Endpoint. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.AccessDeniedException" * "mgn.Client.exceptions.ConflictException" mgn / Client / retry_data_replication retry_data_replication ********************** mgn.Client.retry_data_replication(**kwargs) Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state. See also: AWS API Documentation **Request Syntax** response = client.retry_data_replication( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Retry data replication for Account ID. * **sourceServerID** (*string*) -- **[REQUIRED]** Retry data replication for Source Server ID. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" mgn / Client / list_exports list_exports ************ mgn.Client.list_exports(**kwargs) List exports. See also: AWS API Documentation **Request Syntax** response = client.list_exports( filters={ 'exportIDs': [ 'string', ] }, maxResults=123, nextToken='string' ) Parameters: * **filters** (*dict*) -- List exports request filters. * **exportIDs** *(list) --* List exports request filters export ids. * *(string) --* * **maxResults** (*integer*) -- List export request max results. * **nextToken** (*string*) -- List export request next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'creationDateTime': 'string', 'endDateTime': 'string', 'exportID': 'string', 'progressPercentage': ..., 's3Bucket': 'string', 's3BucketOwner': 'string', 's3Key': 'string', 'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED', 'summary': { 'applicationsCount': 123, 'serversCount': 123, 'wavesCount': 123 } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* List export response. * **items** *(list) --* List export response items. * *(dict) --* Export task. * **creationDateTime** *(string) --* Export task creation datetime. * **endDateTime** *(string) --* Export task end datetime. * **exportID** *(string) --* Export task id. * **progressPercentage** *(float) --* Export task progress percentage. * **s3Bucket** *(string) --* Export task s3 bucket. * **s3BucketOwner** *(string) --* Export task s3 bucket owner. * **s3Key** *(string) --* Export task s3 key. * **status** *(string) --* Export task status. * **summary** *(dict) --* Export task summary. * **applicationsCount** *(integer) --* Export task summary applications count. * **serversCount** *(integer) --* Export task summary servers count. * **wavesCount** *(integer) --* Export task summary waves count. * **nextToken** *(string) --* List export response next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" mgn / Client / describe_jobs describe_jobs ************* mgn.Client.describe_jobs(**kwargs) Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets. See also: AWS API Documentation **Request Syntax** response = client.describe_jobs( accountID='string', filters={ 'fromDate': 'string', 'jobIDs': [ 'string', ], 'toDate': 'string' }, maxResults=123, nextToken='string' ) Parameters: * **accountID** (*string*) -- Request to describe job log items by Account ID. * **filters** (*dict*) -- Request to describe Job log filters. * **fromDate** *(string) --* Request to describe Job log filters by date. * **jobIDs** *(list) --* Request to describe Job log filters by job ID. * *(string) --* * **toDate** *(string) --* Request to describe job log items by last date. * **maxResults** (*integer*) -- Request to describe job log items by max results. * **nextToken** (*string*) -- Request to describe job log items by next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'creationDateTime': 'string', 'endDateTime': 'string', 'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE', 'jobID': 'string', 'participatingServers': [ { 'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED', 'launchedEc2InstanceID': 'string', 'postLaunchActionsStatus': { 'postLaunchActionsLaunchStatusList': [ { 'executionID': 'string', 'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED', 'failureReason': 'string', 'ssmDocument': { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, 'ssmDocumentType': 'AUTOMATION'|'COMMAND' }, ], 'ssmAgentDiscoveryDatetime': 'string' }, 'sourceServerID': 'string' }, ], 'status': 'PENDING'|'STARTED'|'COMPLETED', 'tags': { 'string': 'string' }, 'type': 'LAUNCH'|'TERMINATE' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Request to describe Job log items. * *(dict) --* Job. * **arn** *(string) --* the ARN of the specific Job. * **creationDateTime** *(string) --* Job creation time. * **endDateTime** *(string) --* Job end time. * **initiatedBy** *(string) --* Job initiated by field. * **jobID** *(string) --* Job ID. * **participatingServers** *(list) --* Servers participating in a specific Job. * *(dict) --* Server participating in Job. * **launchStatus** *(string) --* Participating server launch status. * **launchedEc2InstanceID** *(string) --* Participating server's launched ec2 instance ID. * **postLaunchActionsStatus** *(dict) --* Participating server's Post Launch Actions Status. * **postLaunchActionsLaunchStatusList** *(list) --* List of Post Launch Action status. * *(dict) --* Launch Status of the Job Post Launch Actions. * **executionID** *(string) --* AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions. * **executionStatus** *(string) --* AWS Systems Manager Document's execution status. * **failureReason** *(string) --* AWS Systems Manager Document's failure reason. * **ssmDocument** *(dict) --* AWS Systems Manager's Document of the of the Job Post Launch Actions. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **ssmDocumentType** *(string) --* AWS Systems Manager Document type. * **ssmAgentDiscoveryDatetime** *(string) --* Time where the AWS Systems Manager was detected as running on the Test or Cutover instance. * **sourceServerID** *(string) --* Participating server Source Server ID. * **status** *(string) --* Job status. * **tags** *(dict) --* Tags associated with specific Job. * *(string) --* * *(string) --* * **type** *(string) --* Job type. * **nextToken** *(string) --* Request to describe Job response by next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" mgn / Client / disassociate_source_servers disassociate_source_servers *************************** mgn.Client.disassociate_source_servers(**kwargs) Disassociate source servers from application. See also: AWS API Documentation **Request Syntax** response = client.disassociate_source_servers( accountID='string', applicationID='string', sourceServerIDs=[ 'string', ] ) Parameters: * **accountID** (*string*) -- Account ID. * **applicationID** (*string*) -- **[REQUIRED]** Application ID. * **sourceServerIDs** (*list*) -- **[REQUIRED]** Source server IDs list. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / list_waves list_waves ********** mgn.Client.list_waves(**kwargs) Retrieves all waves or multiple waves by ID. See also: AWS API Documentation **Request Syntax** response = client.list_waves( accountID='string', filters={ 'isArchived': True|False, 'waveIDs': [ 'string', ] }, maxResults=123, nextToken='string' ) Parameters: * **accountID** (*string*) -- Request account ID. * **filters** (*dict*) -- Waves list filters. * **isArchived** *(boolean) --* Filter waves list by archival status. * **waveIDs** *(list) --* Filter waves list by wave ID. * *(string) --* * **maxResults** (*integer*) -- Maximum results to return when listing waves. * **nextToken** (*string*) -- Request next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'replicationStartedDateTime': 'string', 'totalApplications': 123 }, 'waveID': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Waves list. * *(dict) --* * **arn** *(string) --* Wave ARN. * **creationDateTime** *(string) --* Wave creation dateTime. * **description** *(string) --* Wave description. * **isArchived** *(boolean) --* Wave archival status. * **lastModifiedDateTime** *(string) --* Wave last modified dateTime. * **name** *(string) --* Wave name. * **tags** *(dict) --* Wave tags. * *(string) --* * *(string) --* * **waveAggregatedStatus** *(dict) --* Wave aggregated status. * **healthStatus** *(string) --* Wave aggregated status health status. * **lastUpdateDateTime** *(string) --* Wave aggregated status last update dateTime. * **progressStatus** *(string) --* Wave aggregated status progress status. * **replicationStartedDateTime** *(string) --* DateTime marking when the first source server in the wave started replication. * **totalApplications** *(integer) --* Wave aggregated status total applications amount. * **waveID** *(string) --* Wave ID. * **nextToken** *(string) --* Response next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" mgn / Client / list_imports list_imports ************ mgn.Client.list_imports(**kwargs) List imports. See also: AWS API Documentation **Request Syntax** response = client.list_imports( filters={ 'importIDs': [ 'string', ] }, maxResults=123, nextToken='string' ) Parameters: * **filters** (*dict*) -- List imports request filters. * **importIDs** *(list) --* List imports request filters import IDs. * *(string) --* * **maxResults** (*integer*) -- List imports request max results. * **nextToken** (*string*) -- List imports request next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'creationDateTime': 'string', 'endDateTime': 'string', 'importID': 'string', 'progressPercentage': ..., 's3BucketSource': { 's3Bucket': 'string', 's3BucketOwner': 'string', 's3Key': 'string' }, 'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED', 'summary': { 'applications': { 'createdCount': 123, 'modifiedCount': 123 }, 'servers': { 'createdCount': 123, 'modifiedCount': 123 }, 'waves': { 'createdCount': 123, 'modifiedCount': 123 } } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* List import response. * **items** *(list) --* List import response items. * *(dict) --* Import task. * **creationDateTime** *(string) --* Import task creation datetime. * **endDateTime** *(string) --* Import task end datetime. * **importID** *(string) --* Import task id. * **progressPercentage** *(float) --* Import task progress percentage. * **s3BucketSource** *(dict) --* Import task s3 bucket source. * **s3Bucket** *(string) --* S3 bucket source s3 bucket. * **s3BucketOwner** *(string) --* S3 bucket source s3 bucket owner. * **s3Key** *(string) --* S3 bucket source s3 key. * **status** *(string) --* Import task status. * **summary** *(dict) --* Import task summary. * **applications** *(dict) --* Import task summary applications. * **createdCount** *(integer) --* Import task summary applications created count. * **modifiedCount** *(integer) --* Import task summary applications modified count. * **servers** *(dict) --* Import task summary servers. * **createdCount** *(integer) --* Import task summary servers created count. * **modifiedCount** *(integer) --* Import task summary servers modified count. * **waves** *(dict) --* Import task summary waves. * **createdCount** *(integer) --* Import task summery waves created count. * **modifiedCount** *(integer) --* Import task summery waves modified count. * **nextToken** *(string) --* List import response next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" mgn / Client / list_managed_accounts list_managed_accounts ********************* mgn.Client.list_managed_accounts(**kwargs) List Managed Accounts. See also: AWS API Documentation **Request Syntax** response = client.list_managed_accounts( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- List managed accounts request max results. * **nextToken** (*string*) -- List managed accounts request next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'accountId': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* List managed accounts response. * **items** *(list) --* List managed accounts response items. * *(dict) --* Managed account. * **accountId** *(string) --* Managed account, account ID. * **nextToken** *(string) --* List managed accounts response next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" mgn / Client / archive_wave archive_wave ************ mgn.Client.archive_wave(**kwargs) Archive wave. See also: AWS API Documentation **Request Syntax** response = client.archive_wave( accountID='string', waveID='string' ) Parameters: * **accountID** (*string*) -- Account ID. * **waveID** (*string*) -- **[REQUIRED]** Wave ID. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'replicationStartedDateTime': 'string', 'totalApplications': 123 }, 'waveID': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* Wave ARN. * **creationDateTime** *(string) --* Wave creation dateTime. * **description** *(string) --* Wave description. * **isArchived** *(boolean) --* Wave archival status. * **lastModifiedDateTime** *(string) --* Wave last modified dateTime. * **name** *(string) --* Wave name. * **tags** *(dict) --* Wave tags. * *(string) --* * *(string) --* * **waveAggregatedStatus** *(dict) --* Wave aggregated status. * **healthStatus** *(string) --* Wave aggregated status health status. * **lastUpdateDateTime** *(string) --* Wave aggregated status last update dateTime. * **progressStatus** *(string) --* Wave aggregated status progress status. * **replicationStartedDateTime** *(string) --* DateTime marking when the first source server in the wave started replication. * **totalApplications** *(integer) --* Wave aggregated status total applications amount. * **waveID** *(string) --* Wave ID. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / remove_source_server_action remove_source_server_action *************************** mgn.Client.remove_source_server_action(**kwargs) Remove source server post migration custom action. See also: AWS API Documentation **Request Syntax** response = client.remove_source_server_action( accountID='string', actionID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Source server post migration account ID. * **actionID** (*string*) -- **[REQUIRED]** Source server post migration custom action ID to remove. * **sourceServerID** (*string*) -- **[REQUIRED]** Source server ID of the post migration custom action to remove. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" mgn / Client / list_tags_for_resource list_tags_for_resource ********************** mgn.Client.list_tags_for_resource(**kwargs) List all tags for your Application Migration Service resources. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** List tags for resource request by ARN. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* List tags for resource response. * *(string) --* * *(string) --* **Exceptions** * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ThrottlingException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.AccessDeniedException" * "mgn.Client.exceptions.InternalServerException" mgn / Client / update_source_server update_source_server ******************** mgn.Client.update_source_server(**kwargs) Update Source Server. See also: AWS API Documentation **Request Syntax** response = client.update_source_server( accountID='string', connectorAction={ 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Update Source Server request account ID. * **connectorAction** (*dict*) -- Update Source Server request connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **sourceServerID** (*string*) -- **[REQUIRED]** Update Source Server request source server ID. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / untag_resource untag_resource ************** mgn.Client.untag_resource(**kwargs) Deletes the specified set of tags from the specified set of Application Migration Service resources. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** Untag resource by ARN. * **tagKeys** (*list*) -- **[REQUIRED]** Untag resource by Keys. * *(string) --* Returns: None **Exceptions** * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ThrottlingException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.AccessDeniedException" * "mgn.Client.exceptions.InternalServerException" mgn / Client / associate_source_servers associate_source_servers ************************ mgn.Client.associate_source_servers(**kwargs) Associate source servers to application. See also: AWS API Documentation **Request Syntax** response = client.associate_source_servers( accountID='string', applicationID='string', sourceServerIDs=[ 'string', ] ) Parameters: * **accountID** (*string*) -- Account ID. * **applicationID** (*string*) -- **[REQUIRED]** Application ID. * **sourceServerIDs** (*list*) -- **[REQUIRED]** Source server IDs list. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / get_waiter get_waiter ********** mgn.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" mgn / Client / archive_application archive_application ******************* mgn.Client.archive_application(**kwargs) Archive application. See also: AWS API Documentation **Request Syntax** response = client.archive_application( accountID='string', applicationID='string' ) Parameters: * **accountID** (*string*) -- Account ID. * **applicationID** (*string*) -- **[REQUIRED]** Application ID. Return type: dict Returns: **Response Syntax** { 'applicationAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'totalSourceServers': 123 }, 'applicationID': 'string', 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveID': 'string' } **Response Structure** * *(dict) --* * **applicationAggregatedStatus** *(dict) --* Application aggregated status. * **healthStatus** *(string) --* Application aggregated status health status. * **lastUpdateDateTime** *(string) --* Application aggregated status last update dateTime. * **progressStatus** *(string) --* Application aggregated status progress status. * **totalSourceServers** *(integer) --* Application aggregated status total source servers amount. * **applicationID** *(string) --* Application ID. * **arn** *(string) --* Application ARN. * **creationDateTime** *(string) --* Application creation dateTime. * **description** *(string) --* Application description. * **isArchived** *(boolean) --* Application archival status. * **lastModifiedDateTime** *(string) --* Application last modified dateTime. * **name** *(string) --* Application name. * **tags** *(dict) --* Application tags. * *(string) --* * *(string) --* * **waveID** *(string) --* Application wave ID. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / delete_source_server delete_source_server ******************** mgn.Client.delete_source_server(**kwargs) Deletes a single source server by ID. See also: AWS API Documentation **Request Syntax** response = client.delete_source_server( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Request to delete Source Server from service by Account ID. * **sourceServerID** (*string*) -- **[REQUIRED]** Request to delete Source Server from service by Server ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / update_connector update_connector **************** mgn.Client.update_connector(**kwargs) Update Connector. See also: AWS API Documentation **Request Syntax** response = client.update_connector( connectorID='string', name='string', ssmCommandConfig={ 'cloudWatchLogGroupName': 'string', 'cloudWatchOutputEnabled': True|False, 'outputS3BucketName': 'string', 's3OutputEnabled': True|False } ) Parameters: * **connectorID** (*string*) -- **[REQUIRED]** Update Connector request connector ID. * **name** (*string*) -- Update Connector request name. * **ssmCommandConfig** (*dict*) -- Update Connector request SSM command config. * **cloudWatchLogGroupName** *(string) --* Connector SSM command config CloudWatch log group name. * **cloudWatchOutputEnabled** *(boolean) --* **[REQUIRED]** Connector SSM command config CloudWatch output enabled. * **outputS3BucketName** *(string) --* Connector SSM command config output S3 bucket name. * **s3OutputEnabled** *(boolean) --* **[REQUIRED]** Connector SSM command config S3 output enabled. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'connectorID': 'string', 'name': 'string', 'ssmCommandConfig': { 'cloudWatchLogGroupName': 'string', 'cloudWatchOutputEnabled': True|False, 'outputS3BucketName': 'string', 's3OutputEnabled': True|False }, 'ssmInstanceID': 'string', 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **arn** *(string) --* Connector arn. * **connectorID** *(string) --* Connector ID. * **name** *(string) --* Connector name. * **ssmCommandConfig** *(dict) --* Connector SSM command config. * **cloudWatchLogGroupName** *(string) --* Connector SSM command config CloudWatch log group name. * **cloudWatchOutputEnabled** *(boolean) --* Connector SSM command config CloudWatch output enabled. * **outputS3BucketName** *(string) --* Connector SSM command config output S3 bucket name. * **s3OutputEnabled** *(boolean) --* Connector SSM command config S3 output enabled. * **ssmInstanceID** *(string) --* Connector SSM instance ID. * **tags** *(dict) --* Connector tags. * *(string) --* * *(string) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" mgn / Client / stop_replication stop_replication **************** mgn.Client.stop_replication(**kwargs) Stop Replication. See also: AWS API Documentation **Request Syntax** response = client.stop_replication( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Stop Replication Request account ID. * **sourceServerID** (*string*) -- **[REQUIRED]** Stop Replication Request source server ID. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / delete_wave delete_wave *********** mgn.Client.delete_wave(**kwargs) Delete wave. See also: AWS API Documentation **Request Syntax** response = client.delete_wave( accountID='string', waveID='string' ) Parameters: * **accountID** (*string*) -- Account ID. * **waveID** (*string*) -- **[REQUIRED]** Wave ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / start_import start_import ************ mgn.Client.start_import(**kwargs) Start import. See also: AWS API Documentation **Request Syntax** response = client.start_import( clientToken='string', s3BucketSource={ 's3Bucket': 'string', 's3BucketOwner': 'string', 's3Key': 'string' } ) Parameters: * **clientToken** (*string*) -- Start import request client token. This field is autopopulated if not provided. * **s3BucketSource** (*dict*) -- **[REQUIRED]** Start import request s3 bucket source. * **s3Bucket** *(string) --* **[REQUIRED]** S3 bucket source s3 bucket. * **s3BucketOwner** *(string) --* S3 bucket source s3 bucket owner. * **s3Key** *(string) --* **[REQUIRED]** S3 bucket source s3 key. Return type: dict Returns: **Response Syntax** { 'importTask': { 'creationDateTime': 'string', 'endDateTime': 'string', 'importID': 'string', 'progressPercentage': ..., 's3BucketSource': { 's3Bucket': 'string', 's3BucketOwner': 'string', 's3Key': 'string' }, 'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED', 'summary': { 'applications': { 'createdCount': 123, 'modifiedCount': 123 }, 'servers': { 'createdCount': 123, 'modifiedCount': 123 }, 'waves': { 'createdCount': 123, 'modifiedCount': 123 } } } } **Response Structure** * *(dict) --* Start import response. * **importTask** *(dict) --* Start import response import task. * **creationDateTime** *(string) --* Import task creation datetime. * **endDateTime** *(string) --* Import task end datetime. * **importID** *(string) --* Import task id. * **progressPercentage** *(float) --* Import task progress percentage. * **s3BucketSource** *(dict) --* Import task s3 bucket source. * **s3Bucket** *(string) --* S3 bucket source s3 bucket. * **s3BucketOwner** *(string) --* S3 bucket source s3 bucket owner. * **s3Key** *(string) --* S3 bucket source s3 key. * **status** *(string) --* Import task status. * **summary** *(dict) --* Import task summary. * **applications** *(dict) --* Import task summary applications. * **createdCount** *(integer) --* Import task summary applications created count. * **modifiedCount** *(integer) --* Import task summary applications modified count. * **servers** *(dict) --* Import task summary servers. * **createdCount** *(integer) --* Import task summary servers created count. * **modifiedCount** *(integer) --* Import task summary servers modified count. * **waves** *(dict) --* Import task summary waves. * **createdCount** *(integer) --* Import task summery waves created count. * **modifiedCount** *(integer) --* Import task summery waves modified count. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / mark_as_archived mark_as_archived **************** mgn.Client.mark_as_archived(**kwargs) Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER. See also: AWS API Documentation **Request Syntax** response = client.mark_as_archived( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Mark as archived by Account ID. * **sourceServerID** (*string*) -- **[REQUIRED]** Mark as archived by Source Server ID. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / update_launch_configuration update_launch_configuration *************************** mgn.Client.update_launch_configuration(**kwargs) Updates multiple LaunchConfigurations by Source Server ID. Note: bootMode valid values are "LEGACY_BIOS | UEFI" See also: AWS API Documentation **Request Syntax** response = client.update_launch_configuration( accountID='string', bootMode='LEGACY_BIOS'|'UEFI'|'USE_SOURCE', copyPrivateIp=True|False, copyTags=True|False, enableMapAutoTagging=True|False, launchDisposition='STOPPED'|'STARTED', licensing={ 'osByol': True|False }, mapAutoTaggingMpeID='string', name='string', postLaunchActions={ 'cloudWatchLogGroupName': 'string', 'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY', 's3LogBucket': 'string', 's3OutputKeyPrefix': 'string', 'ssmDocuments': [ { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, ] }, sourceServerID='string', targetInstanceTypeRightSizingMethod='NONE'|'BASIC' ) Parameters: * **accountID** (*string*) -- Update Launch configuration Account ID. * **bootMode** (*string*) -- Update Launch configuration boot mode request. * **copyPrivateIp** (*boolean*) -- Update Launch configuration copy Private IP request. * **copyTags** (*boolean*) -- Update Launch configuration copy Tags request. * **enableMapAutoTagging** (*boolean*) -- Enable map auto tagging. * **launchDisposition** (*string*) -- Update Launch configuration launch disposition request. * **licensing** (*dict*) -- Update Launch configuration licensing request. * **osByol** *(boolean) --* Configure BYOL OS licensing. * **mapAutoTaggingMpeID** (*string*) -- Launch configuration map auto tagging MPE ID. * **name** (*string*) -- Update Launch configuration name request. * **postLaunchActions** (*dict*) -- Post Launch Actions to executed on the Test or Cutover instance. * **cloudWatchLogGroupName** *(string) --* AWS Systems Manager Command's CloudWatch log group name. * **deployment** *(string) --* Deployment type in which AWS Systems Manager Documents will be executed. * **s3LogBucket** *(string) --* AWS Systems Manager Command's logs S3 log bucket. * **s3OutputKeyPrefix** *(string) --* AWS Systems Manager Command's logs S3 output key prefix. * **ssmDocuments** *(list) --* AWS Systems Manager Documents. * *(dict) --* AWS Systems Manager Document. * **actionName** *(string) --* **[REQUIRED]** User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "dynamicPath". * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* **[REQUIRED]** AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* **[REQUIRED]** AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* **[REQUIRED]** AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **sourceServerID** (*string*) -- **[REQUIRED]** Update Launch configuration by Source Server ID request. * **targetInstanceTypeRightSizingMethod** (*string*) -- Update Launch configuration Target instance right sizing request. Return type: dict Returns: **Response Syntax** { 'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE', 'copyPrivateIp': True|False, 'copyTags': True|False, 'ec2LaunchTemplateID': 'string', 'enableMapAutoTagging': True|False, 'launchDisposition': 'STOPPED'|'STARTED', 'licensing': { 'osByol': True|False }, 'mapAutoTaggingMpeID': 'string', 'name': 'string', 'postLaunchActions': { 'cloudWatchLogGroupName': 'string', 'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY', 's3LogBucket': 'string', 's3OutputKeyPrefix': 'string', 'ssmDocuments': [ { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, ] }, 'sourceServerID': 'string', 'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC' } **Response Structure** * *(dict) --* * **bootMode** *(string) --* Launch configuration boot mode. * **copyPrivateIp** *(boolean) --* Copy Private IP during Launch Configuration. * **copyTags** *(boolean) --* Copy Tags during Launch Configuration. * **ec2LaunchTemplateID** *(string) --* Launch configuration EC2 Launch template ID. * **enableMapAutoTagging** *(boolean) --* Enable map auto tagging. * **launchDisposition** *(string) --* Launch disposition for launch configuration. * **licensing** *(dict) --* Launch configuration OS licensing. * **osByol** *(boolean) --* Configure BYOL OS licensing. * **mapAutoTaggingMpeID** *(string) --* Map auto tagging MPE ID. * **name** *(string) --* Launch configuration name. * **postLaunchActions** *(dict) --* Post Launch Actions to executed on the Test or Cutover instance. * **cloudWatchLogGroupName** *(string) --* AWS Systems Manager Command's CloudWatch log group name. * **deployment** *(string) --* Deployment type in which AWS Systems Manager Documents will be executed. * **s3LogBucket** *(string) --* AWS Systems Manager Command's logs S3 log bucket. * **s3OutputKeyPrefix** *(string) --* AWS Systems Manager Command's logs S3 output key prefix. * **ssmDocuments** *(list) --* AWS Systems Manager Documents. * *(dict) --* AWS Systems Manager Document. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **sourceServerID** *(string) --* Launch configuration Source Server ID. * **targetInstanceTypeRightSizingMethod** *(string) --* Launch configuration Target instance type right sizing method. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ConflictException" mgn / Client / update_replication_configuration_template update_replication_configuration_template ***************************************** mgn.Client.update_replication_configuration_template(**kwargs) Updates multiple ReplicationConfigurationTemplates by ID. See also: AWS API Documentation **Request Syntax** response = client.update_replication_configuration_template( arn='string', associateDefaultSecurityGroup=True|False, bandwidthThrottling=123, createPublicIP=True|False, dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP', defaultLargeStagingDiskType='GP2'|'ST1'|'GP3', ebsEncryption='DEFAULT'|'CUSTOM', ebsEncryptionKeyArn='string', replicationConfigurationTemplateID='string', replicationServerInstanceType='string', replicationServersSecurityGroupsIDs=[ 'string', ], stagingAreaSubnetId='string', stagingAreaTags={ 'string': 'string' }, useDedicatedReplicationServer=True|False, useFipsEndpoint=True|False ) Parameters: * **arn** (*string*) -- Update replication configuration template ARN request. * **associateDefaultSecurityGroup** (*boolean*) -- Update replication configuration template associate default Application Migration Service Security group request. * **bandwidthThrottling** (*integer*) -- Update replication configuration template bandwidth throttling request. * **createPublicIP** (*boolean*) -- Update replication configuration template create Public IP request. * **dataPlaneRouting** (*string*) -- Update replication configuration template data plane routing request. * **defaultLargeStagingDiskType** (*string*) -- Update replication configuration template use default large Staging Disk type request. * **ebsEncryption** (*string*) -- Update replication configuration template EBS encryption request. * **ebsEncryptionKeyArn** (*string*) -- Update replication configuration template EBS encryption key ARN request. * **replicationConfigurationTemplateID** (*string*) -- **[REQUIRED]** Update replication configuration template template ID request. * **replicationServerInstanceType** (*string*) -- Update replication configuration template Replication Server instance type request. * **replicationServersSecurityGroupsIDs** (*list*) -- Update replication configuration template Replication Server Security groups IDs request. * *(string) --* * **stagingAreaSubnetId** (*string*) -- Update replication configuration template Staging Area subnet ID request. * **stagingAreaTags** (*dict*) -- Update replication configuration template Staging Area Tags request. * *(string) --* * *(string) --* * **useDedicatedReplicationServer** (*boolean*) -- Update replication configuration template use dedicated Replication Server request. * **useFipsEndpoint** (*boolean*) -- Update replication configuration template use Fips Endpoint request. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'associateDefaultSecurityGroup': True|False, 'bandwidthThrottling': 123, 'createPublicIP': True|False, 'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP', 'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3', 'ebsEncryption': 'DEFAULT'|'CUSTOM', 'ebsEncryptionKeyArn': 'string', 'replicationConfigurationTemplateID': 'string', 'replicationServerInstanceType': 'string', 'replicationServersSecurityGroupsIDs': [ 'string', ], 'stagingAreaSubnetId': 'string', 'stagingAreaTags': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'useDedicatedReplicationServer': True|False, 'useFipsEndpoint': True|False } **Response Structure** * *(dict) --* * **arn** *(string) --* Replication Configuration template ARN. * **associateDefaultSecurityGroup** *(boolean) --* Replication Configuration template associate default Application Migration Service Security group. * **bandwidthThrottling** *(integer) --* Replication Configuration template bandwidth throttling. * **createPublicIP** *(boolean) --* Replication Configuration template create Public IP. * **dataPlaneRouting** *(string) --* Replication Configuration template data plane routing. * **defaultLargeStagingDiskType** *(string) --* Replication Configuration template use default large Staging Disk type. * **ebsEncryption** *(string) --* Replication Configuration template EBS encryption. * **ebsEncryptionKeyArn** *(string) --* Replication Configuration template EBS encryption key ARN. * **replicationConfigurationTemplateID** *(string) --* Replication Configuration template ID. * **replicationServerInstanceType** *(string) --* Replication Configuration template server instance type. * **replicationServersSecurityGroupsIDs** *(list) --* Replication Configuration template server Security Groups IDs. * *(string) --* * **stagingAreaSubnetId** *(string) --* Replication Configuration template Staging Area subnet ID. * **stagingAreaTags** *(dict) --* Replication Configuration template Staging Area Tags. * *(string) --* * *(string) --* * **tags** *(dict) --* Replication Configuration template Tags. * *(string) --* * *(string) --* * **useDedicatedReplicationServer** *(boolean) --* Replication Configuration template use Dedicated Replication Server. * **useFipsEndpoint** *(boolean) --* Replication Configuration template use Fips Endpoint. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.AccessDeniedException" mgn / Client / create_connector create_connector **************** mgn.Client.create_connector(**kwargs) Create Connector. See also: AWS API Documentation **Request Syntax** response = client.create_connector( name='string', ssmCommandConfig={ 'cloudWatchLogGroupName': 'string', 'cloudWatchOutputEnabled': True|False, 'outputS3BucketName': 'string', 's3OutputEnabled': True|False }, ssmInstanceID='string', tags={ 'string': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** Create Connector request name. * **ssmCommandConfig** (*dict*) -- Create Connector request SSM command config. * **cloudWatchLogGroupName** *(string) --* Connector SSM command config CloudWatch log group name. * **cloudWatchOutputEnabled** *(boolean) --* **[REQUIRED]** Connector SSM command config CloudWatch output enabled. * **outputS3BucketName** *(string) --* Connector SSM command config output S3 bucket name. * **s3OutputEnabled** *(boolean) --* **[REQUIRED]** Connector SSM command config S3 output enabled. * **ssmInstanceID** (*string*) -- **[REQUIRED]** Create Connector request SSM instance ID. * **tags** (*dict*) -- Create Connector request tags. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'connectorID': 'string', 'name': 'string', 'ssmCommandConfig': { 'cloudWatchLogGroupName': 'string', 'cloudWatchOutputEnabled': True|False, 'outputS3BucketName': 'string', 's3OutputEnabled': True|False }, 'ssmInstanceID': 'string', 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **arn** *(string) --* Connector arn. * **connectorID** *(string) --* Connector ID. * **name** *(string) --* Connector name. * **ssmCommandConfig** *(dict) --* Connector SSM command config. * **cloudWatchLogGroupName** *(string) --* Connector SSM command config CloudWatch log group name. * **cloudWatchOutputEnabled** *(boolean) --* Connector SSM command config CloudWatch output enabled. * **outputS3BucketName** *(string) --* Connector SSM command config output S3 bucket name. * **s3OutputEnabled** *(boolean) --* Connector SSM command config S3 output enabled. * **ssmInstanceID** *(string) --* Connector SSM instance ID. * **tags** *(dict) --* Connector tags. * *(string) --* * *(string) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" mgn / Client / update_application update_application ****************** mgn.Client.update_application(**kwargs) Update application. See also: AWS API Documentation **Request Syntax** response = client.update_application( accountID='string', applicationID='string', description='string', name='string' ) Parameters: * **accountID** (*string*) -- Account ID. * **applicationID** (*string*) -- **[REQUIRED]** Application ID. * **description** (*string*) -- Application description. * **name** (*string*) -- Application name. Return type: dict Returns: **Response Syntax** { 'applicationAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'totalSourceServers': 123 }, 'applicationID': 'string', 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveID': 'string' } **Response Structure** * *(dict) --* * **applicationAggregatedStatus** *(dict) --* Application aggregated status. * **healthStatus** *(string) --* Application aggregated status health status. * **lastUpdateDateTime** *(string) --* Application aggregated status last update dateTime. * **progressStatus** *(string) --* Application aggregated status progress status. * **totalSourceServers** *(integer) --* Application aggregated status total source servers amount. * **applicationID** *(string) --* Application ID. * **arn** *(string) --* Application ARN. * **creationDateTime** *(string) --* Application creation dateTime. * **description** *(string) --* Application description. * **isArchived** *(boolean) --* Application archival status. * **lastModifiedDateTime** *(string) --* Application last modified dateTime. * **name** *(string) --* Application name. * **tags** *(dict) --* Application tags. * *(string) --* * *(string) --* * **waveID** *(string) --* Application wave ID. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / start_replication start_replication ***************** mgn.Client.start_replication(**kwargs) Starts replication for SNAPSHOT_SHIPPING agents. See also: AWS API Documentation **Request Syntax** response = client.start_replication( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Account ID on which to start replication. * **sourceServerID** (*string*) -- **[REQUIRED]** ID of source server on which to start replication. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / delete_vcenter_client delete_vcenter_client ********************* mgn.Client.delete_vcenter_client(**kwargs) Deletes a given vCenter client by ID. See also: AWS API Documentation **Request Syntax** response = client.delete_vcenter_client( vcenterClientID='string' ) Parameters: **vcenterClientID** (*string*) -- **[REQUIRED]** ID of resource to be deleted. Returns: None **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" mgn / Client / delete_replication_configuration_template delete_replication_configuration_template ***************************************** mgn.Client.delete_replication_configuration_template(**kwargs) Deletes a single Replication Configuration Template by ID See also: AWS API Documentation **Request Syntax** response = client.delete_replication_configuration_template( replicationConfigurationTemplateID='string' ) Parameters: **replicationConfigurationTemplateID** (*string*) -- **[REQUIRED]** Request to delete Replication Configuration Template from service by Replication Configuration Template ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / put_template_action put_template_action ******************* mgn.Client.put_template_action(**kwargs) Put template post migration custom action. See also: AWS API Documentation **Request Syntax** response = client.put_template_action( actionID='string', actionName='string', active=True|False, category='DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER', description='string', documentIdentifier='string', documentVersion='string', externalParameters={ 'string': { 'dynamicPath': 'string' } }, launchConfigurationTemplateID='string', mustSucceedForCutover=True|False, operatingSystem='string', order=123, parameters={ 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, timeoutSeconds=123 ) Parameters: * **actionID** (*string*) -- **[REQUIRED]** Template post migration custom action ID. * **actionName** (*string*) -- **[REQUIRED]** Template post migration custom action name. * **active** (*boolean*) -- Template post migration custom action active status. * **category** (*string*) -- Template post migration custom action category. * **description** (*string*) -- Template post migration custom action description. * **documentIdentifier** (*string*) -- **[REQUIRED]** Template post migration custom action document identifier. * **documentVersion** (*string*) -- Template post migration custom action document version. * **externalParameters** (*dict*) -- Template post migration custom action external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "dynamicPath". * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **launchConfigurationTemplateID** (*string*) -- **[REQUIRED]** Launch configuration template ID. * **mustSucceedForCutover** (*boolean*) -- Template post migration custom action must succeed for cutover. * **operatingSystem** (*string*) -- Operating system eligible for this template post migration custom action. * **order** (*integer*) -- **[REQUIRED]** Template post migration custom action order. * **parameters** (*dict*) -- Template post migration custom action parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* **[REQUIRED]** AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* **[REQUIRED]** AWS Systems Manager Parameter Store parameter type. * **timeoutSeconds** (*integer*) -- Template post migration custom action timeout in seconds. Return type: dict Returns: **Response Syntax** { 'actionID': 'string', 'actionName': 'string', 'active': True|False, 'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER', 'description': 'string', 'documentIdentifier': 'string', 'documentVersion': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'operatingSystem': 'string', 'order': 123, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'timeoutSeconds': 123 } **Response Structure** * *(dict) --* * **actionID** *(string) --* Template post migration custom action ID. * **actionName** *(string) --* Template post migration custom action name. * **active** *(boolean) --* Template post migration custom action active status. * **category** *(string) --* Template post migration custom action category. * **description** *(string) --* Template post migration custom action description. * **documentIdentifier** *(string) --* Template post migration custom action document identifier. * **documentVersion** *(string) --* Template post migration custom action document version. * **externalParameters** *(dict) --* Template post migration custom action external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* Template post migration custom action must succeed for cutover. * **operatingSystem** *(string) --* Operating system eligible for this template post migration custom action. * **order** *(integer) --* Template post migration custom action order. * **parameters** *(dict) --* Template post migration custom action parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **timeoutSeconds** *(integer) --* Template post migration custom action timeout in seconds. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ConflictException" mgn / Client / list_export_errors list_export_errors ****************** mgn.Client.list_export_errors(**kwargs) List export errors. See also: AWS API Documentation **Request Syntax** response = client.list_export_errors( exportID='string', maxResults=123, nextToken='string' ) Parameters: * **exportID** (*string*) -- **[REQUIRED]** List export errors request export id. * **maxResults** (*integer*) -- List export errors request max results. * **nextToken** (*string*) -- List export errors request next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'errorData': { 'rawError': 'string' }, 'errorDateTime': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* List export errors response. * **items** *(list) --* List export errors response items. * *(dict) --* Export task error. * **errorData** *(dict) --* Export task error data. * **rawError** *(string) --* Export errors data raw error. * **errorDateTime** *(string) --* Export task error datetime. * **nextToken** *(string) --* List export errors response next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" mgn / Client / resume_replication resume_replication ****************** mgn.Client.resume_replication(**kwargs) Resume Replication. See also: AWS API Documentation **Request Syntax** response = client.resume_replication( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Resume Replication Request account ID. * **sourceServerID** (*string*) -- **[REQUIRED]** Resume Replication Request source server ID. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / put_source_server_action put_source_server_action ************************ mgn.Client.put_source_server_action(**kwargs) Put source server post migration custom action. See also: AWS API Documentation **Request Syntax** response = client.put_source_server_action( accountID='string', actionID='string', actionName='string', active=True|False, category='DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER', description='string', documentIdentifier='string', documentVersion='string', externalParameters={ 'string': { 'dynamicPath': 'string' } }, mustSucceedForCutover=True|False, order=123, parameters={ 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, sourceServerID='string', timeoutSeconds=123 ) Parameters: * **accountID** (*string*) -- Source server post migration custom account ID. * **actionID** (*string*) -- **[REQUIRED]** Source server post migration custom action ID. * **actionName** (*string*) -- **[REQUIRED]** Source server post migration custom action name. * **active** (*boolean*) -- Source server post migration custom action active status. * **category** (*string*) -- Source server post migration custom action category. * **description** (*string*) -- Source server post migration custom action description. * **documentIdentifier** (*string*) -- **[REQUIRED]** Source server post migration custom action document identifier. * **documentVersion** (*string*) -- Source server post migration custom action document version. * **externalParameters** (*dict*) -- Source server post migration custom action external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "dynamicPath". * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** (*boolean*) -- Source server post migration custom action must succeed for cutover. * **order** (*integer*) -- **[REQUIRED]** Source server post migration custom action order. * **parameters** (*dict*) -- Source server post migration custom action parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* **[REQUIRED]** AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* **[REQUIRED]** AWS Systems Manager Parameter Store parameter type. * **sourceServerID** (*string*) -- **[REQUIRED]** Source server ID. * **timeoutSeconds** (*integer*) -- Source server post migration custom action timeout in seconds. Return type: dict Returns: **Response Syntax** { 'actionID': 'string', 'actionName': 'string', 'active': True|False, 'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER', 'description': 'string', 'documentIdentifier': 'string', 'documentVersion': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'order': 123, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'timeoutSeconds': 123 } **Response Structure** * *(dict) --* * **actionID** *(string) --* Source server post migration custom action ID. * **actionName** *(string) --* Source server post migration custom action name. * **active** *(boolean) --* Source server post migration custom action active status. * **category** *(string) --* Source server post migration custom action category. * **description** *(string) --* Source server post migration custom action description. * **documentIdentifier** *(string) --* Source server post migration custom action document identifier. * **documentVersion** *(string) --* Source server post migration custom action document version. * **externalParameters** *(dict) --* Source server post migration custom action external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* Source server post migration custom action must succeed for cutover. * **order** *(integer) --* Source server post migration custom action order. * **parameters** *(dict) --* Source server post migration custom action parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **timeoutSeconds** *(integer) --* Source server post migration custom action timeout in seconds. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ConflictException" mgn / Client / describe_vcenter_clients describe_vcenter_clients ************************ mgn.Client.describe_vcenter_clients(**kwargs) Returns a list of the installed vCenter clients. See also: AWS API Documentation **Request Syntax** response = client.describe_vcenter_clients( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- Maximum results to be returned in DescribeVcenterClients. * **nextToken** (*string*) -- Next pagination token to be provided for DescribeVcenterClients. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'datacenterName': 'string', 'hostname': 'string', 'lastSeenDatetime': 'string', 'sourceServerTags': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'vcenterClientID': 'string', 'vcenterUUID': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* List of items returned by DescribeVcenterClients. * *(dict) --* vCenter client. * **arn** *(string) --* Arn of vCenter client. * **datacenterName** *(string) --* Datacenter name of vCenter client. * **hostname** *(string) --* Hostname of vCenter client . * **lastSeenDatetime** *(string) --* Last seen time of vCenter client. * **sourceServerTags** *(dict) --* Tags for Source Server of vCenter client. * *(string) --* * *(string) --* * **tags** *(dict) --* Tags for vCenter client. * *(string) --* * *(string) --* * **vcenterClientID** *(string) --* ID of vCenter client. * **vcenterUUID** *(string) --* Vcenter UUID of vCenter client. * **nextToken** *(string) --* Next pagination token returned from DescribeVcenterClients. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" mgn / Client / create_wave create_wave *********** mgn.Client.create_wave(**kwargs) Create wave. See also: AWS API Documentation **Request Syntax** response = client.create_wave( accountID='string', description='string', name='string', tags={ 'string': 'string' } ) Parameters: * **accountID** (*string*) -- Account ID. * **description** (*string*) -- Wave description. * **name** (*string*) -- **[REQUIRED]** Wave name. * **tags** (*dict*) -- Wave tags. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'replicationStartedDateTime': 'string', 'totalApplications': 123 }, 'waveID': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* Wave ARN. * **creationDateTime** *(string) --* Wave creation dateTime. * **description** *(string) --* Wave description. * **isArchived** *(boolean) --* Wave archival status. * **lastModifiedDateTime** *(string) --* Wave last modified dateTime. * **name** *(string) --* Wave name. * **tags** *(dict) --* Wave tags. * *(string) --* * *(string) --* * **waveAggregatedStatus** *(dict) --* Wave aggregated status. * **healthStatus** *(string) --* Wave aggregated status health status. * **lastUpdateDateTime** *(string) --* Wave aggregated status last update dateTime. * **progressStatus** *(string) --* Wave aggregated status progress status. * **replicationStartedDateTime** *(string) --* DateTime marking when the first source server in the wave started replication. * **totalApplications** *(integer) --* Wave aggregated status total applications amount. * **waveID** *(string) --* Wave ID. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / close close ***** mgn.Client.close() Closes underlying endpoint connections. mgn / Client / update_source_server_replication_type update_source_server_replication_type ************************************* mgn.Client.update_source_server_replication_type(**kwargs) Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type. See also: AWS API Documentation **Request Syntax** response = client.update_source_server_replication_type( accountID='string', replicationType='AGENT_BASED'|'SNAPSHOT_SHIPPING', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Account ID on which to update replication type. * **replicationType** (*string*) -- **[REQUIRED]** Replication type to which to update source server. * **sourceServerID** (*string*) -- **[REQUIRED]** ID of source server on which to update replication type. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ConflictException" mgn / Client / update_wave update_wave *********** mgn.Client.update_wave(**kwargs) Update wave. See also: AWS API Documentation **Request Syntax** response = client.update_wave( accountID='string', description='string', name='string', waveID='string' ) Parameters: * **accountID** (*string*) -- Account ID. * **description** (*string*) -- Wave description. * **name** (*string*) -- Wave name. * **waveID** (*string*) -- **[REQUIRED]** Wave ID. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'replicationStartedDateTime': 'string', 'totalApplications': 123 }, 'waveID': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* Wave ARN. * **creationDateTime** *(string) --* Wave creation dateTime. * **description** *(string) --* Wave description. * **isArchived** *(boolean) --* Wave archival status. * **lastModifiedDateTime** *(string) --* Wave last modified dateTime. * **name** *(string) --* Wave name. * **tags** *(dict) --* Wave tags. * *(string) --* * *(string) --* * **waveAggregatedStatus** *(dict) --* Wave aggregated status. * **healthStatus** *(string) --* Wave aggregated status health status. * **lastUpdateDateTime** *(string) --* Wave aggregated status last update dateTime. * **progressStatus** *(string) --* Wave aggregated status progress status. * **replicationStartedDateTime** *(string) --* DateTime marking when the first source server in the wave started replication. * **totalApplications** *(integer) --* Wave aggregated status total applications amount. * **waveID** *(string) --* Wave ID. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / describe_replication_configuration_templates describe_replication_configuration_templates ******************************************** mgn.Client.describe_replication_configuration_templates(**kwargs) Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs. See also: AWS API Documentation **Request Syntax** response = client.describe_replication_configuration_templates( maxResults=123, nextToken='string', replicationConfigurationTemplateIDs=[ 'string', ] ) Parameters: * **maxResults** (*integer*) -- Request to describe Replication Configuration template by max results. * **nextToken** (*string*) -- Request to describe Replication Configuration template by next token. * **replicationConfigurationTemplateIDs** (*list*) -- Request to describe Replication Configuration template by template IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'associateDefaultSecurityGroup': True|False, 'bandwidthThrottling': 123, 'createPublicIP': True|False, 'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP', 'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3', 'ebsEncryption': 'DEFAULT'|'CUSTOM', 'ebsEncryptionKeyArn': 'string', 'replicationConfigurationTemplateID': 'string', 'replicationServerInstanceType': 'string', 'replicationServersSecurityGroupsIDs': [ 'string', ], 'stagingAreaSubnetId': 'string', 'stagingAreaTags': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'useDedicatedReplicationServer': True|False, 'useFipsEndpoint': True|False }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Request to describe Replication Configuration template by items. * *(dict) --* * **arn** *(string) --* Replication Configuration template ARN. * **associateDefaultSecurityGroup** *(boolean) --* Replication Configuration template associate default Application Migration Service Security group. * **bandwidthThrottling** *(integer) --* Replication Configuration template bandwidth throttling. * **createPublicIP** *(boolean) --* Replication Configuration template create Public IP. * **dataPlaneRouting** *(string) --* Replication Configuration template data plane routing. * **defaultLargeStagingDiskType** *(string) --* Replication Configuration template use default large Staging Disk type. * **ebsEncryption** *(string) --* Replication Configuration template EBS encryption. * **ebsEncryptionKeyArn** *(string) --* Replication Configuration template EBS encryption key ARN. * **replicationConfigurationTemplateID** *(string) --* Replication Configuration template ID. * **replicationServerInstanceType** *(string) --* Replication Configuration template server instance type. * **replicationServersSecurityGroupsIDs** *(list) --* Replication Configuration template server Security Groups IDs. * *(string) --* * **stagingAreaSubnetId** *(string) --* Replication Configuration template Staging Area subnet ID. * **stagingAreaTags** *(dict) --* Replication Configuration template Staging Area Tags. * *(string) --* * *(string) --* * **tags** *(dict) --* Replication Configuration template Tags. * *(string) --* * *(string) --* * **useDedicatedReplicationServer** *(boolean) --* Replication Configuration template use Dedicated Replication Server. * **useFipsEndpoint** *(boolean) --* Replication Configuration template use Fips Endpoint. * **nextToken** *(string) --* Request to describe Replication Configuration template by next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" mgn / Client / list_import_errors list_import_errors ****************** mgn.Client.list_import_errors(**kwargs) List import errors. See also: AWS API Documentation **Request Syntax** response = client.list_import_errors( importID='string', maxResults=123, nextToken='string' ) Parameters: * **importID** (*string*) -- **[REQUIRED]** List import errors request import id. * **maxResults** (*integer*) -- List import errors request max results. * **nextToken** (*string*) -- List import errors request next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'errorData': { 'accountID': 'string', 'applicationID': 'string', 'ec2LaunchTemplateID': 'string', 'rawError': 'string', 'rowNumber': 123, 'sourceServerID': 'string', 'waveID': 'string' }, 'errorDateTime': 'string', 'errorType': 'VALIDATION_ERROR'|'PROCESSING_ERROR' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* List imports errors response. * **items** *(list) --* List imports errors response items. * *(dict) --* Import task error. * **errorData** *(dict) --* Import task error data. * **accountID** *(string) --* Import error data source account ID. * **applicationID** *(string) --* Import error data application ID. * **ec2LaunchTemplateID** *(string) --* Import error data ec2 LaunchTemplate ID. * **rawError** *(string) --* Import error data raw error. * **rowNumber** *(integer) --* Import error data row number. * **sourceServerID** *(string) --* Import error data source server ID. * **waveID** *(string) --* Import error data wave id. * **errorDateTime** *(string) --* Import task error datetime. * **errorType** *(string) --* Import task error type. * **nextToken** *(string) --* List imports errors response next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" mgn / Client / associate_applications associate_applications ********************** mgn.Client.associate_applications(**kwargs) Associate applications to wave. See also: AWS API Documentation **Request Syntax** response = client.associate_applications( accountID='string', applicationIDs=[ 'string', ], waveID='string' ) Parameters: * **accountID** (*string*) -- Account ID. * **applicationIDs** (*list*) -- **[REQUIRED]** Application IDs list. * *(string) --* * **waveID** (*string*) -- **[REQUIRED]** Wave ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / create_launch_configuration_template create_launch_configuration_template ************************************ mgn.Client.create_launch_configuration_template(**kwargs) Creates a new Launch Configuration Template. See also: AWS API Documentation **Request Syntax** response = client.create_launch_configuration_template( associatePublicIpAddress=True|False, bootMode='LEGACY_BIOS'|'UEFI'|'USE_SOURCE', copyPrivateIp=True|False, copyTags=True|False, enableMapAutoTagging=True|False, largeVolumeConf={ 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, launchDisposition='STOPPED'|'STARTED', licensing={ 'osByol': True|False }, mapAutoTaggingMpeID='string', postLaunchActions={ 'cloudWatchLogGroupName': 'string', 'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY', 's3LogBucket': 'string', 's3OutputKeyPrefix': 'string', 'ssmDocuments': [ { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, ] }, smallVolumeConf={ 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, smallVolumeMaxSize=123, tags={ 'string': 'string' }, targetInstanceTypeRightSizingMethod='NONE'|'BASIC' ) Parameters: * **associatePublicIpAddress** (*boolean*) -- Associate public Ip address. * **bootMode** (*string*) -- Launch configuration template boot mode. * **copyPrivateIp** (*boolean*) -- Copy private Ip. * **copyTags** (*boolean*) -- Copy tags. * **enableMapAutoTagging** (*boolean*) -- Enable map auto tagging. * **largeVolumeConf** (*dict*) -- Large volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **launchDisposition** (*string*) -- Launch disposition. * **licensing** (*dict*) -- Configure Licensing. * **osByol** *(boolean) --* Configure BYOL OS licensing. * **mapAutoTaggingMpeID** (*string*) -- Launch configuration template map auto tagging MPE ID. * **postLaunchActions** (*dict*) -- Launch configuration template post launch actions. * **cloudWatchLogGroupName** *(string) --* AWS Systems Manager Command's CloudWatch log group name. * **deployment** *(string) --* Deployment type in which AWS Systems Manager Documents will be executed. * **s3LogBucket** *(string) --* AWS Systems Manager Command's logs S3 log bucket. * **s3OutputKeyPrefix** *(string) --* AWS Systems Manager Command's logs S3 output key prefix. * **ssmDocuments** *(list) --* AWS Systems Manager Documents. * *(dict) --* AWS Systems Manager Document. * **actionName** *(string) --* **[REQUIRED]** User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "dynamicPath". * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* **[REQUIRED]** AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* **[REQUIRED]** AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* **[REQUIRED]** AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **smallVolumeConf** (*dict*) -- Small volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **smallVolumeMaxSize** (*integer*) -- Small volume maximum size. * **tags** (*dict*) -- Request to associate tags during creation of a Launch Configuration Template. * *(string) --* * *(string) --* * **targetInstanceTypeRightSizingMethod** (*string*) -- Target instance type right-sizing method. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'associatePublicIpAddress': True|False, 'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE', 'copyPrivateIp': True|False, 'copyTags': True|False, 'ec2LaunchTemplateID': 'string', 'enableMapAutoTagging': True|False, 'largeVolumeConf': { 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, 'launchConfigurationTemplateID': 'string', 'launchDisposition': 'STOPPED'|'STARTED', 'licensing': { 'osByol': True|False }, 'mapAutoTaggingMpeID': 'string', 'postLaunchActions': { 'cloudWatchLogGroupName': 'string', 'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY', 's3LogBucket': 'string', 's3OutputKeyPrefix': 'string', 'ssmDocuments': [ { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, ] }, 'smallVolumeConf': { 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, 'smallVolumeMaxSize': 123, 'tags': { 'string': 'string' }, 'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC' } **Response Structure** * *(dict) --* * **arn** *(string) --* ARN of the Launch Configuration Template. * **associatePublicIpAddress** *(boolean) --* Associate public Ip address. * **bootMode** *(string) --* Launch configuration template boot mode. * **copyPrivateIp** *(boolean) --* Copy private Ip. * **copyTags** *(boolean) --* Copy tags. * **ec2LaunchTemplateID** *(string) --* EC2 launch template ID. * **enableMapAutoTagging** *(boolean) --* Enable map auto tagging. * **largeVolumeConf** *(dict) --* Large volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **launchConfigurationTemplateID** *(string) --* ID of the Launch Configuration Template. * **launchDisposition** *(string) --* Launch disposition. * **licensing** *(dict) --* Configure Licensing. * **osByol** *(boolean) --* Configure BYOL OS licensing. * **mapAutoTaggingMpeID** *(string) --* Launch configuration template map auto tagging MPE ID. * **postLaunchActions** *(dict) --* Post Launch Actions of the Launch Configuration Template. * **cloudWatchLogGroupName** *(string) --* AWS Systems Manager Command's CloudWatch log group name. * **deployment** *(string) --* Deployment type in which AWS Systems Manager Documents will be executed. * **s3LogBucket** *(string) --* AWS Systems Manager Command's logs S3 log bucket. * **s3OutputKeyPrefix** *(string) --* AWS Systems Manager Command's logs S3 output key prefix. * **ssmDocuments** *(list) --* AWS Systems Manager Documents. * *(dict) --* AWS Systems Manager Document. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **smallVolumeConf** *(dict) --* Small volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **smallVolumeMaxSize** *(integer) --* Small volume maximum size. * **tags** *(dict) --* Tags of the Launch Configuration Template. * *(string) --* * *(string) --* * **targetInstanceTypeRightSizingMethod** *(string) --* Target instance type right-sizing method. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.AccessDeniedException" mgn / Client / delete_application delete_application ****************** mgn.Client.delete_application(**kwargs) Delete application. See also: AWS API Documentation **Request Syntax** response = client.delete_application( accountID='string', applicationID='string' ) Parameters: * **accountID** (*string*) -- Account ID. * **applicationID** (*string*) -- **[REQUIRED]** Application ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / list_template_actions list_template_actions ********************* mgn.Client.list_template_actions(**kwargs) List template post migration custom actions. See also: AWS API Documentation **Request Syntax** response = client.list_template_actions( filters={ 'actionIDs': [ 'string', ] }, launchConfigurationTemplateID='string', maxResults=123, nextToken='string' ) Parameters: * **filters** (*dict*) -- Filters to apply when listing template post migration custom actions. * **actionIDs** *(list) --* Action IDs to filter template post migration custom actions by. * *(string) --* * **launchConfigurationTemplateID** (*string*) -- **[REQUIRED]** Launch configuration template ID. * **maxResults** (*integer*) -- Maximum amount of items to return when listing template post migration custom actions. * **nextToken** (*string*) -- Next token to use when listing template post migration custom actions. Return type: dict Returns: **Response Syntax** { 'items': [ { 'actionID': 'string', 'actionName': 'string', 'active': True|False, 'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER', 'description': 'string', 'documentIdentifier': 'string', 'documentVersion': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'operatingSystem': 'string', 'order': 123, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'timeoutSeconds': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* List of template post migration custom actions. * *(dict) --* * **actionID** *(string) --* Template post migration custom action ID. * **actionName** *(string) --* Template post migration custom action name. * **active** *(boolean) --* Template post migration custom action active status. * **category** *(string) --* Template post migration custom action category. * **description** *(string) --* Template post migration custom action description. * **documentIdentifier** *(string) --* Template post migration custom action document identifier. * **documentVersion** *(string) --* Template post migration custom action document version. * **externalParameters** *(dict) --* Template post migration custom action external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* Template post migration custom action must succeed for cutover. * **operatingSystem** *(string) --* Operating system eligible for this template post migration custom action. * **order** *(integer) --* Template post migration custom action order. * **parameters** *(dict) --* Template post migration custom action parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **timeoutSeconds** *(integer) --* Template post migration custom action timeout in seconds. * **nextToken** *(string) --* Next token returned when listing template post migration custom actions. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" mgn / Client / create_application create_application ****************** mgn.Client.create_application(**kwargs) Create application. See also: AWS API Documentation **Request Syntax** response = client.create_application( accountID='string', description='string', name='string', tags={ 'string': 'string' } ) Parameters: * **accountID** (*string*) -- Account ID. * **description** (*string*) -- Application description. * **name** (*string*) -- **[REQUIRED]** Application name. * **tags** (*dict*) -- Application tags. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'applicationAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'totalSourceServers': 123 }, 'applicationID': 'string', 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveID': 'string' } **Response Structure** * *(dict) --* * **applicationAggregatedStatus** *(dict) --* Application aggregated status. * **healthStatus** *(string) --* Application aggregated status health status. * **lastUpdateDateTime** *(string) --* Application aggregated status last update dateTime. * **progressStatus** *(string) --* Application aggregated status progress status. * **totalSourceServers** *(integer) --* Application aggregated status total source servers amount. * **applicationID** *(string) --* Application ID. * **arn** *(string) --* Application ARN. * **creationDateTime** *(string) --* Application creation dateTime. * **description** *(string) --* Application description. * **isArchived** *(boolean) --* Application archival status. * **lastModifiedDateTime** *(string) --* Application last modified dateTime. * **name** *(string) --* Application name. * **tags** *(dict) --* Application tags. * *(string) --* * *(string) --* * **waveID** *(string) --* Application wave ID. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ServiceQuotaExceededException" * "mgn.Client.exceptions.ConflictException" mgn / Client / delete_launch_configuration_template delete_launch_configuration_template ************************************ mgn.Client.delete_launch_configuration_template(**kwargs) Deletes a single Launch Configuration Template by ID. See also: AWS API Documentation **Request Syntax** response = client.delete_launch_configuration_template( launchConfigurationTemplateID='string' ) Parameters: **launchConfigurationTemplateID** (*string*) -- **[REQUIRED]** ID of resource to be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / tag_resource tag_resource ************ mgn.Client.tag_resource(**kwargs) Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** Tag resource by ARN. * **tags** (*dict*) -- **[REQUIRED]** Tag resource by Tags. * *(string) --* * *(string) --* Returns: None **Exceptions** * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ThrottlingException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.AccessDeniedException" * "mgn.Client.exceptions.InternalServerException" mgn / Client / unarchive_wave unarchive_wave ************** mgn.Client.unarchive_wave(**kwargs) Unarchive wave. See also: AWS API Documentation **Request Syntax** response = client.unarchive_wave( accountID='string', waveID='string' ) Parameters: * **accountID** (*string*) -- Account ID. * **waveID** (*string*) -- **[REQUIRED]** Wave ID. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'creationDateTime': 'string', 'description': 'string', 'isArchived': True|False, 'lastModifiedDateTime': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'waveAggregatedStatus': { 'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR', 'lastUpdateDateTime': 'string', 'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'replicationStartedDateTime': 'string', 'totalApplications': 123 }, 'waveID': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* Wave ARN. * **creationDateTime** *(string) --* Wave creation dateTime. * **description** *(string) --* Wave description. * **isArchived** *(boolean) --* Wave archival status. * **lastModifiedDateTime** *(string) --* Wave last modified dateTime. * **name** *(string) --* Wave name. * **tags** *(dict) --* Wave tags. * *(string) --* * *(string) --* * **waveAggregatedStatus** *(dict) --* Wave aggregated status. * **healthStatus** *(string) --* Wave aggregated status health status. * **lastUpdateDateTime** *(string) --* Wave aggregated status last update dateTime. * **progressStatus** *(string) --* Wave aggregated status progress status. * **replicationStartedDateTime** *(string) --* DateTime marking when the first source server in the wave started replication. * **totalApplications** *(integer) --* Wave aggregated status total applications amount. * **waveID** *(string) --* Wave ID. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ServiceQuotaExceededException" mgn / Client / delete_connector delete_connector **************** mgn.Client.delete_connector(**kwargs) Delete Connector. See also: AWS API Documentation **Request Syntax** response = client.delete_connector( connectorID='string' ) Parameters: **connectorID** (*string*) -- **[REQUIRED]** Delete Connector request connector ID. Returns: None **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" mgn / Client / describe_launch_configuration_templates describe_launch_configuration_templates *************************************** mgn.Client.describe_launch_configuration_templates(**kwargs) Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs See also: AWS API Documentation **Request Syntax** response = client.describe_launch_configuration_templates( launchConfigurationTemplateIDs=[ 'string', ], maxResults=123, nextToken='string' ) Parameters: * **launchConfigurationTemplateIDs** (*list*) -- Request to filter Launch Configuration Templates list by Launch Configuration Template ID. * *(string) --* * **maxResults** (*integer*) -- Maximum results to be returned in DescribeLaunchConfigurationTemplates. * **nextToken** (*string*) -- Next pagination token returned from DescribeLaunchConfigurationTemplates. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'associatePublicIpAddress': True|False, 'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE', 'copyPrivateIp': True|False, 'copyTags': True|False, 'ec2LaunchTemplateID': 'string', 'enableMapAutoTagging': True|False, 'largeVolumeConf': { 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, 'launchConfigurationTemplateID': 'string', 'launchDisposition': 'STOPPED'|'STARTED', 'licensing': { 'osByol': True|False }, 'mapAutoTaggingMpeID': 'string', 'postLaunchActions': { 'cloudWatchLogGroupName': 'string', 'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY', 's3LogBucket': 'string', 's3OutputKeyPrefix': 'string', 'ssmDocuments': [ { 'actionName': 'string', 'externalParameters': { 'string': { 'dynamicPath': 'string' } }, 'mustSucceedForCutover': True|False, 'parameters': { 'string': [ { 'parameterName': 'string', 'parameterType': 'STRING' }, ] }, 'ssmDocumentName': 'string', 'timeoutSeconds': 123 }, ] }, 'smallVolumeConf': { 'iops': 123, 'throughput': 123, 'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard' }, 'smallVolumeMaxSize': 123, 'tags': { 'string': 'string' }, 'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* List of items returned by DescribeLaunchConfigurationTemplates. * *(dict) --* * **arn** *(string) --* ARN of the Launch Configuration Template. * **associatePublicIpAddress** *(boolean) --* Associate public Ip address. * **bootMode** *(string) --* Launch configuration template boot mode. * **copyPrivateIp** *(boolean) --* Copy private Ip. * **copyTags** *(boolean) --* Copy tags. * **ec2LaunchTemplateID** *(string) --* EC2 launch template ID. * **enableMapAutoTagging** *(boolean) --* Enable map auto tagging. * **largeVolumeConf** *(dict) --* Large volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **launchConfigurationTemplateID** *(string) --* ID of the Launch Configuration Template. * **launchDisposition** *(string) --* Launch disposition. * **licensing** *(dict) --* Configure Licensing. * **osByol** *(boolean) --* Configure BYOL OS licensing. * **mapAutoTaggingMpeID** *(string) --* Launch configuration template map auto tagging MPE ID. * **postLaunchActions** *(dict) --* Post Launch Actions of the Launch Configuration Template. * **cloudWatchLogGroupName** *(string) --* AWS Systems Manager Command's CloudWatch log group name. * **deployment** *(string) --* Deployment type in which AWS Systems Manager Documents will be executed. * **s3LogBucket** *(string) --* AWS Systems Manager Command's logs S3 log bucket. * **s3OutputKeyPrefix** *(string) --* AWS Systems Manager Command's logs S3 output key prefix. * **ssmDocuments** *(list) --* AWS Systems Manager Documents. * *(dict) --* AWS Systems Manager Document. * **actionName** *(string) --* User-friendly name for the AWS Systems Manager Document. * **externalParameters** *(dict) --* AWS Systems Manager Document external parameters. * *(string) --* * *(dict) --* AWS Systems Manager Document external parameter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "dynamicPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **dynamicPath** *(string) --* AWS Systems Manager Document external parameters dynamic path. * **mustSucceedForCutover** *(boolean) --* If true, Cutover will not be enabled if the document has failed. * **parameters** *(dict) --* AWS Systems Manager Document parameters. * *(string) --* * *(list) --* * *(dict) --* AWS Systems Manager Parameter Store parameter. * **parameterName** *(string) --* AWS Systems Manager Parameter Store parameter name. * **parameterType** *(string) --* AWS Systems Manager Parameter Store parameter type. * **ssmDocumentName** *(string) --* AWS Systems Manager Document name or full ARN. * **timeoutSeconds** *(integer) --* AWS Systems Manager Document timeout seconds. * **smallVolumeConf** *(dict) --* Small volume config. * **iops** *(integer) --* Launch template disk iops configuration. * **throughput** *(integer) --* Launch template disk throughput configuration. * **volumeType** *(string) --* Launch template disk volume type configuration. * **smallVolumeMaxSize** *(integer) --* Small volume maximum size. * **tags** *(dict) --* Tags of the Launch Configuration Template. * *(string) --* * *(string) --* * **targetInstanceTypeRightSizingMethod** *(string) --* Target instance type right-sizing method. * **nextToken** *(string) --* Next pagination token returned from DescribeLaunchConfigurationTemplates. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" mgn / Client / disassociate_applications disassociate_applications ************************* mgn.Client.disassociate_applications(**kwargs) Disassociate applications from wave. See also: AWS API Documentation **Request Syntax** response = client.disassociate_applications( accountID='string', applicationIDs=[ 'string', ], waveID='string' ) Parameters: * **accountID** (*string*) -- Account ID. * **applicationIDs** (*list*) -- **[REQUIRED]** Application IDs list. * *(string) --* * **waveID** (*string*) -- **[REQUIRED]** Wave ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / disconnect_from_service disconnect_from_service *********************** mgn.Client.disconnect_from_service(**kwargs) Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified. See also: AWS API Documentation **Request Syntax** response = client.disconnect_from_service( accountID='string', sourceServerID='string' ) Parameters: * **accountID** (*string*) -- Request to disconnect Source Server from service by Account ID. * **sourceServerID** (*string*) -- **[REQUIRED]** Request to disconnect Source Server from service by Server ID. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ConflictException" mgn / Client / remove_template_action remove_template_action ********************** mgn.Client.remove_template_action(**kwargs) Remove template post migration custom action. See also: AWS API Documentation **Request Syntax** response = client.remove_template_action( actionID='string', launchConfigurationTemplateID='string' ) Parameters: * **actionID** (*string*) -- **[REQUIRED]** Template post migration custom action ID to remove. * **launchConfigurationTemplateID** (*string*) -- **[REQUIRED]** Launch configuration template ID of the post migration custom action to remove. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" mgn / Client / describe_source_servers describe_source_servers *********************** mgn.Client.describe_source_servers(**kwargs) Retrieves all SourceServers or multiple SourceServers by ID. See also: AWS API Documentation **Request Syntax** response = client.describe_source_servers( accountID='string', filters={ 'applicationIDs': [ 'string', ], 'isArchived': True|False, 'lifeCycleStates': [ 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION', ], 'replicationTypes': [ 'AGENT_BASED'|'SNAPSHOT_SHIPPING', ], 'sourceServerIDs': [ 'string', ] }, maxResults=123, nextToken='string' ) Parameters: * **accountID** (*string*) -- Request to filter Source Servers list by Accoun ID. * **filters** (*dict*) -- Request to filter Source Servers list. * **applicationIDs** *(list) --* Request to filter Source Servers list by application IDs. * *(string) --* * **isArchived** *(boolean) --* Request to filter Source Servers list by archived. * **lifeCycleStates** *(list) --* Request to filter Source Servers list by life cycle states. * *(string) --* * **replicationTypes** *(list) --* Request to filter Source Servers list by replication type. * *(string) --* * **sourceServerIDs** *(list) --* Request to filter Source Servers list by Source Server ID. * *(string) --* * **maxResults** (*integer*) -- Request to filter Source Servers list by maximum results. * **nextToken** (*string*) -- Request to filter Source Servers list by next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Request to filter Source Servers list by item. * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. * **nextToken** *(string) --* Request to filter Source Servers next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" mgn / Client / start_export start_export ************ mgn.Client.start_export(**kwargs) Start export. See also: AWS API Documentation **Request Syntax** response = client.start_export( s3Bucket='string', s3BucketOwner='string', s3Key='string' ) Parameters: * **s3Bucket** (*string*) -- **[REQUIRED]** Start export request s3 bucket. * **s3BucketOwner** (*string*) -- Start export request s3 bucket owner. * **s3Key** (*string*) -- **[REQUIRED]** Start export request s3key. Return type: dict Returns: **Response Syntax** { 'exportTask': { 'creationDateTime': 'string', 'endDateTime': 'string', 'exportID': 'string', 'progressPercentage': ..., 's3Bucket': 'string', 's3BucketOwner': 'string', 's3Key': 'string', 'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED', 'summary': { 'applicationsCount': 123, 'serversCount': 123, 'wavesCount': 123 } } } **Response Structure** * *(dict) --* Start export response. * **exportTask** *(dict) --* Start export response export task. * **creationDateTime** *(string) --* Export task creation datetime. * **endDateTime** *(string) --* Export task end datetime. * **exportID** *(string) --* Export task id. * **progressPercentage** *(float) --* Export task progress percentage. * **s3Bucket** *(string) --* Export task s3 bucket. * **s3BucketOwner** *(string) --* Export task s3 bucket owner. * **s3Key** *(string) --* Export task s3 key. * **status** *(string) --* Export task status. * **summary** *(dict) --* Export task summary. * **applicationsCount** *(integer) --* Export task summary applications count. * **serversCount** *(integer) --* Export task summary servers count. * **wavesCount** *(integer) --* Export task summary waves count. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ServiceQuotaExceededException" mgn / Client / change_server_life_cycle_state change_server_life_cycle_state ****************************** mgn.Client.change_server_life_cycle_state(**kwargs) 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. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.) See also: AWS API Documentation **Request Syntax** response = client.change_server_life_cycle_state( accountID='string', lifeCycle={ 'state': 'READY_FOR_TEST'|'READY_FOR_CUTOVER'|'CUTOVER' }, sourceServerID='string' ) Parameters: * **accountID** (*string*) -- The request to change the source server migration account ID. * **lifeCycle** (*dict*) -- **[REQUIRED]** The request to change the source server migration lifecycle state. * **state** *(string) --* **[REQUIRED]** The request to change the source server migration lifecycle state. * **sourceServerID** (*string*) -- **[REQUIRED]** The request to change the source server migration lifecycle state by source server ID. Return type: dict Returns: **Response Syntax** { 'applicationID': 'string', 'arn': 'string', 'connectorAction': { 'connectorArn': 'string', 'credentialsSecretArn': 'string' }, 'dataReplicationInfo': { 'dataReplicationError': { 'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED', 'rawError': 'string' }, 'dataReplicationInitiation': { 'nextAttemptDateTime': 'string', 'startDateTime': 'string', 'steps': [ { 'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER', 'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED' }, ] }, 'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT', 'etaDateTime': 'string', 'lagDuration': 'string', 'lastSnapshotDateTime': 'string', 'replicatedDisks': [ { 'backloggedStorageBytes': 123, 'deviceName': 'string', 'replicatedStorageBytes': 123, 'rescannedStorageBytes': 123, 'totalStorageBytes': 123 }, ] }, 'fqdnForActionFramework': 'string', 'isArchived': True|False, 'launchedInstance': { 'ec2InstanceID': 'string', 'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED', 'jobID': 'string' }, 'lifeCycle': { 'addedToServiceDateTime': 'string', 'elapsedReplicationDuration': 'string', 'firstByteDateTime': 'string', 'lastCutover': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'lastSeenByServiceDateTime': 'string', 'lastTest': { 'finalized': { 'apiCallDateTime': 'string' }, 'initiated': { 'apiCallDateTime': 'string', 'jobID': 'string' }, 'reverted': { 'apiCallDateTime': 'string' } }, 'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION' }, 'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING', 'sourceProperties': { 'cpus': [ { 'cores': 123, 'modelName': 'string' }, ], 'disks': [ { 'bytes': 123, 'deviceName': 'string' }, ], 'identificationHints': { 'awsInstanceID': 'string', 'fqdn': 'string', 'hostname': 'string', 'vmPath': 'string', 'vmWareUuid': 'string' }, 'lastUpdatedDateTime': 'string', 'networkInterfaces': [ { 'ips': [ 'string', ], 'isPrimary': True|False, 'macAddress': 'string' }, ], 'os': { 'fullString': 'string' }, 'ramBytes': 123, 'recommendedInstanceType': 'string' }, 'sourceServerID': 'string', 'tags': { 'string': 'string' }, 'userProvidedID': 'string', 'vcenterClientID': 'string' } **Response Structure** * *(dict) --* * **applicationID** *(string) --* Source server application ID. * **arn** *(string) --* Source server ARN. * **connectorAction** *(dict) --* Source Server connector action. * **connectorArn** *(string) --* Source Server connector action connector arn. * **credentialsSecretArn** *(string) --* Source Server connector action credentials secret arn. * **dataReplicationInfo** *(dict) --* Source server data replication info. * **dataReplicationError** *(dict) --* Error in obtaining data replication info. * **error** *(string) --* Error in data replication. * **rawError** *(string) --* Error in data replication. * **dataReplicationInitiation** *(dict) --* Request to query whether data replication has been initiated. * **nextAttemptDateTime** *(string) --* Request to query next data initiation date and time. * **startDateTime** *(string) --* Request to query data initiation start date and time. * **steps** *(list) --* Request to query data initiation steps. * *(dict) --* Data replication initiation step. * **name** *(string) --* Request to query data initiation step name. * **status** *(string) --* Request to query data initiation status. * **dataReplicationState** *(string) --* Request to query the data replication state. * **etaDateTime** *(string) --* Request to query the time when data replication will be complete. * **lagDuration** *(string) --* Request to query data replication lag duration. * **lastSnapshotDateTime** *(string) --* Request to query data replication last snapshot time. * **replicatedDisks** *(list) --* Request to query disks replicated. * *(dict) --* Request to query disks replicated. * **backloggedStorageBytes** *(integer) --* Request to query data replication backlog size in bytes. * **deviceName** *(string) --* Request to query device name. * **replicatedStorageBytes** *(integer) --* Request to query amount of data replicated in bytes. * **rescannedStorageBytes** *(integer) --* Request to query amount of data rescanned in bytes. * **totalStorageBytes** *(integer) --* Request to query total amount of data replicated in bytes. * **fqdnForActionFramework** *(string) --* Source server fqdn for action framework. * **isArchived** *(boolean) --* Source server archived status. * **launchedInstance** *(dict) --* Source server launched instance. * **ec2InstanceID** *(string) --* Launched instance EC2 ID. * **firstBoot** *(string) --* Launched instance first boot. * **jobID** *(string) --* Launched instance Job ID. * **lifeCycle** *(dict) --* Source server lifecycle state. * **addedToServiceDateTime** *(string) --* Lifecycle added to service data and time. * **elapsedReplicationDuration** *(string) --* Lifecycle elapsed time and duration. * **firstByteDateTime** *(string) --* Lifecycle replication initiation date and time. * **lastCutover** *(dict) --* Lifecycle last Cutover. * **finalized** *(dict) --* Lifecycle Cutover finalized date and time. * **apiCallDateTime** *(string) --* Lifecycle Cutover finalized date and time. * **initiated** *(dict) --* Lifecycle last Cutover initiated. * **apiCallDateTime** *(string) --* * **jobID** *(string) --* Lifecycle last Cutover initiated by Job ID. * **reverted** *(dict) --* Lifecycle last Cutover reverted. * **apiCallDateTime** *(string) --* Lifecycle last Cutover reverted API call date time. * **lastSeenByServiceDateTime** *(string) --* Lifecycle last seen date and time. * **lastTest** *(dict) --* Lifecycle last Test. * **finalized** *(dict) --* Lifecycle last Test finalized. * **apiCallDateTime** *(string) --* Lifecycle Test failed API call date and time. * **initiated** *(dict) --* Lifecycle last Test initiated. * **apiCallDateTime** *(string) --* Lifecycle last Test initiated API call date and time. * **jobID** *(string) --* Lifecycle last Test initiated Job ID. * **reverted** *(dict) --* Lifecycle last Test reverted. * **apiCallDateTime** *(string) --* Lifecycle last Test reverted API call date and time. * **state** *(string) --* Lifecycle state. * **replicationType** *(string) --* Source server replication type. * **sourceProperties** *(dict) --* Source server properties. * **cpus** *(list) --* Source Server CPUs. * *(dict) --* Source server CPU information. * **cores** *(integer) --* The number of CPU cores on the source server. * **modelName** *(string) --* The source server's CPU model name. * **disks** *(list) --* Source Server disks. * *(dict) --* The disk identifier. * **bytes** *(integer) --* The amount of storage on the disk in bytes. * **deviceName** *(string) --* The disk or device name. * **identificationHints** *(dict) --* Source server identification hints. * **awsInstanceID** *(string) --* AWS Instance ID identification hint. * **fqdn** *(string) --* FQDN address identification hint. * **hostname** *(string) --* Hostname identification hint. * **vmPath** *(string) --* vCenter VM path identification hint. * **vmWareUuid** *(string) --* vmWare UUID identification hint. * **lastUpdatedDateTime** *(string) --* Source server last update date and time. * **networkInterfaces** *(list) --* Source server network interfaces. * *(dict) --* Network interface. * **ips** *(list) --* Network interface IPs. * *(string) --* * **isPrimary** *(boolean) --* Network interface primary IP. * **macAddress** *(string) --* Network interface Mac address. * **os** *(dict) --* Source server OS. * **fullString** *(string) --* OS full string. * **ramBytes** *(integer) --* Source server RAM in bytes. * **recommendedInstanceType** *(string) --* Source server recommended instance type. * **sourceServerID** *(string) --* Source server ID. * **tags** *(dict) --* Source server Tags. * *(string) --* * *(string) --* * **userProvidedID** *(string) --* Source server user provided ID. * **vcenterClientID** *(string) --* Source server vCenter client id. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ResourceNotFoundException" * "mgn.Client.exceptions.ValidationException" * "mgn.Client.exceptions.ConflictException" mgn / Client / list_connectors list_connectors *************** mgn.Client.list_connectors(**kwargs) List Connectors. See also: AWS API Documentation **Request Syntax** response = client.list_connectors( filters={ 'connectorIDs': [ 'string', ] }, maxResults=123, nextToken='string' ) Parameters: * **filters** (*dict*) -- List Connectors Request filters. * **connectorIDs** *(list) --* List Connectors Request Filters connector IDs. * *(string) --* * **maxResults** (*integer*) -- List Connectors Request max results. * **nextToken** (*string*) -- List Connectors Request next token. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'connectorID': 'string', 'name': 'string', 'ssmCommandConfig': { 'cloudWatchLogGroupName': 'string', 'cloudWatchOutputEnabled': True|False, 'outputS3BucketName': 'string', 's3OutputEnabled': True|False }, 'ssmInstanceID': 'string', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* List connectors response items. * *(dict) --* * **arn** *(string) --* Connector arn. * **connectorID** *(string) --* Connector ID. * **name** *(string) --* Connector name. * **ssmCommandConfig** *(dict) --* Connector SSM command config. * **cloudWatchLogGroupName** *(string) --* Connector SSM command config CloudWatch log group name. * **cloudWatchOutputEnabled** *(boolean) --* Connector SSM command config CloudWatch output enabled. * **outputS3BucketName** *(string) --* Connector SSM command config output S3 bucket name. * **s3OutputEnabled** *(boolean) --* Connector SSM command config S3 output enabled. * **ssmInstanceID** *(string) --* Connector SSM instance ID. * **tags** *(dict) --* Connector tags. * *(string) --* * *(string) --* * **nextToken** *(string) --* List connectors response next token. **Exceptions** * "mgn.Client.exceptions.UninitializedAccountException" * "mgn.Client.exceptions.ValidationException"