DatabaseMigrationService / Client / modify_migration_project

modify_migration_project#

DatabaseMigrationService.Client.modify_migration_project(**kwargs)#

Modifies the specified migration project using the provided parameters.

Note

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

Request Syntax

response = client.modify_migration_project(
    MigrationProjectIdentifier='string',
    MigrationProjectName='string',
    SourceDataProviderDescriptors=[
        {
            'DataProviderIdentifier': 'string',
            'SecretsManagerSecretId': 'string',
            'SecretsManagerAccessRoleArn': 'string'
        },
    ],
    TargetDataProviderDescriptors=[
        {
            'DataProviderIdentifier': 'string',
            'SecretsManagerSecretId': 'string',
            'SecretsManagerAccessRoleArn': 'string'
        },
    ],
    InstanceProfileIdentifier='string',
    TransformationRules='string',
    Description='string',
    SchemaConversionApplicationAttributes={
        'S3BucketPath': 'string',
        'S3BucketRoleArn': 'string'
    }
)

Parameters:

MigrationProjectIdentifier (string) –
[REQUIRED]

The identifier of the migration project. 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.
MigrationProjectName (string) – A user-friendly name for the migration project.
SourceDataProviderDescriptors (list) –
Information about the source 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.
TargetDataProviderDescriptors (list) –
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) – The name or Amazon Resource Name (ARN) for the instance profile.
TransformationRules (string) – The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
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.

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 modified.
  - 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 settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
  - 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.

Exceptions

DatabaseMigrationService.Client.exceptions.AccessDeniedFault
DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault
DatabaseMigrationService.Client.exceptions.InvalidResourceStateFault
DatabaseMigrationService.Client.exceptions.S3ResourceNotFoundFault
DatabaseMigrationService.Client.exceptions.S3AccessDeniedFault
DatabaseMigrationService.Client.exceptions.FailedDependencyFault