Module Smaws_Client_MigrationHub

Migration Hub client library built on EIO.

Types

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

type unauthorized_operation = {
  1. message : string option;
}
type throttling_exception = {
  1. retry_after_seconds : int option;
    (*

    The number of seconds the caller should wait before retrying.

    *)
  2. message : string;
    (*

    A message that provides information about the exception.

    *)
}

The request was denied due to request throttling.

type status =
  1. | COMPLETED
  2. | FAILED
  3. | IN_PROGRESS
  4. | NOT_STARTED
type task = {
  1. progress_percent : int option;
    (*

    Indication of the percentage completion of the task.

    *)
  2. status_detail : string option;
    (*

    Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.

    *)
  3. status : status;
    (*

    Status of the task - Not Started, In-Progress, Complete.

    *)
}

Task object encapsulating task information.

type service_unavailable_exception = {
  1. message : string option;
}

Exception raised when there is an internal, configuration, or dependency error encountered.

type resource_not_found_exception = {
  1. message : string option;
}

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

type resource_attribute_type =
  1. | MOTHERBOARD_SERIAL_NUMBER
  2. | BIOS_ID
  3. | VM_PATH
  4. | VM_NAME
  5. | VM_MANAGED_OBJECT_REFERENCE
  6. | VM_MANAGER_ID
  7. | FQDN
  8. | MAC_ADDRESS
  9. | IPV6_ADDRESS
  10. | IPV4_ADDRESS
type resource_attribute = {
  1. value : string;
    (*

    Value of the resource type.

    *)
  2. type_ : resource_attribute_type;
    (*

    Type of resource.

    *)
}

Attribute associated with a resource.

Note the corresponding format required per type listed below:

IPV4 x.x.x.x

where x is an integer in the range [0,255]

IPV6 y : y : y : y : y : y : y : y

where y is a hexadecimal between 0 and FFFF. [0, FFFF]

MAC_ADDRESS ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

FQDN ^[^<>{}\\\\/?,=\\p{Cntrl}]{1,256}$

type put_resource_attributes_result = unit
type put_resource_attributes_request = {
  1. dry_run : bool option;
    (*

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

    *)
  2. resource_attribute_list : resource_attribute list;
    (*

    Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.

    Takes the object array of ResourceAttribute where the Type field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 characters.

    • If any "VM" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the Example section below for a use case of specifying "VM" related values.
    • If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.
    *)
  3. migration_task_name : string;
    (*

    Unique identifier that references the migration task. Do not store personal data in this field.

    *)
  4. progress_update_stream : string;
    (*

    The name of the ProgressUpdateStream.

    *)
}
type invalid_input_exception = {
  1. message : string option;
}

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

type internal_server_error = {
  1. message : string option;
}

Exception raised when an internal, configuration, or dependency error is encountered.

type home_region_not_set_exception = {
  1. message : string option;
}

The home region is not set. Set the home region to continue.

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

type dry_run_operation = {
  1. message : string option;
}
type access_denied_exception = {
  1. message : string option;
}

You do not have sufficient access to perform this action.

type progress_update_stream_summary = {
  1. progress_update_stream_name : string option;
    (*

    The name of the ProgressUpdateStream. Do not store personal data in this field.

    *)
}

Summary of the AWS resource used for access control that is implicitly linked to your AWS account.

type policy_error_exception = {
  1. message : string option;
}

Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

type notify_migration_task_state_result = unit
type notify_migration_task_state_request = {
  1. dry_run : bool option;
    (*

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

    *)
  2. next_update_seconds : int;
    (*

    Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.

    *)
  3. update_date_time : float;
    (*

    The timestamp when the task was gathered.

    *)
  4. task : task;
    (*

    Information about the task's progress and status.

    *)
  5. migration_task_name : string;
    (*

    Unique identifier that references the migration task. Do not store personal data in this field.

    *)
  6. progress_update_stream : string;
    (*

    The name of the ProgressUpdateStream.

    *)
}
type notify_application_state_result = unit
type application_status =
  1. | COMPLETED
  2. | IN_PROGRESS
  3. | NOT_STARTED
type notify_application_state_request = {
  1. dry_run : bool option;
    (*

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

    *)
  2. update_date_time : float option;
    (*

    The timestamp when the application state changed.

    *)
  3. status : application_status;
    (*

    Status of the application - Not Started, In-Progress, Complete.

    *)
  4. application_id : string;
    (*

    The configurationId in Application Discovery Service that uniquely identifies the grouped application.

    *)
}
type migration_task_summary = {
  1. update_date_time : float option;
    (*

    The timestamp when the task was gathered.

    *)
  2. status_detail : string option;
    (*

    Detail information of what is being done within the overall status state.

    *)
  3. progress_percent : int option;
    (*

    Indication of the percentage completion of the task.

    *)
  4. status : status option;
    (*

    Status of the task.

    *)
  5. migration_task_name : string option;
    (*

    Unique identifier that references the migration task. Do not store personal data in this field.

    *)
  6. progress_update_stream : string option;
    (*

    An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool.

    *)
}

