DatabaseMigrationService / Client / describe_migration_projects

describe_migration_projects#

DatabaseMigrationService.Client.describe_migration_projects(**kwargs)#

Returns a paginated list of migration projects for your account in the current region.

See also: AWS API Documentation

Request Syntax

response = client.describe_migration_projects(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • Filters (list) –

    Filters applied to the migration projects described in the form of key-value pairs.

    • (dict) –

      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.

      • Name (string) – [REQUIRED]

        The name of the filter as specified for a Describe* or similar operation.

      • Values (list) – [REQUIRED]

        The filter value, which can specify one or more values used to narrow the returned results.

        • (string) –

  • MaxRecords (integer) – The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

  • Marker (string) –

    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 Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'MigrationProjects': [
        {
            '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) –

    • Marker (string) –

      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 Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    • MigrationProjects (list) –

      A description of migration projects.

      • (dict) –

        Provides information that defines a migration project.

        • 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