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
Amazon Server Migration Service automates the process of migrating servers to EC2.
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24
METHODS
CreateReplicationJob
- Frequency => Int
- SeedReplicationTime => Str
- ServerId => Str
- [Description => Str]
- [LicenseType => Str]
- [RoleName => Str]
Each argument is described in detail in: Paws::SMS::CreateReplicationJob
Returns: a Paws::SMS::CreateReplicationJobResponse instance
The CreateReplicationJob API is used to create a ReplicationJob to replicate a server on AWS. Call this API to first create a ReplicationJob, which will then schedule periodic ReplicationRuns to replicate your server to AWS. Each ReplicationRun will result in the creation of an AWS AMI.
DeleteReplicationJob
Each argument is described in detail in: Paws::SMS::DeleteReplicationJob
Returns: a Paws::SMS::DeleteReplicationJobResponse instance
The DeleteReplicationJob API is used to delete a ReplicationJob, resulting in no further ReplicationRuns. This will delete the contents of the S3 bucket used to store SMS artifacts, but will not delete any AMIs created by the SMS service.
DeleteServerCatalog
Each argument is described in detail in: Paws::SMS::DeleteServerCatalog
Returns: a Paws::SMS::DeleteServerCatalogResponse instance
The DeleteServerCatalog API clears all servers from your server catalog. This means that these servers will no longer be accessible to the Server Migration Service.
DisassociateConnector
Each argument is described in detail in: Paws::SMS::DisassociateConnector
Returns: a Paws::SMS::DisassociateConnectorResponse instance
The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable to support replication jobs.
GetConnectors
Each argument is described in detail in: Paws::SMS::GetConnectors
Returns: a Paws::SMS::GetConnectorsResponse instance
The GetConnectors API returns a list of connectors that are registered with the Server Migration Service.
GetReplicationJobs
Each argument is described in detail in: Paws::SMS::GetReplicationJobs
Returns: a Paws::SMS::GetReplicationJobsResponse instance
The GetReplicationJobs API will return all of your ReplicationJobs and their details. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationJobs.
GetReplicationRuns
Each argument is described in detail in: Paws::SMS::GetReplicationRuns
Returns: a Paws::SMS::GetReplicationRunsResponse instance
The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationRuns for a ReplicationJob.
GetServers
Each argument is described in detail in: Paws::SMS::GetServers
Returns: a Paws::SMS::GetServersResponse instance
The GetServers API returns a list of all servers in your server catalog. For this call to succeed, you must previously have called ImportServerCatalog.
ImportServerCatalog
Each argument is described in detail in: Paws::SMS::ImportServerCatalog
Returns: a Paws::SMS::ImportServerCatalogResponse instance
The ImportServerCatalog API is used to gather the complete list of on-premises servers on your premises. This API call requires connectors to be installed and monitoring all servers you would like imported. This API call returns immediately, but may take some time to retrieve all of the servers.
StartOnDemandReplicationRun
Each argument is described in detail in: Paws::SMS::StartOnDemandReplicationRun
Returns: a Paws::SMS::StartOnDemandReplicationRunResponse instance
The StartOnDemandReplicationRun API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency). This ReplicationRun will start immediately. StartOnDemandReplicationRun is subject to limits on how many on demand ReplicationRuns you may call per 24-hour period.
UpdateReplicationJob
- ReplicationJobId => Str
- [Description => Str]
- [Frequency => Int]
- [LicenseType => Str]
- [NextReplicationRunStartTime => Str]
- [RoleName => Str]
Each argument is described in detail in: Paws::SMS::UpdateReplicationJob
Returns: a Paws::SMS::UpdateReplicationJobResponse instance
The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob. Calling this API will affect the next scheduled ReplicationRun.
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])
GetAllServers([MaxResults => Int, NextToken => Str])
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.
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