MigrationTaskSummary includes MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and UpdateDateTime for each task.

type migration_task = {
  1. resource_attribute_list : resource_attribute list option;
    (*

    Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.

    *)
  2. update_date_time : float option;
    (*

    The timestamp when the task was gathered.

    *)
  3. task : task option;
    (*

    Task object encapsulating task information.

    *)
  4. migration_task_name : string option;
    (*

    Unique identifier that references the migration task. Do not store personal data in this field.

    *)
  5. progress_update_stream : string option;
    (*

    A name that identifies the vendor of the migration tool being used.

    *)
}

Represents a migration task in a migration tool.

type list_progress_update_streams_result = {
  1. next_token : string option;
    (*

    If there are more streams created than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

    *)
  2. progress_update_stream_summary_list : progress_update_stream_summary list option;
    (*

    List of progress update streams up to the max number of results passed in the input.

    *)
}
type list_progress_update_streams_request = {
  1. max_results : int option;
    (*

    Filter to limit the maximum number of results to list per page.

    *)
  2. next_token : string option;
    (*

    If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    *)
}
type list_migration_tasks_result = {
  1. migration_task_summary_list : migration_task_summary list option;
    (*

    Lists the migration task's summary which includes: MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and the UpdateDateTime for each task.

    *)
  2. next_token : string option;
    (*

    If there are more migration tasks than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

    *)
}
type list_migration_tasks_request = {
  1. resource_name : string option;
    (*

    Filter migration tasks by discovered resource name.

    *)
  2. max_results : int option;
    (*

    Value to specify how many results are returned per page.

    *)
  3. next_token : string option;
    (*

    If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    *)
}
type discovered_resource = {
  1. description : string option;
    (*

    A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.

    *)
  2. configuration_id : string;
    (*

    The configurationId in Application Discovery Service that uniquely identifies the on-premise resource.

    *)
}

Object representing the on-premises resource being migrated.

type list_discovered_resources_result = {
  1. discovered_resource_list : discovered_resource list option;
    (*

    Returned list of discovered resources associated with the given MigrationTask.

    *)
  2. next_token : string option;
    (*

    If there are more discovered resources than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

    *)
}
type list_discovered_resources_request = {
  1. max_results : int option;
    (*

    The maximum number of results returned per page.

    *)
  2. next_token : string option;
    (*

    If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    *)
  3. migration_task_name : string;
    (*

    The name of the MigrationTask. Do not store personal data in this field.

    *)
  4. progress_update_stream : string;
    (*

    The name of the ProgressUpdateStream.

    *)
}
type created_artifact = {
  1. description : string option;
    (*

    A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.

    *)
  2. name : string;
    (*

    An ARN that uniquely identifies the result of a migration task.

    *)
}

An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.).

type list_created_artifacts_result = {
  1. created_artifact_list : created_artifact list option;
    (*

    List of created artifacts up to the maximum number of results specified in the request.

    *)
  2. next_token : string option;
    (*

    If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

    *)
}
type list_created_artifacts_request = {
  1. max_results : int option;
    (*

    Maximum number of results to be returned per page.

    *)
  2. next_token : string option;
    (*

    If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    *)
  3. migration_task_name : string;
    (*

    Unique identifier that references the migration task. Do not store personal data in this field.

    *)
  4. progress_update_stream : string;
    (*

    The name of the ProgressUpdateStream.

    *)
}
type application_state = {
  1. last_updated_time : float option;
    (*

    The timestamp when the application status was last updated.

    *)
  2. application_status : application_status option;
    (*

    The current status of an application.

    *)
  3. application_id : string option;
    (*

    The configurationId from the Application Discovery Service that uniquely identifies an application.

    *)
}

The state of an application discovered through Migration Hub import, the AWS Agentless Discovery Connector, or the AWS Application Discovery Agent.

