Database Migration Service (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 DMS, see What Is Database Migration Service? in the Database Migration Service User Guide.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: "#FFFFFF" termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: dms x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/dms-2016-01-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/dms/ servers: - url: http://dms.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Database Migration Service multi-region endpoint - url: https://dms.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Database Migration Service multi-region endpoint - url: http://dms.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Database Migration Service endpoint for China (Beijing) and China (Ningxia) - url: https://dms.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Database Migration Service endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /#X-Amz-Target=AmazonDMSv20160101.AddTagsToResource: post: operationId: AddTagsToResource description: Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet 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. For more information, seeTag data type description.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/AddTagsToResourceResponse"
"480":
description: ResourceNotFoundFault
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundFault"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AddTagsToResourceMessage"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonDMSv20160101.AddTagsToResource
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AmazonDMSv20160101.ApplyPendingMaintenanceAction:
post:
operationId: ApplyPendingMaintenanceAction
description: Applies a pending maintenance action to a resource (for example, to a replication instance).
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ApplyPendingMaintenanceActionResponse"
"480":
description: ResourceNotFoundFault
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundFault"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ApplyPendingMaintenanceActionMessage"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonDMSv20160101.ApplyPendingMaintenanceAction
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AmazonDMSv20160101.BatchStartRecommendations:
post:
operationId: BatchStartRecommendations
description: Starts the analysis of up to 20 source databases to recommend target engines for each source database. This is a batch version of StartRecommendations.
The result of analysis of each source database is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Cancels a single premigration assessment run.
This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CancelReplicationTaskAssessmentRunResponse" "480": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "481": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "482": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CancelReplicationTaskAssessmentRunMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.CancelReplicationTaskAssessmentRun parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.CreateEndpoint: post: operationId: CreateEndpoint description:Creates an endpoint using the provided settings.
For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
Creates an DMS event notification subscription.
You can specify the type of source (SourceType) you want to be notified of, provide a list of 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 DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all DMS sources belonging to your customer account.
For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateEventSubscriptionResponse" "480": description: ResourceQuotaExceededFault content: application/json: schema: $ref: "#/components/schemas/ResourceQuotaExceededFault" "481": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "482": description: ResourceAlreadyExistsFault content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsFault" "483": description: SNSInvalidTopicFault content: application/json: schema: $ref: "#/components/schemas/SNSInvalidTopicFault" "484": description: SNSNoAuthorizationFault content: application/json: schema: $ref: "#/components/schemas/SNSNoAuthorizationFault" "485": description: KMSAccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/KMSAccessDeniedFault" "486": description: KMSDisabledFault content: application/json: schema: $ref: "#/components/schemas/KMSDisabledFault" "487": description: KMSInvalidStateFault content: application/json: schema: $ref: "#/components/schemas/KMSInvalidStateFault" "488": description: KMSNotFoundFault content: application/json: schema: $ref: "#/components/schemas/KMSNotFoundFault" "489": description: KMSThrottlingFault content: application/json: schema: $ref: "#/components/schemas/KMSThrottlingFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateEventSubscriptionMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.CreateEventSubscription parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.CreateFleetAdvisorCollector: post: operationId: CreateFleetAdvisorCollector description: Creates a Fleet Advisor collector using the specified parameters. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateFleetAdvisorCollectorResponse" "480": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "481": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "482": description: S3AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/S3AccessDeniedFault" "483": description: S3ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/S3ResourceNotFoundFault" "484": description: ResourceQuotaExceededFault content: application/json: schema: $ref: "#/components/schemas/ResourceQuotaExceededFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateFleetAdvisorCollectorRequest" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.CreateFleetAdvisorCollector parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.CreateReplicationInstance: post: operationId: CreateReplicationInstance description:Creates the replication instance using the specified parameters.
DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateReplicationInstanceResponse" "480": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "481": description: ResourceAlreadyExistsFault content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsFault" "482": description: InsufficientResourceCapacityFault content: application/json: schema: $ref: "#/components/schemas/InsufficientResourceCapacityFault" "483": description: ResourceQuotaExceededFault content: application/json: schema: $ref: "#/components/schemas/ResourceQuotaExceededFault" "484": description: StorageQuotaExceededFault content: application/json: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "485": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "486": description: ReplicationSubnetGroupDoesNotCoverEnoughAZs content: application/json: schema: $ref: "#/components/schemas/ReplicationSubnetGroupDoesNotCoverEnoughAZs" "487": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "488": description: InvalidSubnet content: application/json: schema: $ref: "#/components/schemas/InvalidSubnet" "489": description: KMSKeyNotAccessibleFault content: application/json: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateReplicationInstanceMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.CreateReplicationInstance parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.CreateReplicationSubnetGroup: post: operationId: CreateReplicationSubnetGroup description:Creates a replication subnet group given a list of the subnet IDs in a VPC.
The VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.
Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
Deletes the specified replication instance.
You must delete any migration tasks that are associated with the replication instance before you can delete it.
Deletes the record of a single premigration assessment run.
This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteReplicationTaskAssessmentRunResponse" "480": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "481": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "482": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DeleteReplicationTaskAssessmentRunMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DeleteReplicationTaskAssessmentRun parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeAccountAttributes: post: operationId: DescribeAccountAttributes description:Lists all of the DMS attributes for a customer account. These attributes include DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.
This command does not take any parameters.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeAccountAttributesResponse" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeAccountAttributesMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeAccountAttributes parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeApplicableIndividualAssessments: post: operationId: DescribeApplicableIndividualAssessments description:Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.
If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.
To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.
If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeApplicableIndividualAssessmentsResponse" "480": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "481": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "482": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeApplicableIndividualAssessmentsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeApplicableIndividualAssessments parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeCertificates: post: operationId: DescribeCertificates description: Provides a description of the certificate. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeCertificatesResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeCertificatesMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeCertificates parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeConnections: post: operationId: DescribeConnections description: 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. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeConnectionsResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeConnectionsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeConnections parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeEndpointSettings: post: operationId: DescribeEndpointSettings description: Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeEndpointSettingsResponse" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeEndpointSettingsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeEndpointSettings parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeEndpointTypes: post: operationId: DescribeEndpointTypes description: Returns information about the type of endpoints available. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeEndpointTypesResponse" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeEndpointTypesMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeEndpointTypes parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeEndpoints: post: operationId: DescribeEndpoints description: Returns information about the endpoints for your account in the current region. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeEndpointsResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeEndpointsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeEndpoints parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeEventCategories: post: operationId: DescribeEventCategories description: '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 Database Migration Service User Guide. ' responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeEventCategoriesResponse" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeEventCategoriesMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeEventCategories parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeEventSubscriptions: post: operationId: DescribeEventSubscriptions description: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.
Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest results.
For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeReplicationTaskAssessmentResultsResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeReplicationTaskAssessmentResultsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeReplicationTaskAssessmentResults parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeReplicationTaskAssessmentRuns: post: operationId: DescribeReplicationTaskAssessmentRuns description:Returns a paginated list of premigration assessment runs based on filter settings.
These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values.
This operation doesn't return information about individual assessments. For this information, see the DescribeReplicationTaskIndividualAssessments operation.
Returns a paginated list of individual assessments based on filter settings.
These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeReplicationTaskIndividualAssessmentsResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeReplicationTaskIndividualAssessmentsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeReplicationTaskIndividualAssessments parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeReplicationTasks: post: operationId: DescribeReplicationTasks description: Returns information about replication tasks for your account in the current region. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeReplicationTasksResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeReplicationTasksMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeReplicationTasks parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeSchemas: post: operationId: DescribeSchemas description:Returns information about the schema for the specified endpoint.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeSchemasResponse" "480": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "481": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeSchemasMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeSchemas parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.DescribeTableStatistics: post: operationId: DescribeTableStatistics description: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 DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeTableStatisticsResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "481": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeTableStatisticsMessage" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeTableStatistics parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.ImportCertificate: post: operationId: ImportCertificate description: Uploads the specified certificate. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ImportCertificateResponse" "480": description: ResourceAlreadyExistsFault content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsFault" "481": description: InvalidCertificateFault content: application/json: schema: $ref: "#/components/schemas/InvalidCertificateFault" "482": description: ResourceQuotaExceededFault content: application/json: schema: $ref: "#/components/schemas/ResourceQuotaExceededFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ImportCertificateMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.ImportCertificate parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.ListTagsForResource: post: operationId: ListTagsForResource description: Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, seeTag data type description.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListTagsForResourceResponse"
"480":
description: ResourceNotFoundFault
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundFault"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListTagsForResourceMessage"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonDMSv20160101.ListTagsForResource
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AmazonDMSv20160101.ModifyEndpoint:
post:
operationId: ModifyEndpoint
description: Modifies the specified endpoint.
For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the ModifyEndpoint API call. Specifying DatabaseName when you modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
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.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ModifyReplicationInstanceResponse" "480": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "481": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "482": description: ResourceAlreadyExistsFault content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsFault" "483": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "484": description: InsufficientResourceCapacityFault content: application/json: schema: $ref: "#/components/schemas/InsufficientResourceCapacityFault" "485": description: StorageQuotaExceededFault content: application/json: schema: $ref: "#/components/schemas/StorageQuotaExceededFault" "486": description: UpgradeDependencyFailureFault content: application/json: schema: $ref: "#/components/schemas/UpgradeDependencyFailureFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ModifyReplicationInstanceMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.ModifyReplicationInstance parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.ModifyReplicationSubnetGroup: post: operationId: ModifyReplicationSubnetGroup description: Modifies the settings for the specified replication subnet group. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ModifyReplicationSubnetGroupResponse" "480": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "481": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "482": description: ResourceQuotaExceededFault content: application/json: schema: $ref: "#/components/schemas/ResourceQuotaExceededFault" "483": description: SubnetAlreadyInUse content: application/json: schema: $ref: "#/components/schemas/SubnetAlreadyInUse" "484": description: ReplicationSubnetGroupDoesNotCoverEnoughAZs content: application/json: schema: $ref: "#/components/schemas/ReplicationSubnetGroupDoesNotCoverEnoughAZs" "485": description: InvalidSubnet content: application/json: schema: $ref: "#/components/schemas/InvalidSubnet" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ModifyReplicationSubnetGroupMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.ModifyReplicationSubnetGroup parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.ModifyReplicationTask: post: operationId: ModifyReplicationTask description: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 DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ModifyReplicationTaskResponse" "480": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "481": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "482": description: ResourceAlreadyExistsFault content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsFault" "483": description: KMSKeyNotAccessibleFault content: application/json: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ModifyReplicationTaskMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.ModifyReplicationTask parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.MoveReplicationTask: post: operationId: MoveReplicationTask description: Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/MoveReplicationTaskResponse" "480": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "481": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "482": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "483": description: KMSKeyNotAccessibleFault content: application/json: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "484": description: ResourceQuotaExceededFault content: application/json: schema: $ref: "#/components/schemas/ResourceQuotaExceededFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/MoveReplicationTaskMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.MoveReplicationTask parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.RebootReplicationInstance: post: operationId: RebootReplicationInstance description: Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RebootReplicationInstanceResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "481": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/RebootReplicationInstanceMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.RebootReplicationInstance parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.RefreshSchemas: post: operationId: RefreshSchemas description: 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. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RefreshSchemasResponse" "480": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "481": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "482": description: KMSKeyNotAccessibleFault content: application/json: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "483": description: ResourceQuotaExceededFault content: application/json: schema: $ref: "#/components/schemas/ResourceQuotaExceededFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/RefreshSchemasMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.RefreshSchemas parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.ReloadTables: post: operationId: ReloadTables description:Reloads the target database table with the source data.
You can only use this operation with a task in the RUNNING state, otherwise the service will throw an InvalidResourceStateFault exception.
Tag data type description.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/RemoveTagsFromResourceResponse"
"480":
description: ResourceNotFoundFault
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundFault"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RemoveTagsFromResourceMessage"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonDMSv20160101.RemoveTagsFromResource
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AmazonDMSv20160101.RunFleetAdvisorLsaAnalysis:
post:
operationId: RunFleetAdvisorLsaAnalysis
description: Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/RunFleetAdvisorLsaAnalysisResponse"
"480":
description: InvalidResourceStateFault
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidResourceStateFault"
"481":
description: ResourceNotFoundFault
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundFault"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonDMSv20160101.RunFleetAdvisorLsaAnalysis
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AmazonDMSv20160101.StartRecommendations:
post:
operationId: StartRecommendations
description: Starts the analysis of your source database to provide recommendations of target engines.
You can create recommendations for multiple source databases using BatchStartRecommendations.
responses: "200": description: Success "480": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "481": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "482": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/StartRecommendationsRequest" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.StartRecommendations parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.StartReplicationTask: post: operationId: StartReplicationTask description:Starts the replication task.
For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartReplicationTaskResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "481": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "482": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/StartReplicationTaskMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.StartReplicationTask parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.StartReplicationTaskAssessment: post: operationId: StartReplicationTaskAssessment description:Starts the replication task assessment for unsupported data types in the source database.
You can only use this operation for a task if the following conditions are true:
The task must be in the stopped state.
The task must have successful connections to the source and target.
If either of these conditions are not met, an InvalidResourceStateFault error will result.
For information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartReplicationTaskAssessmentResponse" "480": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "481": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/StartReplicationTaskAssessmentMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.StartReplicationTaskAssessment parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.StartReplicationTaskAssessmentRun: post: operationId: StartReplicationTaskAssessmentRun description:Starts a new premigration assessment run for one or more individual assessments of a migration task.
The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartReplicationTaskAssessmentRunResponse" "480": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "481": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "482": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "483": description: KMSAccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/KMSAccessDeniedFault" "484": description: KMSDisabledFault content: application/json: schema: $ref: "#/components/schemas/KMSDisabledFault" "485": description: KMSFault content: application/json: schema: $ref: "#/components/schemas/KMSFault" "486": description: KMSInvalidStateFault content: application/json: schema: $ref: "#/components/schemas/KMSInvalidStateFault" "487": description: KMSNotFoundFault content: application/json: schema: $ref: "#/components/schemas/KMSNotFoundFault" "488": description: KMSKeyNotAccessibleFault content: application/json: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "489": description: S3AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/S3AccessDeniedFault" "490": description: S3ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/S3ResourceNotFoundFault" "491": description: ResourceAlreadyExistsFault content: application/json: schema: $ref: "#/components/schemas/ResourceAlreadyExistsFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/StartReplicationTaskAssessmentRunMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.StartReplicationTaskAssessmentRun parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.StopReplicationTask: post: operationId: StopReplicationTask description: Stops the replication task. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StopReplicationTaskResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "481": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/StopReplicationTaskMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.StopReplicationTask parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.TestConnection: post: operationId: TestConnection description: Tests the connection between the replication instance and the endpoint. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/TestConnectionResponse" "480": description: ResourceNotFoundFault content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundFault" "481": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" "482": description: KMSKeyNotAccessibleFault content: application/json: schema: $ref: "#/components/schemas/KMSKeyNotAccessibleFault" "483": description: ResourceQuotaExceededFault content: application/json: schema: $ref: "#/components/schemas/ResourceQuotaExceededFault" "484": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/TestConnectionMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.TestConnection parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=AmazonDMSv20160101.UpdateSubscriptionsToEventBridge: post: operationId: UpdateSubscriptionsToEventBridge description:Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules. By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.6 or higher. If any replication instances are from versions earlier than 3.4.6, the operation raises an error and tells you to upgrade these instances to version 3.4.6 or higher. To enable migration regardless of version, set the Force option to true. However, if you don't upgrade instances earlier than version 3.4.6, some types of events might not be available when you use Amazon EventBridge.
To call this operation, make sure that you have certain permissions added to your user account. For more information, see Migrating event subscriptions to Amazon EventBridge in the Amazon Web Services Database Migration Service User Guide.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateSubscriptionsToEventBridgeResponse" "480": description: AccessDeniedFault content: application/json: schema: $ref: "#/components/schemas/AccessDeniedFault" "481": description: InvalidResourceStateFault content: application/json: schema: $ref: "#/components/schemas/InvalidResourceStateFault" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateSubscriptionsToEventBridgeMessage" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.UpdateSubscriptionsToEventBridge parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: AddTagsToResourceResponse: type: object example: {} properties: {} description: AddTagsToResourceMessage: type: object required: - ResourceArn - Tags title: AddTagsToResourceMessage properties: ResourceArn: allOf: - $ref: "#/components/schemas/String" - description:Identifies the DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).
For DMS, you can tag a replication instance, an endpoint, or a replication task.
Tags: allOf: - $ref: "#/components/schemas/TagList" - description: One or more tags to be assigned to the resource. description: Associates a set of tags with an DMS resource. ResourceNotFoundFault: {} ApplyPendingMaintenanceActionResponse: type: object properties: ResourcePendingMaintenanceActions: allOf: - $ref: "#/components/schemas/ResourcePendingMaintenanceActions" - description: The DMS resource that the pending maintenance action will be applied to. description: ApplyPendingMaintenanceActionMessage: type: object required: - ReplicationInstanceArn - ApplyAction - OptInType title: ApplyPendingMaintenanceActionMessage properties: ReplicationInstanceArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. ApplyAction: allOf: - $ref: "#/components/schemas/String" - description: "The pending maintenance action to apply to this resource.
Valid values: os-upgrade, system-update, db-upgrade
A value that specifies the type of opt-in request, or undoes an opt-in request. You can't undo an opt-in request of type immediate.
Valid values:
immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.
ReplicationTaskAssessmentRun object for the canceled assessment run.
description:
CancelReplicationTaskAssessmentRunMessage:
type: object
required:
- ReplicationTaskAssessmentRunArn
title: CancelReplicationTaskAssessmentRunMessage
properties:
ReplicationTaskAssessmentRunArn:
allOf:
- $ref: "#/components/schemas/String"
- description: Amazon Resource Name (ARN) of the premigration assessment run to be canceled.
description:
CreateEndpointResponse:
type: object
example:
Endpoint:
EndpointArn: arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM
EndpointIdentifier: test-endpoint-1
EndpointType: source
EngineName: mysql
KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd
Port: 3306
ServerName: mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com
Status: active
Username: username
properties:
Endpoint:
allOf:
- $ref: "#/components/schemas/Endpoint"
- description: The endpoint that was created.
description:
CreateEndpointMessage:
type: object
required:
- EndpointIdentifier
- EndpointType
- EngineName
title: CreateEndpointMessage
properties:
EndpointIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
EndpointType:
allOf:
- $ref: "#/components/schemas/ReplicationEndpointTypeValue"
- description: The type of endpoint. Valid values are source and target.
EngineName:
allOf:
- $ref: "#/components/schemas/String"
- description: The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", and "babelfish".
Username:
allOf:
- $ref: "#/components/schemas/String"
- description: The user name to be used to log in to the endpoint database.
Password:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: The password to be used to log in to the endpoint database.
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the server where the endpoint database resides.
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The port used by the endpoint database.
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
ExtraConnectionAttributes:
allOf:
- $ref: "#/components/schemas/String"
- description: 'Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide. '
KmsKeyId:
allOf:
- $ref: "#/components/schemas/String"
- description: An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
Tags: allOf: - $ref: "#/components/schemas/TagList" - description: One or more tags to be assigned to the endpoint. CertificateArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) for the certificate. SslMode: allOf: - $ref: "#/components/schemas/DmsSslModeValue" - description: "The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default isnone "
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: " The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action."
ExternalTableDefinition:
allOf:
- $ref: "#/components/schemas/String"
- description: "The external table definition. "
DynamoDbSettings:
allOf:
- $ref: "#/components/schemas/DynamoDbSettings"
- description: 'Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide. '
S3Settings:
allOf:
- $ref: "#/components/schemas/S3Settings"
- description: 'Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide. '
DmsTransferSettings:
allOf:
- $ref: "#/components/schemas/DmsTransferSettings"
- description: 'The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.
BucketName - The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }
EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
DocDbSettings:
$ref: "#/components/schemas/DocDbSettings"
RedisSettings:
allOf:
- $ref: "#/components/schemas/RedisSettings"
- description: Settings in JSON format for the target Redis endpoint.
GcpMySQLSettings:
allOf:
- $ref: "#/components/schemas/GcpMySQLSettings"
- description: Settings in JSON format for the source GCP MySQL endpoint.
description:
KMSKeyNotAccessibleFault: {}
ResourceAlreadyExistsFault: {}
ResourceQuotaExceededFault: {}
S3AccessDeniedFault: {}
CreateEventSubscriptionResponse:
type: object
properties:
EventSubscription:
allOf:
- $ref: "#/components/schemas/EventSubscription"
- description: The event subscription that was created.
description:
CreateEventSubscriptionMessage:
type: object
required:
- SubscriptionName
- SnsTopicArn
title: CreateEventSubscriptionMessage
properties:
SubscriptionName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DMS event notification subscription. This name must be less than 255 characters.
SnsTopicArn:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/String"
- description: " The type of 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 isn't specified, all events are returned.
Valid values: replication-instance | replication-task
A list of identifiers for which DMS provides notification events.
If you don't specify a value, notifications are provided for all sources.
If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
Enabled: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: " A Boolean value; set totrue to activate the subscription, or set to false to create the subscription but not activate it. "
Tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: One or more tags to be assigned to the event subscription.
description:
SNSInvalidTopicFault: {}
SNSNoAuthorizationFault: {}
KMSAccessDeniedFault: {}
KMSDisabledFault: {}
KMSInvalidStateFault: {}
KMSNotFoundFault: {}
KMSThrottlingFault: {}
CreateFleetAdvisorCollectorResponse:
type: object
properties:
CollectorReferencedId:
allOf:
- $ref: "#/components/schemas/String"
- description: "The unique ID of the new Fleet Advisor collector, for example: 22fda70c-40d5-4acf-b233-a495bd8eb7f5 "
CollectorName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the new Fleet Advisor collector.
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: A summary description of the Fleet Advisor collector.
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The IAM role that grants permissions to access the specified Amazon S3 bucket.
S3BucketName:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon S3 bucket that the collector uses to store inventory metadata.
CreateFleetAdvisorCollectorRequest:
type: object
required:
- CollectorName
- ServiceAccessRoleArn
- S3BucketName
title: CreateFleetAdvisorCollectorRequest
properties:
CollectorName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of your Fleet Advisor collector (for example, sample-collector).
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: A summary description of your Fleet Advisor collector.
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The IAM role that grants permissions to access the specified Amazon S3 bucket.
S3BucketName:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.
S3ResourceNotFoundFault: {}
CreateReplicationInstanceResponse:
type: object
example:
ReplicationInstance:
AllocatedStorage: 5
AutoMinorVersionUpgrade: true
EngineVersion: 1.5.0
KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd
PendingModifiedValues: {}
PreferredMaintenanceWindow: sun:06:00-sun:14:00
PubliclyAccessible: true
ReplicationInstanceArn: arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ
ReplicationInstanceClass: dms.t2.micro
ReplicationInstanceIdentifier: test-rep-1
ReplicationInstanceStatus: creating
ReplicationSubnetGroup:
ReplicationSubnetGroupDescription: default
ReplicationSubnetGroupIdentifier: default
SubnetGroupStatus: Complete
Subnets:
- SubnetAvailabilityZone:
Name: us-east-1d
SubnetIdentifier: subnet-f6dd91af
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1b
SubnetIdentifier: subnet-3605751d
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1c
SubnetIdentifier: subnet-c2daefb5
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1e
SubnetIdentifier: subnet-85e90cb8
SubnetStatus: Active
VpcId: vpc-6741a603
properties:
ReplicationInstance:
allOf:
- $ref: "#/components/schemas/ReplicationInstance"
- description: The replication instance that was created.
description:
CreateReplicationInstanceMessage:
type: object
required:
- ReplicationInstanceIdentifier
- ReplicationInstanceClass
title: CreateReplicationInstanceMessage
properties:
ReplicationInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: "The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
VpcSecurityGroupIds: allOf: - $ref: "#/components/schemas/VpcSecurityGroupIdList" - description: " 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: allOf: - $ref: "#/components/schemas/String" - description: "The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example:us-east-1d "
ReplicationSubnetGroupIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: A subnet group to associate with the replication instance.
PreferredMaintenanceWindow:
allOf:
- $ref: "#/components/schemas/String"
- description: "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 Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
" MultiAZ: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: " Specifies whether the replication instance is a Multi-AZ deployment. You can't set theAvailabilityZone parameter if the Multi-AZ parameter is set to true. "
EngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
AutoMinorVersionUpgrade: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to true.
Default: true
When AutoMinorVersionUpgrade is enabled, DMS uses the current default engine version when you create a replication instance. For example, if you set EngineVersion to a lower version number than the current default version, DMS uses the default version.
If AutoMinorVersionUpgrade isn’t enabled when you create a replication instance, DMS uses the engine version specified by the EngineVersion parameter.
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
PubliclyAccessible: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: " Specifies the accessibility options for the replication instance. A value oftrue 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. "
DnsNameServers:
allOf:
- $ref: "#/components/schemas/String"
- description: 'A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4" '
ResourceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
NetworkType:
allOf:
- $ref: "#/components/schemas/String"
- description: The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
description:
InsufficientResourceCapacityFault: {}
StorageQuotaExceededFault: {}
ReplicationSubnetGroupDoesNotCoverEnoughAZs: {}
InvalidSubnet: {}
CreateReplicationSubnetGroupResponse:
type: object
example:
ReplicationSubnetGroup: {}
properties:
ReplicationSubnetGroup:
allOf:
- $ref: "#/components/schemas/ReplicationSubnetGroup"
- description: The replication subnet group that was created.
description:
CreateReplicationSubnetGroupMessage:
type: object
required:
- ReplicationSubnetGroupIdentifier
- ReplicationSubnetGroupDescription
- SubnetIds
title: CreateReplicationSubnetGroupMessage
properties:
ReplicationSubnetGroupIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: '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
An identifier for the replication task.
Constraints:
Must contain 1-255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
full-load | cdc | full-load-and-cdc "
TableMappings:
allOf:
- $ref: "#/components/schemas/String"
- description: 'The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the Database Migration Service User Guide. '
ReplicationTaskSettings:
allOf:
- $ref: "#/components/schemas/String"
- description: 'Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for Database Migration Service Tasks in the Database Migration Service User Guide. '
CdcStartTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: "Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
" CdcStartPosition: allOf: - $ref: "#/components/schemas/String" - description: 'Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" Tags: allOf: - $ref: "#/components/schemas/TagList" - description: One or more tags to be assigned to the replication task. TaskData: allOf: - $ref: "#/components/schemas/String" - description: 'Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide. ' ResourceIdentifier: allOf: - $ref: "#/components/schemas/String" - description: A friendly name for the resource identifier at the end of theEndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
description:
DeleteCertificateResponse:
type: object
example:
Certificate: {}
properties:
Certificate:
allOf:
- $ref: "#/components/schemas/Certificate"
- description: The Secure Sockets Layer (SSL) certificate.
DeleteCertificateMessage:
type: object
required:
- CertificateArn
title: DeleteCertificateMessage
properties:
CertificateArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the certificate.
DeleteConnectionResponse:
type: object
example:
Connection: {}
properties:
Connection:
allOf:
- $ref: "#/components/schemas/Connection"
- description: The connection that is being deleted.
description:
DeleteConnectionMessage:
type: object
required:
- EndpointArn
- ReplicationInstanceArn
title: DeleteConnectionMessage
properties:
EndpointArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication instance.
description:
DeleteEndpointResponse:
type: object
example:
Endpoint:
EndpointArn: arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM
EndpointIdentifier: test-endpoint-1
EndpointType: source
EngineName: mysql
KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd
Port: 3306
ServerName: mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com
Status: active
Username: username
properties:
Endpoint:
allOf:
- $ref: "#/components/schemas/Endpoint"
- description: The endpoint that was deleted.
description:
DeleteEndpointMessage:
type: object
required:
- EndpointArn
title: DeleteEndpointMessage
properties:
EndpointArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
description:
DeleteEventSubscriptionResponse:
type: object
properties:
EventSubscription:
allOf:
- $ref: "#/components/schemas/EventSubscription"
- description: The event subscription that was deleted.
description:
DeleteEventSubscriptionMessage:
type: object
required:
- SubscriptionName
title: DeleteEventSubscriptionMessage
properties:
SubscriptionName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DMS event notification subscription to be deleted.
description:
DeleteCollectorRequest:
type: object
required:
- CollectorReferencedId
title: DeleteCollectorRequest
properties:
CollectorReferencedId:
allOf:
- $ref: "#/components/schemas/String"
- description: The reference ID of the Fleet Advisor collector to delete.
CollectorNotFoundFault: {}
DeleteFleetAdvisorDatabasesResponse:
type: object
properties:
DatabaseIds:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The IDs of the databases that the operation deleted.
DeleteFleetAdvisorDatabasesRequest:
type: object
required:
- DatabaseIds
title: DeleteFleetAdvisorDatabasesRequest
properties:
DatabaseIds:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The IDs of the Fleet Advisor collector databases to delete.
InvalidOperationFault: {}
DeleteReplicationInstanceResponse:
type: object
example:
ReplicationInstance:
AllocatedStorage: 5
AutoMinorVersionUpgrade: true
EngineVersion: 1.5.0
KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd
PendingModifiedValues: {}
PreferredMaintenanceWindow: sun:06:00-sun:14:00
PubliclyAccessible: true
ReplicationInstanceArn: arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ
ReplicationInstanceClass: dms.t2.micro
ReplicationInstanceIdentifier: test-rep-1
ReplicationInstanceStatus: creating
ReplicationSubnetGroup:
ReplicationSubnetGroupDescription: default
ReplicationSubnetGroupIdentifier: default
SubnetGroupStatus: Complete
Subnets:
- SubnetAvailabilityZone:
Name: us-east-1d
SubnetIdentifier: subnet-f6dd91af
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1b
SubnetIdentifier: subnet-3605751d
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1c
SubnetIdentifier: subnet-c2daefb5
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1e
SubnetIdentifier: subnet-85e90cb8
SubnetStatus: Active
VpcId: vpc-6741a603
properties:
ReplicationInstance:
allOf:
- $ref: "#/components/schemas/ReplicationInstance"
- description: The replication instance that was deleted.
description:
DeleteReplicationInstanceMessage:
type: object
required:
- ReplicationInstanceArn
title: DeleteReplicationInstanceMessage
properties:
ReplicationInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication instance to be deleted.
description:
DeleteReplicationSubnetGroupResponse:
type: object
example: {}
properties: {}
description:
DeleteReplicationSubnetGroupMessage:
type: object
required:
- ReplicationSubnetGroupIdentifier
title: DeleteReplicationSubnetGroupMessage
properties:
ReplicationSubnetGroupIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The subnet group name of the replication instance.
description:
DeleteReplicationTaskResponse:
type: object
example:
ReplicationTask:
MigrationType: full-load
ReplicationInstanceArn: arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ
ReplicationTaskArn: arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM
ReplicationTaskCreationDate: 2016-12-14T18:25:43Z
ReplicationTaskIdentifier: task1
ReplicationTaskSettings: '{"TargetMetadata":{"TargetSchema":"","SupportLobs":true,"FullLobMode":true,"LobChunkSize":64,"LimitedSizeLobMode":false,"LobMaxSize":0},"FullLoadSettings":{"FullLoadEnabled":true,"ApplyChangesEnabled":false,"TargetTablePrepMode":"DROP_AND_CREATE","CreatePkAfterFullLoad":false,"StopTaskCachedChangesApplied":false,"StopTaskCachedChangesNotApplied":false,"ResumeEnabled":false,"ResumeMinTableSize":100000,"ResumeOnlyClusteredPKTables":true,"MaxFullLoadSubTasks":8,"TransactionConsistencyTimeout":600,"CommitRate":10000},"Logging":{"EnableLogging":false}}'
SourceEndpointArn: arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE
Status: creating
TableMappings: file://mappingfile.json
TargetEndpointArn: arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E
properties:
ReplicationTask:
allOf:
- $ref: "#/components/schemas/ReplicationTask"
- description: The deleted replication task.
description:
DeleteReplicationTaskMessage:
type: object
required:
- ReplicationTaskArn
title: DeleteReplicationTaskMessage
properties:
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication task to be deleted.
description:
DeleteReplicationTaskAssessmentRunResponse:
type: object
properties:
ReplicationTaskAssessmentRun:
allOf:
- $ref: "#/components/schemas/ReplicationTaskAssessmentRun"
- description: The ReplicationTaskAssessmentRun object for the deleted assessment run.
description:
DeleteReplicationTaskAssessmentRunMessage:
type: object
required:
- ReplicationTaskAssessmentRunArn
title: DeleteReplicationTaskAssessmentRunMessage
properties:
ReplicationTaskAssessmentRunArn:
allOf:
- $ref: "#/components/schemas/String"
- description: Amazon Resource Name (ARN) of the premigration assessment run to be deleted.
description:
DescribeAccountAttributesResponse:
type: object
example:
AccountQuotas:
- AccountQuotaName: ReplicationInstances
Max: 20
Used: 0
- AccountQuotaName: AllocatedStorage
Max: 20
Used: 0
- AccountQuotaName: Endpoints
Max: 20
Used: 0
properties:
AccountQuotas:
allOf:
- $ref: "#/components/schemas/AccountQuotaList"
- description: Account quota information.
UniqueAccountIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: "A unique DMS identifier for an account in a particular Amazon Web Services Region. The value of this identifier has the following format: c99999999999. DMS uses this identifier to name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given Amazon Web Services Region. The format of this S3 bucket name is the following: dms-AccountNumber-UniqueAccountIdentifier. Here is an example name for this default S3 bucket: dms-111122223333-c44445555666.
DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.
Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.
description:
DescribeApplicableIndividualAssessmentsMessage:
type: object
title: DescribeApplicableIndividualAssessmentsMessage
properties:
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.
ReplicationInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: ARN of a replication instance on which you want to base the default list of individual assessments.
SourceEngineName:
allOf:
- $ref: "#/components/schemas/String"
- description: Name of a database engine that the specified replication instance supports as a source.
TargetEngineName:
allOf:
- $ref: "#/components/schemas/String"
- description: Name of a database engine that the specified replication instance supports as a target.
MigrationType:
allOf:
- $ref: "#/components/schemas/MigrationTypeValue"
- description: Name of the migration type that each provided individual assessment must support.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: 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.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
description:
DescribeCertificatesResponse:
type: object
example:
Certificates: []
Marker: ""
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: The pagination token.
Certificates:
allOf:
- $ref: "#/components/schemas/CertificateList"
- description: The Secure Sockets Layer (SSL) certificates associated with the replication instance.
DescribeCertificatesMessage:
type: object
title: DescribeCertificatesMessage
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: Filters applied to the certificates described in the form of key-value pairs. Valid values are certificate-arn and certificate-id.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
DescribeConnectionsResponse:
type: object
example:
Connections:
- EndpointArn: arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE
EndpointIdentifier: testsrc1
ReplicationInstanceArn: arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ
ReplicationInstanceIdentifier: test
Status: successful
Marker: ""
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/ConnectionList"
- description: A description of the connections.
description:
DescribeConnectionsMessage:
type: object
title: DescribeConnectionsMessage
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "The filters applied to the connection.
Valid filter names: endpoint-arn | replication-instance-arn
" MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
description:
DescribeEndpointSettingsResponse:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
EndpointSettings:
allOf:
- $ref: "#/components/schemas/EndpointSettingsList"
- description: Descriptions of the endpoint settings available for your source or target database engine.
DescribeEndpointSettingsMessage:
type: object
required:
- EngineName
title: DescribeEndpointSettingsMessage
properties:
EngineName:
allOf:
- $ref: "#/components/schemas/String"
- description: The databse engine used for your source or target endpoint.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: 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.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
DescribeEndpointTypesResponse:
type: object
example:
Marker: ""
SupportedEndpointTypes: []
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/SupportedEndpointTypeList"
- description: The types of endpoints that are supported.
description:
DescribeEndpointTypesMessage:
type: object
title: DescribeEndpointTypesMessage
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "Filters applied to the endpoint types.
Valid filter names: engine-name | endpoint-type
" MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
description:
DescribeEndpointsResponse:
type: object
example:
Endpoints: []
Marker: ""
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/EndpointList"
- description: Endpoint description.
description:
DescribeEndpointsMessage:
type: object
title: DescribeEndpointsMessage
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "Filters applied to the endpoints.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
" MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
description:
DescribeEventCategoriesResponse:
type: object
properties:
EventCategoryGroupList:
allOf:
- $ref: "#/components/schemas/EventCategoryGroupList"
- description: A list of event categories.
description:
DescribeEventCategoriesMessage:
type: object
title: DescribeEventCategoriesMessage
properties:
SourceType:
allOf:
- $ref: "#/components/schemas/String"
- description: "The type of DMS resource that generates events.
Valid values: replication-instance | replication-task
" Filters: allOf: - $ref: "#/components/schemas/FilterList" - description: Filters applied to the event categories. description: DescribeEventSubscriptionsResponse: type: object properties: Marker: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
EventSubscriptionsList:
allOf:
- $ref: "#/components/schemas/EventSubscriptionsList"
- description: A list of event subscriptions.
description:
DescribeEventSubscriptionsMessage:
type: object
title: DescribeEventSubscriptionsMessage
properties:
SubscriptionName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the DMS event subscription to be described.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "Filters applied to event subscriptions.
Valid filter names: event-subscription-arn | event-subscription-id
" MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
description:
DescribeEventsResponse:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/EventList"
- description: The events described.
description:
DescribeEventsMessage:
type: object
title: DescribeEventsMessage
properties:
SourceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: " The identifier of an event source."
SourceType:
allOf:
- $ref: "#/components/schemas/SourceType"
- description: "The type of DMS resource that generates events.
Valid values: replication-instance | replication-task
" StartTime: allOf: - $ref: "#/components/schemas/TStamp" - description: The start time for the events to be listed. EndTime: allOf: - $ref: "#/components/schemas/TStamp" - description: The end time for the events to be listed. Duration: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: The duration of the events to be listed. EventCategories: allOf: - $ref: "#/components/schemas/EventCategoriesList" - description: A list of event categories for the source type that you've chosen. Filters: allOf: - $ref: "#/components/schemas/FilterList" - description: Filters applied to events. The only valid filter isreplication-instance-id.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
description:
DescribeFleetAdvisorCollectorsResponse:
type: object
properties:
Collectors:
allOf:
- $ref: "#/components/schemas/CollectorResponses"
- description: "Provides descriptions of the Fleet Advisor collectors, including the collectors' name and ID, and the latest inventory data. "
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. "
DescribeFleetAdvisorCollectorsRequest:
type: object
title: DescribeFleetAdvisorCollectorsRequest
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: 'If you specify any of the following filters, the output includes information for only those collectors that meet the filter criteria:
collector-referenced-id – The ID of the collector agent, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.
collector-name – The name of the collector agent.
An example is: describe-fleet-advisor-collectors --filter Name="collector-referenced-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d"
NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. "
DescribeFleetAdvisorDatabasesResponse:
type: object
properties:
Databases:
allOf:
- $ref: "#/components/schemas/DatabaseList"
- description: Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID, and name.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. "
DescribeFleetAdvisorDatabasesRequest:
type: object
title: DescribeFleetAdvisorDatabasesRequest
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: 'If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria:
database-id – The ID of the database.
database-name – The name of the database.
database-engine – The name of the database engine.
server-ip-address – The IP address of the database server.
database-ip-address – The IP address of the database.
collector-name – The name of the associated Fleet Advisor collector.
An example is: describe-fleet-advisor-databases --filter Name="database-id",Values="45"
NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. "
DescribeFleetAdvisorLsaAnalysisResponse:
type: object
properties:
Analysis:
allOf:
- $ref: "#/components/schemas/FleetAdvisorLsaAnalysisResponseList"
- description: A list of FleetAdvisorLsaAnalysisResponse objects.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. "
DescribeFleetAdvisorLsaAnalysisRequest:
type: object
title: DescribeFleetAdvisorLsaAnalysisRequest
properties:
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Sets the maximum number of records returned in the response.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: "If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. "
DescribeFleetAdvisorSchemaObjectSummaryResponse:
type: object
properties:
FleetAdvisorSchemaObjects:
allOf:
- $ref: "#/components/schemas/FleetAdvisorSchemaObjectList"
- description: A collection of FleetAdvisorSchemaObjectResponse objects.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. "
DescribeFleetAdvisorSchemaObjectSummaryRequest:
type: object
title: DescribeFleetAdvisorSchemaObjectSummaryRequest
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: 'If you specify any of the following filters, the output includes information for only those schema objects that meet the filter criteria:
schema-id – The ID of the schema, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.
Example: describe-fleet-advisor-schema-object-summary --filter Name="schema-id",Values="50"
NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. "
DescribeFleetAdvisorSchemasResponse:
type: object
properties:
FleetAdvisorSchemas:
allOf:
- $ref: "#/components/schemas/FleetAdvisorSchemaList"
- description: A collection of SchemaResponse objects.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. "
DescribeFleetAdvisorSchemasRequest:
type: object
title: DescribeFleetAdvisorSchemasRequest
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "If you specify any of the following filters, the output includes information for only those schemas that meet the filter criteria:
complexity – The schema's complexity, for example Simple.
database-id – The ID of the schema's database.
database-ip-address – The IP address of the schema's database.
database-name – The name of the schema's database.
database-engine – The name of the schema database's engine.
original-schema-name – The name of the schema's database's main schema.
schema-id – The ID of the schema, for example 15.
schema-name – The name of the schema.
server-ip-address – The IP address of the schema database's server.
An example is: describe-fleet-advisor-schemas --filter Name=\"schema-id\",Values=\"50\"
NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. "
DescribeOrderableReplicationInstancesResponse:
type: object
example:
Marker: ""
OrderableReplicationInstances: []
properties:
OrderableReplicationInstances:
allOf:
- $ref: "#/components/schemas/OrderableReplicationInstanceList"
- description: The order-able replication instances available.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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. "
description:
DescribeOrderableReplicationInstancesMessage:
type: object
title: DescribeOrderableReplicationInstancesMessage
properties:
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
description:
DescribePendingMaintenanceActionsResponse:
type: object
properties:
PendingMaintenanceActions:
allOf:
- $ref: "#/components/schemas/PendingMaintenanceActions"
- description: The pending maintenance action.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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. "
description:
DescribePendingMaintenanceActionsMessage:
type: object
title: DescribePendingMaintenanceActionsMessage
properties:
ReplicationInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication instance.
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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. "
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: " 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.
" description: DescribeRecommendationLimitationsResponse: type: object properties: NextToken: allOf: - $ref: "#/components/schemas/String" - description: The unique pagination token returned for you to pass to a subsequent request. Fleet Advisor returns this token when the number of records in the response is greater than theMaxRecords value. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Limitations:
allOf:
- $ref: "#/components/schemas/LimitationList"
- description: The list of limitations for recommendations of target Amazon Web Services engines.
DescribeRecommendationLimitationsRequest:
type: object
title: DescribeRecommendationLimitationsRequest
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: Filters applied to the limitations described in the form of key-value pairs.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, Fleet Advisor includes a pagination token in the response so that you can retrieve the remaining results.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
MaxRecords value. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Recommendations:
allOf:
- $ref: "#/components/schemas/RecommendationList"
- description: The list of recommendations of target engines that Fleet Advisor created for the source database.
DescribeRecommendationsRequest:
type: object
title: DescribeRecommendationsRequest
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: Filters applied to the target engine recommendations described in the form of key-value pairs.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, Fleet Advisor includes a pagination token in the response so that you can retrieve the remaining results.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
MaxRecords."
DescribeReplicationInstanceTaskLogsMessage:
type: object
required:
- ReplicationInstanceArn
title: DescribeReplicationInstanceTaskLogsMessage
properties:
ReplicationInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication instance.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords."
DescribeReplicationInstancesResponse:
type: object
example:
Marker: ""
ReplicationInstances: []
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/ReplicationInstanceList"
- description: The replication instances described.
description:
DescribeReplicationInstancesMessage:
type: object
title: DescribeReplicationInstancesMessage
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "Filters applied to replication instances.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
" MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
description:
DescribeReplicationSubnetGroupsResponse:
type: object
example:
Marker: ""
ReplicationSubnetGroups: []
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/ReplicationSubnetGroups"
- description: A description of the replication subnet groups.
description:
DescribeReplicationSubnetGroupsMessage:
type: object
title: DescribeReplicationSubnetGroupsMessage
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "Filters applied to replication subnet groups.
Valid filter names: replication-subnet-group-id
" MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
description:
DescribeReplicationTaskAssessmentResultsResponse:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/String"
- description: "- The Amazon S3 bucket where the task assessment report is located. "
ReplicationTaskAssessmentResults:
allOf:
- $ref: "#/components/schemas/ReplicationTaskAssessmentResultList"
- description: " The task assessment report. "
description:
DescribeReplicationTaskAssessmentResultsMessage:
type: object
title: DescribeReplicationTaskAssessmentResultsMessage
properties:
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: "The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified, the API returns only one result and ignore the values of the MaxRecords and Marker parameters. "
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
description:
DescribeReplicationTaskAssessmentRunsResponse:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: A pagination token returned for you to pass to a subsequent request. If you pass this token as the Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.
ReplicationTaskAssessmentRuns:
allOf:
- $ref: "#/components/schemas/ReplicationTaskAssessmentRunList"
- description: One or more premigration assessment runs as specified by Filters.
description:
DescribeReplicationTaskAssessmentRunsMessage:
type: object
title: DescribeReplicationTaskAssessmentRunsMessage
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "Filters applied to the premigration assessment runs described in the form of key-value pairs.
Valid filter names: replication-task-assessment-run-arn, replication-task-arn, replication-instance-arn, status
MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
description:
DescribeReplicationTaskIndividualAssessmentsResponse:
type: object
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: A pagination token returned for you to pass to a subsequent request. If you pass this token as the Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.
ReplicationTaskIndividualAssessments:
allOf:
- $ref: "#/components/schemas/ReplicationTaskIndividualAssessmentList"
- description: One or more individual assessments as specified by Filters.
description:
DescribeReplicationTaskIndividualAssessmentsMessage:
type: object
title: DescribeReplicationTaskIndividualAssessmentsMessage
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "Filters applied to the individual assessments described in the form of key-value pairs.
Valid filter names: replication-task-assessment-run-arn, replication-task-arn, status
MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
description:
DescribeReplicationTasksResponse:
type: object
example:
Marker: ""
ReplicationTasks: []
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/ReplicationTaskList"
- description: A description of the replication tasks.
description:
DescribeReplicationTasksMessage:
type: object
title: DescribeReplicationTasksMessage
properties:
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
" MaxRecords: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
WithoutSettings:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: An option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose true; otherwise, choose false (the default).
description:
DescribeSchemasResponse:
type: object
example:
Marker: ""
Schemas: []
properties:
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/SchemaList"
- description: The described schema.
description:
DescribeSchemasMessage:
type: object
required:
- EndpointArn
title: DescribeSchemasMessage
properties:
EndpointArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
description:
DescribeTableStatisticsResponse:
type: object
example:
Marker: ""
ReplicationTaskArn: ""
TableStatistics: []
properties:
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication task.
TableStatistics:
allOf:
- $ref: "#/components/schemas/TableStatisticsList"
- description: The table statistics.
Marker:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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. "
description:
DescribeTableStatisticsMessage:
type: object
required:
- ReplicationTaskArn
title: DescribeTableStatisticsMessage
properties:
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication task.
MaxRecords:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: " 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: allOf: - $ref: "#/components/schemas/String" - description: " 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 byMaxRecords. "
Filters:
allOf:
- $ref: "#/components/schemas/FilterList"
- description: "Filters applied to table statistics.
Valid filter names: schema-name | table-name | table-state
A combination of filters creates an AND condition where each record matches all specified filters.
" description: ImportCertificateResponse: type: object example: Certificate: {} properties: Certificate: allOf: - $ref: "#/components/schemas/Certificate" - description: The certificate to be uploaded. ImportCertificateMessage: type: object required: - CertificateIdentifier title: ImportCertificateMessage properties: CertificateIdentifier: allOf: - $ref: "#/components/schemas/String" - description: A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens. CertificatePem: allOf: - $ref: "#/components/schemas/SecretString" - description: The contents of a.pem file, which contains an X.509 certificate.
CertificateWallet:
allOf:
- $ref: "#/components/schemas/CertificateWallet"
- description: "The location of an imported Oracle Wallet certificate for use with SSL. Provide the name of a .sso file using the fileb:// prefix. You can't provide the certificate inline.
Example: filebase64(\"${path.root}/rds-ca-2019-root.sso\")
ResourceArn value, which is the ARN of the resource for which each listed tag is created. "
description:
ModifyEndpointResponse:
type: object
example:
Endpoint: {}
properties:
Endpoint:
allOf:
- $ref: "#/components/schemas/Endpoint"
- description: The modified endpoint.
description:
ModifyEndpointMessage:
type: object
required:
- EndpointArn
title: ModifyEndpointMessage
properties:
EndpointArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
EndpointIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
EndpointType:
allOf:
- $ref: "#/components/schemas/ReplicationEndpointTypeValue"
- description: The type of endpoint. Valid values are source and target.
EngineName:
allOf:
- $ref: "#/components/schemas/String"
- description: The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".
Username:
allOf:
- $ref: "#/components/schemas/String"
- description: The user name to be used to login to the endpoint database.
Password:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: The password to be used to login to the endpoint database.
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the server where the endpoint database resides.
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The port used by the endpoint database.
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.
ExtraConnectionAttributes:
allOf:
- $ref: "#/components/schemas/String"
- description: Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
CertificateArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the certificate used for SSL connection.
SslMode:
allOf:
- $ref: "#/components/schemas/DmsSslModeValue"
- description: The SSL mode used to connect to the endpoint. The default value is none.
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: " The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action."
ExternalTableDefinition:
allOf:
- $ref: "#/components/schemas/String"
- description: The external table definition.
DynamoDbSettings:
allOf:
- $ref: "#/components/schemas/DynamoDbSettings"
- description: 'Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide. '
S3Settings:
allOf:
- $ref: "#/components/schemas/S3Settings"
- description: 'Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide. '
DmsTransferSettings:
allOf:
- $ref: "#/components/schemas/DmsTransferSettings"
- description: 'The settings in JSON format for the DMS transfer type of source endpoint.
Attributes include the following:
serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.
BucketName - The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"}
If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:
It replaces any endpoint settings that already exist with new values, for settings with the same names.
It creates new endpoint settings that you specify in the call, for settings with different names.
For example, if you call create-endpoint ... --endpoint-settings '{\"a\":1}' ..., the endpoint has the following endpoint settings: '{\"a\":1}'. If you then call modify-endpoint ... --endpoint-settings '{\"b\":2}' ... for the same endpoint, the endpoint has the following settings: '{\"a\":1,\"b\":2}'.
However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{\"b\":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{\"b\":2}'. All existing settings are replaced with the exact settings that you specify.
The type of DMS resource that generates the events you want to subscribe to.
Valid values: replication-instance | replication-task
" EventCategories: allOf: - $ref: "#/components/schemas/EventCategoriesList" - description: " A list of event categories for a source type that you want to subscribe to. Use theDescribeEventCategories action to see a list of event categories. "
Enabled:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: " A Boolean value; set to true to activate the subscription. "
description:
ModifyReplicationInstanceResponse:
type: object
example:
ReplicationInstance:
AllocatedStorage: 5
AutoMinorVersionUpgrade: true
EngineVersion: 1.5.0
KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd
PendingModifiedValues: {}
PreferredMaintenanceWindow: sun:06:00-sun:14:00
PubliclyAccessible: true
ReplicationInstanceArn: arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ
ReplicationInstanceClass: dms.t2.micro
ReplicationInstanceIdentifier: test-rep-1
ReplicationInstanceStatus: available
ReplicationSubnetGroup:
ReplicationSubnetGroupDescription: default
ReplicationSubnetGroupIdentifier: default
SubnetGroupStatus: Complete
Subnets:
- SubnetAvailabilityZone:
Name: us-east-1d
SubnetIdentifier: subnet-f6dd91af
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1b
SubnetIdentifier: subnet-3605751d
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1c
SubnetIdentifier: subnet-c2daefb5
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1e
SubnetIdentifier: subnet-85e90cb8
SubnetStatus: Active
VpcId: vpc-6741a603
properties:
ReplicationInstance:
allOf:
- $ref: "#/components/schemas/ReplicationInstance"
- description: The modified replication instance.
description:
ModifyReplicationInstanceMessage:
type: object
required:
- ReplicationInstanceArn
title: ModifyReplicationInstanceMessage
properties:
ReplicationInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication instance.
AllocatedStorage:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The amount of storage (in gigabytes) to be allocated for the replication instance.
ApplyImmediately:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether the changes should be applied immediately or during the next maintenance window.
ReplicationInstanceClass:
allOf:
- $ref: "#/components/schemas/String"
- description: The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
VpcSecurityGroupIds: allOf: - $ref: "#/components/schemas/VpcSecurityGroupIdList" - description: " 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: allOf: - $ref: "#/components/schemas/String" - description: "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: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: " Specifies whether the replication instance is a Multi-AZ deployment. You can't set theAvailabilityZone parameter if the Multi-AZ parameter is set to true. "
EngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The engine version number of the replication instance.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
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.
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.
A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.
An outage does result if these factors apply:
This parameter is set to true during the maintenance window.
A newer minor version is available.
DMS has enabled automatic patching for the given engine version.
When AutoMinorVersionUpgrade is enabled, DMS uses the current default engine version when you modify a replication instance. For example, if you set EngineVersion to a lower version number than the current default version, DMS uses the default version.
If AutoMinorVersionUpgrade isn’t enabled when you modify a replication instance, DMS uses the engine version specified by the EngineVersion parameter.
The replication task identifier.
Constraints:
Must contain 1-255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
full-load | cdc | full-load-and-cdc "
TableMappings:
allOf:
- $ref: "#/components/schemas/String"
- description: "When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. For example, --table-mappings file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter value. "
ReplicationTaskSettings:
allOf:
- $ref: "#/components/schemas/String"
- description: JSON file that contains settings for the task, such as task metadata settings.
CdcStartTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: "Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
" CdcStartPosition: allOf: - $ref: "#/components/schemas/String" - description: 'Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" TaskData: allOf: - $ref: "#/components/schemas/String" - description: 'Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide. ' description: MoveReplicationTaskResponse: type: object properties: ReplicationTask: allOf: - $ref: "#/components/schemas/ReplicationTask" - description: The replication task that was moved. description: MoveReplicationTaskMessage: type: object required: - ReplicationTaskArn - TargetReplicationInstanceArn title: MoveReplicationTaskMessage properties: ReplicationTaskArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the task that you want to move. TargetReplicationInstanceArn: allOf: - $ref: "#/components/schemas/String" - description: The ARN of the replication instance where you want to move the task to. description: RebootReplicationInstanceResponse: type: object properties: ReplicationInstance: allOf: - $ref: "#/components/schemas/ReplicationInstance" - description: "The replication instance that is being rebooted. " RebootReplicationInstanceMessage: type: object required: - ReplicationInstanceArn title: RebootReplicationInstanceMessage properties: ReplicationInstanceArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the replication instance. ForceFailover: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: If this parameter istrue, the reboot is conducted through a Multi-AZ failover. If the instance isn't configured for Multi-AZ, then you can't specify true. ( --force-planned-failover and --force-failover can't both be set to true.)
ForcePlannedFailover:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: If this parameter is true, the reboot is conducted through a planned Multi-AZ failover where resources are released and cleaned up prior to conducting the failover. If the instance isn''t configured for Multi-AZ, then you can't specify true. ( --force-planned-failover and --force-failover can't both be set to true.)
RefreshSchemasResponse:
type: object
example:
RefreshSchemasStatus: {}
properties:
RefreshSchemasStatus:
allOf:
- $ref: "#/components/schemas/RefreshSchemasStatus"
- description: The status of the refreshed schema.
description:
RefreshSchemasMessage:
type: object
required:
- EndpointArn
- ReplicationInstanceArn
title: RefreshSchemasMessage
properties:
EndpointArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication instance.
description:
ReloadTablesResponse:
type: object
properties:
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: "The Amazon Resource Name (ARN) of the replication task. "
ReloadTablesMessage:
type: object
required:
- ReplicationTaskArn
- TablesToReload
title: ReloadTablesMessage
properties:
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: "The Amazon Resource Name (ARN) of the replication task. "
TablesToReload:
allOf:
- $ref: "#/components/schemas/TableListToReload"
- description: "The name and schema of the table to be reloaded. "
ReloadOption:
allOf:
- $ref: "#/components/schemas/ReloadOptionValue"
- description: "Options for reload. Specify data-reload to reload the data and re-validate it if validation is enabled. Specify validate-only to re-validate the table. This option applies only when validation is enabled for the task.
Valid values: data-reload, validate-only
Default value is data-reload.
" RemoveTagsFromResourceResponse: type: object example: {} properties: {} description: RemoveTagsFromResourceMessage: type: object required: - ResourceArn - TagKeys title: RemoveTagsFromResourceMessage properties: ResourceArn: allOf: - $ref: "#/components/schemas/String" - description: An DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN). TagKeys: allOf: - $ref: "#/components/schemas/KeyList" - description: The tag key (name) of the tag to be removed. description: Removes one or more tags from an DMS resource. RunFleetAdvisorLsaAnalysisResponse: type: object properties: LsaAnalysisId: allOf: - $ref: "#/components/schemas/String" - description: The ID of the LSA analysis run. Status: allOf: - $ref: "#/components/schemas/String" - description: The status of the LSA analysis, for exampleCOMPLETED.
StartRecommendationsRequest:
type: object
required:
- DatabaseId
- Settings
title: StartRecommendationsRequest
properties:
DatabaseId:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the source database to analyze and provide recommendations for.
Settings:
allOf:
- $ref: "#/components/schemas/RecommendationSettings"
- description: "The settings in JSON format that Fleet Advisor uses to determine target engine recommendations. These parameters include target instance sizing and availability and durability settings. For target instance sizing, Fleet Advisor supports the following two options: total capacity and resource utilization. For availability and durability, Fleet Advisor supports the following two options: production (Multi-AZ deployments) and Dev/Test (Single-AZ deployments)."
StartReplicationTaskResponse:
type: object
example:
ReplicationTask:
MigrationType: full-load
ReplicationInstanceArn: arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ
ReplicationTaskArn: arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM
ReplicationTaskCreationDate: 2016-12-14T18:25:43Z
ReplicationTaskIdentifier: task1
ReplicationTaskSettings: '{"TargetMetadata":{"TargetSchema":"","SupportLobs":true,"FullLobMode":true,"LobChunkSize":64,"LimitedSizeLobMode":false,"LobMaxSize":0},"FullLoadSettings":{"FullLoadEnabled":true,"ApplyChangesEnabled":false,"TargetTablePrepMode":"DROP_AND_CREATE","CreatePkAfterFullLoad":false,"StopTaskCachedChangesApplied":false,"StopTaskCachedChangesNotApplied":false,"ResumeEnabled":false,"ResumeMinTableSize":100000,"ResumeOnlyClusteredPKTables":true,"MaxFullLoadSubTasks":8,"TransactionConsistencyTimeout":600,"CommitRate":10000},"Logging":{"EnableLogging":false}}'
SourceEndpointArn: arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE
Status: creating
TableMappings: file://mappingfile.json
TargetEndpointArn: arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E
properties:
ReplicationTask:
allOf:
- $ref: "#/components/schemas/ReplicationTask"
- description: The replication task started.
description:
StartReplicationTaskMessage:
type: object
required:
- ReplicationTaskArn
- StartReplicationTaskType
title: StartReplicationTaskMessage
properties:
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication task to be started.
StartReplicationTaskType:
allOf:
- $ref: "#/components/schemas/StartReplicationTaskTypeValue"
- description: The type of replication task to start.
When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.
You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.
The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.
For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.
Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
" CdcStartPosition: allOf: - $ref: "#/components/schemas/String" - description: 'Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" description: StartReplicationTaskAssessmentResponse: type: object properties: ReplicationTask: allOf: - $ref: "#/components/schemas/ReplicationTask" - description: " The assessed replication task. " description: StartReplicationTaskAssessmentMessage: type: object required: - ReplicationTaskArn title: StartReplicationTaskAssessmentMessage properties: ReplicationTaskArn: allOf: - $ref: "#/components/schemas/String" - description: " The Amazon Resource Name (ARN) of the replication task. " description: StartReplicationTaskAssessmentRunResponse: type: object properties: ReplicationTaskAssessmentRun: allOf: - $ref: "#/components/schemas/ReplicationTaskAssessmentRun" - description: The premigration assessment run that was started. description: StartReplicationTaskAssessmentRunMessage: type: object required: - ReplicationTaskArn - ServiceAccessRoleArn - ResultLocationBucket - AssessmentRunName title: StartReplicationTaskAssessmentRunMessage properties: ReplicationTaskArn: allOf: - $ref: "#/components/schemas/String" - description: Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start. ServiceAccessRoleArn: allOf: - $ref: "#/components/schemas/String" - description: ARN of the service role needed to start the assessment run. The role must allow theiam:PassRole action.
ResultLocationBucket:
allOf:
- $ref: "#/components/schemas/String"
- description: Amazon S3 bucket where you want DMS to store the results of this assessment run.
ResultLocationFolder:
allOf:
- $ref: "#/components/schemas/String"
- description: Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
ResultEncryptionMode:
allOf:
- $ref: "#/components/schemas/String"
- description: Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:
"SSE_S3" – The server-side encryption provided as a default by Amazon S3.
"SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.
ResultEncryptionMode to "SSE_KMS".
AssessmentRunName:
allOf:
- $ref: "#/components/schemas/String"
- description: Unique name to identify the assessment run.
IncludeOnly:
allOf:
- $ref: "#/components/schemas/IncludeTestList"
- description: Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.
You can't set a value for IncludeOnly if you also set a value for Exclude in the API operation.
To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.
Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.
You can't set a value for Exclude if you also set a value for IncludeOnly in the API operation.
To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.
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.
AvailabilityZonesList:
type: array
items:
$ref: "#/components/schemas/String"
BatchStartRecommendationsErrorEntry:
type: object
properties:
DatabaseId:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the source database.
Message:
allOf:
- $ref: "#/components/schemas/String"
- description: The information about the error.
Code:
allOf:
- $ref: "#/components/schemas/String"
- description: The code of an error that occurred during the analysis of the source database.
description: Provides information about the errors that occurred during the analysis of the source database.
BatchStartRecommendationsErrorEntryList:
type: array
items:
$ref: "#/components/schemas/BatchStartRecommendationsErrorEntry"
StartRecommendationsRequestEntryList:
type: array
items:
$ref: "#/components/schemas/StartRecommendationsRequestEntry"
Boolean:
type: boolean
BooleanOptional:
type: boolean
ReplicationTaskAssessmentRun:
type: object
properties:
ReplicationTaskAssessmentRunArn:
allOf:
- $ref: "#/components/schemas/String"
- description: Amazon Resource Name (ARN) of this assessment run.
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: ARN of the migration task associated with this premigration assessment run.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: Assessment run status.
This status can have one of the following values:
"cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.
"deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.
"failed" – At least one individual assessment completed with a failed status.
"error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).
"error-executing" – An internal error occurred while individual assessments ran (during running status).
"invalid state" – The assessment run is in an unknown state.
"passed" – All individual assessments have completed, and none has a failed status.
"provisioning" – Resources required to run individual assessments are being provisioned.
"running" – Individual assessments are being run.
"starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.
StartReplicationTaskAssessmentRun operation.
AssessmentProgress:
allOf:
- $ref: "#/components/schemas/ReplicationTaskAssessmentRunProgress"
- description: Indication of the completion progress for the individual assessments specified to run.
LastFailureMessage:
allOf:
- $ref: "#/components/schemas/String"
- description: Last message generated by an individual assessment failure.
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.
ResultLocationBucket:
allOf:
- $ref: "#/components/schemas/String"
- description: Amazon S3 bucket where DMS stores the results of this assessment run.
ResultLocationFolder:
allOf:
- $ref: "#/components/schemas/String"
- description: Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.
ResultEncryptionMode:
allOf:
- $ref: "#/components/schemas/String"
- description: Encryption mode used to encrypt the assessment run results.
ResultKmsKeyArn:
allOf:
- $ref: "#/components/schemas/String"
- description: ARN of the KMS encryption key used to encrypt the assessment run results.
AssessmentRunName:
allOf:
- $ref: "#/components/schemas/String"
- description: Unique name of the assessment run.
description: 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.
.pem file, which contains an X.509 certificate.
CertificateWallet:
allOf:
- $ref: "#/components/schemas/CertificateWallet"
- description: 'The location of an imported Oracle Wallet certificate for use with SSL. Example: filebase64("${path.root}/rds-ca-2019-root.sso") '
CertificateArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the certificate.
CertificateOwner:
allOf:
- $ref: "#/components/schemas/String"
- description: The owner of the certificate.
ValidFromDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The beginning date that the certificate is valid.
ValidToDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The final date that the certificate is valid.
SigningAlgorithm:
allOf:
- $ref: "#/components/schemas/String"
- description: The signing algorithm for the certificate.
KeyLength:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The key length of the cryptographic algorithm being used.
description: The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.
CertificateList:
type: array
items:
$ref: "#/components/schemas/Certificate"
CharLengthSemantics:
type: string
enum:
- default
- char
- byte
CollectorStatus:
type: string
enum:
- UNREGISTERED
- ACTIVE
CollectorHealthCheck:
type: object
properties:
CollectorStatus:
allOf:
- $ref: "#/components/schemas/CollectorStatus"
- description: The status of the Fleet Advisor collector.
LocalCollectorS3Access:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Whether the local collector can access its Amazon S3 bucket.
WebCollectorS3Access:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Whether the web collector can access its Amazon S3 bucket.
WebCollectorGrantedRoleBasedAccess:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Whether the role that you provided when creating the Fleet Advisor collector has sufficient permissions to access the Fleet Advisor web collector.
description: Describes the last Fleet Advisor collector health check.
VersionStatus:
type: string
enum:
- UP_TO_DATE
- OUTDATED
- UNSUPPORTED
InventoryData:
type: object
properties:
NumberOfDatabases:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The number of databases in the Fleet Advisor collector inventory.
NumberOfSchemas:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The number of schemas in the Fleet Advisor collector inventory.
description: Describes a Fleet Advisor collector inventory.
CollectorResponse:
type: object
properties:
CollectorReferencedId:
allOf:
- $ref: "#/components/schemas/String"
- description: The reference ID of the Fleet Advisor collector.
CollectorName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the Fleet Advisor collector .
CollectorVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: "The version of your Fleet Advisor collector, in semantic versioning format, for example 1.0.2 "
VersionStatus:
allOf:
- $ref: "#/components/schemas/VersionStatus"
- description: Whether the collector version is up to date.
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: A summary description of the Fleet Advisor collector.
S3BucketName:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The IAM role that grants permissions to access the specified Amazon S3 bucket.
CollectorHealthCheck:
$ref: "#/components/schemas/CollectorHealthCheck"
LastDataReceived:
allOf:
- $ref: "#/components/schemas/String"
- description: "The timestamp of the last time the collector received data, in the following format: 2022-01-24T19:04:02.596113Z "
RegisteredDate:
allOf:
- $ref: "#/components/schemas/String"
- description: "The timestamp when DMS registered the collector, in the following format: 2022-01-24T19:04:02.596113Z "
CreatedDate:
allOf:
- $ref: "#/components/schemas/String"
- description: "The timestamp when you created the collector, in the following format: 2022-01-24T19:04:02.596113Z "
ModifiedDate:
allOf:
- $ref: "#/components/schemas/String"
- description: "The timestamp when DMS last modified the collector, in the following format: 2022-01-24T19:04:02.596113Z "
InventoryData:
$ref: "#/components/schemas/InventoryData"
description: Describes a Fleet Advisor collector.
CollectorResponses:
type: array
items:
$ref: "#/components/schemas/CollectorResponse"
CollectorShortInfoResponse:
type: object
properties:
CollectorReferencedId:
allOf:
- $ref: "#/components/schemas/String"
- description: The reference ID of the Fleet Advisor collector.
CollectorName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the Fleet Advisor collector.
description: Briefly describes a Fleet Advisor collector.
CollectorsList:
type: array
items:
$ref: "#/components/schemas/CollectorShortInfoResponse"
CompressionTypeValue:
type: string
enum:
- none
- gzip
Connection:
type: object
properties:
ReplicationInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The ARN of the replication instance.
EndpointArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The ARN string that uniquely identifies the endpoint.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: The connection status. This parameter can return one of the following values:
"successful"
"testing"
"failed"
"deleting"
iam:PassRole action."
description: Provides the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.
S3Settings:
type: object
properties:
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: " The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action. It is a required parameter that enables DMS to write and read objects from an S3 bucket."
ExternalTableDefinition:
allOf:
- $ref: "#/components/schemas/String"
- description: " Specifies how tables are defined in the S3 source files only. "
CsvRowDelimiter:
allOf:
- $ref: "#/components/schemas/String"
- description: " The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (\\n). "
CsvDelimiter:
allOf:
- $ref: "#/components/schemas/String"
- description: " The delimiter used to separate columns in the .csv file for both source and target. The default is a comma. "
BucketFolder:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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 isn't specified, then the path used is schema_name/table_name/. "
BucketName:
allOf:
- $ref: "#/components/schemas/String"
- description: " The name of the S3 bucket. "
CompressionType:
allOf:
- $ref: "#/components/schemas/CompressionTypeValue"
- description: "An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed. This parameter applies to both .csv and .parquet file formats. "
EncryptionMode:
allOf:
- $ref: "#/components/schemas/EncryptionModeValue"
- description: The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS.
For the ModifyEndpoint operation, you can change the existing value of the EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the existing value from SSE_S3 to SSE_KMS.
To use SSE_S3, you need an Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:
s3:CreateBucket
s3:ListBucket
s3:DeleteBucket
s3:GetBucketLocation
s3:GetObject
s3:PutObject
s3:DeleteObject
s3:GetObjectVersion
s3:GetBucketPolicy
s3:PutBucketPolicy
s3:DeleteBucketPolicy
If you are using SSE_KMS for the EncryptionMode, provide the KMS key ID. The key that you use needs an attached policy that enables Identity and Access Management (IAM) user permissions and allows use of the key.
Here is a CLI example: aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value
The format of the data that you want to use for output. You can choose one of the following:
csv : This is a row-based file format with comma-separated values (.csv).
parquet : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response.
The type of encoding you are using:
RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.
PLAIN doesn't use encoding at all. Values are stored as they are.
PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.
PLAIN. This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. This size is used for .parquet file format only. "
RowGroupLength:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only.
If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).
parquet_1_0 (the default) or parquet_2_0."
EnableStatistics:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that enables statistics for Parquet pages and row groups. Choose true to enable statistics, false to disable. Statistics include NULL, DISTINCT, MAX, and MIN values. This parameter defaults to true. This value is used for .parquet file format only.
IncludeOpForFullLoad:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and later.
For full load, records can only be inserted. By default (the false setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If IncludeOpForFullLoad is set to true or y, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.
This setting works together with the CdcInsertsOnly and the CdcInsertsAndUpdates parameters for output to .csv files only. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the false setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.
If CdcInsertsOnly is set to true or y, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of IncludeOpForFullLoad. If IncludeOpForFullLoad is set to true, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If IncludeOpForFullLoad is set to false, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
DMS supports the interaction described preceding between the CdcInsertsOnly and IncludeOpForFullLoad parameters in versions 3.1.4 and later.
CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not both.
A value that when nonblank causes DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.
DMS includes an additional STRING column in the .csv or .parquet object files of your migrated data when you set TimestampColumnName to a nonblank value.
For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS.
For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.
The string format for this timestamp column value is yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database.
When the AddColumnName parameter is set to true, DMS also includes a name for the timestamp column that you set with TimestampColumnName.
A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or y, DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.
Currently, Amazon Athena and Glue can handle only millisecond precision for TIMESTAMP values. Set this parameter to true for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.
DMS writes any TIMESTAMP column values written to an S3 file in .csv format with microsecond precision.
Setting ParquetTimestampInMillisecond has no effect on the string format of the timestamp column value that is inserted by setting the TimestampColumnName parameter.
A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is false, but when CdcInsertsAndUpdates is set to true or y, only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file.
For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the IncludeOpForFullLoad parameter. If IncludeOpForFullLoad is set to true, the first field of every CDC record is set to either I or U to indicate INSERT and UPDATE operations at the source. But if IncludeOpForFullLoad is set to false, CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
DMS supports the use of the CdcInsertsAndUpdates parameter in versions 3.3.1 and later.
CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not both.
true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false. For more information about date-based folder partitioning, see Using date-based folder partitioning.
DatePartitionSequence:
allOf:
- $ref: "#/components/schemas/DatePartitionSequenceValue"
- description: Identifies the sequence of the date format to use during folder partitioning. The default value is YYYYMMDD. Use this parameter when DatePartitionedEnabled is set to true.
DatePartitionDelimiter:
allOf:
- $ref: "#/components/schemas/DatePartitionDelimiterValue"
- description: Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH. Use this parameter when DatePartitionedEnabled is set to true.
UseCsvNoSupValue:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to true for columns not included in the supplemental log, DMS uses the value specified by CsvNoSupValue . If not set or set to false, DMS uses the null value for these columns.
This setting is supported in DMS versions 3.4.1 and later.
This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If UseCsvNoSupValue is set to true, specify a string value that you want DMS to use for all columns not included in the supplemental log. If you do not specify a string value, DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.
This setting is supported in DMS versions 3.4.1 and later.
If set to true, DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath . For more information, see Capturing data changes (CDC) including transaction order on the S3 target.
This setting is supported in DMS versions 3.4.2 and later.
Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If CdcPath is set, DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set PreserveTransactions to true, DMS verifies that you have set this parameter to a folder path on your S3 target where DMS can save the transaction order for the CDC load. DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by BucketFolder and BucketName .
For example, if you specify CdcPath as MyChangedData, and you specify BucketName as MyTargetBucket but do not specify BucketFolder, DMS creates the CDC folder path following: MyTargetBucket/MyChangedData.
If you specify the same CdcPath, and you specify BucketName as MyTargetBucket and BucketFolder as MyTargetData, DMS creates the CDC folder path following: MyTargetBucket/MyTargetData/MyChangedData.
For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3 target.
This setting is supported in DMS versions 3.4.2 and later.
When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when useTaskStartTimeForFullLoadTimestamp is set to true, each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time.
When useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp in the timestamp column increments with the time data arrives at the target.
A value that enables DMS to specify a predefined (canned) access control list for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 Developer Guide.
The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL.
AddColumnName: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:An optional parameter that, when set to true or y, you can use to add column name information to the .csv output file.
The default value is false. Valid values are true, false, y, and n.
Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
When CdcMaxBatchInterval and CdcMinFileSize are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.
The default value is 60 seconds.
CdcMinFileSize: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.
The default value is 32 MB.
CsvNullValue: allOf: - $ref: "#/components/schemas/String" - description:An optional parameter that specifies how DMS treats null values. While handling the null value, you can use this parameter to pass a user-defined string as null when writing to the target. For example, when target columns are not nullable, you can use this option to differentiate between the empty string value and the null value. So, if you set this parameter value to the empty string ("" or ''), DMS treats the empty string as the null value instead of NULL.
The default value is NULL. Valid values include any valid string.
When this value is set to 1, DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature.
The default is 0.
MaxFileSize: allOf: - $ref: "#/components/schemas/IntegerOptional" - description:A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.
The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.
Rfc4180: allOf: - $ref: "#/components/schemas/BooleanOptional" - description:For an S3 source, when this value is set to true or y, each leading double quotation mark has to be followed by an ending double quotation mark. This formatting complies with RFC 4180. When this value is set to false or n, string literals are copied to the target as is. In this case, a delimiter (row or column) signals the end of the field. Thus, you can't use a delimiter as part of the string, because it signals the end of the value.
For an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using .csv file format only. When this value is set to true or y using Amazon S3 as a target, if the data has quotation marks or newline characters in it, DMS encloses the entire column with an additional pair of double quotation marks ("). Every quotation mark within the data is repeated twice.
The default value is true. Valid values include true, false, y, and n.
When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone. The conversion occurs when a date partition folder is created and a CDC filename is generated. The time zone format is Area/Location. Use this parameter when DatePartitionedEnabled is set to true, as shown in the following example.
s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\", \"DatePartitionDelimiter\": \"SLASH\", \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\": \"dms-nattarat-test\"}'
AddTrailingPaddingCharacter to add padding on string data. The default value is false.
ExpectedBucketOwner:
allOf:
- $ref: "#/components/schemas/String"
- description: "To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.
Example: --s3-settings='{\"ExpectedBucketOwner\": \"AWS_Account_ID\"}'
When you make a request to test a connection or perform a migration, S3 checks the account ID of the bucket owner against the specified parameter.
" GlueCatalogGeneration: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: When true, allows Glue to catalog your S3 bucket. Creating an Glue catalog lets you use Athena to query your data. description: "Settings for exporting data to Amazon S3. " DmsTransferSettings: type: object properties: ServiceAccessRoleArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow theiam:PassRole action.
BucketName:
allOf:
- $ref: "#/components/schemas/String"
- description: " The name of the S3 bucket to use. "
description: " The settings in JSON format for the DMS Transfer type source endpoint. "
MongoDbSettings:
type: object
properties:
Username:
allOf:
- $ref: "#/components/schemas/String"
- description: "The user name you use to access the MongoDB source endpoint. "
Password:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: " The password for the user account you use to access the MongoDB source endpoint. "
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: " The name of the server on the MongoDB source endpoint. "
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: " The port value for the MongoDB source endpoint. "
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: " The database name on the MongoDB source endpoint. "
AuthType:
allOf:
- $ref: "#/components/schemas/AuthTypeValue"
- description: The authentication type you use to access the MongoDB source endpoint.
When when set to "no", user name and password parameters are not used and can be empty.
The authentication mechanism you use to access the MongoDB source endpoint.
For the default value, in MongoDB version 2.x, "default" is "mongodb_cr". For MongoDB version 3.x or later, "default" is "scram_sha_1". This setting isn't used when AuthType is set to "no".
Specifies either document or table mode.
Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.
Specifies the document ID. Use this setting when NestingLevel is set to "none".
Default value is "false".
Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
Must be a positive value greater than 0. Default value is 1000.
The MongoDB database name. This setting isn't used when AuthType is set to "no".
The default is "admin".
KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
SecretsManagerAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MongoDB endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret that contains the MongoDB endpoint connection details.
description: Provides information that defines a MongoDB endpoint.
KinesisSettings:
type: object
properties:
StreamArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
MessageFormat:
allOf:
- $ref: "#/components/schemas/MessageFormatValue"
- description: The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.
IncludeTransactionDetails:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.
IncludePartitionValue:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is false.
PartitionIncludeSchemaTable:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is false.
IncludeTableAlterOperations:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.
IncludeControlDetails:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false.
IncludeNullAndEmpty:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Include NULL and empty columns for records migrated to the endpoint. The default is false.
NoHexPrefix:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
description: 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.
KafkaSettings:
type: object
properties:
Broker:
allOf:
- $ref: "#/components/schemas/String"
- description: 'A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide. '
Topic:
allOf:
- $ref: "#/components/schemas/String"
- description: The topic to which you migrate the data. If you don't specify a topic, DMS specifies "kafka-default-topic" as the migration topic.
MessageFormat:
allOf:
- $ref: "#/components/schemas/MessageFormatValue"
- description: The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).
IncludeTransactionDetails:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.
IncludePartitionValue:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.
PartitionIncludeSchemaTable:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is false.
IncludeTableAlterOperations:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.
IncludeControlDetails:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
MessageMaxBytes:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The maximum size in bytes for records created on the endpoint The default is 1,000,000.
IncludeNullAndEmpty:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Include NULL and empty columns for records migrated to the endpoint. The default is false.
SecurityProtocol:
allOf:
- $ref: "#/components/schemas/KafkaSecurityProtocol"
- description: Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.
SslClientCertificateArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
SslClientKeyArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
SslClientKeyPassword:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: " The password for the client private key used to securely connect to a Kafka target endpoint."
SslCaCertificateArn:
allOf:
- $ref: "#/components/schemas/String"
- description: " The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint."
SaslUsername:
allOf:
- $ref: "#/components/schemas/String"
- description: " The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication."
SaslPassword:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
NoHexPrefix:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
SaslMechanism:
allOf:
- $ref: "#/components/schemas/KafkaSaslMechanism"
- description: "For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN. "
description: 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.
ElasticsearchSettings:
type: object
required:
- ServiceAccessRoleArn
- EndpointUri
properties:
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
EndpointUri:
allOf:
- $ref: "#/components/schemas/String"
- description: The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.
FullLoadErrorPercentage:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The maximum percentage of records that can fail to be written before a full load operation stops.
To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.
ErrorRetryDuration: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster. UseNewMappingType: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: Set this option totrue for DMS to migrate documentation using the documentation type _doc. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is false.
description: Provides information that defines an OpenSearch endpoint.
NeptuneSettings:
type: object
required:
- S3BucketName
- S3BucketFolder
properties:
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: 'The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. The role must allow the iam:PassRole action. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the Database Migration Service User Guide. '
S3BucketName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the Amazon S3 bucket where DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. DMS maps the SQL source data to graph data before storing it in these .csv files.
S3BucketFolder:
allOf:
- $ref: "#/components/schemas/String"
- description: "A folder path where you want DMS to store migrated graph data in the S3 bucket specified by S3BucketName "
ErrorRetryDuration:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The number of milliseconds for DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250.
MaxFileSize:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The maximum size in kilobytes of migrated graph data stored in a .csv file before DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, DMS clears the bucket, ready to store the next batch of migrated graph data.
MaxRetryCount:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
IamAuthEnabled:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to true. Then attach the appropriate IAM policy document to your service role specified by ServiceAccessRoleArn. The default is false.
description: Provides information that defines an Amazon Neptune endpoint.
RedshiftSettings:
type: object
properties:
AcceptAnyDate:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose true or false (the default).
This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
AfterConnectScript: allOf: - $ref: "#/components/schemas/String" - description: Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code. BucketFolder: allOf: - $ref: "#/components/schemas/String" - description:An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
For full load mode, DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. DMS uses the Redshift COPY command to upload the .csv files to the target table. The files are deleted once the COPY operation has finished. For more information, see COPY in the Amazon Redshift Database Developer Guide.
For change-data-capture (CDC) mode, DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
BucketName: allOf: - $ref: "#/components/schemas/String" - description: The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift. CaseSensitiveNames: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: If Amazon Redshift is configured to support case sensitive schema names, setCaseSensitiveNames to true. The default is false.
CompUpdate:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty. This applies even if the table columns already have encodings other than RAW. If you set CompUpdate to false, automatic compression is disabled and existing column encodings aren't changed. The default is true.
ConnectionTimeout:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the Amazon Redshift data warehouse (service) that you are working with.
DateFormat:
allOf:
- $ref: "#/components/schemas/String"
- description: The date format that you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that aren't supported when you use a date format string.
If your date and time values use formats different from each other, set this to auto.
true sets empty CHAR and VARCHAR fields to null. The default is false.
EncryptionMode:
allOf:
- $ref: "#/components/schemas/EncryptionModeValue"
- description: 'The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS.
For the ModifyEndpoint operation, you can change the existing value of the EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the existing value from SSE_S3 to SSE_KMS.
To use SSE_S3, create an Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
ExplicitIds to true to have tables with IDENTITY columns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default is false.
FileTransferUploadStreams:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.
The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see Multipart upload overview.
FileTransferUploadStreams accepts a value from 1 through 64. It defaults to 10.
username property.
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The port number for Amazon Redshift. The default value is 5439.
RemoveQuotes:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that specifies to remove surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose true to remove quotation marks. The default is false.
ReplaceInvalidChars:
allOf:
- $ref: "#/components/schemas/String"
- description: A list of characters that you want to replace. Use with ReplaceChars.
ReplaceChars:
allOf:
- $ref: "#/components/schemas/String"
- description: A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the Amazon Redshift cluster you are using.
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. The role must allow the iam:PassRole action.
ServerSideEncryptionKmsKeyId:
allOf:
- $ref: "#/components/schemas/String"
- description: The KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
TimeFormat:
allOf:
- $ref: "#/components/schemas/String"
- description: The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that aren't supported when you use a time format string.
If your date and time values use formats different from each other, set this parameter to auto.
true to remove unneeded white space. The default is false.
TruncateColumns:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose true to truncate data. The default is false.
Username:
allOf:
- $ref: "#/components/schemas/String"
- description: An Amazon Redshift user name for a registered user.
WriteBufferSize:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB).
SecretsManagerAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Amazon Redshift endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
MapBooleanAsBoolean:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: When true, lets Redshift migrate the boolean type as boolean. By default, Redshift migrates booleans as varchar(1).
description: Provides information that defines an Amazon Redshift endpoint.
PostgreSQLSettings:
type: object
properties:
AfterConnectScript:
allOf:
- $ref: "#/components/schemas/String"
- description: "For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
Example: afterConnectScript=SET session_replication_role='replica'
To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
If this value is set to N, you don't have to create tables or triggers on the source database.
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
When set to true, this value causes a task to fail if the actual size of a LOB column is greater than the specified LobMaxSize.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
HeartbeatEnable: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keepsrestart_lsn moving and prevents storage full scenarios.
HeartbeatSchema:
allOf:
- $ref: "#/components/schemas/String"
- description: Sets the schema in which the heartbeat artifacts are created.
HeartbeatFrequency:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Sets the WAL heartbeat frequency (in minutes).
Password:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: Endpoint connection password.
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Endpoint TCP port. The default is 5432.
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: The host name of the endpoint database.
For an Amazon RDS PostgreSQL instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
For an Aurora PostgreSQL instance, this is the output of DescribeDBClusters, in the Endpoint field.
Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
When used with the CdcStartPosition request parameter for the DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of CdcStartPosition. If the specified slot doesn't exist or the task doesn't have a valid CdcStartPosition setting, DMS raises an error.
For more information about setting the CdcStartPosition request parameter, see Determining a CDC native start point in the Database Migration Service User Guide. For more information about using CdcStartPosition, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the PostgreSQL endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
TrimSpaceInChar:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.
MapBooleanAsBoolean:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as varchar(5).
description: Provides information that defines a PostgreSQL endpoint.
MySQLSettings:
type: object
properties:
AfterConnectScript:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
For this parameter, provide the code of the script itself, not the name of a file containing the script.
CleanSourceMetadataOnMismatch: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "Cleans and recreates table metadata information on the replication instance when a mismatch occurs. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance. " DatabaseName: allOf: - $ref: "#/components/schemas/String" - description: Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using theDatabaseName request parameter on either the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
EventsPollInterval:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: "Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
Example: eventsPollInterval=5;
In the example, DMS checks for changes in the binary logs every five seconds.
" TargetDbType: allOf: - $ref: "#/components/schemas/TargetDbType" - description: "Specifies where to migrate source tables on the target, either to a single database or multiple databases. If you specify SPECIFIC_DATABASE, specify the database name using the DatabaseName parameter of the Endpoint object.
Example: targetDbType=MULTIPLE_DATABASES
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.
Example: parallelLoadThreads=1
The host name of the endpoint database.
For an Amazon RDS MySQL instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
For an Aurora MySQL instance, this is the output of DescribeDBClusters, in the Endpoint field.
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
" Username: allOf: - $ref: "#/components/schemas/String" - description: Endpoint connection user name. SecretsManagerAccessRoleArn: allOf: - $ref: "#/components/schemas/String" - description:The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret that contains the MySQL endpoint connection details.
description: Provides information that defines a MySQL endpoint.
OracleSettings:
type: object
properties:
AddSupplementalLogging:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.
If you use this option, you still need to enable database-level supplemental logging.
ArchivedLogDestId: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use theAdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
AdditionalArchivedLogDestId:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.
Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the dest_id column in the v$archived_log view. Use this setting with the archivedLogDestId extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup.
This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings.
archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
In a primary-to-multiple-standby setup, you might apply the following settings.
archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
true to enable replication of Oracle tables containing columns that are nested tables or defined types.
ParallelAsmReadThreads:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.
ReadAheadBlocks:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).
AccessAlternateDirectly:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Set this attribute to false in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.
UseAlternateFolderForOnline:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all online redo logs.
OraclePathPrefix:
allOf:
- $ref: "#/components/schemas/String"
- description: Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.
UsePathPrefix:
allOf:
- $ref: "#/components/schemas/String"
- description: Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.
ReplacePathPrefix:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified usePathPrefix setting to access the redo logs.
EnableHomogenousTablespace:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
DirectPathNoLog:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: When set to true, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.
ArchivedLogsOnly:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: When this field is set to Y, DMS only accesses the archived redo logs. If the archived redo logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.
AsmPassword:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the asm_user_password value. You set this value as part of the comma-separated value that you set to the Password request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
AsmServer:
allOf:
- $ref: "#/components/schemas/String"
- description: For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
AsmUser:
allOf:
- $ref: "#/components/schemas/String"
- description: For an Oracle source endpoint, your ASM user name. You can set this value from the asm_user value. You set asm_user as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
CharLengthSemantics:
allOf:
- $ref: "#/components/schemas/CharLengthSemantics"
- description: "Specifies whether the length of a character column is in bytes or in characters. To indicate that the character column length is in characters, set this attribute to CHAR. Otherwise, the character column length is in bytes.
Example: charLengthSemantics=CHAR;
true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
FailTasksOnLobTruncation:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: When set to true, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified LobMaxSize.
If a task is set to limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.
Example: numberDataTypeScale=12
true, this attribute supports tablespace replication.
RetryInterval:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: "Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
TDE_Password part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide. '
SecurityDbEncryptionName:
allOf:
- $ref: "#/components/schemas/String"
- description: For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: Fully qualified domain name of the endpoint.
For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
SDO_GEOMETRY to GEOJSON format. By default, DMS calls the SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName to call it instead. "
StandbyDelayTime:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.
In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.
Username: allOf: - $ref: "#/components/schemas/String" - description: Endpoint connection user name. UseBFile: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: Set this attribute to Y to capture change data using the Binary Reader utility. SetUseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for CDC.
UseDirectPathFullLoad:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load.
UseLogminerReader:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this attribute to N if you want to access the redo logs as a binary file. When you set UseLogminerReader to N, also set UseBfile to Y. For more information on this setting and using Oracle ASM, see Using Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
SecretsManagerAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Oracle endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret that contains the Oracle endpoint connection details.
SecretsManagerOracleAsmAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUserName, AsmPassword, and AsmServerName. You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
TrimSpaceInChar:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.
ConvertTimestampWithZoneToUTC:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: When true, converts timestamps with the timezone datatype to their UTC value.
description: Provides information that defines an Oracle endpoint.
SybaseSettings:
type: object
properties:
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: Database name for the endpoint.
Password:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: Endpoint connection password.
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Endpoint TCP port. The default is 5000.
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: Fully qualified domain name of the endpoint.
Username:
allOf:
- $ref: "#/components/schemas/String"
- description: Endpoint connection user name.
SecretsManagerAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret that contains the SAP SAE endpoint connection details.
description: Provides information that defines a SAP ASE endpoint.
MicrosoftSQLServerSettings:
type: object
properties:
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Endpoint TCP port.
BcpPacketSize:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The maximum size of the packets (in bytes) used to transfer data using BCP.
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: Database name for the endpoint.
ControlTablesFileGroup:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
Password:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: Endpoint connection password.
QuerySingleAlwaysOnNode:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.
ReadBackupOnly:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: When this attribute is set to Y, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
SafeguardPolicy:
allOf:
- $ref: "#/components/schemas/SafeguardPolicy"
- description: "Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods.
Start transactions in the database: This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
Exclusively use sp_repldone within a single task: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.
" ServerName: allOf: - $ref: "#/components/schemas/String" - description: Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
Username:
allOf:
- $ref: "#/components/schemas/String"
- description: Endpoint connection user name.
UseBcpFullLoad:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
UseThirdPartyBackupDevice:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
SecretsManagerAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SQL Server endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret that contains the SQL Server endpoint connection details.
TrimSpaceInChar:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.
TlogAccessMode:
allOf:
- $ref: "#/components/schemas/TlogAccessMode"
- description: Indicates the mode used to fetch CDC data.
ForceLobLookup:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Forces LOB lookup on inline LOB.
description: Provides information that defines a Microsoft SQL Server endpoint.
IBMDb2Settings:
type: object
properties:
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: Database name for the endpoint.
Password:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: Endpoint connection password.
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Endpoint TCP port. The default value is 50000.
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: Fully qualified domain name of the endpoint.
SetDataCaptureChanges:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
CurrentLsn:
allOf:
- $ref: "#/components/schemas/String"
- description: For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
MaxKBytesPerRead:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
Username:
allOf:
- $ref: "#/components/schemas/String"
- description: Endpoint connection user name.
SecretsManagerAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Db2 LUW endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
description: Provides information that defines an IBM Db2 LUW endpoint.
DocDbSettings:
type: object
properties:
Username:
allOf:
- $ref: "#/components/schemas/String"
- description: "The user name you use to access the DocumentDB source endpoint. "
Password:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: " The password for the user account you use to access the DocumentDB source endpoint. "
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: " The name of the server on the DocumentDB source endpoint. "
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: " The port value for the DocumentDB source endpoint. "
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: " The database name on the DocumentDB source endpoint. "
NestingLevel:
allOf:
- $ref: "#/components/schemas/NestingLevelValue"
- description: Specifies either document or table mode.
Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.
Specifies the document ID. Use this setting when NestingLevel is set to "none".
Default value is "false".
Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
Must be a positive value greater than 0. Default value is 1000.
KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
SecretsManagerAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the DocumentDB endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret that contains the DocumentDB endpoint connection details.
description: Provides information that defines a DocumentDB endpoint.
RedisSettings:
type: object
required:
- ServerName
- Port
properties:
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: Fully qualified domain name of the endpoint.
Port:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Transmission Control Protocol (TCP) port for the endpoint.
SslSecurityProtocol:
allOf:
- $ref: "#/components/schemas/SslSecurityProtocolValue"
- description: The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption. The default is ssl-encryption. The ssl-encryption option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the SslCaCertificateArn setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.
The plaintext option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.
none, auth-token, and auth-role. The auth-token option requires an AuthPassword value to be provided. The auth-role option requires AuthUserName and AuthPassword values to be provided.
AuthUserName:
allOf:
- $ref: "#/components/schemas/String"
- description: The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
AuthPassword:
allOf:
- $ref: "#/components/schemas/SecretString"
- description: The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
SslCaCertificateArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
description: Provides information that defines a Redis target endpoint.
GcpMySQLSettings:
type: object
properties:
AfterConnectScript:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
For this parameter, provide the code of the script itself, not the name of a file containing the script.
CleanSourceMetadataOnMismatch: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: "Cleans and recreates table metadata information on the replication instance when a mismatch occurs. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance. " DatabaseName: allOf: - $ref: "#/components/schemas/String" - description: "Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using theDatabaseName request parameter on either the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task. "
EventsPollInterval:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: "Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
Example: eventsPollInterval=5;
In the example, DMS checks for changes in the binary logs every five seconds.
" TargetDbType: allOf: - $ref: "#/components/schemas/TargetDbType" - description: "Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.
Example: parallelLoadThreads=1
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
" Username: allOf: - $ref: "#/components/schemas/String" - description: Endpoint connection user name. SecretsManagerAccessRoleArn: allOf: - $ref: "#/components/schemas/String" - description:The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret that contains the MySQL endpoint connection details. "
description: Settings in JSON format for the source GCP MySQL endpoint.
Endpoint:
type: object
properties:
EndpointIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
EndpointType:
allOf:
- $ref: "#/components/schemas/ReplicationEndpointTypeValue"
- description: The type of endpoint. Valid values are source and target.
EngineName:
allOf:
- $ref: "#/components/schemas/String"
- description: The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".
EngineDisplayName:
allOf:
- $ref: "#/components/schemas/String"
- description: The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".
Username:
allOf:
- $ref: "#/components/schemas/String"
- description: The user name used to connect to the endpoint.
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the server at the endpoint.
Port:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The port value used to access the endpoint.
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the database at the endpoint.
ExtraConnectionAttributes:
allOf:
- $ref: "#/components/schemas/String"
- description: Additional connection attributes used to connect to the endpoint.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: The status of the endpoint.
KmsKeyId:
allOf:
- $ref: "#/components/schemas/String"
- description: An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
EndpointArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. CertificateArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) used for SSL connection to the endpoint. SslMode: allOf: - $ref: "#/components/schemas/DmsSslModeValue" - description: The SSL mode used to connect to the endpoint. The default value isnone.
ServiceAccessRoleArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
ExternalTableDefinition:
allOf:
- $ref: "#/components/schemas/String"
- description: The external table definition.
ExternalId:
allOf:
- $ref: "#/components/schemas/String"
- description: " 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:
allOf:
- $ref: "#/components/schemas/DynamoDbSettings"
- description: The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
S3Settings:
allOf:
- $ref: "#/components/schemas/S3Settings"
- description: The settings for the S3 target endpoint. For more information, see the S3Settings structure.
DmsTransferSettings:
allOf:
- $ref: "#/components/schemas/DmsTransferSettings"
- description: "The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure. "
MongoDbSettings:
allOf:
- $ref: "#/components/schemas/MongoDbSettings"
- description: The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
KinesisSettings:
allOf:
- $ref: "#/components/schemas/KinesisSettings"
- description: The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
KafkaSettings:
allOf:
- $ref: "#/components/schemas/KafkaSettings"
- description: The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
ElasticsearchSettings:
allOf:
- $ref: "#/components/schemas/ElasticsearchSettings"
- description: The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings structure.
NeptuneSettings:
allOf:
- $ref: "#/components/schemas/NeptuneSettings"
- description: The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
RedshiftSettings:
allOf:
- $ref: "#/components/schemas/RedshiftSettings"
- description: Settings for the Amazon Redshift endpoint.
PostgreSQLSettings:
allOf:
- $ref: "#/components/schemas/PostgreSQLSettings"
- description: The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
MySQLSettings:
allOf:
- $ref: "#/components/schemas/MySQLSettings"
- description: The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
OracleSettings:
allOf:
- $ref: "#/components/schemas/OracleSettings"
- description: The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
SybaseSettings:
allOf:
- $ref: "#/components/schemas/SybaseSettings"
- description: The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
MicrosoftSQLServerSettings:
allOf:
- $ref: "#/components/schemas/MicrosoftSQLServerSettings"
- description: The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
IBMDb2Settings:
allOf:
- $ref: "#/components/schemas/IBMDb2Settings"
- description: "The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure. "
DocDbSettings:
$ref: "#/components/schemas/DocDbSettings"
RedisSettings:
allOf:
- $ref: "#/components/schemas/RedisSettings"
- description: The settings for the Redis target endpoint. For more information, see the RedisSettings structure.
GcpMySQLSettings:
allOf:
- $ref: "#/components/schemas/GcpMySQLSettings"
- description: Settings in JSON format for the source GCP MySQL endpoint.
description: Describes an endpoint of a database instance in response to operations such as the following:
CreateEndpoint
DescribeEndpoint
ModifyEndpoint
The status of the 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 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: allOf: - $ref: "#/components/schemas/String" - description: The time the DMS event notification subscription was created. SourceType: allOf: - $ref: "#/components/schemas/String" - description: "The type of DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
" SourceIdsList: allOf: - $ref: "#/components/schemas/SourceIdsList" - description: A list of source Ids for the event subscription. EventCategoriesList: allOf: - $ref: "#/components/schemas/EventCategoriesList" - description: A lists of event categories. Enabled: allOf: - $ref: "#/components/schemas/Boolean" - description: Boolean value that indicates if the event subscription is enabled. description: Describes an event notification subscription created by theCreateEventSubscription operation.
VpcSecurityGroupIdList:
type: array
items:
$ref: "#/components/schemas/String"
ReplicationInstance:
type: object
properties:
ReplicationInstanceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: "The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
ReplicationInstanceStatus: allOf: - $ref: "#/components/schemas/String" - description:The status of the replication instance. The possible return values include:
"available"
"creating"
"deleted"
"deleting"
"failed"
"modifying"
"upgrading"
"rebooting"
"resetting-master-credentials"
"storage-full"
"incompatible-credentials"
"incompatible-network"
"maintenance"
AvailabilityZone parameter if the Multi-AZ parameter is set to true. "
EngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
ReplicationInstanceArn: allOf: - $ref: "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the replication instance. ReplicationInstancePublicIpAddress: allOf: - $ref: "#/components/schemas/String" - deprecated: true description: The public IP address of the replication instance. ReplicationInstancePrivateIpAddress: allOf: - $ref: "#/components/schemas/String" - deprecated: true description: The private IP address of the replication instance. ReplicationInstancePublicIpAddresses: allOf: - $ref: "#/components/schemas/ReplicationInstancePublicIpAddressList" - description: One or more public IP addresses for the replication instance. ReplicationInstancePrivateIpAddresses: allOf: - $ref: "#/components/schemas/ReplicationInstancePrivateIpAddressList" - description: One or more private IP addresses for the replication instance. ReplicationInstanceIpv6Addresses: allOf: - $ref: "#/components/schemas/ReplicationInstanceIpv6AddressList" - description: One or more IPv6 addresses for the replication instance. PubliclyAccessible: allOf: - $ref: "#/components/schemas/Boolean" - description: " Specifies the accessibility options for the replication instance. A value oftrue 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:
allOf:
- $ref: "#/components/schemas/String"
- description: The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: " The expiration date of the free replication instance that is part of the Free DMS program. "
DnsNameServers:
allOf:
- $ref: "#/components/schemas/String"
- description: The DNS name servers supported for the replication instance to access your on-premise source or target database.
NetworkType:
allOf:
- $ref: "#/components/schemas/String"
- description: The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
description: Provides information that defines a replication instance.
SubnetIdentifierList:
type: array
items:
$ref: "#/components/schemas/String"
ReplicationSubnetGroup:
type: object
properties:
ReplicationSubnetGroupIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the replication instance subnet group.
ReplicationSubnetGroupDescription:
allOf:
- $ref: "#/components/schemas/String"
- description: A description for the replication subnet group.
VpcId:
allOf:
- $ref: "#/components/schemas/String"
- description: The ID of the VPC.
SubnetGroupStatus:
allOf:
- $ref: "#/components/schemas/String"
- description: The status of the subnet group.
Subnets:
allOf:
- $ref: "#/components/schemas/SubnetList"
- description: The subnets that are in the subnet group.
SupportedNetworkTypes:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
description: Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.
MigrationTypeValue:
type: string
enum:
- full-load
- cdc
- full-load-and-cdc
ReplicationTask:
type: object
properties:
ReplicationTaskIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The user-assigned replication task identifier or name.
Constraints:
Must contain 1-255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
The status of the replication task. This response parameter can return one of the following values:
"moving" – The task is being moved in response to running the MoveReplicationTask operation.
"creating" – The task is being created in response to running the CreateReplicationTask operation.
"deleting" – The task is being deleted in response to running the DeleteReplicationTask operation.
"failed" – The task failed to successfully complete the database migration in response to running the StartReplicationTask operation.
"failed-move" – The task failed to move in response to running the MoveReplicationTask operation.
"modifying" – The task definition is being modified in response to running the ModifyReplicationTask operation.
"ready" – The task is in a ready state where it can respond to other task operations, such as StartReplicationTask or DeleteReplicationTask .
"running" – The task is performing a database migration in response to running the StartReplicationTask operation.
"starting" – The task is preparing to perform a database migration in response to running the StartReplicationTask operation.
"stopped" – The task has stopped in response to running the StopReplicationTask operation.
"stopping" – The task is preparing to stop in response to running the StopReplicationTask operation.
"testing" – The database migration specified for this task is being tested in response to running either the StartReplicationTaskAssessmentRun or the StartReplicationTaskAssessment operation.
StartReplicationTaskAssessmentRun is an improved premigration task assessment operation. The StartReplicationTaskAssessment operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, StartReplicationTaskAssessmentRun enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
The reason the replication task was stopped. This response parameter can return one of the following values:
"Stop Reason NORMAL"
"Stop Reason RECOVERABLE_ERROR"
"Stop Reason FATAL_ERROR"
"Stop Reason FULL_LOAD_ONLY_FINISHED"
"Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied
"Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied
"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"
"Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied
"Stop Reason STOPPED_DUE_TO_LOW_MEMORY"
"Stop Reason STOPPED_DUE_TO_LOW_DISK"
"Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task
"Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task
"Stop Reason RECONFIGURATION_RESTART"
"Stop Reason RECYCLE_TASK"
Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
' CdcStopPosition: allOf: - $ref: "#/components/schemas/String" - description: "Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" RecoveryCheckpoint: allOf: - $ref: "#/components/schemas/String" - description: Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to theCdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskStats:
allOf:
- $ref: "#/components/schemas/ReplicationTaskStats"
- description: The statistics for the task, including elapsed time, tables loaded, and table errors.
TaskData:
allOf:
- $ref: "#/components/schemas/String"
- description: 'Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide. '
TargetReplicationInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
description: Provides information that describes a replication task created by the CreateReplicationTask operation.
DataFormatValue:
type: string
enum:
- csv
- parquet
DatabaseInstanceSoftwareDetailsResponse:
type: object
properties:
Engine:
allOf:
- $ref: "#/components/schemas/String"
- description: The database engine of a database in a Fleet Advisor collector inventory, for example Microsoft SQL Server.
EngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The database engine version of a database in a Fleet Advisor collector inventory, for example 2019.
EngineEdition:
allOf:
- $ref: "#/components/schemas/String"
- description: The database engine edition of a database in a Fleet Advisor collector inventory, for example Express.
ServicePack:
allOf:
- $ref: "#/components/schemas/String"
- description: The service pack level of the database.
SupportLevel:
allOf:
- $ref: "#/components/schemas/String"
- description: The support level of the database, for example Mainstream support.
OsArchitecture:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The operating system architecture of the database.
Tooltip:
allOf:
- $ref: "#/components/schemas/String"
- description: Information about the database engine software, for example Mainstream support ends on November 14th, 2024.
description: Describes an inventory database instance for a Fleet Advisor collector.
DatabaseResponse:
type: object
properties:
DatabaseId:
allOf:
- $ref: "#/components/schemas/String"
- description: The ID of a database in a Fleet Advisor collector inventory.
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: "The name of a database in a Fleet Advisor collector inventory. "
IpAddress:
allOf:
- $ref: "#/components/schemas/String"
- description: "The IP address of a database in a Fleet Advisor collector inventory. "
NumberOfSchemas:
allOf:
- $ref: "#/components/schemas/LongOptional"
- description: "The number of schemas in a Fleet Advisor collector inventory database. "
Server:
allOf:
- $ref: "#/components/schemas/ServerShortInfoResponse"
- description: "The server name of a database in a Fleet Advisor collector inventory. "
SoftwareDetails:
allOf:
- $ref: "#/components/schemas/DatabaseInstanceSoftwareDetailsResponse"
- description: The software details of a database in a Fleet Advisor collector inventory, such as database engine and version.
Collectors:
allOf:
- $ref: "#/components/schemas/CollectorsList"
- description: A list of collectors associated with the database.
description: Describes a database in a Fleet Advisor collector inventory.
DatabaseList:
type: array
items:
$ref: "#/components/schemas/DatabaseResponse"
LongOptional:
type: integer
ServerShortInfoResponse:
type: object
properties:
ServerId:
allOf:
- $ref: "#/components/schemas/String"
- description: The ID of a server in a Fleet Advisor collector inventory.
IpAddress:
allOf:
- $ref: "#/components/schemas/String"
- description: The IP address of a server in a Fleet Advisor collector inventory.
ServerName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name address of a server in a Fleet Advisor collector inventory.
description: Describes a server in a Fleet Advisor collector inventory.
DatabaseShortInfoResponse:
type: object
properties:
DatabaseId:
allOf:
- $ref: "#/components/schemas/String"
- description: The ID of a database in a Fleet Advisor collector inventory.
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of a database in a Fleet Advisor collector inventory.
DatabaseIpAddress:
allOf:
- $ref: "#/components/schemas/String"
- description: The IP address of a database in a Fleet Advisor collector inventory.
DatabaseEngine:
allOf:
- $ref: "#/components/schemas/String"
- description: The database engine of a database in a Fleet Advisor collector inventory, for example PostgreSQL.
description: Describes a database in a Fleet Advisor collector inventory.
DatePartitionDelimiterValue:
type: string
enum:
- SLASH
- UNDERSCORE
- DASH
- NONE
DatePartitionSequenceValue:
type: string
enum:
- YYYYMMDD
- YYYYMMDDHH
- YYYYMM
- MMYYYYDD
- DDMMYYYY
StringList:
type: array
items:
$ref: "#/components/schemas/String"
IndividualAssessmentNameList:
type: array
items:
$ref: "#/components/schemas/String"
FilterList:
type: array
items:
$ref: "#/components/schemas/Filter"
EndpointSettingsList:
type: array
items:
$ref: "#/components/schemas/EndpointSetting"
SupportedEndpointTypeList:
type: array
items:
$ref: "#/components/schemas/SupportedEndpointType"
EndpointList:
type: array
items:
$ref: "#/components/schemas/Endpoint"
EventCategoryGroupList:
type: array
items:
$ref: "#/components/schemas/EventCategoryGroup"
EventSubscriptionsList:
type: array
items:
$ref: "#/components/schemas/EventSubscription"
SourceType:
type: string
enum:
- replication-instance
EventList:
type: array
items:
$ref: "#/components/schemas/Event"
FleetAdvisorLsaAnalysisResponseList:
type: array
items:
$ref: "#/components/schemas/FleetAdvisorLsaAnalysisResponse"
FleetAdvisorSchemaObjectList:
type: array
items:
$ref: "#/components/schemas/FleetAdvisorSchemaObjectResponse"
FleetAdvisorSchemaList:
type: array
items:
$ref: "#/components/schemas/SchemaResponse"
OrderableReplicationInstanceList:
type: array
items:
$ref: "#/components/schemas/OrderableReplicationInstance"
PendingMaintenanceActions:
type: array
items:
$ref: "#/components/schemas/ResourcePendingMaintenanceActions"
LimitationList:
type: array
items:
$ref: "#/components/schemas/Limitation"
RecommendationList:
type: array
items:
$ref: "#/components/schemas/Recommendation"
RefreshSchemasStatus:
type: object
properties:
EndpointArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationInstanceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication instance.
Status:
allOf:
- $ref: "#/components/schemas/RefreshSchemasStatusTypeValue"
- description: The status of the schema.
LastRefreshDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date the schema was last refreshed.
LastFailureMessage:
allOf:
- $ref: "#/components/schemas/String"
- description: The last failure message for the schema.
description: Provides information that describes status of a schema at an endpoint specified by the DescribeRefreshSchemaStatus operation.
ReplicationInstanceTaskLogsList:
type: array
items:
$ref: "#/components/schemas/ReplicationInstanceTaskLog"
ReplicationInstanceList:
type: array
items:
$ref: "#/components/schemas/ReplicationInstance"
ReplicationSubnetGroups:
type: array
items:
$ref: "#/components/schemas/ReplicationSubnetGroup"
ReplicationTaskAssessmentResultList:
type: array
items:
$ref: "#/components/schemas/ReplicationTaskAssessmentResult"
ReplicationTaskAssessmentRunList:
type: array
items:
$ref: "#/components/schemas/ReplicationTaskAssessmentRun"
ReplicationTaskIndividualAssessmentList:
type: array
items:
$ref: "#/components/schemas/ReplicationTaskIndividualAssessment"
ReplicationTaskList:
type: array
items:
$ref: "#/components/schemas/ReplicationTask"
SchemaList:
type: array
items:
$ref: "#/components/schemas/String"
TableStatisticsList:
type: array
items:
$ref: "#/components/schemas/TableStatistics"
NestingLevelValue:
type: string
enum:
- none
- one
DoubleOptional:
type: number
format: double
EncodingTypeValue:
type: string
enum:
- plain
- plain-dictionary
- rle-dictionary
EncryptionModeValue:
type: string
enum:
- sse-s3
- sse-kms
EndpointSettingTypeValue:
type: string
enum:
- string
- boolean
- integer
- enum
EndpointSettingEnumValues:
type: array
items:
$ref: "#/components/schemas/String"
EndpointSetting:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name that you want to give the endpoint settings.
Type:
allOf:
- $ref: "#/components/schemas/EndpointSettingTypeValue"
- description: The type of endpoint. Valid values are source and target.
EnumValues:
allOf:
- $ref: "#/components/schemas/EndpointSettingEnumValues"
- description: Enumerated values to use for this endpoint.
Sensitive:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that marks this endpoint setting as sensitive.
Units:
allOf:
- $ref: "#/components/schemas/String"
- description: The unit of measure for this endpoint setting.
Applicability:
allOf:
- $ref: "#/components/schemas/String"
- description: The relevance or validity of an endpoint setting for an engine name and its endpoint type.
IntValueMin:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The minimum value of an endpoint setting that is of type int.
IntValueMax:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The maximum value of an endpoint setting that is of type int.
DefaultValue:
allOf:
- $ref: "#/components/schemas/String"
- description: The default value of the endpoint setting if no value is specified using CreateEndpoint or ModifyEndpoint.
description: Endpoint settings.
Event:
type: object
properties:
SourceIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: " The identifier of an event source."
SourceType:
allOf:
- $ref: "#/components/schemas/SourceType"
- description: "The type of DMS resource that generates events.
Valid values: replication-instance | endpoint | replication-task
" Message: allOf: - $ref: "#/components/schemas/String" - description: The event message. EventCategories: allOf: - $ref: "#/components/schemas/EventCategoriesList" - description: The event categories available for the specified source type. Date: allOf: - $ref: "#/components/schemas/TStamp" - description: The date of the event. description: 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: type: object properties: SourceType: allOf: - $ref: "#/components/schemas/String" - description: "The type of DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
" EventCategories: allOf: - $ref: "#/components/schemas/EventCategoriesList" - description: " A list of event categories from a source type that you've chosen." description: Lists categories of events subscribed to, and generated by, the applicable DMS resource type. This data type appears in response to theDescribeEventCategories action.
ExcludeTestList:
type: array
items:
$ref: "#/components/schemas/String"
FilterValueList:
type: array
items:
$ref: "#/components/schemas/String"
Filter:
type: object
required:
- Name
- Values
properties:
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the filter as specified for a Describe* or similar operation.
Values:
allOf:
- $ref: "#/components/schemas/FilterValueList"
- description: The filter value, which can specify one or more values used to narrow the returned results.
description: "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:
type: object
properties:
LsaAnalysisId:
allOf:
- $ref: "#/components/schemas/String"
- description: The ID of an LSA analysis run by a Fleet Advisor collector.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: The status of an LSA analysis run by a Fleet Advisor collector.
description: Describes a large-scale assessment (LSA) analysis run by a Fleet Advisor collector.
SchemaResponse:
type: object
properties:
CodeLineCount:
allOf:
- $ref: "#/components/schemas/LongOptional"
- description: The number of lines of code in a schema in a Fleet Advisor collector inventory.
CodeSize:
allOf:
- $ref: "#/components/schemas/LongOptional"
- description: The size level of the code in a schema in a Fleet Advisor collector inventory.
Complexity:
allOf:
- $ref: "#/components/schemas/String"
- description: The complexity level of the code in a schema in a Fleet Advisor collector inventory.
Server:
allOf:
- $ref: "#/components/schemas/ServerShortInfoResponse"
- description: The database server for a schema in a Fleet Advisor collector inventory.
DatabaseInstance:
allOf:
- $ref: "#/components/schemas/DatabaseShortInfoResponse"
- description: The database for a schema in a Fleet Advisor collector inventory.
SchemaId:
allOf:
- $ref: "#/components/schemas/String"
- description: The ID of a schema in a Fleet Advisor collector inventory.
SchemaName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of a schema in a Fleet Advisor collector inventory.
OriginalSchema:
$ref: "#/components/schemas/SchemaShortInfoResponse"
Similarity:
allOf:
- $ref: "#/components/schemas/DoubleOptional"
- description: The similarity value for a schema in a Fleet Advisor collector inventory. A higher similarity value indicates that a schema is likely to be a duplicate.
description: Describes a schema in a Fleet Advisor collector inventory.
FleetAdvisorSchemaObjectResponse:
type: object
properties:
SchemaId:
allOf:
- $ref: "#/components/schemas/String"
- description: The ID of a schema object in a Fleet Advisor collector inventory.
ObjectType:
allOf:
- $ref: "#/components/schemas/String"
- description: The type of the schema object, as reported by the database engine. Examples include the following:
function
trigger
SYSTEM_TABLE
QUEUE
"rds-aurora-mysql", "rds-aurora-postgresql", "rds-mysql", "rds-oracle", "rds-sql-server", and "rds-postgresql".
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the limitation. Describes unsupported database features, migration action items, and other limitations.
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: A description of the limitation. Provides additional information about the limitation, and includes recommended actions that you can take to address or avoid this limitation.
Impact:
allOf:
- $ref: "#/components/schemas/String"
- description: The impact of the limitation. You can use this parameter to prioritize limitations that you want to address. Valid values include "Blocker", "High", "Medium", and "Low".
Type:
allOf:
- $ref: "#/components/schemas/String"
- description: The type of the limitation, such as action required, upgrade required, and limited feature.
description: 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.
SafeguardPolicy: type: string enum: - rely-on-sql-server-replication-agent - exclusive-automatic-truncation - shared-automatic-truncation TlogAccessMode: type: string enum: - BackupOnly - PreferBackup - PreferTlog - TlogOnly ReleaseStatusValues: type: string enum: - beta - prod OrderableReplicationInstance: type: object properties: EngineVersion: allOf: - $ref: "#/components/schemas/String" - description: The version of the replication engine. ReplicationInstanceClass: allOf: - $ref: "#/components/schemas/String" - description:The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
StorageType: allOf: - $ref: "#/components/schemas/String" - description: The type of storage used by the replication instance. MinAllocatedStorage: allOf: - $ref: "#/components/schemas/Integer" - description: The minimum amount of storage (in gigabytes) that can be allocated for the replication instance. MaxAllocatedStorage: allOf: - $ref: "#/components/schemas/Integer" - description: The minimum amount of storage (in gigabytes) that can be allocated for the replication instance. DefaultAllocatedStorage: allOf: - $ref: "#/components/schemas/Integer" - description: The default amount of storage (in gigabytes) that is allocated for the replication instance. IncludedAllocatedStorage: allOf: - $ref: "#/components/schemas/Integer" - description: The amount of storage (in gigabytes) that is allocated for the replication instance. AvailabilityZones: allOf: - $ref: "#/components/schemas/AvailabilityZonesList" - description: List of Availability Zones for this replication instance. ReleaseStatus: allOf: - $ref: "#/components/schemas/ReleaseStatusValues" - description:The value returned when the specified EngineVersion of the replication instance is in Beta or test mode. This indicates some features might not work as expected.
DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
DescribeOrderableReplicationInstances operation, this object describes an available replication instance. This description includes the replication instance's type, engine version, and allocated storage.
ParquetVersionValue:
type: string
enum:
- parquet-1-0
- parquet-2-0
PendingMaintenanceAction:
type: object
properties:
Action:
allOf:
- $ref: "#/components/schemas/String"
- description: The type of pending maintenance action that is available for the resource.
AutoAppliedAfterDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date of the maintenance window when the action is to be applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.
ForcedApplyDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date when the maintenance action will be automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.
OptInStatus:
allOf:
- $ref: "#/components/schemas/String"
- description: The type of opt-in request that has been received for the resource.
CurrentApplyDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API operation, and also the AutoAppliedAfterDate and ForcedApplyDate parameter values. This value is blank if an opt-in request has not been received and nothing has been specified for AutoAppliedAfterDate or ForcedApplyDate.
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: A description providing more detail about the maintenance action.
description: 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.
PendingMaintenanceActionDetails:
type: array
items:
$ref: "#/components/schemas/PendingMaintenanceAction"
PluginNameValue:
type: string
enum:
- no-preference
- test-decoding
- pglogical
RdsConfiguration:
type: object
properties:
EngineEdition:
allOf:
- $ref: "#/components/schemas/String"
- description: Describes the recommended target Amazon RDS engine edition.
InstanceType:
allOf:
- $ref: "#/components/schemas/String"
- description: Describes the recommended target Amazon RDS instance type.
InstanceVcpu:
allOf:
- $ref: "#/components/schemas/DoubleOptional"
- description: Describes the number of virtual CPUs (vCPU) on the recommended Amazon RDS DB instance that meets your requirements.
InstanceMemory:
allOf:
- $ref: "#/components/schemas/DoubleOptional"
- description: Describes the memory on the recommended Amazon RDS DB instance that meets your requirements.
StorageType:
allOf:
- $ref: "#/components/schemas/String"
- description: "Describes the storage type of the recommended Amazon RDS DB instance that meets your requirements.
Amazon RDS provides three storage types: General Purpose SSD (also known as gp2 and gp3), Provisioned IOPS SSD (also known as io1), and magnetic (also known as standard).
" StorageSize: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: Describes the storage size of the recommended Amazon RDS DB instance that meets your requirements. StorageIops: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: Describes the number of I/O operations completed each second (IOPS) on the recommended Amazon RDS DB instance that meets your requirements. DeploymentOption: allOf: - $ref: "#/components/schemas/String" - description: Describes the deployment option for the recommended Amazon RDS DB instance. The deployment options include Multi-AZ and Single-AZ deployments. Valid values include"MULTI_AZ" and "SINGLE_AZ".
description: Provides information that describes the configuration of the recommended target engine on Amazon RDS.
RdsRequirements:
type: object
properties:
EngineEdition:
allOf:
- $ref: "#/components/schemas/String"
- description: The required target Amazon RDS engine edition.
InstanceVcpu:
allOf:
- $ref: "#/components/schemas/DoubleOptional"
- description: The required number of virtual CPUs (vCPU) on the Amazon RDS DB instance.
InstanceMemory:
allOf:
- $ref: "#/components/schemas/DoubleOptional"
- description: The required memory on the Amazon RDS DB instance.
StorageSize:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The required Amazon RDS DB instance storage size.
StorageIops:
allOf:
- $ref: "#/components/schemas/IntegerOptional"
- description: The required number of I/O operations completed each second (IOPS) on your Amazon RDS DB instance.
DeploymentOption:
allOf:
- $ref: "#/components/schemas/String"
- description: The required deployment option for the Amazon RDS DB instance. Valid values include "MULTI_AZ" for Multi-AZ deployments and "SINGLE_AZ" for Single-AZ deployments.
description: Provides information that describes the requirements to the target engine on Amazon RDS.
RdsRecommendation:
type: object
properties:
RequirementsToTarget:
allOf:
- $ref: "#/components/schemas/RdsRequirements"
- description: Supplemental information about the requirements to the recommended target database on Amazon RDS.
TargetConfiguration:
allOf:
- $ref: "#/components/schemas/RdsConfiguration"
- description: Supplemental information about the configuration of the recommended target database on Amazon RDS.
description: Provides information that describes a recommendation of a target engine on Amazon RDS.
RecommendationSettings:
type: object
required:
- InstanceSizingType
- WorkloadType
properties:
InstanceSizingType:
allOf:
- $ref: "#/components/schemas/String"
- description: The size of your target instance. Fleet Advisor calculates this value based on your data collection type, such as total capacity and resource utilization. Valid values include "total-capacity" and "utilization".
WorkloadType:
allOf:
- $ref: "#/components/schemas/String"
- description: The deployment option for your target engine. For production databases, Fleet Advisor chooses Multi-AZ deployment. For development or test databases, Fleet Advisor chooses Single-AZ deployment. Valid values include "development" and "production".
description: Provides information about the required target engine settings.
RecommendationData:
type: object
properties:
RdsEngine:
allOf:
- $ref: "#/components/schemas/RdsRecommendation"
- description: The recommendation of a target Amazon RDS database engine.
description: Provides information about the target engine for the specified source database.
Recommendation:
type: object
properties:
DatabaseId:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the source database for which Fleet Advisor provided this recommendation.
EngineName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the target engine. Valid values include "rds-aurora-mysql", "rds-aurora-postgresql", "rds-mysql", "rds-oracle", "rds-sql-server", and "rds-postgresql".
CreatedDate:
allOf:
- $ref: "#/components/schemas/String"
- description: The date when Fleet Advisor created the target engine recommendation.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: The status of the target engine recommendation. Valid values include "alternate", "in-progress", "not-viable", and "recommended".
Preferred:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: Indicates that this target is the rightsized migration destination.
Settings:
allOf:
- $ref: "#/components/schemas/RecommendationSettings"
- description: The settings in JSON format for the preferred target engine parameters. These parameters include capacity, resource utilization, and the usage type (production, development, or testing).
Data:
allOf:
- $ref: "#/components/schemas/RecommendationData"
- description: The recommendation of a target engine for the specified source database.
description: 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.
RedisAuthTypeValue: type: string enum: - none - auth-role - auth-token SslSecurityProtocolValue: type: string enum: - plaintext - ssl-encryption RefreshSchemasStatusTypeValue: type: string enum: - successful - failed - refreshing ReloadOptionValue: type: string enum: - data-reload - validate-only TableListToReload: type: array items: $ref: "#/components/schemas/TableToReload" VpcSecurityGroupMembershipList: type: array items: $ref: "#/components/schemas/VpcSecurityGroupMembership" ReplicationPendingModifiedValues: type: object properties: ReplicationInstanceClass: allOf: - $ref: "#/components/schemas/String" - description:The compute and memory capacity of the replication instance as defined for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
AllocatedStorage: allOf: - $ref: "#/components/schemas/IntegerOptional" - description: The amount of storage (in gigabytes) that is allocated for the replication instance. MultiAZ: allOf: - $ref: "#/components/schemas/BooleanOptional" - description: " Specifies whether the replication instance is a Multi-AZ deployment. You can't set theAvailabilityZone parameter if the Multi-AZ parameter is set to true. "
EngineVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The engine version number of the replication instance.
NetworkType:
allOf:
- $ref: "#/components/schemas/String"
- description: The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
description: '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. '
ReplicationInstancePublicIpAddressList:
type: array
items:
$ref: "#/components/schemas/String"
ReplicationInstancePrivateIpAddressList:
type: array
items:
$ref: "#/components/schemas/String"
ReplicationInstanceIpv6AddressList:
type: array
items:
$ref: "#/components/schemas/String"
ReplicationInstanceTaskLog:
type: object
properties:
ReplicationTaskName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the replication task.
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) of the replication task.
ReplicationInstanceTaskLogSize:
allOf:
- $ref: "#/components/schemas/Long"
- description: The size, in bytes, of the replication task log.
description: Contains metadata for a replication instance task log.
SubnetList:
type: array
items:
$ref: "#/components/schemas/Subnet"
ReplicationTaskStats:
type: object
properties:
FullLoadProgressPercent:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The percent complete for the full load migration task.
ElapsedTimeMillis:
allOf:
- $ref: "#/components/schemas/Long"
- description: The elapsed time of the task, in milliseconds.
TablesLoaded:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The number of tables loaded for this task.
TablesLoading:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The number of tables currently loading for this task.
TablesQueued:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The number of tables queued for this task.
TablesErrored:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The number of errors that have occurred during this task.
FreshStartDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date the replication task was started either with a fresh start or a target reload.
StartDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType.
StopDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date the replication task was stopped.
FullLoadStartDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date the replication task full load was started.
FullLoadFinishDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The date the replication task full load was completed.
description: In response to a request by the DescribeReplicationTasks operation, this object provides a collection of statistics about a replication task.
ReplicationTaskAssessmentResult:
type: object
properties:
ReplicationTaskIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: " The replication task identifier of the task on which the task assessment was run. "
ReplicationTaskArn:
allOf:
- $ref: "#/components/schemas/String"
- description: "The Amazon Resource Name (ARN) of the replication task. "
ReplicationTaskLastAssessmentDate:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: "The date the task assessment was completed. "
AssessmentStatus:
allOf:
- $ref: "#/components/schemas/String"
- description: " The status of the task assessment. "
AssessmentResultsFile:
allOf:
- $ref: "#/components/schemas/String"
- description: " The file containing the results of the task assessment. "
AssessmentResults:
allOf:
- $ref: "#/components/schemas/String"
- description: The task assessment results in JSON format.
The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.
S3ObjectUrl: allOf: - $ref: "#/components/schemas/String" - description:The URL of the S3 object containing the task assessment results.
The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.
description: " The task assessment report in JSON format. " ReplicationTaskAssessmentRunProgress: type: object properties: IndividualAssessmentCount: allOf: - $ref: "#/components/schemas/Integer" - description: The number of individual assessments that are specified to run. IndividualAssessmentCompletedCount: allOf: - $ref: "#/components/schemas/Integer" - description: The number of individual assessments that have completed, successfully or not. description: The progress values reported by theAssessmentProgress response element.
ReplicationTaskIndividualAssessment:
type: object
properties:
ReplicationTaskIndividualAssessmentArn:
allOf:
- $ref: "#/components/schemas/String"
- description: Amazon Resource Name (ARN) of this individual assessment.
ReplicationTaskAssessmentRunArn:
allOf:
- $ref: "#/components/schemas/String"
- description: ARN of the premigration assessment run that is created to run this individual assessment.
IndividualAssessmentName:
allOf:
- $ref: "#/components/schemas/String"
- description: Name of this individual assessment.
Status:
allOf:
- $ref: "#/components/schemas/String"
- description: Individual assessment status.
This status can have one of the following values:
"cancelled"
"error"
"failed"
"passed"
"pending"
"running"
StartReplicationTaskAssessmentRun operation.
description: Provides information that describes an individual assessment from a premigration assessment run.
SchemaShortInfoResponse:
type: object
properties:
SchemaId:
allOf:
- $ref: "#/components/schemas/String"
- description: The ID of a schema in a Fleet Advisor collector inventory.
SchemaName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of a schema in a Fleet Advisor collector inventory.
DatabaseId:
allOf:
- $ref: "#/components/schemas/String"
- description: The ID of a database in a Fleet Advisor collector inventory.
DatabaseName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of a database in a Fleet Advisor collector inventory.
DatabaseIpAddress:
allOf:
- $ref: "#/components/schemas/String"
- description: The IP address of a database in a Fleet Advisor collector inventory.
description: Describes a schema in a Fleet Advisor collector inventory.
StartRecommendationsRequestEntry:
type: object
required:
- DatabaseId
- Settings
properties:
DatabaseId:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the source database.
Settings:
allOf:
- $ref: "#/components/schemas/RecommendationSettings"
- description: The required target engine settings.
description: Provides information about the source database to analyze and provide target recommendations according to the specified requirements.
StartReplicationTaskTypeValue:
type: string
enum:
- start-replication
- resume-processing
- reload-target
Subnet:
type: object
properties:
SubnetIdentifier:
allOf:
- $ref: "#/components/schemas/String"
- description: The subnet identifier.
SubnetAvailabilityZone:
allOf:
- $ref: "#/components/schemas/AvailabilityZone"
- description: The Availability Zone of the subnet.
SubnetStatus:
allOf:
- $ref: "#/components/schemas/String"
- description: The status of the subnet.
description: In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
SupportedEndpointType:
type: object
properties:
EngineName:
allOf:
- $ref: "#/components/schemas/String"
- description: The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".
SupportsCDC:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates if change data capture (CDC) is supported.
EndpointType:
allOf:
- $ref: "#/components/schemas/ReplicationEndpointTypeValue"
- description: The type of endpoint. Valid values are source and target.
ReplicationInstanceEngineMinimumVersion:
allOf:
- $ref: "#/components/schemas/String"
- description: The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.
EngineDisplayName:
allOf:
- $ref: "#/components/schemas/String"
- description: The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".
description: 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.
TableToReload:
type: object
required:
- SchemaName
- TableName
properties:
SchemaName:
allOf:
- $ref: "#/components/schemas/String"
- description: The schema name of the table to be reloaded.
TableName:
allOf:
- $ref: "#/components/schemas/String"
- description: The table name of the table to be reloaded.
description: Provides the name of the schema and table to be reloaded.
TableStatistics:
type: object
properties:
SchemaName:
allOf:
- $ref: "#/components/schemas/String"
- description: The schema name.
TableName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the table.
Inserts:
allOf:
- $ref: "#/components/schemas/Long"
- description: The number of insert actions performed on a table.
Deletes:
allOf:
- $ref: "#/components/schemas/Long"
- description: The number of delete actions performed on a table.
Updates:
allOf:
- $ref: "#/components/schemas/Long"
- description: The number of update actions performed on a table.
Ddls:
allOf:
- $ref: "#/components/schemas/Long"
- description: The data definition language (DDL) used to build and modify the structure of your tables.
AppliedInserts:
allOf:
- $ref: "#/components/schemas/LongOptional"
- description: The number of insert actions applied on a target table.
AppliedDeletes:
allOf:
- $ref: "#/components/schemas/LongOptional"
- description: The number of delete actions applied on a target table.
AppliedUpdates:
allOf:
- $ref: "#/components/schemas/LongOptional"
- description: The number of update actions applied on a target table.
AppliedDdls:
allOf:
- $ref: "#/components/schemas/LongOptional"
- description: The number of data definition language (DDL) statements used to build and modify the structure of your tables applied on the target.
FullLoadRows:
allOf:
- $ref: "#/components/schemas/Long"
- description: The number of rows added during the full load operation.
FullLoadCondtnlChkFailedRows:
allOf:
- $ref: "#/components/schemas/Long"
- description: The number of rows that failed conditional checks during the full load operation (valid only for migrations where DynamoDB is the target).
FullLoadErrorRows:
allOf:
- $ref: "#/components/schemas/Long"
- description: The number of rows that failed to load during the full load operation (valid only for migrations where DynamoDB is the target).
FullLoadStartTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The time when the full load operation started.
FullLoadEndTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The time when the full load operation completed.
FullLoadReloaded:
allOf:
- $ref: "#/components/schemas/BooleanOptional"
- description: A value that indicates if the table was reloaded (true) or loaded as part of a new full load operation (false).
LastUpdateTime:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: The last time a table was updated.
TableState:
allOf:
- $ref: "#/components/schemas/String"
- description: "The state of the tables described.
Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table is being reloaded
" ValidationPendingRecords: allOf: - $ref: "#/components/schemas/Long" - description: The number of records that have yet to be validated. ValidationFailedRecords: allOf: - $ref: "#/components/schemas/Long" - description: The number of records that failed validation. ValidationSuspendedRecords: allOf: - $ref: "#/components/schemas/Long" - description: The number of records that couldn't be validated. ValidationState: allOf: - $ref: "#/components/schemas/String" - description:The validation state of the table.
This parameter can have the following values:
Not enabled – Validation isn't 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 don't match between the source and target.
Suspended records – Some records in the table couldn't be validated.
No primary key –The table couldn't be validated because it has no primary key.
Table error – The table wasn't validated because it's in an error state and some data wasn't migrated.
Validated – All rows in the table are validated. If the table is updated, the status can change from Validated.
Error – The table couldn't be validated because of an unexpected error.
Pending validation – The table is waiting validation.
Preparing table – Preparing the table enabled in the migration task for validation.
Pending revalidation – All rows in the table are pending validation after the table was updated.
DescribeTableStatistics operation.
Tag:
type: object
properties:
Key:
allOf:
- $ref: "#/components/schemas/String"
- description: "A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\")."
Value:
allOf:
- $ref: "#/components/schemas/String"
- description: "A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\")."
ResourceArn:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
description: 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