GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::SMS(3) User Contributed Perl Documentation Paws::SMS(3)

Paws::SMS - Perl Interface to AWS AWS Server Migration Service

  use Paws;
  my $obj = Paws->service('SMS');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

AWS Server Migration Service

AWS Server Migration Service (AWS SMS) makes it easier and faster for you to migrate your on-premises workloads to AWS. To learn more about AWS SMS, see the following resources:

  • AWS Server Migration Service product page (http://aws.amazon.com/server-migration-service/)
  • AWS Server Migration Service User Guide (https://docs.aws.amazon.com/server-migration-service/latest/userguide/)

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24>

[ClientToken => Str]
[Description => Str]
[Name => Str]
[RoleName => Str]
[ServerGroups => ArrayRef[Paws::SMS::ServerGroup]]
[Tags => ArrayRef[Paws::SMS::Tag]]

Each argument is described in detail in: Paws::SMS::CreateApp

Returns: a Paws::SMS::CreateAppResponse instance

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

[Description => Str]
[Encrypted => Bool]
[Frequency => Int]
[KmsKeyId => Str]
[LicenseType => Str]
[NumberOfRecentAmisToKeep => Int]
[RoleName => Str]
[RunOnce => Bool]

Each argument is described in detail in: Paws::SMS::CreateReplicationJob

Returns: a Paws::SMS::CreateReplicationJobResponse instance

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).

[AppId => Str]
[ForceStopAppReplication => Bool]
[ForceTerminateApp => Bool]

Each argument is described in detail in: Paws::SMS::DeleteApp

Returns: a Paws::SMS::DeleteAppResponse instance

Deletes the specified application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

[AppId => Str]

Each argument is described in detail in: Paws::SMS::DeleteAppLaunchConfiguration

Returns: a Paws::SMS::DeleteAppLaunchConfigurationResponse instance

Deletes the launch configuration for the specified application.

[AppId => Str]

Each argument is described in detail in: Paws::SMS::DeleteAppReplicationConfiguration

Returns: a Paws::SMS::DeleteAppReplicationConfigurationResponse instance

Deletes the replication configuration for the specified application.

Each argument is described in detail in: Paws::SMS::DeleteAppValidationConfiguration

Returns: a Paws::SMS::DeleteAppValidationConfigurationResponse instance

Deletes the validation configuration for the specified application.

Each argument is described in detail in: Paws::SMS::DeleteReplicationJob

Returns: a Paws::SMS::DeleteReplicationJobResponse instance

Deletes the specified replication job.

After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.

Each argument is described in detail in: Paws::SMS::DeleteServerCatalog

Returns: a Paws::SMS::DeleteServerCatalogResponse instance

Deletes all servers from your server catalog.

Each argument is described in detail in: Paws::SMS::DisassociateConnector

Returns: a Paws::SMS::DisassociateConnectorResponse instance

Disassociates the specified connector from AWS SMS.

After you disassociate a connector, it is no longer available to support replication jobs.

[AppId => Str]
[ChangesetFormat => Str]

Each argument is described in detail in: Paws::SMS::GenerateChangeSet

Returns: a Paws::SMS::GenerateChangeSetResponse instance

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

[AppId => Str]
[TemplateFormat => Str]

Each argument is described in detail in: Paws::SMS::GenerateTemplate

Returns: a Paws::SMS::GenerateTemplateResponse instance

Generates an AWS CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

[AppId => Str]

Each argument is described in detail in: Paws::SMS::GetApp

Returns: a Paws::SMS::GetAppResponse instance

Retrieve information about the specified application.

[AppId => Str]

Each argument is described in detail in: Paws::SMS::GetAppLaunchConfiguration

Returns: a Paws::SMS::GetAppLaunchConfigurationResponse instance

Retrieves the application launch configuration associated with the specified application.

[AppId => Str]

Each argument is described in detail in: Paws::SMS::GetAppReplicationConfiguration

Returns: a Paws::SMS::GetAppReplicationConfigurationResponse instance

Retrieves the application replication configuration associated with the specified application.

Each argument is described in detail in: Paws::SMS::GetAppValidationConfiguration

Returns: a Paws::SMS::GetAppValidationConfigurationResponse instance

Retrieves information about a configuration for validating an application.

Each argument is described in detail in: Paws::SMS::GetAppValidationOutput

Returns: a Paws::SMS::GetAppValidationOutputResponse instance

Retrieves output from validating an application.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SMS::GetConnectors

Returns: a Paws::SMS::GetConnectorsResponse instance

Describes the connectors registered with the AWS SMS.

[MaxResults => Int]
[NextToken => Str]
[ReplicationJobId => Str]

Each argument is described in detail in: Paws::SMS::GetReplicationJobs

Returns: a Paws::SMS::GetReplicationJobsResponse instance

Describes the specified replication job or all of your replication jobs.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SMS::GetReplicationRuns

Returns: a Paws::SMS::GetReplicationRunsResponse instance

Describes the replication runs for the specified replication job.

[MaxResults => Int]
[NextToken => Str]
[VmServerAddressList => ArrayRef[Paws::SMS::VmServerAddress]]

Each argument is described in detail in: Paws::SMS::GetServers

Returns: a Paws::SMS::GetServersResponse instance

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

[RoleName => Str]

Each argument is described in detail in: Paws::SMS::ImportAppCatalog

Returns: a Paws::SMS::ImportAppCatalogResponse instance

Allows application import from AWS Migration Hub.

Each argument is described in detail in: Paws::SMS::ImportServerCatalog

Returns: a Paws::SMS::ImportServerCatalogResponse instance

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.

This call returns immediately, but might take additional time to retrieve all the servers.

[AppId => Str]

Each argument is described in detail in: Paws::SMS::LaunchApp

Returns: a Paws::SMS::LaunchAppResponse instance

Launches the specified application as a stack in AWS CloudFormation.

[AppIds => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SMS::ListApps

Returns: a Paws::SMS::ListAppsResponse instance

Retrieves summaries for all applications.

[NotificationContext => Paws::SMS::NotificationContext]

Each argument is described in detail in: Paws::SMS::NotifyAppValidationOutput

Returns: a Paws::SMS::NotifyAppValidationOutputResponse instance

Provides information to AWS SMS about whether application validation is successful.

[AppId => Str]
[AutoLaunch => Bool]
[RoleName => Str]
[ServerGroupLaunchConfigurations => ArrayRef[Paws::SMS::ServerGroupLaunchConfiguration]]

Each argument is described in detail in: Paws::SMS::PutAppLaunchConfiguration

Returns: a Paws::SMS::PutAppLaunchConfigurationResponse instance

Creates or updates the launch configuration for the specified application.

[AppId => Str]
[ServerGroupReplicationConfigurations => ArrayRef[Paws::SMS::ServerGroupReplicationConfiguration]]

Each argument is described in detail in: Paws::SMS::PutAppReplicationConfiguration

Returns: a Paws::SMS::PutAppReplicationConfigurationResponse instance

Creates or updates the replication configuration for the specified application.

[AppValidationConfigurations => ArrayRef[Paws::SMS::AppValidationConfiguration]]
[ServerGroupValidationConfigurations => ArrayRef[Paws::SMS::ServerGroupValidationConfiguration]]

Each argument is described in detail in: Paws::SMS::PutAppValidationConfiguration

Returns: a Paws::SMS::PutAppValidationConfigurationResponse instance

Creates or updates a validation configuration for the specified application.

[AppId => Str]

Each argument is described in detail in: Paws::SMS::StartAppReplication

Returns: a Paws::SMS::StartAppReplicationResponse instance

Starts replicating the specified application by creating replication jobs for each server in the application.

[Description => Str]

Each argument is described in detail in: Paws::SMS::StartOnDemandAppReplication

Returns: a Paws::SMS::StartOnDemandAppReplicationResponse instance

Starts an on-demand replication run for the specified application.

[Description => Str]

Each argument is described in detail in: Paws::SMS::StartOnDemandReplicationRun

Returns: a Paws::SMS::StartOnDemandReplicationRunResponse instance

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.

[AppId => Str]

Each argument is described in detail in: Paws::SMS::StopAppReplication

Returns: a Paws::SMS::StopAppReplicationResponse instance

Stops replicating the specified application by deleting the replication job for each server in the application.

[AppId => Str]

Each argument is described in detail in: Paws::SMS::TerminateApp

Returns: a Paws::SMS::TerminateAppResponse instance

Terminates the stack for the specified application.

[AppId => Str]
[Description => Str]
[Name => Str]
[RoleName => Str]
[ServerGroups => ArrayRef[Paws::SMS::ServerGroup]]
[Tags => ArrayRef[Paws::SMS::Tag]]

Each argument is described in detail in: Paws::SMS::UpdateApp

Returns: a Paws::SMS::UpdateAppResponse instance

Updates the specified application.

[Description => Str]
[Encrypted => Bool]
[Frequency => Int]
[KmsKeyId => Str]
[LicenseType => Str]
[NextReplicationRunStartTime => Str]
[NumberOfRecentAmisToKeep => Int]
[RoleName => Str]

Each argument is described in detail in: Paws::SMS::UpdateReplicationJob

Returns: a Paws::SMS::UpdateReplicationJobResponse instance

Updates the specified settings for the specified replication job.

Paginator methods are helpers that repetively call methods that return partial results

If passed a sub as first parameter, it will call the sub for each element found in :

 - connectorList, passing the object as the first parameter, and the string 'connectorList' as the second parameter

If not, it will return a a Paws::SMS::GetConnectorsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - replicationJobList, passing the object as the first parameter, and the string 'replicationJobList' as the second parameter

If not, it will return a a Paws::SMS::GetReplicationJobsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - replicationRunList, passing the object as the first parameter, and the string 'replicationRunList' as the second parameter

If not, it will return a a Paws::SMS::GetReplicationRunsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - serverList, passing the object as the first parameter, and the string 'serverList' as the second parameter

If not, it will return a a Paws::SMS::GetServersResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - apps, passing the object as the first parameter, and the string 'apps' as the second parameter

If not, it will return a a Paws::SMS::ListAppsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

This service class forms part of Paws

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.