MigrationHubClient

Index > MigrationHub > MigrationHubClient

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

MigrationHubClient

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

Usage example

from boto3.session import Session
from mypy_boto3_mgh.client import MigrationHubClient

def get_mgh_client() -> MigrationHubClient:
    return Session().client("mgh")

Exceptions

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

Usage example

client = boto3.client("mgh")

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)

Type checking example

from mypy_boto3_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 boto3.client("mgh").associate_created_artifact method. boto3 documentation

Method definition

def associate_created_artifact(
    self,
    *,
    ProgressUpdateStream: str,
    MigrationTaskName: str,
    CreatedArtifact: CreatedArtifactTypeDef,  # (1)
    DryRun: bool = ...,
) -> Dict[str, Any]:
    ...

1. See CreatedArtifactTypeDef

Usage example with kwargs

kwargs: AssociateCreatedArtifactRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStream": ...,
    "MigrationTaskName": ...,
    "CreatedArtifact": ...,
}

parent.associate_created_artifact(**kwargs)

1. See AssociateCreatedArtifactRequestRequestTypeDef

associate_discovered_resource

Associates a discovered resource ID from Application Discovery Service with a migration task.

Type annotations and code completion for boto3.client("mgh").associate_discovered_resource method. boto3 documentation

Method definition

def associate_discovered_resource(
    self,
    *,
    ProgressUpdateStream: str,
    MigrationTaskName: str,
    DiscoveredResource: DiscoveredResourceTypeDef,  # (1)
    DryRun: bool = ...,
) -> Dict[str, Any]:
    ...

1. See DiscoveredResourceTypeDef

Usage example with kwargs

kwargs: AssociateDiscoveredResourceRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStream": ...,
    "MigrationTaskName": ...,
    "DiscoveredResource": ...,
}

parent.associate_discovered_resource(**kwargs)

1. See AssociateDiscoveredResourceRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

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

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 boto3.client("mgh").create_progress_update_stream method. boto3 documentation

Method definition

def create_progress_update_stream(
    self,
    *,
    ProgressUpdateStreamName: str,
    DryRun: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: CreateProgressUpdateStreamRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStreamName": ...,
}

parent.create_progress_update_stream(**kwargs)

1. See CreateProgressUpdateStreamRequestRequestTypeDef

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 boto3.client("mgh").delete_progress_update_stream method. boto3 documentation

Method definition

def delete_progress_update_stream(
    self,
    *,
    ProgressUpdateStreamName: str,
    DryRun: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteProgressUpdateStreamRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStreamName": ...,
}

parent.delete_progress_update_stream(**kwargs)

1. See DeleteProgressUpdateStreamRequestRequestTypeDef

describe_application_state

Gets the migration status of an application.

Type annotations and code completion for boto3.client("mgh").describe_application_state method. boto3 documentation

Method definition

def describe_application_state(
    self,
    *,
    ApplicationId: str,
) -> DescribeApplicationStateResultTypeDef:  # (1)
    ...

1. See DescribeApplicationStateResultTypeDef

Usage example with kwargs

kwargs: DescribeApplicationStateRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.describe_application_state(**kwargs)

1. See DescribeApplicationStateRequestRequestTypeDef

describe_migration_task

Retrieves a list of all attributes associated with a specific migration task.

Type annotations and code completion for boto3.client("mgh").describe_migration_task method. boto3 documentation

Method definition

def describe_migration_task(
    self,
    *,
    ProgressUpdateStream: str,
    MigrationTaskName: str,
) -> DescribeMigrationTaskResultTypeDef:  # (1)
    ...

1. See DescribeMigrationTaskResultTypeDef

Usage example with kwargs

kwargs: DescribeMigrationTaskRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStream": ...,
    "MigrationTaskName": ...,
}

parent.describe_migration_task(**kwargs)

1. See DescribeMigrationTaskRequestRequestTypeDef

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 boto3.client("mgh").disassociate_created_artifact method. boto3 documentation

Method definition

def disassociate_created_artifact(
    self,
    *,
    ProgressUpdateStream: str,
    MigrationTaskName: str,
    CreatedArtifactName: str,
    DryRun: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DisassociateCreatedArtifactRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStream": ...,
    "MigrationTaskName": ...,
    "CreatedArtifactName": ...,
}

parent.disassociate_created_artifact(**kwargs)

1. See DisassociateCreatedArtifactRequestRequestTypeDef

disassociate_discovered_resource

Disassociate an Application Discovery Service discovered resource from a migration task.

Type annotations and code completion for boto3.client("mgh").disassociate_discovered_resource method. boto3 documentation

Method definition

def disassociate_discovered_resource(
    self,
    *,
    ProgressUpdateStream: str,
    MigrationTaskName: str,
    ConfigurationId: str,
    DryRun: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DisassociateDiscoveredResourceRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStream": ...,
    "MigrationTaskName": ...,
    "ConfigurationId": ...,
}

parent.disassociate_discovered_resource(**kwargs)

1. See DisassociateDiscoveredResourceRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("mgh").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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 boto3.client("mgh").import_migration_task method. boto3 documentation

Method definition

def import_migration_task(
    self,
    *,
    ProgressUpdateStream: str,
    MigrationTaskName: str,
    DryRun: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: ImportMigrationTaskRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStream": ...,
    "MigrationTaskName": ...,
}

parent.import_migration_task(**kwargs)

1. See ImportMigrationTaskRequestRequestTypeDef

list_application_states

Lists all the migration statuses for your applications.

