Module types

Data structures used by operation inputs/outputs.

Modules

• builders
  Builders
• error
  Error types that AWS Database Migration Service can respond with.

Structs

• AccountQuota

  Describes a quota for an Amazon Web Services account, for example the number of replication instances allowed.

• AvailabilityZone

  The name of an Availability Zone for use during database migration. AvailabilityZone is an optional parameter to the CreateReplicationInstance operation, and it’s value relates to the Amazon Web Services Region of an endpoint. For example, the availability zone of an endpoint in the us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.

• BatchStartRecommendationsErrorEntry

  Provides information about the errors that occurred during the analysis of the source database.

• Certificate

  The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.

• CollectorHealthCheck

  Describes the last Fleet Advisor collector health check.

• CollectorResponse

  Describes a Fleet Advisor collector.

• CollectorShortInfoResponse

  Briefly describes a Fleet Advisor collector.

• ComputeConfig

  Configuration parameters for provisioning an DMS Serverless replication.

• Connection

  Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.

• DataMigration

  This object provides information about a DMS data migration.

• DataMigrationSettings

  Options for configuring a data migration, including whether to enable CloudWatch logs, and the selection rules to use to include or exclude database objects from the migration.

• DataMigrationStatistics

  Information about the data migration run, including start and stop time, latency, and migration progress.

• DataProvider

  Provides information that defines a data provider.

• DataProviderDescriptor

  Information about a data provider.

• DataProviderDescriptorDefinition

  Information about a data provider.

• DatabaseInstanceSoftwareDetailsResponse

  Describes an inventory database instance for a Fleet Advisor collector.

• DatabaseResponse

  Describes a database in a Fleet Advisor collector inventory.

• DatabaseShortInfoResponse

  Describes a database in a Fleet Advisor collector inventory.

• DefaultErrorDetails

  Provides error information about a schema conversion operation.

• DmsTransferSettings

  The settings in JSON format for the DMS Transfer type source endpoint.

• DocDbDataProviderSettings

  Provides information that defines a DocumentDB data provider.

• DocDbSettings

  Provides information that defines a DocumentDB endpoint.

• DynamoDbSettings

  Provides the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.

• ElasticsearchSettings

  Provides information that defines an OpenSearch endpoint.

• Endpoint

  Describes an endpoint of a database instance in response to operations such as the following:

  • CreateEndpoint

  • DescribeEndpoint

  • ModifyEndpoint

• EndpointSetting

  Endpoint settings.

• EngineVersion

  Provides information about a replication instance version.

• Event

  Describes an identifiable significant activity that affects a replication instance or task. This object can provide the message, the available event categories, the date and source of the event, and the DMS resource type.

• EventCategoryGroup

  Lists categories of events subscribed to, and generated by, the applicable DMS resource type. This data type appears in response to the DescribeEventCategories action.

• EventSubscription

  Describes an event notification subscription created by the CreateEventSubscription operation.

• ExportMetadataModelAssessmentResultEntry

  Provides information about an exported metadata model assessment.

• ExportSqlDetails

  Provides information about a metadata model assessment exported to SQL.

• Filter

  Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

• FleetAdvisorLsaAnalysisResponse

  Describes a large-scale assessment (LSA) analysis run by a Fleet Advisor collector.

• FleetAdvisorSchemaObjectResponse

  Describes a schema object in a Fleet Advisor collector inventory.

• GcpMySqlSettings

  Settings in JSON format for the source GCP MySQL endpoint.

• IbmDb2Settings

  Provides information that defines an IBM Db2 LUW endpoint.

• InstanceProfile

  Provides information that defines an instance profile.

• InventoryData

  Describes a Fleet Advisor collector inventory.

• KafkaSettings

  Provides information that describes an Apache Kafka endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

• KerberosAuthenticationSettings

  Specifies using Kerberos authentication settings for use with DMS.

• KinesisSettings

  Provides information that describes an Amazon Kinesis Data Stream endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

• Limitation

  Provides information about the limitations of target Amazon Web Services engines.

  Your source database might include features that the target Amazon Web Services engine doesn't support. Fleet Advisor lists these features as limitations. You should consider these limitations during database migration. For each limitation, Fleet Advisor recommends an action that you can take to address or avoid this limitation.

• MariaDbDataProviderSettings

  Provides information that defines a MariaDB data provider.

