amazonka-migrationhub-2.0: Amazon Migration Hub SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MigrationHub.Lens

Description

 
Synopsis

Operations

AssociateCreatedArtifact

associateCreatedArtifact_dryRun :: Lens' AssociateCreatedArtifact (Maybe Bool) Source #

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

associateCreatedArtifact_migrationTaskName :: Lens' AssociateCreatedArtifact Text Source #

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

associateCreatedArtifact_createdArtifact :: Lens' AssociateCreatedArtifact CreatedArtifact Source #

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

AssociateDiscoveredResource

associateDiscoveredResource_dryRun :: Lens' AssociateDiscoveredResource (Maybe Bool) Source #

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

associateDiscoveredResource_migrationTaskName :: Lens' AssociateDiscoveredResource Text Source #

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

CreateProgressUpdateStream

createProgressUpdateStream_dryRun :: Lens' CreateProgressUpdateStream (Maybe Bool) Source #

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

createProgressUpdateStream_progressUpdateStreamName :: Lens' CreateProgressUpdateStream Text Source #

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

DeleteProgressUpdateStream

deleteProgressUpdateStream_dryRun :: Lens' DeleteProgressUpdateStream (Maybe Bool) Source #

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

deleteProgressUpdateStream_progressUpdateStreamName :: Lens' DeleteProgressUpdateStream Text Source #

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

DescribeApplicationState

describeApplicationState_applicationId :: Lens' DescribeApplicationState Text Source #

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

describeApplicationStateResponse_lastUpdatedTime :: Lens' DescribeApplicationStateResponse (Maybe UTCTime) Source #

The timestamp when the application status was last updated.

DescribeMigrationTask

describeMigrationTask_migrationTaskName :: Lens' DescribeMigrationTask Text Source #

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

describeMigrationTaskResponse_migrationTask :: Lens' DescribeMigrationTaskResponse (Maybe MigrationTask) Source #

Object encapsulating information about the migration task.

DisassociateCreatedArtifact

disassociateCreatedArtifact_dryRun :: Lens' DisassociateCreatedArtifact (Maybe Bool) Source #

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

disassociateCreatedArtifact_migrationTaskName :: Lens' DisassociateCreatedArtifact Text Source #

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

disassociateCreatedArtifact_createdArtifactName :: Lens' DisassociateCreatedArtifact Text Source #

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

DisassociateDiscoveredResource

disassociateDiscoveredResource_dryRun :: Lens' DisassociateDiscoveredResource (Maybe Bool) Source #

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

disassociateDiscoveredResource_migrationTaskName :: Lens' DisassociateDiscoveredResource Text Source #

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

disassociateDiscoveredResource_configurationId :: Lens' DisassociateDiscoveredResource Text Source #

ConfigurationId of the Application Discovery Service resource to be disassociated.

ImportMigrationTask

importMigrationTask_dryRun :: Lens' ImportMigrationTask (Maybe Bool) Source #

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

importMigrationTask_migrationTaskName :: Lens' ImportMigrationTask Text Source #

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

ListApplicationStates

listApplicationStates_applicationIds :: Lens' ListApplicationStates (Maybe (NonEmpty Text)) Source #

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

listApplicationStates_maxResults :: Lens' ListApplicationStates (Maybe Natural) Source #

Maximum number of results to be returned per page.

listApplicationStates_nextToken :: Lens' ListApplicationStates (Maybe Text) Source #

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.

listApplicationStatesResponse_applicationStateList :: Lens' ListApplicationStatesResponse (Maybe [ApplicationState]) Source #

A list of Applications that exist in Application Discovery Service.

listApplicationStatesResponse_nextToken :: Lens' ListApplicationStatesResponse (Maybe Text) Source #

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.

ListCreatedArtifacts

listCreatedArtifacts_maxResults :: Lens' ListCreatedArtifacts (Maybe Natural) Source #

Maximum number of results to be returned per page.

listCreatedArtifacts_nextToken :: Lens' ListCreatedArtifacts (Maybe Text) Source #

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.

listCreatedArtifacts_migrationTaskName :: Lens' ListCreatedArtifacts Text Source #

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

listCreatedArtifactsResponse_createdArtifactList :: Lens' ListCreatedArtifactsResponse (Maybe [CreatedArtifact]) Source #

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

listCreatedArtifactsResponse_nextToken :: Lens' ListCreatedArtifactsResponse (Maybe Text) Source #

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.

ListDiscoveredResources

listDiscoveredResources_maxResults :: Lens' ListDiscoveredResources (Maybe Natural) Source #

The maximum number of results returned per page.

listDiscoveredResources_nextToken :: Lens' ListDiscoveredResources (Maybe Text) Source #

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.

listDiscoveredResources_migrationTaskName :: Lens' ListDiscoveredResources Text Source #

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

listDiscoveredResourcesResponse_discoveredResourceList :: Lens' ListDiscoveredResourcesResponse (Maybe [DiscoveredResource]) Source #

Returned list of discovered resources associated with the given MigrationTask.

