DatabaseMigrationService / Client / create_migration_project

create_migration_project¶

DatabaseMigrationService.Client.create_migration_project(**kwargs)¶

Creates the migration project using the specified parameters.

You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider.

Required permissions: dms:CreateMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service.

Request Syntax

response = client.create_migration_project(
    MigrationProjectName='string',
    SourceDataProviderDescriptors=[
        {
            'DataProviderIdentifier': 'string',
            'SecretsManagerSecretId': 'string',
            'SecretsManagerAccessRoleArn': 'string'
        },
    ],
    TargetDataProviderDescriptors=[
        {
            'DataProviderIdentifier': 'string',
            'SecretsManagerSecretId': 'string',
            'SecretsManagerAccessRoleArn': 'string'
        },
    ],
    InstanceProfileIdentifier='string',
    TransformationRules='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string',
            'ResourceArn': 'string'
        },
    ],
    SchemaConversionApplicationAttributes={
        'S3BucketPath': 'string',
        'S3BucketRoleArn': 'string'
    }
)

Parameters:

MigrationProjectName (string) – A user-friendly name for the migration project.
SourceDataProviderDescriptors (list) –
[REQUIRED]

Information about the source data provider, including the name, ARN, and Secrets Manager parameters.
- (dict) –
  
  Information about a data provider.
  - DataProviderIdentifier (string) – [REQUIRED]
    
    The name or Amazon Resource Name (ARN) of the data provider.
  - SecretsManagerSecretId (string) –
    
    The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
  - SecretsManagerAccessRoleArn (string) –
    
    The ARN of the role used to access Amazon Web Services Secrets Manager.
TargetDataProviderDescriptors (list) –
[REQUIRED]

Information about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
- (dict) –
  
  Information about a data provider.
  - DataProviderIdentifier (string) – [REQUIRED]
    
    The name or Amazon Resource Name (ARN) of the data provider.
  - SecretsManagerSecretId (string) –
    
    The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
  - SecretsManagerAccessRoleArn (string) –
    
    The ARN of the role used to access Amazon Web Services Secrets Manager.
InstanceProfileIdentifier (string) –
[REQUIRED]

The identifier of the associated instance profile. 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.
TransformationRules (string) –
A JSON string that specifies the transformation rules for the migration project. Transformation rules let you customize how DMS Schema Conversion converts your source database objects, including renaming, adding prefixes or suffixes, and changing data types. For the transformation rule format and examples, see Transformation rules in DMS Schema Conversion.

Note
Homogeneous data migrations do not support transformation rules.
Description (string) – A user-friendly description of the migration project.
Tags (list) –
One or more tags to be assigned to the migration project.
- (dict) –
  
  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
  - Key (string) –
    
    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 (string) –
    
    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 (string) –
    
    The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
SchemaConversionApplicationAttributes (dict) –
The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
- S3BucketPath (string) –
  
  The path for the Amazon S3 bucket that the application uses for exporting assessment reports.
- S3BucketRoleArn (string) –
  
  The ARN for the role the application uses to access its Amazon S3 bucket.

Return type:

dict

Returns:

Response Syntax

{
    'MigrationProject': {
        'MigrationProjectName': 'string',
        'MigrationProjectArn': 'string',
        'MigrationProjectCreationTime': datetime(2015, 1, 1),
        'SourceDataProviderDescriptors': [
            {
                'SecretsManagerSecretId': 'string',
                'SecretsManagerAccessRoleArn': 'string',
                'DataProviderName': 'string',
                'DataProviderArn': 'string'
            },
        ],
        'TargetDataProviderDescriptors': [
            {
                'SecretsManagerSecretId': 'string',
                'SecretsManagerAccessRoleArn': 'string',
                'DataProviderName': 'string',
                'DataProviderArn': 'string'
            },
        ],
        'InstanceProfileArn': 'string',
        'InstanceProfileName': 'string',
        'TransformationRules': 'string',
        'Description': 'string',
        'SchemaConversionApplicationAttributes': {
            'S3BucketPath': 'string',
            'S3BucketRoleArn': 'string'
        }
    }
}

Response Structure

(dict) –
- MigrationProject (dict) –
  
  The migration project that was created.
  - MigrationProjectName (string) –
    
    The name of the migration project.
  - MigrationProjectArn (string) –
    
    The ARN string that uniquely identifies the migration project.
  - MigrationProjectCreationTime (datetime) –
    
    The time when the migration project was created.
  - SourceDataProviderDescriptors (list) –
    
    Information about the source data provider, including the name or ARN, and Secrets Manager parameters.
    - (dict) –
      
      Information about a data provider.
      - SecretsManagerSecretId (string) –
        
        The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
      - SecretsManagerAccessRoleArn (string) –
        
        The ARN of the role used to access Amazon Web Services Secrets Manager.
      - DataProviderName (string) –
        
        The user-friendly name of the data provider.
      - DataProviderArn (string) –
        
        The Amazon Resource Name (ARN) of the data provider.
  - TargetDataProviderDescriptors (list) –
    
    Information about the target data provider, including the name or ARN, and Secrets Manager parameters.
    - (dict) –
      
      Information about a data provider.
      - SecretsManagerSecretId (string) –
        
        The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
      - SecretsManagerAccessRoleArn (string) –
        
        The ARN of the role used to access Amazon Web Services Secrets Manager.
      - DataProviderName (string) –
        
        The user-friendly name of the data provider.
      - DataProviderArn (string) –
        
        The Amazon Resource Name (ARN) of the data provider.
  - InstanceProfileArn (string) –
    
    The Amazon Resource Name (ARN) of the instance profile for your migration project.
  - InstanceProfileName (string) –
    
    The name of the associated instance profile.
  - TransformationRules (string) –
    
    The transformation rules for the migration project in JSON format. Transformation rules let you customize how DMS Schema Conversion converts your source database objects, including renaming, adding prefixes or suffixes, and changing data types. For the transformation rule format and examples, see Transformation rules in DMS Schema Conversion.
    
    Note
    Homogeneous data migrations do not support transformation rules.
  - Description (string) –
    
    A user-friendly description of the migration project.
  - SchemaConversionApplicationAttributes (dict) –
    
    The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
    - S3BucketPath (string) –
      
      The path for the Amazon S3 bucket that the application uses for exporting assessment reports.
    - S3BucketRoleArn (string) –
      
      The ARN for the role the application uses to access its Amazon S3 bucket.

create_migration_project¶

Request Syntax

Note

Response Syntax

Response Structure

Note

Exceptions