• MicrosoftSqlServerDataProviderSettings

  Provides information that defines a Microsoft SQL Server data provider.

• MicrosoftSqlServerSettings

  Provides information that defines a Microsoft SQL Server endpoint.

• MigrationProject

  Provides information that defines a migration project.

• MongoDbDataProviderSettings

  Provides information that defines a MongoDB data provider.

• MongoDbSettings

  Provides information that defines a MongoDB endpoint.

• MySqlDataProviderSettings

  Provides information that defines a MySQL data provider.

• MySqlSettings

  Provides information that defines a MySQL endpoint.

• NeptuneSettings

  Provides information that defines an Amazon Neptune endpoint.

• OracleDataProviderSettings

  Provides information that defines an Oracle data provider.

• OracleSettings

  Provides information that defines an Oracle endpoint.

• OrderableReplicationInstance

  In response to the DescribeOrderableReplicationInstances operation, this object describes an available replication instance. This description includes the replication instance's type, engine version, and allocated storage.

• PendingMaintenanceAction

  Describes a maintenance action pending for an DMS resource, including when and how it will be applied. This data type is a response element to the DescribePendingMaintenanceActions operation.

• PostgreSqlDataProviderSettings

  Provides information that defines a PostgreSQL data provider.

• PostgreSqlSettings

  Provides information that defines a PostgreSQL endpoint.

• ProvisionData

  Information about provisioning resources for an DMS serverless replication.

• RdsConfiguration

  Provides information that describes the configuration of the recommended target engine on Amazon RDS.

• RdsRecommendation

  Provides information that describes a recommendation of a target engine on Amazon RDS.

• RdsRequirements

  Provides information that describes the requirements to the target engine on Amazon RDS.

• Recommendation

  Provides information that describes a recommendation of a target engine.

  A recommendation is a set of possible Amazon Web Services target engines that you can choose to migrate your source on-premises database. In this set, Fleet Advisor suggests a single target engine as the right sized migration destination. To determine this rightsized migration destination, Fleet Advisor uses the inventory metadata and metrics from data collector. You can use recommendations before the start of migration to save costs and reduce risks.

  With recommendations, you can explore different target options and compare metrics, so you can make an informed decision when you choose the migration target.

• RecommendationData

  Provides information about the target engine for the specified source database.

• RecommendationSettings

  Provides information about the required target engine settings.

• RedisSettings

  Provides information that defines a Redis target endpoint.

• RedshiftDataProviderSettings

  Provides information that defines an Amazon Redshift data provider.

• RedshiftSettings

  Provides information that defines an Amazon Redshift endpoint.

• RefreshSchemasStatus

  Provides information that describes status of a schema at an endpoint specified by the DescribeRefreshSchemaStatus operation.

• Replication

  Provides information that describes a serverless replication created by the CreateReplication operation.

• ReplicationConfig

  This object provides configuration information about a serverless replication.

• ReplicationInstance

  Provides information that defines a replication instance.

• ReplicationInstanceTaskLog

  Contains metadata for a replication instance task log.

• ReplicationPendingModifiedValues

  Provides information about the values of pending modifications to a replication instance. This data type is an object of the ReplicationInstance user-defined data type.

• ReplicationStats

  This object provides a collection of statistics about a serverless replication.

• ReplicationSubnetGroup

  Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.

• ReplicationTask

  Provides information that describes a replication task created by the CreateReplicationTask operation.

• ReplicationTaskAssessmentResult

  The task assessment report in JSON format.

• ReplicationTaskAssessmentRun

  Provides information that describes a premigration assessment run that you have started using the StartReplicationTaskAssessmentRun operation.

  Some of the information appears based on other operations that can return the ReplicationTaskAssessmentRun object.

• ReplicationTaskAssessmentRunProgress

  The progress values reported by the AssessmentProgress response element.

• ReplicationTaskAssessmentRunResultStatistic

  The object containing the result statistics for a completed assessment run.

• ReplicationTaskIndividualAssessment

  Provides information that describes an individual assessment from a premigration assessment run.

• ReplicationTaskStats

  In response to a request by the DescribeReplicationTasks operation, this object provides a collection of statistics about a replication task.

• ResourcePendingMaintenanceActions

  Identifies an DMS resource and any pending actions for it.

• S3Settings

  Settings for exporting data to Amazon S3.

• ScApplicationAttributes

  Provides information that defines a schema conversion application.