listDiscoveredResourcesResponse_nextToken :: Lens' ListDiscoveredResourcesResponse (Maybe Text) Source #

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.

ListMigrationTasks

listMigrationTasks_maxResults :: Lens' ListMigrationTasks (Maybe Natural) Source #

Value to specify how many results are returned per page.

listMigrationTasks_nextToken :: Lens' ListMigrationTasks (Maybe Text) Source #

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.

listMigrationTasks_resourceName :: Lens' ListMigrationTasks (Maybe Text) Source #

Filter migration tasks by discovered resource name.

listMigrationTasksResponse_migrationTaskSummaryList :: Lens' ListMigrationTasksResponse (Maybe [MigrationTaskSummary]) Source #

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

listMigrationTasksResponse_nextToken :: Lens' ListMigrationTasksResponse (Maybe Text) Source #

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.

ListProgressUpdateStreams

listProgressUpdateStreams_maxResults :: Lens' ListProgressUpdateStreams (Maybe Natural) Source #

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

listProgressUpdateStreams_nextToken :: Lens' ListProgressUpdateStreams (Maybe Text) Source #

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.

listProgressUpdateStreamsResponse_nextToken :: Lens' ListProgressUpdateStreamsResponse (Maybe Text) Source #

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.

listProgressUpdateStreamsResponse_progressUpdateStreamSummaryList :: Lens' ListProgressUpdateStreamsResponse (Maybe [ProgressUpdateStreamSummary]) Source #

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

NotifyApplicationState

notifyApplicationState_dryRun :: Lens' NotifyApplicationState (Maybe Bool) Source #

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

notifyApplicationState_updateDateTime :: Lens' NotifyApplicationState (Maybe UTCTime) Source #

The timestamp when the application state changed.

notifyApplicationState_applicationId :: Lens' NotifyApplicationState Text Source #

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

notifyApplicationState_status :: Lens' NotifyApplicationState ApplicationStatus Source #

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

NotifyMigrationTaskState

notifyMigrationTaskState_dryRun :: Lens' NotifyMigrationTaskState (Maybe Bool) Source #

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

notifyMigrationTaskState_migrationTaskName :: Lens' NotifyMigrationTaskState Text Source #

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

notifyMigrationTaskState_task :: Lens' NotifyMigrationTaskState Task Source #

Information about the task's progress and status.

notifyMigrationTaskState_nextUpdateSeconds :: Lens' NotifyMigrationTaskState Natural Source #

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.

PutResourceAttributes

putResourceAttributes_dryRun :: Lens' PutResourceAttributes (Maybe Bool) Source #

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

putResourceAttributes_migrationTaskName :: Lens' PutResourceAttributes Text Source #

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

putResourceAttributes_resourceAttributeList :: Lens' PutResourceAttributes (NonEmpty ResourceAttribute) Source #

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.

Types

ApplicationState

applicationState_applicationId :: Lens' ApplicationState (Maybe Text) Source #

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

applicationState_lastUpdatedTime :: Lens' ApplicationState (Maybe UTCTime) Source #

The timestamp when the application status was last updated.

CreatedArtifact

createdArtifact_description :: Lens' CreatedArtifact (Maybe Text) Source #

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

createdArtifact_name :: Lens' CreatedArtifact Text Source #

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

DiscoveredResource

discoveredResource_description :: Lens' DiscoveredResource (Maybe Text) Source #

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

discoveredResource_configurationId :: Lens' DiscoveredResource Text Source #

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

MigrationTask

migrationTask_migrationTaskName :: Lens' MigrationTask (Maybe Text) Source #

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

migrationTask_progressUpdateStream :: Lens' MigrationTask (Maybe Text) Source #

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

migrationTask_resourceAttributeList :: Lens' MigrationTask (Maybe [ResourceAttribute]) Source #

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.

migrationTask_task :: Lens' MigrationTask (Maybe Task) Source #

Task object encapsulating task information.

migrationTask_updateDateTime :: Lens' MigrationTask (Maybe UTCTime) Source #

The timestamp when the task was gathered.

MigrationTaskSummary

migrationTaskSummary_migrationTaskName :: Lens' MigrationTaskSummary (Maybe Text) Source #

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

migrationTaskSummary_progressPercent :: Lens' MigrationTaskSummary (Maybe Natural) Source #

Indication of the percentage completion of the task.

migrationTaskSummary_progressUpdateStream :: Lens' MigrationTaskSummary (Maybe Text) Source #

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_statusDetail :: Lens' MigrationTaskSummary (Maybe Text) Source #

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

ProgressUpdateStreamSummary

progressUpdateStreamSummary_progressUpdateStreamName :: Lens' ProgressUpdateStreamSummary (Maybe Text) Source #

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

ResourceAttribute

Task

task_progressPercent :: Lens' Task (Maybe Natural) Source #

Indication of the percentage completion of the task.

task_statusDetail :: Lens' Task (Maybe Text) Source #

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.

task_status :: Lens' Task MigrationStatus Source #

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