NAME

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

SYNOPSIS

  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' } ],
  );

DESCRIPTION

AAWS Sever Migration Service

This is the AWS Sever Migration Service API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for the AWS Sever Migration Service (AWS SMS). The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.

Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs (http://aws.amazon.com/tools/#SDKs).

To learn more about the Server Migration Service, see the following resources:

  • AWS Sever Migration Service product page (https://aws.amazon.com/server-migration-service/)

  • AWS Sever Migration Service User Guide (https://docs.aws.amazon.com/server-migration-service/latest/userguide/server-migration.html)

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

METHODS

CreateApp

[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.

CreateReplicationJob

SeedReplicationTime => Str
ServerId => Str
[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).

DeleteApp

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

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

Returns: a Paws::SMS::DeleteAppResponse instance

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

DeleteAppLaunchConfiguration

[AppId => Str]

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

Returns: a Paws::SMS::DeleteAppLaunchConfigurationResponse instance

Deletes existing launch configuration for an application.

DeleteAppReplicationConfiguration

[AppId => Str]

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

Returns: a Paws::SMS::DeleteAppReplicationConfigurationResponse instance

Deletes existing replication configuration for an application.

DeleteReplicationJob

ReplicationJobId => Str

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.

DeleteServerCatalog

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

Returns: a Paws::SMS::DeleteServerCatalogResponse instance

Deletes all servers from your server catalog.

DisassociateConnector

ConnectorId => Str

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.

GenerateChangeSet

[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.

GenerateTemplate

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

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

Returns: a Paws::SMS::GenerateTemplateResponse instance

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

GetApp

[AppId => Str]

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

Returns: a Paws::SMS::GetAppResponse instance

Retrieve information about an application.

GetAppLaunchConfiguration

[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 an application.

GetAppReplicationConfiguration

[AppId => Str]

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

Returns: a Paws::SMS::GetAppReplicationConfigurationResponse instance

Retrieves an application replication configuration associatd with an application.

GetConnectors

[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.

GetReplicationJobs

[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.

GetReplicationRuns

ReplicationJobId => Str
[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.

GetServers

[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.

ImportServerCatalog

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 that you want to import.

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

LaunchApp

[AppId => Str]

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

Returns: a Paws::SMS::LaunchAppResponse instance

Launches an application stack.

ListApps

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

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

Returns: a Paws::SMS::ListAppsResponse instance

Returns a list of summaries for all applications.

PutAppLaunchConfiguration

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

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

Returns: a Paws::SMS::PutAppLaunchConfigurationResponse instance

Creates a launch configuration for an application.

PutAppReplicationConfiguration

[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 a replication configuration for an application.

StartAppReplication

[AppId => Str]

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

Returns: a Paws::SMS::StartAppReplicationResponse instance

Starts replicating an application.

StartOnDemandReplicationRun

ReplicationJobId => Str
[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 you can request in a 24-hour period.

StopAppReplication

[AppId => Str]

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

Returns: a Paws::SMS::StopAppReplicationResponse instance

Stops replicating an application.

TerminateApp

[AppId => Str]

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

Returns: a Paws::SMS::TerminateAppResponse instance

Terminates the stack for an application.

UpdateApp

[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 an application.

UpdateReplicationJob

ReplicationJobId => Str
[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.

PAGINATORS

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

GetAllConnectors(sub { },[MaxResults => Int, NextToken => Str])

GetAllConnectors([MaxResults => Int, NextToken => Str])

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 params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllReplicationJobs(sub { },[MaxResults => Int, NextToken => Str, ReplicationJobId => Str])

GetAllReplicationJobs([MaxResults => Int, NextToken => Str, ReplicationJobId => Str])

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 params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllReplicationRuns(sub { },ReplicationJobId => Str, [MaxResults => Int, NextToken => Str])

GetAllReplicationRuns(ReplicationJobId => Str, [MaxResults => Int, NextToken => Str])

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 params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllServers(sub { },[MaxResults => Int, NextToken => Str, VmServerAddressList => ArrayRef[Paws::SMS::VmServerAddress]])

GetAllServers([MaxResults => Int, NextToken => Str, VmServerAddressList => ArrayRef[Paws::SMS::VmServerAddress]])

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 params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllApps(sub { },[AppIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

ListAllApps([AppIds => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

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 params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

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