Module Smaws_Client_MigrationHub

Migration Hub client library built on EIO.

Types

type nonrec unauthorized_operation = {
  1. message : string option;
}

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

type nonrec 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 nonrec status =
  1. | COMPLETED
  2. | FAILED
  3. | IN_PROGRESS
  4. | NOT_STARTED
type nonrec 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 nonrec service_unavailable_exception = {
  1. message : string option;
}

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

type nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec internal_server_error = {
  1. message : string option;
}

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

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

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

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

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

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

You do not have sufficient access to perform this action.

type nonrec 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 nonrec 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 nonrec 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 : Smaws_Lib.CoreTypes.Timestamp.t;
    (*

    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 nonrec application_status =
  1. | COMPLETED
  2. | IN_PROGRESS
  3. | NOT_STARTED
type nonrec 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 : Smaws_Lib.CoreTypes.Timestamp.t 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 nonrec migration_task_summary = {
  1. update_date_time : Smaws_Lib.CoreTypes.Timestamp.t 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 nonrec 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 : Smaws_Lib.CoreTypes.Timestamp.t 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec application_state = {
  1. last_updated_time : Smaws_Lib.CoreTypes.Timestamp.t 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec 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 nonrec describe_migration_task_result = {
  1. migration_task : migration_task option;
    (*

    Object encapsulating information about the migration task.

    *)
}
type nonrec 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 nonrec describe_application_state_result = {
  1. last_updated_time : Smaws_Lib.CoreTypes.Timestamp.t 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 nonrec describe_application_state_request = {
  1. application_id : string;
    (*

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

    *)
}
type nonrec 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 nonrec 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 nonrec 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 nonrec 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.

    *)
}

Builders

val make_task : ?progress_percent:int -> ?status_detail:string -> status:status -> unit -> task
val make_resource_attribute : value:string -> type_:resource_attribute_type -> unit -> resource_attribute
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
val make_progress_update_stream_summary : ?progress_update_stream_name:string -> unit -> progress_update_stream_summary
val make_notify_migration_task_state_request : ?dry_run:bool -> next_update_seconds:int -> update_date_time:Smaws_Lib.CoreTypes.Timestamp.t -> task:task -> migration_task_name:string -> progress_update_stream:string -> unit -> notify_migration_task_state_request
val make_notify_application_state_request : ?dry_run:bool -> ?update_date_time:Smaws_Lib.CoreTypes.Timestamp.t -> status:application_status -> application_id:string -> unit -> notify_application_state_request
val make_migration_task_summary : ?update_date_time:Smaws_Lib.CoreTypes.Timestamp.t -> ?status_detail:string -> ?progress_percent:int -> ?status:status -> ?migration_task_name:string -> ?progress_update_stream:string -> unit -> migration_task_summary
val make_migration_task : ?resource_attribute_list:resource_attribute list -> ?update_date_time:Smaws_Lib.CoreTypes.Timestamp.t -> ?task:task -> ?migration_task_name:string -> ?progress_update_stream:string -> unit -> migration_task
val make_list_progress_update_streams_request : ?max_results:int -> ?next_token:string -> unit -> list_progress_update_streams_request
val make_list_migration_tasks_request : ?resource_name:string -> ?max_results:int -> ?next_token:string -> unit -> list_migration_tasks_request
val make_discovered_resource : ?description:string -> configuration_id:string -> unit -> discovered_resource
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
val make_created_artifact : ?description:string -> name:string -> unit -> created_artifact
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
val make_application_state : ?last_updated_time:Smaws_Lib.CoreTypes.Timestamp.t -> ?application_status:application_status -> ?application_id:string -> unit -> application_state
val make_list_application_states_request : ?max_results:int -> ?next_token:string -> ?application_ids:string list -> unit -> list_application_states_request
val make_import_migration_task_request : ?dry_run:bool -> migration_task_name:string -> progress_update_stream:string -> unit -> import_migration_task_request
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
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
val make_describe_migration_task_request : migration_task_name:string -> progress_update_stream:string -> unit -> describe_migration_task_request
val make_describe_application_state_request : application_id:string -> unit -> describe_application_state_request
val make_delete_progress_update_stream_request : ?dry_run:bool -> progress_update_stream_name:string -> unit -> delete_progress_update_stream_request
val make_create_progress_update_stream_request : ?dry_run:bool -> progress_update_stream_name:string -> unit -> create_progress_update_stream_request
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
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

Operations

module AssociateCreatedArtifact : sig ... end

Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:

module AssociateDiscoveredResource : sig ... end

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

module CreateProgressUpdateStream : sig ... end

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. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.

module DeleteProgressUpdateStream : sig ... end

Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:

module DescribeApplicationState : sig ... end

Gets the migration status of an application.

module DescribeMigrationTask : sig ... end

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

module DisassociateCreatedArtifact : sig ... end

Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:

module DisassociateDiscoveredResource : sig ... end

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

module ImportMigrationTask : sig ... end

Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.

module ListApplicationStates : sig ... end

Lists all the migration statuses for your applications. If you use the optional ApplicationIds parameter, only the migration statuses for those applications will be returned.

module ListCreatedArtifacts : sig ... end

Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:

module ListDiscoveredResources : sig ... end

Lists discovered resources associated with the given MigrationTask.

module ListMigrationTasks : sig ... end

Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:

module ListProgressUpdateStreams : sig ... end

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

module NotifyApplicationState : sig ... end

Sets the migration state of an application. For a given application identified by the value passed to ApplicationId, its status is set or updated by passing one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED.

module NotifyMigrationTaskState : sig ... end

Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:

module PutResourceAttributes : sig ... end

Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository. This association occurs asynchronously after PutResourceAttributes returns.