codegen-resources.service-2.json Maven / Gradle / Ivy
Show all versions of dms Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-01-01",
"endpointPrefix":"dms",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Database Migration Service",
"serviceId":"Database Migration Service",
"signatureVersion":"v4",
"targetPrefix":"AmazonDMSv20160101",
"uid":"dms-2016-01-01"
},
"operations":{
"AddTagsToResource":{
"name":"AddTagsToResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddTagsToResourceMessage"},
"output":{"shape":"AddTagsToResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Adds metadata tags to a 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":{
"name":"CreateEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateEndpointMessage"},
"output":{"shape":"CreateEndpointResponse"},
"errors":[
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"ResourceAlreadyExistsFault"},
{"shape":"ResourceQuotaExceededFault"},
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"AccessDeniedFault"}
],
"documentation":"Creates an endpoint using the provided settings.
"
},
"CreateEventSubscription":{
"name":"CreateEventSubscription",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateEventSubscriptionMessage"},
"output":{"shape":"CreateEventSubscriptionResponse"},
"errors":[
{"shape":"ResourceQuotaExceededFault"},
{"shape":"ResourceAlreadyExistsFault"},
{"shape":"SNSInvalidTopicFault"},
{"shape":"SNSNoAuthorizationFault"},
{"shape":"ResourceNotFoundFault"}
],
"documentation":" 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 in the AWS Database MIgration Service User Guide.
"
},
"CreateReplicationInstance":{
"name":"CreateReplicationInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateReplicationInstanceMessage"},
"output":{"shape":"CreateReplicationInstanceResponse"},
"errors":[
{"shape":"AccessDeniedFault"},
{"shape":"ResourceAlreadyExistsFault"},
{"shape":"InsufficientResourceCapacityFault"},
{"shape":"ResourceQuotaExceededFault"},
{"shape":"StorageQuotaExceededFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"ReplicationSubnetGroupDoesNotCoverEnoughAZs"},
{"shape":"InvalidResourceStateFault"},
{"shape":"InvalidSubnet"},
{"shape":"KMSKeyNotAccessibleFault"}
],
"documentation":"Creates the replication instance using the specified parameters.
"
},
"CreateReplicationSubnetGroup":{
"name":"CreateReplicationSubnetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateReplicationSubnetGroupMessage"},
"output":{"shape":"CreateReplicationSubnetGroupResponse"},
"errors":[
{"shape":"AccessDeniedFault"},
{"shape":"ResourceAlreadyExistsFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"ResourceQuotaExceededFault"},
{"shape":"ReplicationSubnetGroupDoesNotCoverEnoughAZs"},
{"shape":"InvalidSubnet"}
],
"documentation":"Creates a replication subnet group given a list of the subnet IDs in a VPC.
"
},
"CreateReplicationTask":{
"name":"CreateReplicationTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateReplicationTaskMessage"},
"output":{"shape":"CreateReplicationTaskResponse"},
"errors":[
{"shape":"AccessDeniedFault"},
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceAlreadyExistsFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"ResourceQuotaExceededFault"}
],
"documentation":"Creates a replication task using the specified parameters.
"
},
"DeleteCertificate":{
"name":"DeleteCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteCertificateMessage"},
"output":{"shape":"DeleteCertificateResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":"Deletes the specified certificate.
"
},
"DeleteEndpoint":{
"name":"DeleteEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteEndpointMessage"},
"output":{"shape":"DeleteEndpointResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":"Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
"
},
"DeleteEventSubscription":{
"name":"DeleteEventSubscription",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteEventSubscriptionMessage"},
"output":{"shape":"DeleteEventSubscriptionResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":" Deletes an AWS DMS event subscription.
"
},
"DeleteReplicationInstance":{
"name":"DeleteReplicationInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteReplicationInstanceMessage"},
"output":{"shape":"DeleteReplicationInstanceResponse"},
"errors":[
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Deletes the specified replication instance.
You must delete any migration tasks that are associated with the replication instance before you can delete it.
"
},
"DeleteReplicationSubnetGroup":{
"name":"DeleteReplicationSubnetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteReplicationSubnetGroupMessage"},
"output":{"shape":"DeleteReplicationSubnetGroupResponse"},
"errors":[
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Deletes a subnet group.
"
},
"DeleteReplicationTask":{
"name":"DeleteReplicationTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteReplicationTaskMessage"},
"output":{"shape":"DeleteReplicationTaskResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":"Deletes the specified replication task.
"
},
"DescribeAccountAttributes":{
"name":"DescribeAccountAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAccountAttributesMessage"},
"output":{"shape":"DescribeAccountAttributesResponse"},
"documentation":"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":{
"name":"DescribeCertificates",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCertificatesMessage"},
"output":{"shape":"DescribeCertificatesResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Provides a description of the certificate.
"
},
"DescribeConnections":{
"name":"DescribeConnections",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConnectionsMessage"},
"output":{"shape":"DescribeConnectionsResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"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.
"
},
"DescribeEndpointTypes":{
"name":"DescribeEndpointTypes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEndpointTypesMessage"},
"output":{"shape":"DescribeEndpointTypesResponse"},
"documentation":"Returns information about the type of endpoints available.
"
},
"DescribeEndpoints":{
"name":"DescribeEndpoints",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEndpointsMessage"},
"output":{"shape":"DescribeEndpointsResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Returns information about the endpoints for your account in the current region.
"
},
"DescribeEventCategories":{
"name":"DescribeEventCategories",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventCategoriesMessage"},
"output":{"shape":"DescribeEventCategoriesResponse"},
"documentation":"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 in the AWS Database Migration Service User Guide.
"
},
"DescribeEventSubscriptions":{
"name":"DescribeEventSubscriptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventSubscriptionsMessage"},
"output":{"shape":"DescribeEventSubscriptionsResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"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.
"
},
"DescribeEvents":{
"name":"DescribeEvents",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventsMessage"},
"output":{"shape":"DescribeEventsResponse"},
"documentation":" 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 .
"
},
"DescribeOrderableReplicationInstances":{
"name":"DescribeOrderableReplicationInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeOrderableReplicationInstancesMessage"},
"output":{"shape":"DescribeOrderableReplicationInstancesResponse"},
"documentation":"Returns information about the replication instance types that can be created in the specified region.
"
},
"DescribeRefreshSchemasStatus":{
"name":"DescribeRefreshSchemasStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeRefreshSchemasStatusMessage"},
"output":{"shape":"DescribeRefreshSchemasStatusResponse"},
"errors":[
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Returns the status of the RefreshSchemas operation.
"
},
"DescribeReplicationInstances":{
"name":"DescribeReplicationInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeReplicationInstancesMessage"},
"output":{"shape":"DescribeReplicationInstancesResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Returns information about replication instances for your account in the current region.
"
},
"DescribeReplicationSubnetGroups":{
"name":"DescribeReplicationSubnetGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeReplicationSubnetGroupsMessage"},
"output":{"shape":"DescribeReplicationSubnetGroupsResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Returns information about the replication subnet groups.
"
},
"DescribeReplicationTaskAssessmentResults":{
"name":"DescribeReplicationTaskAssessmentResults",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeReplicationTaskAssessmentResultsMessage"},
"output":{"shape":"DescribeReplicationTaskAssessmentResultsResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Returns the task assessment results from Amazon S3. This action always returns the latest results.
"
},
"DescribeReplicationTasks":{
"name":"DescribeReplicationTasks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeReplicationTasksMessage"},
"output":{"shape":"DescribeReplicationTasksResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Returns information about replication tasks for your account in the current region.
"
},
"DescribeSchemas":{
"name":"DescribeSchemas",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeSchemasMessage"},
"output":{"shape":"DescribeSchemasResponse"},
"errors":[
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Returns information about the schema for the specified endpoint.
"
},
"DescribeTableStatistics":{
"name":"DescribeTableStatistics",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTableStatisticsMessage"},
"output":{"shape":"DescribeTableStatisticsResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":"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":{
"name":"ImportCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ImportCertificateMessage"},
"output":{"shape":"ImportCertificateResponse"},
"errors":[
{"shape":"ResourceAlreadyExistsFault"},
{"shape":"InvalidCertificateFault"}
],
"documentation":"Uploads the specified certificate.
"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceMessage"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Lists all tags for an AWS DMS resource.
"
},
"ModifyEndpoint":{
"name":"ModifyEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyEndpointMessage"},
"output":{"shape":"ModifyEndpointResponse"},
"errors":[
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"ResourceAlreadyExistsFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"AccessDeniedFault"}
],
"documentation":"Modifies the specified endpoint.
"
},
"ModifyEventSubscription":{
"name":"ModifyEventSubscription",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyEventSubscriptionMessage"},
"output":{"shape":"ModifyEventSubscriptionResponse"},
"errors":[
{"shape":"ResourceQuotaExceededFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"SNSInvalidTopicFault"},
{"shape":"SNSNoAuthorizationFault"}
],
"documentation":"Modifies an existing AWS DMS event notification subscription.
"
},
"ModifyReplicationInstance":{
"name":"ModifyReplicationInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyReplicationInstanceMessage"},
"output":{"shape":"ModifyReplicationInstanceResponse"},
"errors":[
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceAlreadyExistsFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"InsufficientResourceCapacityFault"},
{"shape":"StorageQuotaExceededFault"},
{"shape":"UpgradeDependencyFailureFault"}
],
"documentation":"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":{
"name":"ModifyReplicationSubnetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyReplicationSubnetGroupMessage"},
"output":{"shape":"ModifyReplicationSubnetGroupResponse"},
"errors":[
{"shape":"AccessDeniedFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"ResourceQuotaExceededFault"},
{"shape":"SubnetAlreadyInUse"},
{"shape":"ReplicationSubnetGroupDoesNotCoverEnoughAZs"},
{"shape":"InvalidSubnet"}
],
"documentation":"Modifies the settings for the specified replication subnet group.
"
},
"ModifyReplicationTask":{
"name":"ModifyReplicationTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyReplicationTaskMessage"},
"output":{"shape":"ModifyReplicationTaskResponse"},
"errors":[
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"ResourceAlreadyExistsFault"},
{"shape":"KMSKeyNotAccessibleFault"}
],
"documentation":"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 the AWS DMS user guide at Working with Migration Tasks
"
},
"RefreshSchemas":{
"name":"RefreshSchemas",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RefreshSchemasMessage"},
"output":{"shape":"RefreshSchemasResponse"},
"errors":[
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"ResourceQuotaExceededFault"}
],
"documentation":"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":{
"name":"ReloadTables",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ReloadTablesMessage"},
"output":{"shape":"ReloadTablesResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":"Reloads the target database table with the source data.
"
},
"RemoveTagsFromResource":{
"name":"RemoveTagsFromResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveTagsFromResourceMessage"},
"output":{"shape":"RemoveTagsFromResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"Removes metadata tags from a DMS resource.
"
},
"StartReplicationTask":{
"name":"StartReplicationTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartReplicationTaskMessage"},
"output":{"shape":"StartReplicationTaskResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":"Starts the replication task.
For more information about AWS DMS tasks, see the AWS DMS user guide at Working with Migration Tasks
"
},
"StartReplicationTaskAssessment":{
"name":"StartReplicationTaskAssessment",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartReplicationTaskAssessmentMessage"},
"output":{"shape":"StartReplicationTaskAssessmentResponse"},
"errors":[
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceNotFoundFault"}
],
"documentation":" Starts the replication task assessment for unsupported data types in the source database.
"
},
"StopReplicationTask":{
"name":"StopReplicationTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopReplicationTaskMessage"},
"output":{"shape":"StopReplicationTaskResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":"Stops the replication task.
"
},
"TestConnection":{
"name":"TestConnection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TestConnectionMessage"},
"output":{"shape":"TestConnectionResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"ResourceQuotaExceededFault"}
],
"documentation":"Tests the connection between the replication instance and the endpoint.
"
}
},
"shapes":{
"AccessDeniedFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"AWS DMS was denied access to the endpoint.
",
"exception":true
},
"AccountQuota":{
"type":"structure",
"members":{
"AccountQuotaName":{
"shape":"String",
"documentation":"The name of the AWS DMS quota for this AWS account.
"
},
"Used":{
"shape":"Long",
"documentation":"The amount currently used toward the quota maximum.
"
},
"Max":{
"shape":"Long",
"documentation":"The maximum allowed value for the quota.
"
}
},
"documentation":"Describes a quota for an AWS account, for example, the number of replication instances allowed.
"
},
"AccountQuotaList":{
"type":"list",
"member":{"shape":"AccountQuota"}
},
"AddTagsToResourceMessage":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be added to. AWS DMS resources include a replication instance, endpoint, and a replication task.
"
},
"Tags":{
"shape":"TagList",
"documentation":"The tag to be assigned to the DMS resource.
"
}
},
"documentation":""
},
"AddTagsToResourceResponse":{
"type":"structure",
"members":{
},
"documentation":""
},
"AuthMechanismValue":{
"type":"string",
"enum":[
"default",
"mongodb_cr",
"scram_sha_1"
]
},
"AuthTypeValue":{
"type":"string",
"enum":[
"no",
"password"
]
},
"AvailabilityZone":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"The name of the availability zone.
"
}
},
"documentation":""
},
"Boolean":{"type":"boolean"},
"BooleanOptional":{"type":"boolean"},
"Certificate":{
"type":"structure",
"members":{
"CertificateIdentifier":{
"shape":"String",
"documentation":"The customer-assigned name of the certificate. Valid characters are A-z and 0-9.
"
},
"CertificateCreationDate":{
"shape":"TStamp",
"documentation":"The date that the certificate was created.
"
},
"CertificatePem":{
"shape":"String",
"documentation":"The contents of the .pem X.509 certificate file for the certificate.
"
},
"CertificateWallet":{
"shape":"CertificateWallet",
"documentation":"The location of the imported Oracle Wallet certificate for use with SSL.
"
},
"CertificateArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) for the certificate.
"
},
"CertificateOwner":{
"shape":"String",
"documentation":"The owner of the certificate.
"
},
"ValidFromDate":{
"shape":"TStamp",
"documentation":"The beginning date that the certificate is valid.
"
},
"ValidToDate":{
"shape":"TStamp",
"documentation":"The final date that the certificate is valid.
"
},
"SigningAlgorithm":{
"shape":"String",
"documentation":"The signing algorithm for the certificate.
"
},
"KeyLength":{
"shape":"IntegerOptional",
"documentation":"The key length of the cryptographic algorithm being used.
"
}
},
"documentation":"The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.
"
},
"CertificateList":{
"type":"list",
"member":{"shape":"Certificate"}
},
"CertificateWallet":{"type":"blob"},
"CompressionTypeValue":{
"type":"string",
"enum":[
"none",
"gzip"
]
},
"Connection":{
"type":"structure",
"members":{
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication instance.
"
},
"EndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
},
"Status":{
"shape":"String",
"documentation":"The connection status.
"
},
"LastFailureMessage":{
"shape":"String",
"documentation":"The error message when the connection last failed.
"
},
"EndpointIdentifier":{
"shape":"String",
"documentation":"The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
"
},
"ReplicationInstanceIdentifier":{
"shape":"String",
"documentation":"The replication instance identifier. This parameter is stored as a lowercase string.
"
}
},
"documentation":""
},
"ConnectionList":{
"type":"list",
"member":{"shape":"Connection"}
},
"CreateEndpointMessage":{
"type":"structure",
"required":[
"EndpointIdentifier",
"EndpointType",
"EngineName"
],
"members":{
"EndpointIdentifier":{
"shape":"String",
"documentation":"The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
"
},
"EndpointType":{
"shape":"ReplicationEndpointTypeValue",
"documentation":"The type of endpoint.
"
},
"EngineName":{
"shape":"String",
"documentation":"The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.
"
},
"Username":{
"shape":"String",
"documentation":"The user name to be used to login to the endpoint database.
"
},
"Password":{
"shape":"SecretString",
"documentation":"The password to be used to login to the endpoint database.
"
},
"ServerName":{
"shape":"String",
"documentation":"The name of the server where the endpoint database resides.
"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"The port used by the endpoint database.
"
},
"DatabaseName":{
"shape":"String",
"documentation":"The name of the endpoint database.
"
},
"ExtraConnectionAttributes":{
"shape":"String",
"documentation":"Additional attributes associated with the connection.
"
},
"KmsKeyId":{
"shape":"String",
"documentation":"The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
"
},
"Tags":{
"shape":"TagList",
"documentation":"Tags to be added to the endpoint.
"
},
"CertificateArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) for the certificate.
"
},
"SslMode":{
"shape":"DmsSslModeValue",
"documentation":"The SSL mode to use for the SSL connection.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
"
},
"DynamoDbSettings":{
"shape":"DynamoDbSettings",
"documentation":"Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.
"
},
"S3Settings":{
"shape":"S3Settings",
"documentation":"Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.
"
},
"MongoDbSettings":{
"shape":"MongoDbSettings",
"documentation":"Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.
"
}
},
"documentation":""
},
"CreateEndpointResponse":{
"type":"structure",
"members":{
"Endpoint":{
"shape":"Endpoint",
"documentation":"The endpoint that was created.
"
}
},
"documentation":""
},
"CreateEventSubscriptionMessage":{
"type":"structure",
"required":[
"SubscriptionName",
"SnsTopicArn"
],
"members":{
"SubscriptionName":{
"shape":"String",
"documentation":"The name of the DMS event notification subscription.
Constraints: The name must be less than 255 characters.
"
},
"SnsTopicArn":{
"shape":"String",
"documentation":" The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
"
},
"SourceType":{
"shape":"String",
"documentation":" The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value is not specified, all events are returned.
Valid values: replication-instance | migration-task
"
},
"EventCategories":{
"shape":"EventCategoriesList",
"documentation":" A list of event categories for a source type that you want to subscribe to. You can see a list of the categories for a given source type by calling the DescribeEventCategories action or in the topic Working with Events and Notifications in the AWS Database Migration Service User Guide.
"
},
"SourceIds":{
"shape":"SourceIdsList",
"documentation":" The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
"
},
"Enabled":{
"shape":"BooleanOptional",
"documentation":" A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.
"
},
"Tags":{
"shape":"TagList",
"documentation":"A tag to be attached to the event subscription.
"
}
},
"documentation":""
},
"CreateEventSubscriptionResponse":{
"type":"structure",
"members":{
"EventSubscription":{
"shape":"EventSubscription",
"documentation":"The event subscription that was created.
"
}
},
"documentation":""
},
"CreateReplicationInstanceMessage":{
"type":"structure",
"required":[
"ReplicationInstanceIdentifier",
"ReplicationInstanceClass"
],
"members":{
"ReplicationInstanceIdentifier":{
"shape":"String",
"documentation":"The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
"
},
"AllocatedStorage":{
"shape":"IntegerOptional",
"documentation":"The amount of storage (in gigabytes) to be initially allocated for the replication instance.
"
},
"ReplicationInstanceClass":{
"shape":"String",
"documentation":"The compute and memory capacity of the replication instance as specified by the replication instance class.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":" Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
"
},
"AvailabilityZone":{
"shape":"String",
"documentation":"The EC2 Availability Zone that the replication instance will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
"
},
"ReplicationSubnetGroupIdentifier":{
"shape":"String",
"documentation":"A subnet group to associate with the replication instance.
"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
"
},
"MultiAZ":{
"shape":"BooleanOptional",
"documentation":" Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
"
},
"EngineVersion":{
"shape":"String",
"documentation":"The engine version number of the replication instance.
"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
"documentation":"Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
Default: true
"
},
"Tags":{
"shape":"TagList",
"documentation":"Tags to be associated with the replication instance.
"
},
"KmsKeyId":{
"shape":"String",
"documentation":"The KMS key identifier that will be used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
"
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
"documentation":" Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
"
}
},
"documentation":""
},
"CreateReplicationInstanceResponse":{
"type":"structure",
"members":{
"ReplicationInstance":{
"shape":"ReplicationInstance",
"documentation":"The replication instance that was created.
"
}
},
"documentation":""
},
"CreateReplicationSubnetGroupMessage":{
"type":"structure",
"required":[
"ReplicationSubnetGroupIdentifier",
"ReplicationSubnetGroupDescription",
"SubnetIds"
],
"members":{
"ReplicationSubnetGroupIdentifier":{
"shape":"String",
"documentation":"The name for the replication subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be \"default\".
Example: mySubnetgroup
"
},
"ReplicationSubnetGroupDescription":{
"shape":"String",
"documentation":"The description for the subnet group.
"
},
"SubnetIds":{
"shape":"SubnetIdentifierList",
"documentation":"The EC2 subnet IDs for the subnet group.
"
},
"Tags":{
"shape":"TagList",
"documentation":"The tag to be assigned to the subnet group.
"
}
},
"documentation":""
},
"CreateReplicationSubnetGroupResponse":{
"type":"structure",
"members":{
"ReplicationSubnetGroup":{
"shape":"ReplicationSubnetGroup",
"documentation":"The replication subnet group that was created.
"
}
},
"documentation":""
},
"CreateReplicationTaskMessage":{
"type":"structure",
"required":[
"ReplicationTaskIdentifier",
"SourceEndpointArn",
"TargetEndpointArn",
"ReplicationInstanceArn",
"MigrationType",
"TableMappings"
],
"members":{
"ReplicationTaskIdentifier":{
"shape":"String",
"documentation":"The replication task identifier.
Constraints:
-
Must contain from 1 to 255 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
"
},
"SourceEndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
},
"TargetEndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
},
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication instance.
"
},
"MigrationType":{
"shape":"MigrationTypeValue",
"documentation":"The migration type.
"
},
"TableMappings":{
"shape":"String",
"documentation":"When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with \"file://\". When working with the DMS API, provide the JSON as the parameter value.
For example, --table-mappings file://mappingfile.json
"
},
"ReplicationTaskSettings":{
"shape":"String",
"documentation":"Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.
"
},
"CdcStartTime":{
"shape":"TStamp",
"documentation":"The start time for the Change Data Capture (CDC) operation.
"
},
"Tags":{
"shape":"TagList",
"documentation":"Tags to be added to the replication instance.
"
}
},
"documentation":""
},
"CreateReplicationTaskResponse":{
"type":"structure",
"members":{
"ReplicationTask":{
"shape":"ReplicationTask",
"documentation":"The replication task that was created.
"
}
},
"documentation":""
},
"DeleteCertificateMessage":{
"type":"structure",
"required":["CertificateArn"],
"members":{
"CertificateArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the deleted certificate.
"
}
}
},
"DeleteCertificateResponse":{
"type":"structure",
"members":{
"Certificate":{
"shape":"Certificate",
"documentation":"The Secure Sockets Layer (SSL) certificate.
"
}
}
},
"DeleteEndpointMessage":{
"type":"structure",
"required":["EndpointArn"],
"members":{
"EndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
}
},
"documentation":""
},
"DeleteEndpointResponse":{
"type":"structure",
"members":{
"Endpoint":{
"shape":"Endpoint",
"documentation":"The endpoint that was deleted.
"
}
},
"documentation":""
},
"DeleteEventSubscriptionMessage":{
"type":"structure",
"required":["SubscriptionName"],
"members":{
"SubscriptionName":{
"shape":"String",
"documentation":"The name of the DMS event notification subscription to be deleted.
"
}
},
"documentation":""
},
"DeleteEventSubscriptionResponse":{
"type":"structure",
"members":{
"EventSubscription":{
"shape":"EventSubscription",
"documentation":"The event subscription that was deleted.
"
}
},
"documentation":""
},
"DeleteReplicationInstanceMessage":{
"type":"structure",
"required":["ReplicationInstanceArn"],
"members":{
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication instance to be deleted.
"
}
},
"documentation":""
},
"DeleteReplicationInstanceResponse":{
"type":"structure",
"members":{
"ReplicationInstance":{
"shape":"ReplicationInstance",
"documentation":"The replication instance that was deleted.
"
}
},
"documentation":""
},
"DeleteReplicationSubnetGroupMessage":{
"type":"structure",
"required":["ReplicationSubnetGroupIdentifier"],
"members":{
"ReplicationSubnetGroupIdentifier":{
"shape":"String",
"documentation":"The subnet group name of the replication instance.
"
}
},
"documentation":""
},
"DeleteReplicationSubnetGroupResponse":{
"type":"structure",
"members":{
},
"documentation":""
},
"DeleteReplicationTaskMessage":{
"type":"structure",
"required":["ReplicationTaskArn"],
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication task to be deleted.
"
}
},
"documentation":""
},
"DeleteReplicationTaskResponse":{
"type":"structure",
"members":{
"ReplicationTask":{
"shape":"ReplicationTask",
"documentation":"The deleted replication task.
"
}
},
"documentation":""
},
"DescribeAccountAttributesMessage":{
"type":"structure",
"members":{
},
"documentation":""
},
"DescribeAccountAttributesResponse":{
"type":"structure",
"members":{
"AccountQuotas":{
"shape":"AccountQuotaList",
"documentation":"Account quota information.
"
}
},
"documentation":""
},
"DescribeCertificatesMessage":{
"type":"structure",
"members":{
"Filters":{
"shape":"FilterList",
"documentation":"Filters applied to the certificate described in the form of key-value pairs.
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 10
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
}
},
"DescribeCertificatesResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"The pagination token.
"
},
"Certificates":{
"shape":"CertificateList",
"documentation":"The Secure Sockets Layer (SSL) certificates associated with the replication instance.
"
}
}
},
"DescribeConnectionsMessage":{
"type":"structure",
"members":{
"Filters":{
"shape":"FilterList",
"documentation":"The filters applied to the connection.
Valid filter names: endpoint-arn | replication-instance-arn
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeConnectionsResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"Connections":{
"shape":"ConnectionList",
"documentation":"A description of the connections.
"
}
},
"documentation":""
},
"DescribeEndpointTypesMessage":{
"type":"structure",
"members":{
"Filters":{
"shape":"FilterList",
"documentation":"Filters applied to the describe action.
Valid filter names: engine-name | endpoint-type
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeEndpointTypesResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"SupportedEndpointTypes":{
"shape":"SupportedEndpointTypeList",
"documentation":"The type of endpoints that are supported.
"
}
},
"documentation":""
},
"DescribeEndpointsMessage":{
"type":"structure",
"members":{
"Filters":{
"shape":"FilterList",
"documentation":"Filters applied to the describe action.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeEndpointsResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"Endpoints":{
"shape":"EndpointList",
"documentation":"Endpoint description.
"
}
},
"documentation":""
},
"DescribeEventCategoriesMessage":{
"type":"structure",
"members":{
"SourceType":{
"shape":"String",
"documentation":" The type of AWS DMS resource that generates events.
Valid values: replication-instance | migration-task
"
},
"Filters":{
"shape":"FilterList",
"documentation":"Filters applied to the action.
"
}
},
"documentation":""
},
"DescribeEventCategoriesResponse":{
"type":"structure",
"members":{
"EventCategoryGroupList":{
"shape":"EventCategoryGroupList",
"documentation":"A list of event categories.
"
}
},
"documentation":""
},
"DescribeEventSubscriptionsMessage":{
"type":"structure",
"members":{
"SubscriptionName":{
"shape":"String",
"documentation":"The name of the AWS DMS event subscription to be described.
"
},
"Filters":{
"shape":"FilterList",
"documentation":"Filters applied to the action.
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeEventSubscriptionsResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"EventSubscriptionsList":{
"shape":"EventSubscriptionsList",
"documentation":"A list of event subscriptions.
"
}
},
"documentation":""
},
"DescribeEventsMessage":{
"type":"structure",
"members":{
"SourceIdentifier":{
"shape":"String",
"documentation":" The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens.
"
},
"SourceType":{
"shape":"SourceType",
"documentation":"The type of AWS DMS resource that generates events.
Valid values: replication-instance | migration-task
"
},
"StartTime":{
"shape":"TStamp",
"documentation":"The start time for the events to be listed.
"
},
"EndTime":{
"shape":"TStamp",
"documentation":"The end time for the events to be listed.
"
},
"Duration":{
"shape":"IntegerOptional",
"documentation":"The duration of the events to be listed.
"
},
"EventCategories":{
"shape":"EventCategoriesList",
"documentation":"A list of event categories for a source type that you want to subscribe to.
"
},
"Filters":{
"shape":"FilterList",
"documentation":"Filters applied to the action.
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeEventsResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"Events":{
"shape":"EventList",
"documentation":"The events described.
"
}
},
"documentation":""
},
"DescribeOrderableReplicationInstancesMessage":{
"type":"structure",
"members":{
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeOrderableReplicationInstancesResponse":{
"type":"structure",
"members":{
"OrderableReplicationInstances":{
"shape":"OrderableReplicationInstanceList",
"documentation":"The order-able replication instances available.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeRefreshSchemasStatusMessage":{
"type":"structure",
"required":["EndpointArn"],
"members":{
"EndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
}
},
"documentation":""
},
"DescribeRefreshSchemasStatusResponse":{
"type":"structure",
"members":{
"RefreshSchemasStatus":{
"shape":"RefreshSchemasStatus",
"documentation":"The status of the schema.
"
}
},
"documentation":""
},
"DescribeReplicationInstancesMessage":{
"type":"structure",
"members":{
"Filters":{
"shape":"FilterList",
"documentation":"Filters applied to the describe action.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeReplicationInstancesResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"ReplicationInstances":{
"shape":"ReplicationInstanceList",
"documentation":"The replication instances described.
"
}
},
"documentation":""
},
"DescribeReplicationSubnetGroupsMessage":{
"type":"structure",
"members":{
"Filters":{
"shape":"FilterList",
"documentation":"Filters applied to the describe action.
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeReplicationSubnetGroupsResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"ReplicationSubnetGroups":{
"shape":"ReplicationSubnetGroups",
"documentation":"A description of the replication subnet groups.
"
}
},
"documentation":""
},
"DescribeReplicationTaskAssessmentResultsMessage":{
"type":"structure",
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":"- The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified the API will return only one result and ignore the values of the max-records and marker parameters.
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeReplicationTaskAssessmentResultsResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"BucketName":{
"shape":"String",
"documentation":"- The Amazon S3 bucket where the task assessment report is located.
"
},
"ReplicationTaskAssessmentResults":{
"shape":"ReplicationTaskAssessmentResultList",
"documentation":" The task assessment report.
"
}
},
"documentation":""
},
"DescribeReplicationTasksMessage":{
"type":"structure",
"members":{
"Filters":{
"shape":"FilterList",
"documentation":"Filters applied to the describe action.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeReplicationTasksResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"ReplicationTasks":{
"shape":"ReplicationTaskList",
"documentation":"A description of the replication tasks.
"
}
},
"documentation":""
},
"DescribeSchemasMessage":{
"type":"structure",
"required":["EndpointArn"],
"members":{
"EndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DescribeSchemasResponse":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"Schemas":{
"shape":"SchemaList",
"documentation":"The described schema.
"
}
},
"documentation":""
},
"DescribeTableStatisticsMessage":{
"type":"structure",
"required":["ReplicationTaskArn"],
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication task.
"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 500.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
},
"Filters":{
"shape":"FilterList",
"documentation":"Filters applied to the describe table statistics action.
Valid filter names: schema-name | table-name | table-state
A combination of filters creates an AND condition where each record matches all specified filters.
"
}
},
"documentation":""
},
"DescribeTableStatisticsResponse":{
"type":"structure",
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication task.
"
},
"TableStatistics":{
"shape":"TableStatisticsList",
"documentation":"The table statistics.
"
},
"Marker":{
"shape":"String",
"documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
"
}
},
"documentation":""
},
"DmsSslModeValue":{
"type":"string",
"enum":[
"none",
"require",
"verify-ca",
"verify-full"
]
},
"DynamoDbSettings":{
"type":"structure",
"required":["ServiceAccessRoleArn"],
"members":{
"ServiceAccessRoleArn":{
"shape":"String",
"documentation":" The Amazon Resource Name (ARN) used by the service access IAM role.
"
}
},
"documentation":""
},
"Endpoint":{
"type":"structure",
"members":{
"EndpointIdentifier":{
"shape":"String",
"documentation":"The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
"
},
"EndpointType":{
"shape":"ReplicationEndpointTypeValue",
"documentation":"The type of endpoint.
"
},
"EngineName":{
"shape":"String",
"documentation":"The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.
"
},
"Username":{
"shape":"String",
"documentation":"The user name used to connect to the endpoint.
"
},
"ServerName":{
"shape":"String",
"documentation":"The name of the server at the endpoint.
"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"The port value used to access the endpoint.
"
},
"DatabaseName":{
"shape":"String",
"documentation":"The name of the database at the endpoint.
"
},
"ExtraConnectionAttributes":{
"shape":"String",
"documentation":"Additional connection attributes used to connect to the endpoint.
"
},
"Status":{
"shape":"String",
"documentation":"The status of the endpoint.
"
},
"KmsKeyId":{
"shape":"String",
"documentation":"The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
"
},
"EndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
},
"CertificateArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
"
},
"SslMode":{
"shape":"DmsSslModeValue",
"documentation":"The SSL mode used to connect to the endpoint.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
"
},
"ExternalId":{
"shape":"String",
"documentation":" Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
"
},
"DynamoDbSettings":{
"shape":"DynamoDbSettings",
"documentation":"The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
"
},
"S3Settings":{
"shape":"S3Settings",
"documentation":"The settings for the S3 target endpoint. For more information, see the S3Settings structure.
"
},
"MongoDbSettings":{
"shape":"MongoDbSettings",
"documentation":"The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
"
}
},
"documentation":""
},
"EndpointList":{
"type":"list",
"member":{"shape":"Endpoint"}
},
"Event":{
"type":"structure",
"members":{
"SourceIdentifier":{
"shape":"String",
"documentation":" The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:replication instance, endpoint, migration task
"
},
"SourceType":{
"shape":"SourceType",
"documentation":" The type of AWS DMS resource that generates events.
Valid values: replication-instance | endpoint | migration-task
"
},
"Message":{
"shape":"String",
"documentation":"The event message.
"
},
"EventCategories":{
"shape":"EventCategoriesList",
"documentation":"The event categories available for the specified source type.
"
},
"Date":{
"shape":"TStamp",
"documentation":"The date of the event.
"
}
},
"documentation":""
},
"EventCategoriesList":{
"type":"list",
"member":{"shape":"String"}
},
"EventCategoryGroup":{
"type":"structure",
"members":{
"SourceType":{
"shape":"String",
"documentation":" The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | migration-task
"
},
"EventCategories":{
"shape":"EventCategoriesList",
"documentation":" A list of event categories for a SourceType that you want to subscribe to.
"
}
},
"documentation":""
},
"EventCategoryGroupList":{
"type":"list",
"member":{"shape":"EventCategoryGroup"}
},
"EventList":{
"type":"list",
"member":{"shape":"Event"}
},
"EventSubscription":{
"type":"structure",
"members":{
"CustomerAwsId":{
"shape":"String",
"documentation":"The AWS customer account associated with the AWS DMS event notification subscription.
"
},
"CustSubscriptionId":{
"shape":"String",
"documentation":"The AWS DMS event notification subscription Id.
"
},
"SnsTopicArn":{
"shape":"String",
"documentation":"The topic ARN of the AWS DMS event notification subscription.
"
},
"Status":{
"shape":"String",
"documentation":"The status of the AWS DMS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status \"no-permission\" indicates that AWS DMS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
"
},
"SubscriptionCreationTime":{
"shape":"String",
"documentation":"The time the RDS event notification subscription was created.
"
},
"SourceType":{
"shape":"String",
"documentation":" The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | migration-task
"
},
"SourceIdsList":{
"shape":"SourceIdsList",
"documentation":"A list of source Ids for the event subscription.
"
},
"EventCategoriesList":{
"shape":"EventCategoriesList",
"documentation":"A lists of event categories.
"
},
"Enabled":{
"shape":"Boolean",
"documentation":"Boolean value that indicates if the event subscription is enabled.
"
}
},
"documentation":""
},
"EventSubscriptionsList":{
"type":"list",
"member":{"shape":"EventSubscription"}
},
"ExceptionMessage":{"type":"string"},
"Filter":{
"type":"structure",
"required":[
"Name",
"Values"
],
"members":{
"Name":{
"shape":"String",
"documentation":"The name of the filter.
"
},
"Values":{
"shape":"FilterValueList",
"documentation":"The filter value.
"
}
},
"documentation":""
},
"FilterList":{
"type":"list",
"member":{"shape":"Filter"}
},
"FilterValueList":{
"type":"list",
"member":{"shape":"String"}
},
"ImportCertificateMessage":{
"type":"structure",
"required":["CertificateIdentifier"],
"members":{
"CertificateIdentifier":{
"shape":"String",
"documentation":"The customer-assigned name of the certificate. Valid characters are A-z and 0-9.
"
},
"CertificatePem":{
"shape":"String",
"documentation":"The contents of the .pem X.509 certificate file for the certificate.
"
},
"CertificateWallet":{
"shape":"CertificateWallet",
"documentation":"The location of the imported Oracle Wallet certificate for use with SSL.
"
},
"Tags":{
"shape":"TagList",
"documentation":"The tags associated with the certificate.
"
}
}
},
"ImportCertificateResponse":{
"type":"structure",
"members":{
"Certificate":{
"shape":"Certificate",
"documentation":"The certificate to be uploaded.
"
}
}
},
"InsufficientResourceCapacityFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"There are not enough resources allocated to the database migration.
",
"exception":true
},
"Integer":{"type":"integer"},
"IntegerOptional":{"type":"integer"},
"InvalidCertificateFault":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"The certificate was not valid.
",
"exception":true
},
"InvalidResourceStateFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"The resource is in a state that prevents it from being used for database migration.
",
"exception":true
},
"InvalidSubnet":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"The subnet provided is invalid.
",
"exception":true
},
"KMSKeyNotAccessibleFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"AWS DMS cannot access the KMS key.
",
"exception":true
},
"KeyList":{
"type":"list",
"member":{"shape":"String"}
},
"ListTagsForResourceMessage":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.
"
}
},
"documentation":""
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"TagList":{
"shape":"TagList",
"documentation":"A list of tags for the resource.
"
}
},
"documentation":""
},
"Long":{"type":"long"},
"MigrationTypeValue":{
"type":"string",
"enum":[
"full-load",
"cdc",
"full-load-and-cdc"
]
},
"ModifyEndpointMessage":{
"type":"structure",
"required":["EndpointArn"],
"members":{
"EndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
},
"EndpointIdentifier":{
"shape":"String",
"documentation":"The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
"
},
"EndpointType":{
"shape":"ReplicationEndpointTypeValue",
"documentation":"The type of endpoint.
"
},
"EngineName":{
"shape":"String",
"documentation":"The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, DYNAMODB, MONGODB, SYBASE, and SQLSERVER.
"
},
"Username":{
"shape":"String",
"documentation":"The user name to be used to login to the endpoint database.
"
},
"Password":{
"shape":"SecretString",
"documentation":"The password to be used to login to the endpoint database.
"
},
"ServerName":{
"shape":"String",
"documentation":"The name of the server where the endpoint database resides.
"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"The port used by the endpoint database.
"
},
"DatabaseName":{
"shape":"String",
"documentation":"The name of the endpoint database.
"
},
"ExtraConnectionAttributes":{
"shape":"String",
"documentation":"Additional attributes associated with the connection. To reset this parameter, pass the empty string (\"\") as an argument.
"
},
"CertificateArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the certificate used for SSL connection.
"
},
"SslMode":{
"shape":"DmsSslModeValue",
"documentation":"The SSL mode to be used.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
"
},
"DynamoDbSettings":{
"shape":"DynamoDbSettings",
"documentation":"Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.
"
},
"S3Settings":{
"shape":"S3Settings",
"documentation":"Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.
"
},
"MongoDbSettings":{
"shape":"MongoDbSettings",
"documentation":"Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.
"
}
},
"documentation":""
},
"ModifyEndpointResponse":{
"type":"structure",
"members":{
"Endpoint":{
"shape":"Endpoint",
"documentation":"The modified endpoint.
"
}
},
"documentation":""
},
"ModifyEventSubscriptionMessage":{
"type":"structure",
"required":["SubscriptionName"],
"members":{
"SubscriptionName":{
"shape":"String",
"documentation":"The name of the AWS DMS event notification subscription to be modified.
"
},
"SnsTopicArn":{
"shape":"String",
"documentation":" The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
"
},
"SourceType":{
"shape":"String",
"documentation":" The type of AWS DMS resource that generates the events you want to subscribe to.
Valid values: replication-instance | migration-task
"
},
"EventCategories":{
"shape":"EventCategoriesList",
"documentation":" A list of event categories for a source type that you want to subscribe to. Use the DescribeEventCategories action to see a list of event categories.
"
},
"Enabled":{
"shape":"BooleanOptional",
"documentation":" A Boolean value; set to true to activate the subscription.
"
}
},
"documentation":""
},
"ModifyEventSubscriptionResponse":{
"type":"structure",
"members":{
"EventSubscription":{
"shape":"EventSubscription",
"documentation":"The modified event subscription.
"
}
},
"documentation":""
},
"ModifyReplicationInstanceMessage":{
"type":"structure",
"required":["ReplicationInstanceArn"],
"members":{
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication instance.
"
},
"AllocatedStorage":{
"shape":"IntegerOptional",
"documentation":"The amount of storage (in gigabytes) to be allocated for the replication instance.
"
},
"ApplyImmediately":{
"shape":"Boolean",
"documentation":"Indicates whether the changes should be applied immediately or during the next maintenance window.
"
},
"ReplicationInstanceClass":{
"shape":"String",
"documentation":"The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":" Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
"
},
"MultiAZ":{
"shape":"BooleanOptional",
"documentation":" Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
"
},
"EngineVersion":{
"shape":"String",
"documentation":"The engine version number of the replication instance.
"
},
"AllowMajorVersionUpgrade":{
"shape":"Boolean",
"documentation":"Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.
"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
"documentation":" Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version.
"
},
"ReplicationInstanceIdentifier":{
"shape":"String",
"documentation":"The replication instance identifier. This parameter is stored as a lowercase string.
"
}
},
"documentation":""
},
"ModifyReplicationInstanceResponse":{
"type":"structure",
"members":{
"ReplicationInstance":{
"shape":"ReplicationInstance",
"documentation":"The modified replication instance.
"
}
},
"documentation":""
},
"ModifyReplicationSubnetGroupMessage":{
"type":"structure",
"required":[
"ReplicationSubnetGroupIdentifier",
"SubnetIds"
],
"members":{
"ReplicationSubnetGroupIdentifier":{
"shape":"String",
"documentation":"The name of the replication instance subnet group.
"
},
"ReplicationSubnetGroupDescription":{
"shape":"String",
"documentation":"The description of the replication instance subnet group.
"
},
"SubnetIds":{
"shape":"SubnetIdentifierList",
"documentation":"A list of subnet IDs.
"
}
},
"documentation":""
},
"ModifyReplicationSubnetGroupResponse":{
"type":"structure",
"members":{
"ReplicationSubnetGroup":{
"shape":"ReplicationSubnetGroup",
"documentation":"The modified replication subnet group.
"
}
},
"documentation":""
},
"ModifyReplicationTaskMessage":{
"type":"structure",
"required":["ReplicationTaskArn"],
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication task.
"
},
"ReplicationTaskIdentifier":{
"shape":"String",
"documentation":"The replication task identifier.
Constraints:
-
Must contain from 1 to 255 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
"
},
"MigrationType":{
"shape":"MigrationTypeValue",
"documentation":"The migration type.
Valid values: full-load | cdc | full-load-and-cdc
"
},
"TableMappings":{
"shape":"String",
"documentation":"When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with \"file://\". When working with the DMS API, provide the JSON as the parameter value.
For example, --table-mappings file://mappingfile.json
"
},
"ReplicationTaskSettings":{
"shape":"String",
"documentation":"JSON file that contains settings for the task, such as target metadata settings.
"
},
"CdcStartTime":{
"shape":"TStamp",
"documentation":"The start time for the Change Data Capture (CDC) operation.
"
}
},
"documentation":""
},
"ModifyReplicationTaskResponse":{
"type":"structure",
"members":{
"ReplicationTask":{
"shape":"ReplicationTask",
"documentation":"The replication task that was modified.
"
}
},
"documentation":""
},
"MongoDbSettings":{
"type":"structure",
"members":{
"Username":{
"shape":"String",
"documentation":"The user name you use to access the MongoDB source endpoint.
"
},
"Password":{
"shape":"SecretString",
"documentation":" The password for the user account you use to access the MongoDB source endpoint.
"
},
"ServerName":{
"shape":"String",
"documentation":" The name of the server on the MongoDB source endpoint.
"
},
"Port":{
"shape":"IntegerOptional",
"documentation":" The port value for the MongoDB source endpoint.
"
},
"DatabaseName":{
"shape":"String",
"documentation":" The database name on the MongoDB source endpoint.
"
},
"AuthType":{
"shape":"AuthTypeValue",
"documentation":" The authentication type you use to access the MongoDB source endpoint.
Valid values: NO, PASSWORD
When NO is selected, user name and password parameters are not used and can be empty.
"
},
"AuthMechanism":{
"shape":"AuthMechanismValue",
"documentation":" The authentication mechanism you use to access the MongoDB source endpoint.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
"
},
"NestingLevel":{
"shape":"NestingLevelValue",
"documentation":" Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
"
},
"ExtractDocId":{
"shape":"String",
"documentation":" Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
Default value is false.
"
},
"DocsToInvestigate":{
"shape":"String",
"documentation":" Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
Must be a positive value greater than 0. Default value is 1000.
"
},
"AuthSource":{
"shape":"String",
"documentation":" The MongoDB database name. This attribute is not used when authType=NO.
The default is admin.
"
}
},
"documentation":""
},
"NestingLevelValue":{
"type":"string",
"enum":[
"none",
"one"
]
},
"OrderableReplicationInstance":{
"type":"structure",
"members":{
"EngineVersion":{
"shape":"String",
"documentation":"The version of the replication engine.
"
},
"ReplicationInstanceClass":{
"shape":"String",
"documentation":"The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
"
},
"StorageType":{
"shape":"String",
"documentation":"The type of storage used by the replication instance.
"
},
"MinAllocatedStorage":{
"shape":"Integer",
"documentation":"The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
"
},
"MaxAllocatedStorage":{
"shape":"Integer",
"documentation":"The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
"
},
"DefaultAllocatedStorage":{
"shape":"Integer",
"documentation":"The default amount of storage (in gigabytes) that is allocated for the replication instance.
"
},
"IncludedAllocatedStorage":{
"shape":"Integer",
"documentation":"The amount of storage (in gigabytes) that is allocated for the replication instance.
"
}
},
"documentation":""
},
"OrderableReplicationInstanceList":{
"type":"list",
"member":{"shape":"OrderableReplicationInstance"}
},
"RefreshSchemasMessage":{
"type":"structure",
"required":[
"EndpointArn",
"ReplicationInstanceArn"
],
"members":{
"EndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
},
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication instance.
"
}
},
"documentation":""
},
"RefreshSchemasResponse":{
"type":"structure",
"members":{
"RefreshSchemasStatus":{
"shape":"RefreshSchemasStatus",
"documentation":"The status of the refreshed schema.
"
}
},
"documentation":""
},
"RefreshSchemasStatus":{
"type":"structure",
"members":{
"EndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
},
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication instance.
"
},
"Status":{
"shape":"RefreshSchemasStatusTypeValue",
"documentation":"The status of the schema.
"
},
"LastRefreshDate":{
"shape":"TStamp",
"documentation":"The date the schema was last refreshed.
"
},
"LastFailureMessage":{
"shape":"String",
"documentation":"The last failure message for the schema.
"
}
},
"documentation":""
},
"RefreshSchemasStatusTypeValue":{
"type":"string",
"enum":[
"successful",
"failed",
"refreshing"
]
},
"ReloadTablesMessage":{
"type":"structure",
"required":[
"ReplicationTaskArn",
"TablesToReload"
],
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication instance.
"
},
"TablesToReload":{
"shape":"TableListToReload",
"documentation":"The name and schema of the table to be reloaded.
"
}
}
},
"ReloadTablesResponse":{
"type":"structure",
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication task.
"
}
}
},
"RemoveTagsFromResourceMessage":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"String",
"documentation":">The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be removed from.
"
},
"TagKeys":{
"shape":"KeyList",
"documentation":"The tag key (name) of the tag to be removed.
"
}
},
"documentation":""
},
"RemoveTagsFromResourceResponse":{
"type":"structure",
"members":{
},
"documentation":""
},
"ReplicationEndpointTypeValue":{
"type":"string",
"enum":[
"source",
"target"
]
},
"ReplicationInstance":{
"type":"structure",
"members":{
"ReplicationInstanceIdentifier":{
"shape":"String",
"documentation":"The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
"
},
"ReplicationInstanceClass":{
"shape":"String",
"documentation":"The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
"
},
"ReplicationInstanceStatus":{
"shape":"String",
"documentation":"The status of the replication instance.
"
},
"AllocatedStorage":{
"shape":"Integer",
"documentation":"The amount of storage (in gigabytes) that is allocated for the replication instance.
"
},
"InstanceCreateTime":{
"shape":"TStamp",
"documentation":"The time the replication instance was created.
"
},
"VpcSecurityGroups":{
"shape":"VpcSecurityGroupMembershipList",
"documentation":"The VPC security group for the instance.
"
},
"AvailabilityZone":{
"shape":"String",
"documentation":"The Availability Zone for the instance.
"
},
"ReplicationSubnetGroup":{
"shape":"ReplicationSubnetGroup",
"documentation":"The subnet group for the replication instance.
"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"The maintenance window times for the replication instance.
"
},
"PendingModifiedValues":{
"shape":"ReplicationPendingModifiedValues",
"documentation":"The pending modification values.
"
},
"MultiAZ":{
"shape":"Boolean",
"documentation":" Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
"
},
"EngineVersion":{
"shape":"String",
"documentation":"The engine version number of the replication instance.
"
},
"AutoMinorVersionUpgrade":{
"shape":"Boolean",
"documentation":"Boolean value indicating if minor version upgrades will be automatically applied to the instance.
"
},
"KmsKeyId":{
"shape":"String",
"documentation":"The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
"
},
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication instance.
"
},
"ReplicationInstancePublicIpAddress":{
"shape":"String",
"documentation":"The public IP address of the replication instance.
",
"deprecated":true
},
"ReplicationInstancePrivateIpAddress":{
"shape":"String",
"documentation":"The private IP address of the replication instance.
",
"deprecated":true
},
"ReplicationInstancePublicIpAddresses":{
"shape":"ReplicationInstancePublicIpAddressList",
"documentation":"The public IP address of the replication instance.
"
},
"ReplicationInstancePrivateIpAddresses":{
"shape":"ReplicationInstancePrivateIpAddressList",
"documentation":"The private IP address of the replication instance.
"
},
"PubliclyAccessible":{
"shape":"Boolean",
"documentation":" Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
"
},
"SecondaryAvailabilityZone":{
"shape":"String",
"documentation":"The availability zone of the standby replication instance in a Multi-AZ deployment.
"
}
},
"documentation":""
},
"ReplicationInstanceList":{
"type":"list",
"member":{"shape":"ReplicationInstance"}
},
"ReplicationInstancePrivateIpAddressList":{
"type":"list",
"member":{"shape":"String"}
},
"ReplicationInstancePublicIpAddressList":{
"type":"list",
"member":{"shape":"String"}
},
"ReplicationPendingModifiedValues":{
"type":"structure",
"members":{
"ReplicationInstanceClass":{
"shape":"String",
"documentation":"The compute and memory capacity of the replication instance.
Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
"
},
"AllocatedStorage":{
"shape":"IntegerOptional",
"documentation":"The amount of storage (in gigabytes) that is allocated for the replication instance.
"
},
"MultiAZ":{
"shape":"BooleanOptional",
"documentation":" Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
"
},
"EngineVersion":{
"shape":"String",
"documentation":"The engine version number of the replication instance.
"
}
},
"documentation":""
},
"ReplicationSubnetGroup":{
"type":"structure",
"members":{
"ReplicationSubnetGroupIdentifier":{
"shape":"String",
"documentation":"The identifier of the replication instance subnet group.
"
},
"ReplicationSubnetGroupDescription":{
"shape":"String",
"documentation":"The description of the replication subnet group.
"
},
"VpcId":{
"shape":"String",
"documentation":"The ID of the VPC.
"
},
"SubnetGroupStatus":{
"shape":"String",
"documentation":"The status of the subnet group.
"
},
"Subnets":{
"shape":"SubnetList",
"documentation":"The subnets that are in the subnet group.
"
}
},
"documentation":""
},
"ReplicationSubnetGroupDoesNotCoverEnoughAZs":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
",
"exception":true
},
"ReplicationSubnetGroups":{
"type":"list",
"member":{"shape":"ReplicationSubnetGroup"}
},
"ReplicationTask":{
"type":"structure",
"members":{
"ReplicationTaskIdentifier":{
"shape":"String",
"documentation":"The replication task identifier.
Constraints:
-
Must contain from 1 to 255 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
"
},
"SourceEndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
},
"TargetEndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
},
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication instance.
"
},
"MigrationType":{
"shape":"MigrationTypeValue",
"documentation":"The type of migration.
"
},
"TableMappings":{
"shape":"String",
"documentation":"Table mappings specified in the task.
"
},
"ReplicationTaskSettings":{
"shape":"String",
"documentation":"The settings for the replication task.
"
},
"Status":{
"shape":"String",
"documentation":"The status of the replication task.
"
},
"LastFailureMessage":{
"shape":"String",
"documentation":"The last error (failure) message generated for the replication instance.
"
},
"StopReason":{
"shape":"String",
"documentation":"The reason the replication task was stopped.
"
},
"ReplicationTaskCreationDate":{
"shape":"TStamp",
"documentation":"The date the replication task was created.
"
},
"ReplicationTaskStartDate":{
"shape":"TStamp",
"documentation":"The date the replication task is scheduled to start.
"
},
"ReplicationTaskArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication task.
"
},
"ReplicationTaskStats":{
"shape":"ReplicationTaskStats",
"documentation":"The statistics for the task, including elapsed time, tables loaded, and table errors.
"
}
},
"documentation":""
},
"ReplicationTaskAssessmentResult":{
"type":"structure",
"members":{
"ReplicationTaskIdentifier":{
"shape":"String",
"documentation":" The replication task identifier of the task on which the task assessment was run.
"
},
"ReplicationTaskArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication task.
"
},
"ReplicationTaskLastAssessmentDate":{
"shape":"TStamp",
"documentation":"The date the task assessment was completed.
"
},
"AssessmentStatus":{
"shape":"String",
"documentation":" The status of the task assessment.
"
},
"AssessmentResultsFile":{
"shape":"String",
"documentation":" The file containing the results of the task assessment.
"
},
"AssessmentResults":{
"shape":"String",
"documentation":" The task assessment results in JSON format.
"
},
"S3ObjectUrl":{
"shape":"String",
"documentation":" The URL of the S3 object containing the task assessment results.
"
}
},
"documentation":" The task assessment report in JSON format.
"
},
"ReplicationTaskAssessmentResultList":{
"type":"list",
"member":{"shape":"ReplicationTaskAssessmentResult"}
},
"ReplicationTaskList":{
"type":"list",
"member":{"shape":"ReplicationTask"}
},
"ReplicationTaskStats":{
"type":"structure",
"members":{
"FullLoadProgressPercent":{
"shape":"Integer",
"documentation":"The percent complete for the full load migration task.
"
},
"ElapsedTimeMillis":{
"shape":"Long",
"documentation":"The elapsed time of the task, in milliseconds.
"
},
"TablesLoaded":{
"shape":"Integer",
"documentation":"The number of tables loaded for this task.
"
},
"TablesLoading":{
"shape":"Integer",
"documentation":"The number of tables currently loading for this task.
"
},
"TablesQueued":{
"shape":"Integer",
"documentation":"The number of tables queued for this task.
"
},
"TablesErrored":{
"shape":"Integer",
"documentation":"The number of errors that have occurred during this task.
"
}
},
"documentation":""
},
"ResourceAlreadyExistsFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"The resource you are attempting to create already exists.
",
"exception":true
},
"ResourceNotFoundFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"The resource could not be found.
",
"exception":true
},
"ResourceQuotaExceededFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"The quota for this resource quota has been exceeded.
",
"exception":true
},
"S3Settings":{
"type":"structure",
"members":{
"ServiceAccessRoleArn":{
"shape":"String",
"documentation":" The Amazon Resource Name (ARN) used by the service access IAM role.
"
},
"ExternalTableDefinition":{
"shape":"String",
"documentation":"
"
},
"CsvRowDelimiter":{
"shape":"String",
"documentation":" The delimiter used to separate rows in the source files. The default is a carriage return (\\n).
"
},
"CsvDelimiter":{
"shape":"String",
"documentation":" The delimiter used to separate columns in the source files. The default is a comma.
"
},
"BucketFolder":{
"shape":"String",
"documentation":" An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
"
},
"BucketName":{
"shape":"String",
"documentation":" The name of the S3 bucket.
"
},
"CompressionType":{
"shape":"CompressionTypeValue",
"documentation":" An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
"
}
},
"documentation":""
},
"SNSInvalidTopicFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"The SNS topic is invalid.
",
"exception":true
},
"SNSNoAuthorizationFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"You are not authorized for the SNS subscription.
",
"exception":true
},
"SchemaList":{
"type":"list",
"member":{"shape":"String"}
},
"SecretString":{
"type":"string",
"sensitive":true
},
"SourceIdsList":{
"type":"list",
"member":{"shape":"String"}
},
"SourceType":{
"type":"string",
"enum":["replication-instance"]
},
"StartReplicationTaskAssessmentMessage":{
"type":"structure",
"required":["ReplicationTaskArn"],
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":" The Amazon Resource Name (ARN) of the replication task.
"
}
},
"documentation":""
},
"StartReplicationTaskAssessmentResponse":{
"type":"structure",
"members":{
"ReplicationTask":{
"shape":"ReplicationTask",
"documentation":" The assessed replication task.
"
}
},
"documentation":""
},
"StartReplicationTaskMessage":{
"type":"structure",
"required":[
"ReplicationTaskArn",
"StartReplicationTaskType"
],
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication task to be started.
"
},
"StartReplicationTaskType":{
"shape":"StartReplicationTaskTypeValue",
"documentation":"The type of replication task.
"
},
"CdcStartTime":{
"shape":"TStamp",
"documentation":"The start time for the Change Data Capture (CDC) operation.
"
}
},
"documentation":""
},
"StartReplicationTaskResponse":{
"type":"structure",
"members":{
"ReplicationTask":{
"shape":"ReplicationTask",
"documentation":"The replication task started.
"
}
},
"documentation":""
},
"StartReplicationTaskTypeValue":{
"type":"string",
"enum":[
"start-replication",
"resume-processing",
"reload-target"
]
},
"StopReplicationTaskMessage":{
"type":"structure",
"required":["ReplicationTaskArn"],
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":"The Amazon Resource Name(ARN) of the replication task to be stopped.
"
}
},
"documentation":""
},
"StopReplicationTaskResponse":{
"type":"structure",
"members":{
"ReplicationTask":{
"shape":"ReplicationTask",
"documentation":"The replication task stopped.
"
}
},
"documentation":""
},
"StorageQuotaExceededFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"The storage quota has been exceeded.
",
"exception":true
},
"String":{"type":"string"},
"Subnet":{
"type":"structure",
"members":{
"SubnetIdentifier":{
"shape":"String",
"documentation":"The subnet identifier.
"
},
"SubnetAvailabilityZone":{
"shape":"AvailabilityZone",
"documentation":"The Availability Zone of the subnet.
"
},
"SubnetStatus":{
"shape":"String",
"documentation":"The status of the subnet.
"
}
},
"documentation":""
},
"SubnetAlreadyInUse":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"The specified subnet is already in use.
",
"exception":true
},
"SubnetIdentifierList":{
"type":"list",
"member":{"shape":"String"}
},
"SubnetList":{
"type":"list",
"member":{"shape":"Subnet"}
},
"SupportedEndpointType":{
"type":"structure",
"members":{
"EngineName":{
"shape":"String",
"documentation":"The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.
"
},
"SupportsCDC":{
"shape":"Boolean",
"documentation":"Indicates if Change Data Capture (CDC) is supported.
"
},
"EndpointType":{
"shape":"ReplicationEndpointTypeValue",
"documentation":"The type of endpoint.
"
}
},
"documentation":""
},
"SupportedEndpointTypeList":{
"type":"list",
"member":{"shape":"SupportedEndpointType"}
},
"TStamp":{"type":"timestamp"},
"TableListToReload":{
"type":"list",
"member":{"shape":"TableToReload"}
},
"TableStatistics":{
"type":"structure",
"members":{
"SchemaName":{
"shape":"String",
"documentation":"The schema name.
"
},
"TableName":{
"shape":"String",
"documentation":"The name of the table.
"
},
"Inserts":{
"shape":"Long",
"documentation":"The number of insert actions performed on a table.
"
},
"Deletes":{
"shape":"Long",
"documentation":"The number of delete actions performed on a table.
"
},
"Updates":{
"shape":"Long",
"documentation":"The number of update actions performed on a table.
"
},
"Ddls":{
"shape":"Long",
"documentation":"The Data Definition Language (DDL) used to build and modify the structure of your tables.
"
},
"FullLoadRows":{
"shape":"Long",
"documentation":"The number of rows added during the Full Load operation.
"
},
"FullLoadCondtnlChkFailedRows":{
"shape":"Long",
"documentation":"The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a target migrations).
"
},
"FullLoadErrorRows":{
"shape":"Long",
"documentation":"The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).
"
},
"LastUpdateTime":{
"shape":"TStamp",
"documentation":"The last time the table was updated.
"
},
"TableState":{
"shape":"String",
"documentation":"The state of the tables described.
Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded
"
},
"ValidationPendingRecords":{
"shape":"Long",
"documentation":"The number of records that have yet to be validated.
"
},
"ValidationFailedRecords":{
"shape":"Long",
"documentation":"The number of records that failed validation.
"
},
"ValidationSuspendedRecords":{
"shape":"Long",
"documentation":"The number of records that could not be validated.
"
},
"ValidationState":{
"shape":"String",
"documentation":"The validation state of the table.
The parameter can have the following values
-
Not enabled—Validation is not enabled for the table in the migration task.
-
Pending records—Some records in the table are waiting for validation.
-
Mismatched records—Some records in the table do not match between the source and target.
-
Suspended records—Some records in the table could not be validated.
-
No primary key—The table could not be validated because it had no primary key.
-
Table error—The table was not validated because it was in an error state and some data was not migrated.
-
Validated—All rows in the table were validated. If the table is updated, the status can change from Validated.
-
Error—The table could not be validated because of an unexpected error.
"
}
},
"documentation":""
},
"TableStatisticsList":{
"type":"list",
"member":{"shape":"TableStatistics"}
},
"TableToReload":{
"type":"structure",
"members":{
"SchemaName":{
"shape":"String",
"documentation":"The schema name of the table to be reloaded.
"
},
"TableName":{
"shape":"String",
"documentation":"The table name of the table to be reloaded.
"
}
},
"documentation":""
},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"String",
"documentation":"A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
"
},
"Value":{
"shape":"String",
"documentation":"A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
"
}
},
"documentation":""
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"}
},
"TestConnectionMessage":{
"type":"structure",
"required":[
"ReplicationInstanceArn",
"EndpointArn"
],
"members":{
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) of the replication instance.
"
},
"EndpointArn":{
"shape":"String",
"documentation":"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
"
}
},
"documentation":""
},
"TestConnectionResponse":{
"type":"structure",
"members":{
"Connection":{
"shape":"Connection",
"documentation":"The connection tested.
"
}
},
"documentation":""
},
"UpgradeDependencyFailureFault":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":""
}
},
"documentation":"An upgrade dependency is preventing the database migration.
",
"exception":true
},
"VpcSecurityGroupIdList":{
"type":"list",
"member":{"shape":"String"}
},
"VpcSecurityGroupMembership":{
"type":"structure",
"members":{
"VpcSecurityGroupId":{
"shape":"String",
"documentation":"The VPC security group Id.
"
},
"Status":{
"shape":"String",
"documentation":"The status of the VPC security group.
"
}
},
"documentation":""
},
"VpcSecurityGroupMembershipList":{
"type":"list",
"member":{"shape":"VpcSecurityGroupMembership"}
}
},
"documentation":"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 the AWS DMS user guide at What Is AWS Database Migration Service?
"
}