mgnClient
Auto-generated documentation for mgn type annotations stubs module types-aiobotocore-mgn.
mgnClient
Type annotations and code completion for session.client("mgn")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_mgn.client import mgnClient
session = Session()
async with session.client("mgn") as client:
client: mgnClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("mgn").exceptions
structure.
async with session.client("mgn") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.UninitializedAccountException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_mgn.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("mgn").can_paginate
method.
boto3 documentation
change_server_life_cycle_state
Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER.
Type annotations and code completion for session.client("mgn").change_server_life_cycle_state
method.
boto3 documentation
await def change_server_life_cycle_state(
self,
*,
lifeCycle: ChangeServerLifeCycleStateSourceServerLifecycleTypeDef, # (1)
sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef: # (2)
...
kwargs: ChangeServerLifeCycleStateRequestRequestTypeDef = { # (1)
"lifeCycle": ...,
"sourceServerID": ...,
}
parent.change_server_life_cycle_state(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("mgn").close
method.
boto3 documentation
create_launch_configuration_template
Creates a new ReplicationConfigurationTemplate.
Type annotations and code completion for session.client("mgn").create_launch_configuration_template
method.
boto3 documentation
await def create_launch_configuration_template(
self,
*,
postLaunchActions: PostLaunchActionsTypeDef = ..., # (1)
tags: Mapping[str, str] = ...,
) -> LaunchConfigurationTemplateResponseMetadataTypeDef: # (2)
...
kwargs: CreateLaunchConfigurationTemplateRequestRequestTypeDef = { # (1)
"postLaunchActions": ...,
}
parent.create_launch_configuration_template(**kwargs)
create_replication_configuration_template
Creates a new ReplicationConfigurationTemplate.
Type annotations and code completion for session.client("mgn").create_replication_configuration_template
method.
boto3 documentation
await def create_replication_configuration_template(
self,
*,
associateDefaultSecurityGroup: bool,
bandwidthThrottling: int,
createPublicIP: bool,
dataPlaneRouting: ReplicationConfigurationDataPlaneRoutingType, # (1)
defaultLargeStagingDiskType: ReplicationConfigurationDefaultLargeStagingDiskTypeType, # (2)
ebsEncryption: ReplicationConfigurationEbsEncryptionType, # (3)
replicationServerInstanceType: str,
replicationServersSecurityGroupsIDs: Sequence[str],
stagingAreaSubnetId: str,
stagingAreaTags: Mapping[str, str],
useDedicatedReplicationServer: bool,
ebsEncryptionKeyArn: str = ...,
tags: Mapping[str, str] = ...,
) -> ReplicationConfigurationTemplateResponseMetadataTypeDef: # (4)
...
- See ReplicationConfigurationDataPlaneRoutingType
- See ReplicationConfigurationDefaultLargeStagingDiskTypeType
- See ReplicationConfigurationEbsEncryptionType
- See ReplicationConfigurationTemplateResponseMetadataTypeDef
kwargs: CreateReplicationConfigurationTemplateRequestRequestTypeDef = { # (1)
"associateDefaultSecurityGroup": ...,
"bandwidthThrottling": ...,
"createPublicIP": ...,
"dataPlaneRouting": ...,
"defaultLargeStagingDiskType": ...,
"ebsEncryption": ...,
"replicationServerInstanceType": ...,
"replicationServersSecurityGroupsIDs": ...,
"stagingAreaSubnetId": ...,
"stagingAreaTags": ...,
"useDedicatedReplicationServer": ...,
}
parent.create_replication_configuration_template(**kwargs)
delete_job
Deletes a single Job by ID.
Type annotations and code completion for session.client("mgn").delete_job
method.
boto3 documentation
kwargs: DeleteJobRequestRequestTypeDef = { # (1)
"jobID": ...,
}
parent.delete_job(**kwargs)
delete_launch_configuration_template
Creates a new ReplicationConfigurationTemplate.
Type annotations and code completion for session.client("mgn").delete_launch_configuration_template
method.
boto3 documentation
await def delete_launch_configuration_template(
self,
*,
launchConfigurationTemplateID: str,
) -> Dict[str, Any]:
...
kwargs: DeleteLaunchConfigurationTemplateRequestRequestTypeDef = { # (1)
"launchConfigurationTemplateID": ...,
}
parent.delete_launch_configuration_template(**kwargs)
delete_replication_configuration_template
Deletes a single Replication Configuration Template by ID See also: AWS API Documentation.
Type annotations and code completion for session.client("mgn").delete_replication_configuration_template
method.
boto3 documentation
await def delete_replication_configuration_template(
self,
*,
replicationConfigurationTemplateID: str,
) -> Dict[str, Any]:
...
kwargs: DeleteReplicationConfigurationTemplateRequestRequestTypeDef = { # (1)
"replicationConfigurationTemplateID": ...,
}
parent.delete_replication_configuration_template(**kwargs)
delete_source_server
Deletes a single source server by ID.
Type annotations and code completion for session.client("mgn").delete_source_server
method.
boto3 documentation
await def delete_source_server(
self,
*,
sourceServerID: str,
) -> Dict[str, Any]:
...
kwargs: DeleteSourceServerRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.delete_source_server(**kwargs)
delete_vcenter_client
Deletes a given vCenter client by ID.
Type annotations and code completion for session.client("mgn").delete_vcenter_client
method.
boto3 documentation
await def delete_vcenter_client(
self,
*,
vcenterClientID: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteVcenterClientRequestRequestTypeDef = { # (1)
"vcenterClientID": ...,
}
parent.delete_vcenter_client(**kwargs)
describe_job_log_items
Retrieves detailed job log items with paging.
Type annotations and code completion for session.client("mgn").describe_job_log_items
method.
boto3 documentation
await def describe_job_log_items(
self,
*,
jobID: str,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeJobLogItemsResponseTypeDef: # (1)
...
kwargs: DescribeJobLogItemsRequestRequestTypeDef = { # (1)
"jobID": ...,
}
parent.describe_job_log_items(**kwargs)
describe_jobs
Returns a list of Jobs.
Type annotations and code completion for session.client("mgn").describe_jobs
method.
boto3 documentation
await def describe_jobs(
self,
*,
filters: DescribeJobsRequestFiltersTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeJobsResponseTypeDef: # (2)
...
kwargs: DescribeJobsRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.describe_jobs(**kwargs)
describe_launch_configuration_templates
Creates a new ReplicationConfigurationTemplate.
Type annotations and code completion for session.client("mgn").describe_launch_configuration_templates
method.
boto3 documentation
await def describe_launch_configuration_templates(
self,
*,
launchConfigurationTemplateIDs: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeLaunchConfigurationTemplatesResponseTypeDef: # (1)
...
kwargs: DescribeLaunchConfigurationTemplatesRequestRequestTypeDef = { # (1)
"launchConfigurationTemplateIDs": ...,
}
parent.describe_launch_configuration_templates(**kwargs)
describe_replication_configuration_templates
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
Type annotations and code completion for session.client("mgn").describe_replication_configuration_templates
method.
boto3 documentation
await def describe_replication_configuration_templates(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
replicationConfigurationTemplateIDs: Sequence[str] = ...,
) -> DescribeReplicationConfigurationTemplatesResponseTypeDef: # (1)
...
kwargs: DescribeReplicationConfigurationTemplatesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.describe_replication_configuration_templates(**kwargs)
describe_source_servers
Retrieves all SourceServers or multiple SourceServers by ID.
Type annotations and code completion for session.client("mgn").describe_source_servers
method.
boto3 documentation
await def describe_source_servers(
self,
*,
filters: DescribeSourceServersRequestFiltersTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeSourceServersResponseTypeDef: # (2)
...
kwargs: DescribeSourceServersRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.describe_source_servers(**kwargs)
describe_vcenter_clients
Returns a list of the installed vCenter clients.
Type annotations and code completion for session.client("mgn").describe_vcenter_clients
method.
boto3 documentation
await def describe_vcenter_clients(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeVcenterClientsResponseTypeDef: # (1)
...
kwargs: DescribeVcenterClientsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.describe_vcenter_clients(**kwargs)
disconnect_from_service
Disconnects specific Source Servers from Application Migration Service.
Type annotations and code completion for session.client("mgn").disconnect_from_service
method.
boto3 documentation
await def disconnect_from_service(
self,
*,
sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef: # (1)
...
kwargs: DisconnectFromServiceRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.disconnect_from_service(**kwargs)
finalize_cutover
Finalizes the cutover immediately for specific Source Servers.
Type annotations and code completion for session.client("mgn").finalize_cutover
method.
boto3 documentation
await def finalize_cutover(
self,
*,
sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef: # (1)
...
kwargs: FinalizeCutoverRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.finalize_cutover(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("mgn").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_launch_configuration
Lists all LaunchConfigurations available, filtered by Source Server IDs.
Type annotations and code completion for session.client("mgn").get_launch_configuration
method.
boto3 documentation
await def get_launch_configuration(
self,
*,
sourceServerID: str,
) -> LaunchConfigurationTypeDef: # (1)
...
kwargs: GetLaunchConfigurationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.get_launch_configuration(**kwargs)
get_replication_configuration
Lists all ReplicationConfigurations, filtered by Source Server ID.
Type annotations and code completion for session.client("mgn").get_replication_configuration
method.
boto3 documentation
await def get_replication_configuration(
self,
*,
sourceServerID: str,
) -> ReplicationConfigurationTypeDef: # (1)
...
kwargs: GetReplicationConfigurationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.get_replication_configuration(**kwargs)
initialize_service
Initialize Application Migration Service.
Type annotations and code completion for session.client("mgn").initialize_service
method.
boto3 documentation
list_tags_for_resource
List all tags for your Application Migration Service resources.
Type annotations and code completion for session.client("mgn").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
mark_as_archived
Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID.
Type annotations and code completion for session.client("mgn").mark_as_archived
method.
boto3 documentation
await def mark_as_archived(
self,
*,
sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef: # (1)
...
kwargs: MarkAsArchivedRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.mark_as_archived(**kwargs)
retry_data_replication
Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started.
Type annotations and code completion for session.client("mgn").retry_data_replication
method.
boto3 documentation
await def retry_data_replication(
self,
*,
sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef: # (1)
...
kwargs: RetryDataReplicationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.retry_data_replication(**kwargs)
start_cutover
Launches a Cutover Instance for specific Source Servers.
Type annotations and code completion for session.client("mgn").start_cutover
method.
boto3 documentation
await def start_cutover(
self,
*,
sourceServerIDs: Sequence[str],
tags: Mapping[str, str] = ...,
) -> StartCutoverResponseTypeDef: # (1)
...
kwargs: StartCutoverRequestRequestTypeDef = { # (1)
"sourceServerIDs": ...,
}
parent.start_cutover(**kwargs)
start_replication
Starts replication for SNAPSHOT_SHIPPING agents.
Type annotations and code completion for session.client("mgn").start_replication
method.
boto3 documentation
await def start_replication(
self,
*,
sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef: # (1)
...
kwargs: StartReplicationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.start_replication(**kwargs)
start_test
Launches a Test Instance for specific Source Servers.
Type annotations and code completion for session.client("mgn").start_test
method.
boto3 documentation
await def start_test(
self,
*,
sourceServerIDs: Sequence[str],
tags: Mapping[str, str] = ...,
) -> StartTestResponseTypeDef: # (1)
...
kwargs: StartTestRequestRequestTypeDef = { # (1)
"sourceServerIDs": ...,
}
parent.start_test(**kwargs)
tag_resource
Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources.
Type annotations and code completion for session.client("mgn").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
terminate_target_instances
Starts a job that terminates specific launched EC2 Test and Cutover instances.
Type annotations and code completion for session.client("mgn").terminate_target_instances
method.
boto3 documentation
await def terminate_target_instances(
self,
*,
sourceServerIDs: Sequence[str],
tags: Mapping[str, str] = ...,
) -> TerminateTargetInstancesResponseTypeDef: # (1)
...
kwargs: TerminateTargetInstancesRequestRequestTypeDef = { # (1)
"sourceServerIDs": ...,
}
parent.terminate_target_instances(**kwargs)
untag_resource
Deletes the specified set of tags from the specified set of Application Migration Service resources.
Type annotations and code completion for session.client("mgn").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_launch_configuration
Updates multiple LaunchConfigurations by Source Server ID.
Type annotations and code completion for session.client("mgn").update_launch_configuration
method.
boto3 documentation
await def update_launch_configuration(
self,
*,
sourceServerID: str,
bootMode: BootModeType = ..., # (1)
copyPrivateIp: bool = ...,
copyTags: bool = ...,
launchDisposition: LaunchDispositionType = ..., # (2)
licensing: LicensingTypeDef = ..., # (3)
name: str = ...,
postLaunchActions: PostLaunchActionsTypeDef = ..., # (4)
targetInstanceTypeRightSizingMethod: TargetInstanceTypeRightSizingMethodType = ..., # (5)
) -> LaunchConfigurationTypeDef: # (6)
...
- See BootModeType
- See LaunchDispositionType
- See LicensingTypeDef
- See PostLaunchActionsTypeDef
- See TargetInstanceTypeRightSizingMethodType
- See LaunchConfigurationTypeDef
kwargs: UpdateLaunchConfigurationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.update_launch_configuration(**kwargs)
update_launch_configuration_template
Creates a new ReplicationConfigurationTemplate.
Type annotations and code completion for session.client("mgn").update_launch_configuration_template
method.
boto3 documentation
await def update_launch_configuration_template(
self,
*,
launchConfigurationTemplateID: str,
postLaunchActions: PostLaunchActionsTypeDef = ..., # (1)
) -> LaunchConfigurationTemplateResponseMetadataTypeDef: # (2)
...
kwargs: UpdateLaunchConfigurationTemplateRequestRequestTypeDef = { # (1)
"launchConfigurationTemplateID": ...,
}
parent.update_launch_configuration_template(**kwargs)
update_replication_configuration
Allows you to update multiple ReplicationConfigurations by Source Server ID.
Type annotations and code completion for session.client("mgn").update_replication_configuration
method.
boto3 documentation
await def update_replication_configuration(
self,
*,
sourceServerID: str,
associateDefaultSecurityGroup: bool = ...,
bandwidthThrottling: int = ...,
createPublicIP: bool = ...,
dataPlaneRouting: ReplicationConfigurationDataPlaneRoutingType = ..., # (1)
defaultLargeStagingDiskType: ReplicationConfigurationDefaultLargeStagingDiskTypeType = ..., # (2)
ebsEncryption: ReplicationConfigurationEbsEncryptionType = ..., # (3)
ebsEncryptionKeyArn: str = ...,
name: str = ...,
replicatedDisks: Sequence[ReplicationConfigurationReplicatedDiskTypeDef] = ..., # (4)
replicationServerInstanceType: str = ...,
replicationServersSecurityGroupsIDs: Sequence[str] = ...,
stagingAreaSubnetId: str = ...,
stagingAreaTags: Mapping[str, str] = ...,
useDedicatedReplicationServer: bool = ...,
) -> ReplicationConfigurationTypeDef: # (5)
...
- See ReplicationConfigurationDataPlaneRoutingType
- See ReplicationConfigurationDefaultLargeStagingDiskTypeType
- See ReplicationConfigurationEbsEncryptionType
- See ReplicationConfigurationReplicatedDiskTypeDef
- See ReplicationConfigurationTypeDef
kwargs: UpdateReplicationConfigurationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.update_replication_configuration(**kwargs)
update_replication_configuration_template
Updates multiple ReplicationConfigurationTemplates by ID.
Type annotations and code completion for session.client("mgn").update_replication_configuration_template
method.
boto3 documentation
await def update_replication_configuration_template(
self,
*,
replicationConfigurationTemplateID: str,
arn: str = ...,
associateDefaultSecurityGroup: bool = ...,
bandwidthThrottling: int = ...,
createPublicIP: bool = ...,
dataPlaneRouting: ReplicationConfigurationDataPlaneRoutingType = ..., # (1)
defaultLargeStagingDiskType: ReplicationConfigurationDefaultLargeStagingDiskTypeType = ..., # (2)
ebsEncryption: ReplicationConfigurationEbsEncryptionType = ..., # (3)
ebsEncryptionKeyArn: str = ...,
replicationServerInstanceType: str = ...,
replicationServersSecurityGroupsIDs: Sequence[str] = ...,
stagingAreaSubnetId: str = ...,
stagingAreaTags: Mapping[str, str] = ...,
useDedicatedReplicationServer: bool = ...,
) -> ReplicationConfigurationTemplateResponseMetadataTypeDef: # (4)
...
- See ReplicationConfigurationDataPlaneRoutingType
- See ReplicationConfigurationDefaultLargeStagingDiskTypeType
- See ReplicationConfigurationEbsEncryptionType
- See ReplicationConfigurationTemplateResponseMetadataTypeDef
kwargs: UpdateReplicationConfigurationTemplateRequestRequestTypeDef = { # (1)
"replicationConfigurationTemplateID": ...,
}
parent.update_replication_configuration_template(**kwargs)
update_source_server_replication_type
Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.
Type annotations and code completion for session.client("mgn").update_source_server_replication_type
method.
boto3 documentation
await def update_source_server_replication_type(
self,
*,
replicationType: ReplicationTypeType, # (1)
sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef: # (2)
...
kwargs: UpdateSourceServerReplicationTypeRequestRequestTypeDef = { # (1)
"replicationType": ...,
"sourceServerID": ...,
}
parent.update_source_server_replication_type(**kwargs)
__aenter__
Type annotations and code completion for session.client("mgn").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("mgn").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("mgn").get_paginator
method with overloads.
client.get_paginator("describe_job_log_items")
-> DescribeJobLogItemsPaginatorclient.get_paginator("describe_jobs")
-> DescribeJobsPaginatorclient.get_paginator("describe_launch_configuration_templates")
-> DescribeLaunchConfigurationTemplatesPaginatorclient.get_paginator("describe_replication_configuration_templates")
-> DescribeReplicationConfigurationTemplatesPaginatorclient.get_paginator("describe_source_servers")
-> DescribeSourceServersPaginatorclient.get_paginator("describe_vcenter_clients")
-> DescribeVcenterClientsPaginator