• SchemaConversionRequest

  Provides information about a schema conversion action.

• SchemaResponse

  Describes a schema in a Fleet Advisor collector inventory.

• SchemaShortInfoResponse

  Describes a schema in a Fleet Advisor collector inventory.

• ServerShortInfoResponse

  Describes a server in a Fleet Advisor collector inventory.

• SourceDataSetting

  Defines settings for a source data provider for a data migration.

• StartRecommendationsRequestEntry

  Provides information about the source database to analyze and provide target recommendations according to the specified requirements.

• Subnet

  In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.

• SupportedEndpointType

  Provides information about types of supported endpoints in response to a request by the DescribeEndpointTypes operation. This information includes the type of endpoint, the database engine name, and whether change data capture (CDC) is supported.

• SybaseSettings

  Provides information that defines a SAP ASE endpoint.

• TableStatistics

  Provides a collection of table statistics in response to a request by the DescribeTableStatistics operation.

• TableToReload

  Provides the name of the schema and table to be reloaded.

• Tag

  A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:

  • AddTagsToResource

  • ListTagsForResource

  • RemoveTagsFromResource

• TimestreamSettings

  Provides information that defines an Amazon Timestream endpoint.

• VpcSecurityGroupMembership

  Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.

Enums

• AssessmentReportType
  When writing a match expression against AssessmentReportType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AuthMechanismValue
  When writing a match expression against AuthMechanismValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AuthTypeValue
  When writing a match expression against AuthTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CannedAclForObjectsValue
  When writing a match expression against CannedAclForObjectsValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CharLengthSemantics
  When writing a match expression against CharLengthSemantics, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CollectorStatus
  When writing a match expression against CollectorStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CompressionTypeValue
  When writing a match expression against CompressionTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DataFormatValue
  When writing a match expression against DataFormatValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DataProviderSettings

  Provides information that defines a data provider.

• DatabaseMode
  When writing a match expression against DatabaseMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DatePartitionDelimiterValue
  When writing a match expression against DatePartitionDelimiterValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DatePartitionSequenceValue
  When writing a match expression against DatePartitionSequenceValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DmsSslModeValue
  When writing a match expression against DmsSslModeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EncodingTypeValue
  When writing a match expression against EncodingTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EncryptionModeValue
  When writing a match expression against EncryptionModeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EndpointSettingTypeValue
  When writing a match expression against EndpointSettingTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ErrorDetails

  Provides error information about a project.

• KafkaSaslMechanism
  When writing a match expression against KafkaSaslMechanism, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• KafkaSecurityProtocol
  When writing a match expression against KafkaSecurityProtocol, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• KafkaSslEndpointIdentificationAlgorithm
  When writing a match expression against KafkaSslEndpointIdentificationAlgorithm, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• LongVarcharMappingType
  When writing a match expression against LongVarcharMappingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• MessageFormatValue
  When writing a match expression against MessageFormatValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• MigrationTypeValue
  When writing a match expression against MigrationTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• NestingLevelValue
  When writing a match expression against NestingLevelValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• OracleAuthenticationMethod
  When writing a match expression against OracleAuthenticationMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• OriginTypeValue
  When writing a match expression against OriginTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ParquetVersionValue
  When writing a match expression against ParquetVersionValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• PluginNameValue
  When writing a match expression against PluginNameValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RedisAuthTypeValue
  When writing a match expression against RedisAuthTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RefreshSchemasStatusTypeValue
  When writing a match expression against RefreshSchemasStatusTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ReleaseStatusValues
  When writing a match expression against ReleaseStatusValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ReloadOptionValue
  When writing a match expression against ReloadOptionValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ReplicationEndpointTypeValue
  When writing a match expression against ReplicationEndpointTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SafeguardPolicy
  When writing a match expression against SafeguardPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SourceType
  When writing a match expression against SourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SqlServerAuthenticationMethod
  When writing a match expression against SqlServerAuthenticationMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SslSecurityProtocolValue
  When writing a match expression against SslSecurityProtocolValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• StartReplicationMigrationTypeValue
  When writing a match expression against StartReplicationMigrationTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• StartReplicationTaskTypeValue
  When writing a match expression against StartReplicationTaskTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• TargetDbType
  When writing a match expression against TargetDbType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• TlogAccessMode
  When writing a match expression against TlogAccessMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• VersionStatus
  When writing a match expression against VersionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.