Type annotations and code completion for boto3.client("mgh").list_application_states method. boto3 documentation

Method definition

def list_application_states(
    self,
    *,
    ApplicationIds: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListApplicationStatesResultTypeDef:  # (1)
    ...

1. See ListApplicationStatesResultTypeDef

Usage example with kwargs

kwargs: ListApplicationStatesRequestRequestTypeDef = {  # (1)
    "ApplicationIds": ...,
}

parent.list_application_states(**kwargs)

1. See ListApplicationStatesRequestRequestTypeDef

list_created_artifacts

Lists the created artifacts attached to a given migration task in an update stream.

Type annotations and code completion for boto3.client("mgh").list_created_artifacts method. boto3 documentation

Method definition

def list_created_artifacts(
    self,
    *,
    ProgressUpdateStream: str,
    MigrationTaskName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListCreatedArtifactsResultTypeDef:  # (1)
    ...

1. See ListCreatedArtifactsResultTypeDef

Usage example with kwargs

kwargs: ListCreatedArtifactsRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStream": ...,
    "MigrationTaskName": ...,
}

parent.list_created_artifacts(**kwargs)

1. See ListCreatedArtifactsRequestRequestTypeDef

list_discovered_resources

Lists discovered resources associated with the given MigrationTask .

Type annotations and code completion for boto3.client("mgh").list_discovered_resources method. boto3 documentation

Method definition

def list_discovered_resources(
    self,
    *,
    ProgressUpdateStream: str,
    MigrationTaskName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDiscoveredResourcesResultTypeDef:  # (1)
    ...

1. See ListDiscoveredResourcesResultTypeDef

Usage example with kwargs

kwargs: ListDiscoveredResourcesRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStream": ...,
    "MigrationTaskName": ...,
}

parent.list_discovered_resources(**kwargs)

1. See ListDiscoveredResourcesRequestRequestTypeDef

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 boto3.client("mgh").list_migration_tasks method. boto3 documentation

Method definition

def list_migration_tasks(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    ResourceName: str = ...,
) -> ListMigrationTasksResultTypeDef:  # (1)
    ...

1. See ListMigrationTasksResultTypeDef

Usage example with kwargs

kwargs: ListMigrationTasksRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_migration_tasks(**kwargs)

1. See ListMigrationTasksRequestRequestTypeDef

list_progress_update_streams

Lists progress update streams associated with the user account making this call.

Type annotations and code completion for boto3.client("mgh").list_progress_update_streams method. boto3 documentation

Method definition

def list_progress_update_streams(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProgressUpdateStreamsResultTypeDef:  # (1)
    ...

1. See ListProgressUpdateStreamsResultTypeDef

Usage example with kwargs

kwargs: ListProgressUpdateStreamsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_progress_update_streams(**kwargs)

1. See ListProgressUpdateStreamsRequestRequestTypeDef

notify_application_state

Sets the migration state of an application.

Type annotations and code completion for boto3.client("mgh").notify_application_state method. boto3 documentation

Method definition

def notify_application_state(
    self,
    *,
    ApplicationId: str,
    Status: ApplicationStatusType,  # (1)
    UpdateDateTime: Union[datetime, str] = ...,
    DryRun: bool = ...,
) -> Dict[str, Any]:
    ...

1. See ApplicationStatusType

Usage example with kwargs

kwargs: NotifyApplicationStateRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "Status": ...,
}

parent.notify_application_state(**kwargs)

1. See NotifyApplicationStateRequestRequestTypeDef

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 boto3.client("mgh").notify_migration_task_state method. boto3 documentation

Method definition

def notify_migration_task_state(
    self,
    *,
    ProgressUpdateStream: str,
    MigrationTaskName: str,
    Task: TaskTypeDef,  # (1)
    UpdateDateTime: Union[datetime, str],
    NextUpdateSeconds: int,
    DryRun: bool = ...,
) -> Dict[str, Any]:
    ...

1. See TaskTypeDef

Usage example with kwargs

kwargs: NotifyMigrationTaskStateRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStream": ...,
    "MigrationTaskName": ...,
    "Task": ...,
    "UpdateDateTime": ...,
    "NextUpdateSeconds": ...,
}

parent.notify_migration_task_state(**kwargs)

1. See NotifyMigrationTaskStateRequestRequestTypeDef

put_resource_attributes

Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository.

Type annotations and code completion for boto3.client("mgh").put_resource_attributes method. boto3 documentation

Method definition

def put_resource_attributes(
    self,
    *,
    ProgressUpdateStream: str,
    MigrationTaskName: str,
    ResourceAttributeList: Sequence[ResourceAttributeTypeDef],  # (1)
    DryRun: bool = ...,
) -> Dict[str, Any]:
    ...

1. See ResourceAttributeTypeDef

Usage example with kwargs

kwargs: PutResourceAttributesRequestRequestTypeDef = {  # (1)
    "ProgressUpdateStream": ...,
    "MigrationTaskName": ...,
    "ResourceAttributeList": ...,
}

parent.put_resource_attributes(**kwargs)

1. See PutResourceAttributesRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_application_states") -> ListApplicationStatesPaginator
• client.get_paginator("list_created_artifacts") -> ListCreatedArtifactsPaginator
• client.get_paginator("list_discovered_resources") -> ListDiscoveredResourcesPaginator
• client.get_paginator("list_migration_tasks") -> ListMigrationTasksPaginator
• client.get_paginator("list_progress_update_streams") -> ListProgressUpdateStreamsPaginator