type list_application_states_result = {
  1. next_token : string option;
    (*

    If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    *)
  2. application_state_list : application_state list option;
    (*

    A list of Applications that exist in Application Discovery Service.

    *)
}
type list_application_states_request = {
  1. max_results : int option;
    (*

    Maximum number of results to be returned per page.

    *)
  2. next_token : string option;
    (*

    If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    *)
  3. application_ids : string list option;
    (*

    The configurationIds from the Application Discovery Service that uniquely identifies your applications.

    *)
}
type import_migration_task_result = unit
type import_migration_task_request = {
  1. dry_run : bool option;
    (*

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

    *)
  2. migration_task_name : string;
    (*

    Unique identifier that references the migration task. Do not store personal data in this field.

    *)
  3. progress_update_stream : string;
    (*

    The name of the ProgressUpdateStream. >

    *)
}
type disassociate_discovered_resource_result = unit
type disassociate_discovered_resource_request = {
  1. dry_run : bool option;
    (*

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

    *)
  2. configuration_id : string;
    (*

    ConfigurationId of the Application Discovery Service resource to be disassociated.

    *)
  3. migration_task_name : string;
    (*

    The identifier given to the MigrationTask. Do not store personal data in this field.

    *)
  4. progress_update_stream : string;
    (*

    The name of the ProgressUpdateStream.

    *)
}
type disassociate_created_artifact_result = unit
type disassociate_created_artifact_request = {
  1. dry_run : bool option;
    (*

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

    *)
  2. created_artifact_name : string;
    (*

    An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)

    *)
  3. migration_task_name : string;
    (*

    Unique identifier that references the migration task to be disassociated with the artifact. Do not store personal data in this field.

    *)
  4. progress_update_stream : string;
    (*

    The name of the ProgressUpdateStream.

    *)
}
type describe_migration_task_result = {
  1. migration_task : migration_task option;
    (*

    Object encapsulating information about the migration task.

    *)
}
type describe_migration_task_request = {
  1. migration_task_name : string;
    (*

    The identifier given to the MigrationTask. Do not store personal data in this field.

    *)
  2. progress_update_stream : string;
    (*

    The name of the ProgressUpdateStream.

    *)
}
type describe_application_state_result = {
  1. last_updated_time : float option;
    (*

    The timestamp when the application status was last updated.

    *)
  2. application_status : application_status option;
    (*

    Status of the application - Not Started, In-Progress, Complete.

    *)
}
type describe_application_state_request = {
  1. application_id : string;
    (*

    The configurationId in Application Discovery Service that uniquely identifies the grouped application.

    *)
}
type delete_progress_update_stream_result = unit
type delete_progress_update_stream_request = {
  1. dry_run : bool option;
    (*

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

    *)
  2. progress_update_stream_name : string;
    (*

    The name of the ProgressUpdateStream. Do not store personal data in this field.

    *)
}
type create_progress_update_stream_result = unit
type create_progress_update_stream_request = {
  1. dry_run : bool option;
    (*

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

    *)
  2. progress_update_stream_name : string;
    (*

    The name of the ProgressUpdateStream. Do not store personal data in this field.

    *)
}
type associate_discovered_resource_result = unit
type associate_discovered_resource_request = {
  1. dry_run : bool option;
    (*

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

    *)
  2. discovered_resource : discovered_resource;
    (*

    Object representing a Resource.

    *)
  3. migration_task_name : string;
    (*

    The identifier given to the MigrationTask. Do not store personal data in this field.

    *)
  4. progress_update_stream : string;
    (*

    The name of the ProgressUpdateStream.

    *)
}
type associate_created_artifact_result = unit
type associate_created_artifact_request = {
  1. dry_run : bool option;
    (*

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

    *)
  2. created_artifact : created_artifact;
    (*

    An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)

    *)
  3. migration_task_name : string;
    (*

    Unique identifier that references the migration task. Do not store personal data in this field.

    *)
  4. progress_update_stream : string;
    (*

    The name of the ProgressUpdateStream.

    *)
}

The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub.

Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a HomeRegionNotSetException error will be returned. Also, you must make the API calls while in your home region.

type base_document = Smaws_Lib.Json.t

Builders

val make_task : ?progress_percent:int -> ?status_detail:string -> status:status -> unit -> task

Create a task type

val make_resource_attribute : value:string -> type_:resource_attribute_type -> unit -> resource_attribute

Create a resource_attribute type

val make_put_resource_attributes_request : ?dry_run:bool -> resource_attribute_list:resource_attribute list -> migration_task_name:string -> progress_update_stream:string -> unit -> put_resource_attributes_request

Create a put_resource_attributes_request type

val make_progress_update_stream_summary : ?progress_update_stream_name:string -> unit -> progress_update_stream_summary

Create a progress_update_stream_summary type

val make_notify_migration_task_state_request : ?dry_run:bool -> next_update_seconds:int -> update_date_time:float -> task:task -> migration_task_name:string -> progress_update_stream:string -> unit -> notify_migration_task_state_request

