MigrationHubClient
Index > MigrationHub > MigrationHubClient
Auto-generated documentation for MigrationHub type annotations stubs module types-aiobotocore-mgh.
MigrationHubClient
Type annotations and code completion for session.client("mgh")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_mgh.client import MigrationHubClient
session = Session()
async with session.client("mgh") as client:
client: MigrationHubClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("mgh").exceptions
structure.
async with session.client("mgh") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.DryRunOperation,
client.HomeRegionNotSetException,
client.InternalServerError,
client.InvalidInputException,
client.PolicyErrorException,
client.ResourceNotFoundException,
client.ServiceUnavailableException,
client.ThrottlingException,
client.UnauthorizedOperation,
) as e:
print(e)
from types_aiobotocore_mgh.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
associate_created_artifact
Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool.
Type annotations and code completion for session.client("mgh").associate_created_artifact
method.
boto3 documentation
await def associate_created_artifact(
self,
*,
ProgressUpdateStream: str,
MigrationTaskName: str,
CreatedArtifact: CreatedArtifactTypeDef, # (1)
DryRun: bool = ...,
) -> Dict[str, Any]:
...
kwargs: AssociateCreatedArtifactRequestRequestTypeDef = { # (1)
"ProgressUpdateStream": ...,
"MigrationTaskName": ...,
"CreatedArtifact": ...,
}
parent.associate_created_artifact(**kwargs)
associate_discovered_resource
Associates a discovered resource ID from Application Discovery Service with a migration task.
Type annotations and code completion for session.client("mgh").associate_discovered_resource
method.
boto3 documentation
await def associate_discovered_resource(
self,
*,
ProgressUpdateStream: str,
MigrationTaskName: str,
DiscoveredResource: DiscoveredResourceTypeDef, # (1)
DryRun: bool = ...,
) -> Dict[str, Any]:
...
kwargs: AssociateDiscoveredResourceRequestRequestTypeDef = { # (1)
"ProgressUpdateStream": ...,
"MigrationTaskName": ...,
"DiscoveredResource": ...,
}
parent.associate_discovered_resource(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("mgh").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("mgh").close
method.
boto3 documentation
create_progress_update_stream
Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account.
Type annotations and code completion for session.client("mgh").create_progress_update_stream
method.
boto3 documentation
await def create_progress_update_stream(
self,
*,
ProgressUpdateStreamName: str,
DryRun: bool = ...,
) -> Dict[str, Any]:
...
kwargs: CreateProgressUpdateStreamRequestRequestTypeDef = { # (1)
"ProgressUpdateStreamName": ...,
}
parent.create_progress_update_stream(**kwargs)
delete_progress_update_stream
Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control.
Type annotations and code completion for session.client("mgh").delete_progress_update_stream
method.
boto3 documentation
await def delete_progress_update_stream(
self,
*,
ProgressUpdateStreamName: str,
DryRun: bool = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteProgressUpdateStreamRequestRequestTypeDef = { # (1)
"ProgressUpdateStreamName": ...,
}
parent.delete_progress_update_stream(**kwargs)
describe_application_state
Gets the migration status of an application.
Type annotations and code completion for session.client("mgh").describe_application_state
method.
boto3 documentation
await def describe_application_state(
self,
*,
ApplicationId: str,
) -> DescribeApplicationStateResultTypeDef: # (1)
...
kwargs: DescribeApplicationStateRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.describe_application_state(**kwargs)
describe_migration_task
Retrieves a list of all attributes associated with a specific migration task.
Type annotations and code completion for session.client("mgh").describe_migration_task
method.
boto3 documentation
await def describe_migration_task(
self,
*,
ProgressUpdateStream: str,
MigrationTaskName: str,
) -> DescribeMigrationTaskResultTypeDef: # (1)
...
kwargs: DescribeMigrationTaskRequestRequestTypeDef = { # (1)
"ProgressUpdateStream": ...,
"MigrationTaskName": ...,
}
parent.describe_migration_task(**kwargs)
disassociate_created_artifact
Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated.
Type annotations and code completion for session.client("mgh").disassociate_created_artifact
method.
boto3 documentation
await def disassociate_created_artifact(
self,
*,
ProgressUpdateStream: str,
MigrationTaskName: str,
CreatedArtifactName: str,
DryRun: bool = ...,
) -> Dict[str, Any]:
...
kwargs: DisassociateCreatedArtifactRequestRequestTypeDef = { # (1)
"ProgressUpdateStream": ...,
"MigrationTaskName": ...,
"CreatedArtifactName": ...,
}
parent.disassociate_created_artifact(**kwargs)
disassociate_discovered_resource
Disassociate an Application Discovery Service discovered resource from a migration task.
Type annotations and code completion for session.client("mgh").disassociate_discovered_resource
method.
boto3 documentation
await def disassociate_discovered_resource(
self,
*,
ProgressUpdateStream: str,
MigrationTaskName: str,
ConfigurationId: str,
DryRun: bool = ...,
) -> Dict[str, Any]:
...
kwargs: DisassociateDiscoveredResourceRequestRequestTypeDef = { # (1)
"ProgressUpdateStream": ...,
"MigrationTaskName": ...,
"ConfigurationId": ...,
}
parent.disassociate_discovered_resource(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("mgh").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
import_migration_task
Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.
Type annotations and code completion for session.client("mgh").import_migration_task
method.
boto3 documentation
await def import_migration_task(
self,
*,
ProgressUpdateStream: str,
MigrationTaskName: str,
DryRun: bool = ...,
) -> Dict[str, Any]:
...
kwargs: ImportMigrationTaskRequestRequestTypeDef = { # (1)
"ProgressUpdateStream": ...,
"MigrationTaskName": ...,
}
parent.import_migration_task(**kwargs)
list_application_states
Lists all the migration statuses for your applications.
Type annotations and code completion for session.client("mgh").list_application_states
method.
boto3 documentation
await def list_application_states(
self,
*,
ApplicationIds: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListApplicationStatesResultTypeDef: # (1)
...
kwargs: ListApplicationStatesRequestRequestTypeDef = { # (1)
"ApplicationIds": ...,
}
parent.list_application_states(**kwargs)
list_created_artifacts
Lists the created artifacts attached to a given migration task in an update stream.
Type annotations and code completion for session.client("mgh").list_created_artifacts
method.
boto3 documentation
await def list_created_artifacts(
self,
*,
ProgressUpdateStream: str,
MigrationTaskName: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListCreatedArtifactsResultTypeDef: # (1)
...
kwargs: ListCreatedArtifactsRequestRequestTypeDef = { # (1)
"ProgressUpdateStream": ...,
"MigrationTaskName": ...,
}
parent.list_created_artifacts(**kwargs)
list_discovered_resources
Lists discovered resources associated with the given MigrationTask
.
Type annotations and code completion for session.client("mgh").list_discovered_resources
method.
boto3 documentation
await def list_discovered_resources(
self,
*,
ProgressUpdateStream: str,
MigrationTaskName: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDiscoveredResourcesResultTypeDef: # (1)
...
kwargs: ListDiscoveredResourcesRequestRequestTypeDef = { # (1)
"ProgressUpdateStream": ...,
"MigrationTaskName": ...,
}
parent.list_discovered_resources(**kwargs)
list_migration_tasks
Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
Type annotations and code completion for session.client("mgh").list_migration_tasks
method.
boto3 documentation
await def list_migration_tasks(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
ResourceName: str = ...,
) -> ListMigrationTasksResultTypeDef: # (1)
...
kwargs: ListMigrationTasksRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_migration_tasks(**kwargs)
list_progress_update_streams
Lists progress update streams associated with the user account making this call.
Type annotations and code completion for session.client("mgh").list_progress_update_streams
method.
boto3 documentation
await def list_progress_update_streams(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListProgressUpdateStreamsResultTypeDef: # (1)
...
kwargs: ListProgressUpdateStreamsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_progress_update_streams(**kwargs)
notify_application_state
Sets the migration state of an application.
Type annotations and code completion for session.client("mgh").notify_application_state
method.
boto3 documentation
await def notify_application_state(
self,
*,
ApplicationId: str,
Status: ApplicationStatusType, # (1)
UpdateDateTime: Union[datetime, str] = ...,
DryRun: bool = ...,
) -> Dict[str, Any]:
...
kwargs: NotifyApplicationStateRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"Status": ...,
}
parent.notify_application_state(**kwargs)
notify_migration_task_state
Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
Type annotations and code completion for session.client("mgh").notify_migration_task_state
method.
boto3 documentation
await def notify_migration_task_state(
self,
*,
ProgressUpdateStream: str,
MigrationTaskName: str,
Task: TaskTypeDef, # (1)
UpdateDateTime: Union[datetime, str],
NextUpdateSeconds: int,
DryRun: bool = ...,
) -> Dict[str, Any]:
...
- See TaskTypeDef
kwargs: NotifyMigrationTaskStateRequestRequestTypeDef = { # (1)
"ProgressUpdateStream": ...,
"MigrationTaskName": ...,
"Task": ...,
"UpdateDateTime": ...,
"NextUpdateSeconds": ...,
}
parent.notify_migration_task_state(**kwargs)
put_resource_attributes
.
Type annotations and code completion for session.client("mgh").put_resource_attributes
method.
boto3 documentation
await def put_resource_attributes(
self,
*,
ProgressUpdateStream: str,
MigrationTaskName: str,
ResourceAttributeList: Sequence[ResourceAttributeTypeDef], # (1)
DryRun: bool = ...,
) -> Dict[str, Any]:
...
kwargs: PutResourceAttributesRequestRequestTypeDef = { # (1)
"ProgressUpdateStream": ...,
"MigrationTaskName": ...,
"ResourceAttributeList": ...,
}
parent.put_resource_attributes(**kwargs)
__aenter__
Type annotations and code completion for session.client("mgh").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("mgh").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("mgh").get_paginator
method with overloads.
client.get_paginator("list_application_states")
-> ListApplicationStatesPaginatorclient.get_paginator("list_created_artifacts")
-> ListCreatedArtifactsPaginatorclient.get_paginator("list_discovered_resources")
-> ListDiscoveredResourcesPaginatorclient.get_paginator("list_migration_tasks")
-> ListMigrationTasksPaginatorclient.get_paginator("list_progress_update_streams")
-> ListProgressUpdateStreamsPaginator