NAME

Paws::DMS - Perl Interface to AWS AWS Database Migration Service

SYNOPSIS

  use Paws;

  my $obj = Paws->service('DMS');
  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

AWS Database Migration Service

AWS Database Migration Service (AWS DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.

For more information about AWS DMS, see What Is AWS Database Migration Service? (http://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) in the AWS Database Migration User Guide.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01

METHODS

AddTagsToResource

ResourceArn => Str
Tags => ArrayRef[Paws::DMS::Tag]

Each argument is described in detail in: Paws::DMS::AddTagsToResource

Returns: a Paws::DMS::AddTagsToResourceResponse instance

Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.

CreateEndpoint

EndpointIdentifier => Str
EndpointType => Str
EngineName => Str
[CertificateArn => Str]
[DatabaseName => Str]
[DmsTransferSettings => Paws::DMS::DmsTransferSettings]
[DynamoDbSettings => Paws::DMS::DynamoDbSettings]
[ElasticsearchSettings => Paws::DMS::ElasticsearchSettings]
[ExternalTableDefinition => Str]
[ExtraConnectionAttributes => Str]
[KinesisSettings => Paws::DMS::KinesisSettings]
[KmsKeyId => Str]
[MongoDbSettings => Paws::DMS::MongoDbSettings]
[Password => Str]
[Port => Int]
[S3Settings => Paws::DMS::S3Settings]
[ServerName => Str]
[ServiceAccessRoleArn => Str]
[SslMode => Str]
[Tags => ArrayRef[Paws::DMS::Tag]]
[Username => Str]

Each argument is described in detail in: Paws::DMS::CreateEndpoint

Returns: a Paws::DMS::CreateEndpointResponse instance

Creates an endpoint using the provided settings.

CreateEventSubscription

SnsTopicArn => Str
SubscriptionName => Str
[Enabled => Bool]
[EventCategories => ArrayRef[Str|Undef]]
[SourceIds => ArrayRef[Str|Undef]]
[SourceType => Str]
[Tags => ArrayRef[Paws::DMS::Tag]]

Each argument is described in detail in: Paws::DMS::CreateEventSubscription

Returns: a Paws::DMS::CreateEventSubscriptionResponse instance

Creates an AWS DMS event notification subscription.

You can specify the type of source (SourceType) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all AWS DMS sources belonging to your customer account.

For more information about AWS DMS events, see Working with Events and Notifications (http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the AWS Database Migration Service User Guide.

CreateReplicationInstance

ReplicationInstanceClass => Str
ReplicationInstanceIdentifier => Str
[AllocatedStorage => Int]
[AutoMinorVersionUpgrade => Bool]
[AvailabilityZone => Str]
[DnsNameServers => Str]
[EngineVersion => Str]
[KmsKeyId => Str]
[MultiAZ => Bool]
[PreferredMaintenanceWindow => Str]
[PubliclyAccessible => Bool]
[ReplicationSubnetGroupIdentifier => Str]
[Tags => ArrayRef[Paws::DMS::Tag]]
[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DMS::CreateReplicationInstance

Returns: a Paws::DMS::CreateReplicationInstanceResponse instance

Creates the replication instance using the specified parameters.

CreateReplicationSubnetGroup

ReplicationSubnetGroupDescription => Str
ReplicationSubnetGroupIdentifier => Str
SubnetIds => ArrayRef[Str|Undef]
[Tags => ArrayRef[Paws::DMS::Tag]]

Each argument is described in detail in: Paws::DMS::CreateReplicationSubnetGroup

Returns: a Paws::DMS::CreateReplicationSubnetGroupResponse instance

Creates a replication subnet group given a list of the subnet IDs in a VPC.

CreateReplicationTask

MigrationType => Str
ReplicationInstanceArn => Str
ReplicationTaskIdentifier => Str
SourceEndpointArn => Str
TableMappings => Str
TargetEndpointArn => Str
[CdcStartPosition => Str]
[CdcStartTime => Str]
[CdcStopPosition => Str]
[ReplicationTaskSettings => Str]
[Tags => ArrayRef[Paws::DMS::Tag]]

Each argument is described in detail in: Paws::DMS::CreateReplicationTask

Returns: a Paws::DMS::CreateReplicationTaskResponse instance

Creates a replication task using the specified parameters.

DeleteCertificate

CertificateArn => Str

Each argument is described in detail in: Paws::DMS::DeleteCertificate

Returns: a Paws::DMS::DeleteCertificateResponse instance

Deletes the specified certificate.

DeleteEndpoint

EndpointArn => Str

Each argument is described in detail in: Paws::DMS::DeleteEndpoint

Returns: a Paws::DMS::DeleteEndpointResponse instance

Deletes the specified endpoint.

All tasks associated with the endpoint must be deleted before you can delete the endpoint.

DeleteEventSubscription

SubscriptionName => Str

Each argument is described in detail in: Paws::DMS::DeleteEventSubscription

Returns: a Paws::DMS::DeleteEventSubscriptionResponse instance

Deletes an AWS DMS event subscription.

DeleteReplicationInstance

ReplicationInstanceArn => Str

Each argument is described in detail in: Paws::DMS::DeleteReplicationInstance

Returns: a Paws::DMS::DeleteReplicationInstanceResponse instance

Deletes the specified replication instance.

You must delete any migration tasks that are associated with the replication instance before you can delete it.

DeleteReplicationSubnetGroup

ReplicationSubnetGroupIdentifier => Str

Each argument is described in detail in: Paws::DMS::DeleteReplicationSubnetGroup

Returns: a Paws::DMS::DeleteReplicationSubnetGroupResponse instance

Deletes a subnet group.

DeleteReplicationTask

ReplicationTaskArn => Str

Each argument is described in detail in: Paws::DMS::DeleteReplicationTask

Returns: a Paws::DMS::DeleteReplicationTaskResponse instance

Deletes the specified replication task.

DescribeAccountAttributes

Each argument is described in detail in: Paws::DMS::DescribeAccountAttributes

Returns: a Paws::DMS::DescribeAccountAttributesResponse instance

Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command does not take any parameters.

DescribeCertificates

[Filters => ArrayRef[Paws::DMS::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeCertificates

Returns: a Paws::DMS::DescribeCertificatesResponse instance

Provides a description of the certificate.

DescribeConnections

[Filters => ArrayRef[Paws::DMS::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeConnections

Returns: a Paws::DMS::DescribeConnectionsResponse instance

Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

DescribeEndpoints

[Filters => ArrayRef[Paws::DMS::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeEndpoints

Returns: a Paws::DMS::DescribeEndpointsResponse instance

Returns information about the endpoints for your account in the current region.

DescribeEndpointTypes

[Filters => ArrayRef[Paws::DMS::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeEndpointTypes

Returns: a Paws::DMS::DescribeEndpointTypesResponse instance

Returns information about the type of endpoints available.

DescribeEventCategories

[Filters => ArrayRef[Paws::DMS::Filter]]
[SourceType => Str]

Each argument is described in detail in: Paws::DMS::DescribeEventCategories

Returns: a Paws::DMS::DescribeEventCategoriesResponse instance

Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications (http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the AWS Database Migration Service User Guide.

DescribeEvents

[Duration => Int]
[EndTime => Str]
[EventCategories => ArrayRef[Str|Undef]]
[Filters => ArrayRef[Paws::DMS::Filter]]
[Marker => Str]
[MaxRecords => Int]
[SourceIdentifier => Str]
[SourceType => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::DMS::DescribeEvents

Returns: a Paws::DMS::DescribeEventsResponse instance

Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications (http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the AWS Database Migration User Guide.

DescribeEventSubscriptions

[Filters => ArrayRef[Paws::DMS::Filter]]
[Marker => Str]
[MaxRecords => Int]
[SubscriptionName => Str]

Each argument is described in detail in: Paws::DMS::DescribeEventSubscriptions

Returns: a Paws::DMS::DescribeEventSubscriptionsResponse instance

Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify SubscriptionName, this action lists the description for that subscription.

DescribeOrderableReplicationInstances

[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeOrderableReplicationInstances

Returns: a Paws::DMS::DescribeOrderableReplicationInstancesResponse instance

Returns information about the replication instance types that can be created in the specified region.

DescribeRefreshSchemasStatus

EndpointArn => Str

Each argument is described in detail in: Paws::DMS::DescribeRefreshSchemasStatus

Returns: a Paws::DMS::DescribeRefreshSchemasStatusResponse instance

Returns the status of the RefreshSchemas operation.

DescribeReplicationInstances

[Filters => ArrayRef[Paws::DMS::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeReplicationInstances

Returns: a Paws::DMS::DescribeReplicationInstancesResponse instance

Returns information about replication instances for your account in the current region.

DescribeReplicationInstanceTaskLogs

ReplicationInstanceArn => Str
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeReplicationInstanceTaskLogs

Returns: a Paws::DMS::DescribeReplicationInstanceTaskLogsResponse instance

Returns information about the task logs for the specified task.

DescribeReplicationSubnetGroups

[Filters => ArrayRef[Paws::DMS::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeReplicationSubnetGroups

Returns: a Paws::DMS::DescribeReplicationSubnetGroupsResponse instance

Returns information about the replication subnet groups.

DescribeReplicationTaskAssessmentResults

[Marker => Str]
[MaxRecords => Int]
[ReplicationTaskArn => Str]

Each argument is described in detail in: Paws::DMS::DescribeReplicationTaskAssessmentResults

Returns: a Paws::DMS::DescribeReplicationTaskAssessmentResultsResponse instance

Returns the task assessment results from Amazon S3. This action always returns the latest results.

DescribeReplicationTasks

[Filters => ArrayRef[Paws::DMS::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeReplicationTasks

Returns: a Paws::DMS::DescribeReplicationTasksResponse instance

Returns information about replication tasks for your account in the current region.

DescribeSchemas

EndpointArn => Str
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeSchemas

Returns: a Paws::DMS::DescribeSchemasResponse instance

Returns information about the schema for the specified endpoint.

DescribeTableStatistics

ReplicationTaskArn => Str
[Filters => ArrayRef[Paws::DMS::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DMS::DescribeTableStatistics

Returns: a Paws::DMS::DescribeTableStatisticsResponse instance

Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.

Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.

ImportCertificate

CertificateIdentifier => Str
[CertificatePem => Str]
[CertificateWallet => Str]
[Tags => ArrayRef[Paws::DMS::Tag]]

Each argument is described in detail in: Paws::DMS::ImportCertificate

Returns: a Paws::DMS::ImportCertificateResponse instance

Uploads the specified certificate.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::DMS::ListTagsForResource

Returns: a Paws::DMS::ListTagsForResourceResponse instance

Lists all tags for an AWS DMS resource.

ModifyEndpoint

EndpointArn => Str
[CertificateArn => Str]
[DatabaseName => Str]
[DmsTransferSettings => Paws::DMS::DmsTransferSettings]
[DynamoDbSettings => Paws::DMS::DynamoDbSettings]
[ElasticsearchSettings => Paws::DMS::ElasticsearchSettings]
[EndpointIdentifier => Str]
[EndpointType => Str]
[EngineName => Str]
[ExternalTableDefinition => Str]
[ExtraConnectionAttributes => Str]
[KinesisSettings => Paws::DMS::KinesisSettings]
[MongoDbSettings => Paws::DMS::MongoDbSettings]
[Password => Str]
[Port => Int]
[S3Settings => Paws::DMS::S3Settings]
[ServerName => Str]
[ServiceAccessRoleArn => Str]
[SslMode => Str]
[Username => Str]

Each argument is described in detail in: Paws::DMS::ModifyEndpoint

Returns: a Paws::DMS::ModifyEndpointResponse instance

Modifies the specified endpoint.

ModifyEventSubscription

SubscriptionName => Str
[Enabled => Bool]
[EventCategories => ArrayRef[Str|Undef]]
[SnsTopicArn => Str]
[SourceType => Str]

Each argument is described in detail in: Paws::DMS::ModifyEventSubscription

Returns: a Paws::DMS::ModifyEventSubscriptionResponse instance

Modifies an existing AWS DMS event notification subscription.

ModifyReplicationInstance

ReplicationInstanceArn => Str
[AllocatedStorage => Int]
[AllowMajorVersionUpgrade => Bool]
[ApplyImmediately => Bool]
[AutoMinorVersionUpgrade => Bool]
[EngineVersion => Str]
[MultiAZ => Bool]
[PreferredMaintenanceWindow => Str]
[ReplicationInstanceClass => Str]
[ReplicationInstanceIdentifier => Str]
[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DMS::ModifyReplicationInstance

Returns: a Paws::DMS::ModifyReplicationInstanceResponse instance

Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.

Some settings are applied during the maintenance window.

ModifyReplicationSubnetGroup

ReplicationSubnetGroupIdentifier => Str
SubnetIds => ArrayRef[Str|Undef]
[ReplicationSubnetGroupDescription => Str]

Each argument is described in detail in: Paws::DMS::ModifyReplicationSubnetGroup

Returns: a Paws::DMS::ModifyReplicationSubnetGroupResponse instance

Modifies the settings for the specified replication subnet group.

ModifyReplicationTask

ReplicationTaskArn => Str
[CdcStartPosition => Str]
[CdcStartTime => Str]
[CdcStopPosition => Str]
[MigrationType => Str]
[ReplicationTaskIdentifier => Str]
[ReplicationTaskSettings => Str]
[TableMappings => Str]

Each argument is described in detail in: Paws::DMS::ModifyReplicationTask

Returns: a Paws::DMS::ModifyReplicationTaskResponse instance

Modifies the specified replication task.

You can't modify the task endpoints. The task must be stopped before you can modify it.

For more information about AWS DMS tasks, see Working with Migration Tasks (http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) in the AWS Database Migration Service User Guide.

RebootReplicationInstance

ReplicationInstanceArn => Str
[ForceFailover => Bool]

Each argument is described in detail in: Paws::DMS::RebootReplicationInstance

Returns: a Paws::DMS::RebootReplicationInstanceResponse instance

Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.

RefreshSchemas

EndpointArn => Str
ReplicationInstanceArn => Str

Each argument is described in detail in: Paws::DMS::RefreshSchemas

Returns: a Paws::DMS::RefreshSchemasResponse instance

Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.

ReloadTables

ReplicationTaskArn => Str
TablesToReload => ArrayRef[Paws::DMS::TableToReload]
[ReloadOption => Str]

Each argument is described in detail in: Paws::DMS::ReloadTables

Returns: a Paws::DMS::ReloadTablesResponse instance

Reloads the target database table with the source data.

RemoveTagsFromResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::DMS::RemoveTagsFromResource

Returns: a Paws::DMS::RemoveTagsFromResourceResponse instance

Removes metadata tags from a DMS resource.

StartReplicationTask

ReplicationTaskArn => Str
StartReplicationTaskType => Str
[CdcStartPosition => Str]
[CdcStartTime => Str]
[CdcStopPosition => Str]

Each argument is described in detail in: Paws::DMS::StartReplicationTask

Returns: a Paws::DMS::StartReplicationTaskResponse instance

Starts the replication task.

For more information about AWS DMS tasks, see Working with Migration Tasks (http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) in the AWS Database Migration Service User Guide.

StartReplicationTaskAssessment

ReplicationTaskArn => Str

Each argument is described in detail in: Paws::DMS::StartReplicationTaskAssessment

Returns: a Paws::DMS::StartReplicationTaskAssessmentResponse instance

Starts the replication task assessment for unsupported data types in the source database.

StopReplicationTask

ReplicationTaskArn => Str

Each argument is described in detail in: Paws::DMS::StopReplicationTask

Returns: a Paws::DMS::StopReplicationTaskResponse instance

Stops the replication task.

TestConnection

EndpointArn => Str
ReplicationInstanceArn => Str

Each argument is described in detail in: Paws::DMS::TestConnection

Returns: a Paws::DMS::TestConnectionResponse instance

Tests the connection between the replication instance and the endpoint.

PAGINATORS

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