openapi: 3.0.0 info: version: 2016-01-01 x-release: v4 title: 'AWS Database Migration Service Endpoints #X Amz Target=AmazonDMSv20160101.BatchStartRecommendations API' description: Database Migration Service

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 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) security: - hmac: [] tags: - name: '#X Amz Target=AmazonDMSv20160101.BatchStartRecommendations' paths: /#X-Amz-Target=AmazonDMSv20160101.BatchStartRecommendations: 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' 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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchStartRecommendationsResponse' '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/BatchStartRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.BatchStartRecommendations tags: - '#X Amz Target=AmazonDMSv20160101.BatchStartRecommendations' components: schemas: 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. StartRecommendationsRequestEntryList: type: array items: $ref: '#/components/schemas/StartRecommendationsRequestEntry' 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. InvalidResourceStateFault: {} String: type: string BatchStartRecommendationsErrorEntryList: type: array items: $ref: '#/components/schemas/BatchStartRecommendationsErrorEntry' BatchStartRecommendationsRequest: type: object title: BatchStartRecommendationsRequest properties: Data: allOf: - $ref: '#/components/schemas/StartRecommendationsRequestEntryList' - description: Provides information about source databases to analyze. After this analysis, Fleet Advisor recommends target engines for each source database. 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. BatchStartRecommendationsResponse: type: object properties: ErrorEntries: allOf: - $ref: '#/components/schemas/BatchStartRecommendationsErrorEntryList' - description: A list with error details about the analysis of each source database. ResourceNotFoundFault: {} AccessDeniedFault: {} parameters: X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 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 securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/dms/ x-hasEquivalentPaths: true