Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DeleteMigrationProject

Deletes the specified migration project.

Note

The migration project must be closed before you can delete it.

Request Syntax


{
   "MigrationProjectIdentifier": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MigrationProjectIdentifier

The name or Amazon Resource Name (ARN) of the migration project to delete.

Type: String

Required: Yes

Response Syntax


{
   "MigrationProject": { 
      "Description": "string",
      "InstanceProfileArn": "string",
      "InstanceProfileName": "string",
      "MigrationProjectArn": "string",
      "MigrationProjectCreationTime": "string",
      "MigrationProjectName": "string",
      "SchemaConversionApplicationAttributes": { 
         "S3BucketPath": "string",
         "S3BucketRoleArn": "string"
      },
      "SourceDataProviderDescriptors": [ 
         { 
            "DataProviderArn": "string",
            "DataProviderName": "string",
            "SecretsManagerAccessRoleArn": "string",
            "SecretsManagerSecretId": "string"
         }
      ],
      "TargetDataProviderDescriptors": [ 
         { 
            "DataProviderArn": "string",
            "DataProviderName": "string",
            "SecretsManagerAccessRoleArn": "string",
            "SecretsManagerSecretId": "string"
         }
      ],
      "TransformationRules": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MigrationProject

The migration project that was deleted.

Type: MigrationProject object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedFault

Amazon DMS was denied access to the endpoint. Check that the role is correctly configured.

HTTP Status Code: 400

AccessDeniedFault

Amazon DMS was denied access to the endpoint. Check that the role is correctly configured.

HTTP Status Code: 400

FailedDependencyFault

A dependency threw an exception.

HTTP Status Code: 400

InvalidResourceStateFault

The resource is in a state that prevents it from being used for database migration.

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeleteMigrationProject.

Sample Request


{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
}