Create a notify_migration_task_state_request type

val make_notify_application_state_request : ?dry_run:bool -> ?update_date_time:float -> status:application_status -> application_id:string -> unit -> notify_application_state_request

Create a notify_application_state_request type

val make_migration_task_summary : ?update_date_time:float -> ?status_detail:string -> ?progress_percent:int -> ?status:status -> ?migration_task_name:string -> ?progress_update_stream:string -> unit -> migration_task_summary

Create a migration_task_summary type

val make_migration_task : ?resource_attribute_list:resource_attribute list -> ?update_date_time:float -> ?task:task -> ?migration_task_name:string -> ?progress_update_stream:string -> unit -> migration_task

Create a migration_task type

val make_list_progress_update_streams_request : ?max_results:int -> ?next_token:string -> unit -> list_progress_update_streams_request

Create a list_progress_update_streams_request type

val make_list_migration_tasks_request : ?resource_name:string -> ?max_results:int -> ?next_token:string -> unit -> list_migration_tasks_request

Create a list_migration_tasks_request type

val make_discovered_resource : ?description:string -> configuration_id:string -> unit -> discovered_resource

Create a discovered_resource type

val make_list_discovered_resources_request : ?max_results:int -> ?next_token:string -> migration_task_name:string -> progress_update_stream:string -> unit -> list_discovered_resources_request

Create a list_discovered_resources_request type

val make_created_artifact : ?description:string -> name:string -> unit -> created_artifact

Create a created_artifact type

val make_list_created_artifacts_request : ?max_results:int -> ?next_token:string -> migration_task_name:string -> progress_update_stream:string -> unit -> list_created_artifacts_request

Create a list_created_artifacts_request type

val make_application_state : ?last_updated_time:float -> ?application_status:application_status -> ?application_id:string -> unit -> application_state

Create a application_state type

val make_list_application_states_request : ?max_results:int -> ?next_token:string -> ?application_ids:string list -> unit -> list_application_states_request

Create a list_application_states_request type

val make_import_migration_task_request : ?dry_run:bool -> migration_task_name:string -> progress_update_stream:string -> unit -> import_migration_task_request

Create a import_migration_task_request type

val make_disassociate_discovered_resource_request : ?dry_run:bool -> configuration_id:string -> migration_task_name:string -> progress_update_stream:string -> unit -> disassociate_discovered_resource_request

Create a disassociate_discovered_resource_request type

val make_disassociate_created_artifact_request : ?dry_run:bool -> created_artifact_name:string -> migration_task_name:string -> progress_update_stream:string -> unit -> disassociate_created_artifact_request

Create a disassociate_created_artifact_request type

val make_describe_migration_task_request : migration_task_name:string -> progress_update_stream:string -> unit -> describe_migration_task_request

Create a describe_migration_task_request type

val make_describe_application_state_request : application_id:string -> unit -> describe_application_state_request

Create a describe_application_state_request type

val make_delete_progress_update_stream_request : ?dry_run:bool -> progress_update_stream_name:string -> unit -> delete_progress_update_stream_request

Create a delete_progress_update_stream_request type

val make_create_progress_update_stream_request : ?dry_run:bool -> progress_update_stream_name:string -> unit -> create_progress_update_stream_request

Create a create_progress_update_stream_request type

val make_associate_discovered_resource_request : ?dry_run:bool -> discovered_resource:discovered_resource -> migration_task_name:string -> progress_update_stream:string -> unit -> associate_discovered_resource_request

Create a associate_discovered_resource_request type

val make_associate_created_artifact_request : ?dry_run:bool -> created_artifact:created_artifact -> migration_task_name:string -> progress_update_stream:string -> unit -> associate_created_artifact_request

Create a associate_created_artifact_request type

Operations

module AssociateCreatedArtifact : sig ... end
module AssociateDiscoveredResource : sig ... end
module CreateProgressUpdateStream : sig ... end
module DeleteProgressUpdateStream : sig ... end
module DescribeApplicationState : sig ... end
module DescribeMigrationTask : sig ... end
module DisassociateCreatedArtifact : sig ... end
module DisassociateDiscoveredResource : sig ... end
module ImportMigrationTask : sig ... end
module ListApplicationStates : sig ... end
module ListCreatedArtifacts : sig ... end
module ListDiscoveredResources : sig ... end
module ListMigrationTasks : sig ... end
module ListProgressUpdateStreams : sig ... end
module NotifyApplicationState : sig ... end
module NotifyMigrationTaskState : sig ... end
module PutResourceAttributes : sig ... end