Packages
aws
1.0.0
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.14.1
0.14.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.0.12
0.0.11
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1
AWS clients for Elixir
Current section
Files
Jump to
Current section
Files
lib/aws/generated/migration_hub.ex
# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.MigrationHub do
@moduledoc """
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.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
list_application_states_request() :: %{
optional("ApplicationIds") => list(String.t()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t()
}
"""
@type list_application_states_request() :: %{String.t() => any()}
@typedoc """
## Example:
task() :: %{
"ProgressPercent" => integer(),
"Status" => list(any()),
"StatusDetail" => String.t()
}
"""
@type task() :: %{String.t() => any()}
@typedoc """
## Example:
resource_attribute() :: %{
"Type" => list(any()),
"Value" => String.t()
}
"""
@type resource_attribute() :: %{String.t() => any()}
@typedoc """
## Example:
notify_application_state_request() :: %{
optional("DryRun") => boolean(),
optional("UpdateDateTime") => non_neg_integer(),
required("ApplicationId") => String.t(),
required("Status") => list(any())
}
"""
@type notify_application_state_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_migration_tasks_result() :: %{
"MigrationTaskSummaryList" => list(migration_task_summary()()),
"NextToken" => String.t()
}
"""
@type list_migration_tasks_result() :: %{String.t() => any()}
@typedoc """
## Example:
notify_migration_task_state_result() :: %{}
"""
@type notify_migration_task_state_result() :: %{}
@typedoc """
## Example:
disassociate_discovered_resource_result() :: %{}
"""
@type disassociate_discovered_resource_result() :: %{}
@typedoc """
## Example:
put_resource_attributes_request() :: %{
optional("DryRun") => boolean(),
required("MigrationTaskName") => String.t(),
required("ProgressUpdateStream") => String.t(),
required("ResourceAttributeList") => list(resource_attribute()())
}
"""
@type put_resource_attributes_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_progress_update_streams_result() :: %{
"NextToken" => String.t(),
"ProgressUpdateStreamSummaryList" => list(progress_update_stream_summary()())
}
"""
@type list_progress_update_streams_result() :: %{String.t() => any()}
@typedoc """
## Example:
put_resource_attributes_result() :: %{}
"""
@type put_resource_attributes_result() :: %{}
@typedoc """
## Example:
delete_progress_update_stream_request() :: %{
optional("DryRun") => boolean(),
required("ProgressUpdateStreamName") => String.t()
}
"""
@type delete_progress_update_stream_request() :: %{String.t() => any()}
@typedoc """
## Example:
disassociate_created_artifact_result() :: %{}
"""
@type disassociate_created_artifact_result() :: %{}
@typedoc """
## Example:
associate_discovered_resource_request() :: %{
optional("DryRun") => boolean(),
required("DiscoveredResource") => discovered_resource(),
required("MigrationTaskName") => String.t(),
required("ProgressUpdateStream") => String.t()
}
"""
@type associate_discovered_resource_request() :: %{String.t() => any()}
@typedoc """
## Example:
unauthorized_operation() :: %{
"Message" => String.t()
}
"""
@type unauthorized_operation() :: %{String.t() => any()}
@typedoc """
## Example:
create_progress_update_stream_request() :: %{
optional("DryRun") => boolean(),
required("ProgressUpdateStreamName") => String.t()
}
"""
@type create_progress_update_stream_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_progress_update_stream_result() :: %{}
"""
@type delete_progress_update_stream_result() :: %{}
@typedoc """
## Example:
dry_run_operation() :: %{
"Message" => String.t()
}
"""
@type dry_run_operation() :: %{String.t() => any()}
@typedoc """
## Example:
list_application_states_result() :: %{
"ApplicationStateList" => list(application_state()()),
"NextToken" => String.t()
}
"""
@type list_application_states_result() :: %{String.t() => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"Message" => String.t()
}
"""
@type resource_not_found_exception() :: %{String.t() => any()}
@typedoc """
## Example:
import_migration_task_request() :: %{
optional("DryRun") => boolean(),
required("MigrationTaskName") => String.t(),
required("ProgressUpdateStream") => String.t()
}
"""
@type import_migration_task_request() :: %{String.t() => any()}
@typedoc """
## Example:
created_artifact() :: %{
"Description" => String.t(),
"Name" => String.t()
}
"""
@type created_artifact() :: %{String.t() => any()}
@typedoc """
## Example:
list_discovered_resources_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
required("MigrationTaskName") => String.t(),
required("ProgressUpdateStream") => String.t()
}
"""
@type list_discovered_resources_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_progress_update_streams_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t()
}
"""
@type list_progress_update_streams_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_created_artifacts_result() :: %{
"CreatedArtifactList" => list(created_artifact()()),
"NextToken" => String.t()
}
"""
@type list_created_artifacts_result() :: %{String.t() => any()}
@typedoc """
## Example:
invalid_input_exception() :: %{
"Message" => String.t()
}
"""
@type invalid_input_exception() :: %{String.t() => any()}
@typedoc """
## Example:
progress_update_stream_summary() :: %{
"ProgressUpdateStreamName" => String.t()
}
"""
@type progress_update_stream_summary() :: %{String.t() => any()}
@typedoc """
## Example:
associate_created_artifact_request() :: %{
optional("DryRun") => boolean(),
required("CreatedArtifact") => created_artifact(),
required("MigrationTaskName") => String.t(),
required("ProgressUpdateStream") => String.t()
}
"""
@type associate_created_artifact_request() :: %{String.t() => any()}
@typedoc """
## Example:
import_migration_task_result() :: %{}
"""
@type import_migration_task_result() :: %{}
@typedoc """
## Example:
disassociate_discovered_resource_request() :: %{
optional("DryRun") => boolean(),
required("ConfigurationId") => String.t(),
required("MigrationTaskName") => String.t(),
required("ProgressUpdateStream") => String.t()
}
"""
@type disassociate_discovered_resource_request() :: %{String.t() => any()}
@typedoc """
## Example:
service_unavailable_exception() :: %{
"Message" => String.t()
}
"""
@type service_unavailable_exception() :: %{String.t() => any()}
@typedoc """
## Example:
notify_migration_task_state_request() :: %{
optional("DryRun") => boolean(),
required("MigrationTaskName") => String.t(),
required("NextUpdateSeconds") => integer(),
required("ProgressUpdateStream") => String.t(),
required("Task") => task(),
required("UpdateDateTime") => non_neg_integer()
}
"""
@type notify_migration_task_state_request() :: %{String.t() => any()}
@typedoc """
## Example:
disassociate_created_artifact_request() :: %{
optional("DryRun") => boolean(),
required("CreatedArtifactName") => String.t(),
required("MigrationTaskName") => String.t(),
required("ProgressUpdateStream") => String.t()
}
"""
@type disassociate_created_artifact_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_created_artifacts_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
required("MigrationTaskName") => String.t(),
required("ProgressUpdateStream") => String.t()
}
"""
@type list_created_artifacts_request() :: %{String.t() => any()}
@typedoc """
## Example:
discovered_resource() :: %{
"ConfigurationId" => String.t(),
"Description" => String.t()
}
"""
@type discovered_resource() :: %{String.t() => any()}
@typedoc """
## Example:
internal_server_error() :: %{
"Message" => String.t()
}
"""
@type internal_server_error() :: %{String.t() => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"Message" => String.t()
}
"""
@type access_denied_exception() :: %{String.t() => any()}
@typedoc """
## Example:
describe_migration_task_request() :: %{
required("MigrationTaskName") => String.t(),
required("ProgressUpdateStream") => String.t()
}
"""
@type describe_migration_task_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_migration_tasks_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("ResourceName") => String.t()
}
"""
@type list_migration_tasks_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_migration_task_result() :: %{
"MigrationTask" => migration_task()
}
"""
@type describe_migration_task_result() :: %{String.t() => any()}
@typedoc """
## Example:
policy_error_exception() :: %{
"Message" => String.t()
}
"""
@type policy_error_exception() :: %{String.t() => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"Message" => String.t(),
"RetryAfterSeconds" => integer()
}
"""
@type throttling_exception() :: %{String.t() => any()}
@typedoc """
## Example:
create_progress_update_stream_result() :: %{}
"""
@type create_progress_update_stream_result() :: %{}
@typedoc """
## Example:
home_region_not_set_exception() :: %{
"Message" => String.t()
}
"""
@type home_region_not_set_exception() :: %{String.t() => any()}
@typedoc """
## Example:
associate_created_artifact_result() :: %{}
"""
@type associate_created_artifact_result() :: %{}
@typedoc """
## Example:
associate_discovered_resource_result() :: %{}
"""
@type associate_discovered_resource_result() :: %{}
@typedoc """
## Example:
notify_application_state_result() :: %{}
"""
@type notify_application_state_result() :: %{}
@typedoc """
## Example:
describe_application_state_request() :: %{
required("ApplicationId") => String.t()
}
"""
@type describe_application_state_request() :: %{String.t() => any()}
@typedoc """
## Example:
migration_task_summary() :: %{
"MigrationTaskName" => String.t(),
"ProgressPercent" => integer(),
"ProgressUpdateStream" => String.t(),
"Status" => list(any()),
"StatusDetail" => String.t(),
"UpdateDateTime" => non_neg_integer()
}
"""
@type migration_task_summary() :: %{String.t() => any()}
@typedoc """
## Example:
list_discovered_resources_result() :: %{
"DiscoveredResourceList" => list(discovered_resource()()),
"NextToken" => String.t()
}
"""
@type list_discovered_resources_result() :: %{String.t() => any()}
@typedoc """
## Example:
application_state() :: %{
"ApplicationId" => String.t(),
"ApplicationStatus" => list(any()),
"LastUpdatedTime" => non_neg_integer()
}
"""
@type application_state() :: %{String.t() => any()}
@typedoc """
## Example:
describe_application_state_result() :: %{
"ApplicationStatus" => list(any()),
"LastUpdatedTime" => non_neg_integer()
}
"""
@type describe_application_state_result() :: %{String.t() => any()}
@typedoc """
## Example:
migration_task() :: %{
"MigrationTaskName" => String.t(),
"ProgressUpdateStream" => String.t(),
"ResourceAttributeList" => list(resource_attribute()()),
"Task" => task(),
"UpdateDateTime" => non_neg_integer()
}
"""
@type migration_task() :: %{String.t() => any()}
@type associate_created_artifact_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
| dry_run_operation()
| unauthorized_operation()
@type associate_discovered_resource_errors() ::
home_region_not_set_exception()
| throttling_exception()
| policy_error_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
| dry_run_operation()
| unauthorized_operation()
@type create_progress_update_stream_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| dry_run_operation()
| unauthorized_operation()
@type delete_progress_update_stream_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
| dry_run_operation()
| unauthorized_operation()
@type describe_application_state_errors() ::
home_region_not_set_exception()
| throttling_exception()
| policy_error_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
@type describe_migration_task_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
@type disassociate_created_artifact_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
| dry_run_operation()
| unauthorized_operation()
@type disassociate_discovered_resource_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
| dry_run_operation()
| unauthorized_operation()
@type import_migration_task_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
| dry_run_operation()
| unauthorized_operation()
@type list_application_states_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
@type list_created_artifacts_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
@type list_discovered_resources_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
@type list_migration_tasks_errors() ::
home_region_not_set_exception()
| throttling_exception()
| policy_error_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
@type list_progress_update_streams_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
@type notify_application_state_errors() ::
home_region_not_set_exception()
| throttling_exception()
| policy_error_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
| dry_run_operation()
| unauthorized_operation()
@type notify_migration_task_state_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
| dry_run_operation()
| unauthorized_operation()
@type put_resource_attributes_errors() ::
home_region_not_set_exception()
| throttling_exception()
| access_denied_exception()
| internal_server_error()
| service_unavailable_exception()
| invalid_input_exception()
| resource_not_found_exception()
| dry_run_operation()
| unauthorized_operation()
def metadata do
%{
api_version: "2017-05-31",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "mgh",
global?: false,
protocol: "json",
service_id: "Migration Hub",
signature_version: "v4",
signing_name: "mgh",
target_prefix: "AWSMigrationHub"
}
end
@doc """
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:
*
Migration tools can call the `AssociateCreatedArtifact` operation to
indicate which AWS artifact is associated with a migration task.
*
The created artifact name must be provided in ARN (Amazon Resource Name) format
which will contain information about type and region; for example:
`arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b`.
*
Examples of the AWS resource behind the created artifact are, AMI's, EC2
instance,
or DMS endpoint, etc.
"""
@spec associate_created_artifact(map(), associate_created_artifact_request(), list()) ::
{:ok, associate_created_artifact_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, associate_created_artifact_errors()}
def associate_created_artifact(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AssociateCreatedArtifact", input, options)
end
@doc """
Associates a discovered resource ID from Application Discovery Service with a
migration
task.
"""
@spec associate_discovered_resource(map(), associate_discovered_resource_request(), list()) ::
{:ok, associate_discovered_resource_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, associate_discovered_resource_errors()}
def associate_discovered_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AssociateDiscoveredResource", input, options)
end
@doc """
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.
"""
@spec create_progress_update_stream(map(), create_progress_update_stream_request(), list()) ::
{:ok, create_progress_update_stream_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_progress_update_stream_errors()}
def create_progress_update_stream(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateProgressUpdateStream", input, options)
end
@doc """
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:
*
The only parameter needed for `DeleteProgressUpdateStream` is the
stream name (same as a `CreateProgressUpdateStream` call).
*
The call will return, and a background process will asynchronously delete the
stream and all of its resources (tasks, associated resources, resource
attributes,
created artifacts).
*
If the stream takes time to be deleted, it might still show up on a
`ListProgressUpdateStreams` call.
*
`CreateProgressUpdateStream`, `ImportMigrationTask`,
`NotifyMigrationTaskState`, and all Associate[*] APIs related to the
tasks belonging to the stream will throw "InvalidInputException" if the stream
of the
same name is in the process of being deleted.
*
Once the stream and all of its resources are deleted,
`CreateProgressUpdateStream` for a stream of the same name will
succeed, and that stream will be an entirely new logical resource (without any
resources associated with the old stream).
"""
@spec delete_progress_update_stream(map(), delete_progress_update_stream_request(), list()) ::
{:ok, delete_progress_update_stream_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_progress_update_stream_errors()}
def delete_progress_update_stream(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteProgressUpdateStream", input, options)
end
@doc """
Gets the migration status of an application.
"""
@spec describe_application_state(map(), describe_application_state_request(), list()) ::
{:ok, describe_application_state_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_application_state_errors()}
def describe_application_state(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeApplicationState", input, options)
end
@doc """
Retrieves a list of all attributes associated with a specific migration task.
"""
@spec describe_migration_task(map(), describe_migration_task_request(), list()) ::
{:ok, describe_migration_task_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_migration_task_errors()}
def describe_migration_task(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeMigrationTask", input, options)
end
@doc """
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:
*
A migration user can call the `DisassociateCreatedArtifacts` operation
to disassociate a created AWS Artifact from a migration task.
*
The created artifact name must be provided in ARN (Amazon Resource Name) format
which will contain information about type and region; for example:
`arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b`.
*
Examples of the AWS resource behind the created artifact are, AMI's, EC2
instance,
or RDS instance, etc.
"""
@spec disassociate_created_artifact(map(), disassociate_created_artifact_request(), list()) ::
{:ok, disassociate_created_artifact_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, disassociate_created_artifact_errors()}
def disassociate_created_artifact(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DisassociateCreatedArtifact", input, options)
end
@doc """
Disassociate an Application Discovery Service discovered resource from a
migration
task.
"""
@spec disassociate_discovered_resource(
map(),
disassociate_discovered_resource_request(),
list()
) ::
{:ok, disassociate_discovered_resource_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, disassociate_discovered_resource_errors()}
def disassociate_discovered_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DisassociateDiscoveredResource", input, options)
end
@doc """
Registers a new migration task which represents a server, database, etc., being
migrated
to AWS by a migration tool.
This API is a prerequisite to calling the `NotifyMigrationTaskState` API as
the migration tool must first register the migration task with Migration Hub.
"""
@spec import_migration_task(map(), import_migration_task_request(), list()) ::
{:ok, import_migration_task_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, import_migration_task_errors()}
def import_migration_task(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ImportMigrationTask", input, options)
end
@doc """
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.
"""
@spec list_application_states(map(), list_application_states_request(), list()) ::
{:ok, list_application_states_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_application_states_errors()}
def list_application_states(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListApplicationStates", input, options)
end
@doc """
Lists the created artifacts attached to a given migration task in an update
stream.
This
API has the following traits:
*
Gets the list of the created artifacts while
migration is taking place.
*
Shows the artifacts created by the migration tool that was associated by the
`AssociateCreatedArtifact` API.
*
Lists created artifacts in a paginated interface.
"""
@spec list_created_artifacts(map(), list_created_artifacts_request(), list()) ::
{:ok, list_created_artifacts_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_created_artifacts_errors()}
def list_created_artifacts(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListCreatedArtifacts", input, options)
end
@doc """
Lists discovered resources associated with the given `MigrationTask`.
"""
@spec list_discovered_resources(map(), list_discovered_resources_request(), list()) ::
{:ok, list_discovered_resources_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_discovered_resources_errors()}
def list_discovered_resources(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListDiscoveredResources", input, options)
end
@doc """
Lists all, or filtered by resource name, migration tasks associated with the
user
account making this call.
This API has the following traits:
*
Can show a summary list of the most recent migration tasks.
*
Can show a summary list of migration tasks associated with a given discovered
resource.
*
Lists migration tasks in a paginated interface.
"""
@spec list_migration_tasks(map(), list_migration_tasks_request(), list()) ::
{:ok, list_migration_tasks_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_migration_tasks_errors()}
def list_migration_tasks(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListMigrationTasks", input, options)
end
@doc """
Lists progress update streams associated with the user account making this call.
"""
@spec list_progress_update_streams(map(), list_progress_update_streams_request(), list()) ::
{:ok, list_progress_update_streams_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_progress_update_streams_errors()}
def list_progress_update_streams(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListProgressUpdateStreams", input, options)
end
@doc """
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
```
.
"""
@spec notify_application_state(map(), notify_application_state_request(), list()) ::
{:ok, notify_application_state_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, notify_application_state_errors()}
def notify_application_state(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "NotifyApplicationState", input, options)
end
@doc """
Notifies Migration Hub of the current status, progress, or other detail
regarding a
migration task.
This API has the following traits:
*
Migration tools will call the `NotifyMigrationTaskState` API to share
the latest progress and status.
*
`MigrationTaskName` is used for addressing updates to the correct
target.
*
`ProgressUpdateStream` is used for access control and to provide a
namespace for each migration tool.
"""
@spec notify_migration_task_state(map(), notify_migration_task_state_request(), list()) ::
{:ok, notify_migration_task_state_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, notify_migration_task_state_errors()}
def notify_migration_task_state(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "NotifyMigrationTaskState", input, options)
end
@doc """
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.
Keep in mind that subsequent calls to PutResourceAttributes will override
previously stored attributes. For example, if it is first called with a MAC
address, but later, it is desired to *add* an IP address, it
will then be required to call it with *both* the IP and MAC
addresses to prevent overriding the MAC address.
Note the instructions regarding the special use case of the [
`ResourceAttributeList`
](https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#migrationhub-PutResourceAttributes-request-ResourceAttributeList)
parameter when specifying any
"VM" related value.
Because this is an asynchronous call, it will always return 200, whether an
association occurs or not. To confirm if an association was found based on the
provided
details, call `ListDiscoveredResources`.
"""
@spec put_resource_attributes(map(), put_resource_attributes_request(), list()) ::
{:ok, put_resource_attributes_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_resource_attributes_errors()}
def put_resource_attributes(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutResourceAttributes", input, options)
end
end