Skip to content

describe_applicable_individual_assessments

describe_applicable_individual_assessments(
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
    replication_task_arn: Optional[String] = None,
    replication_instance_arn: Optional[String] = None,
    replication_config_arn: Optional[String] = None,
    source_engine_name: Optional[String] = None,
    target_engine_name: Optional[String] = None,
    migration_type: Optional[MigrationTypeValue] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> DescribeApplicableIndividualAssessmentsResponse

Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.

If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.

To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.

If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.

Parameters:

  • replication_task_arn (Optional[String], default: None ) –

    Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.

  • replication_instance_arn (Optional[String], default: None ) –

    ARN of a replication instance on which you want to base the default list of individual assessments.

  • replication_config_arn (Optional[String], default: None ) –

    Amazon Resource Name (ARN) of a serverless replication on which you want to base the default list of individual assessments.

  • source_engine_name (Optional[String], default: None ) –

    Name of a database engine that the specified replication instance supports as a source.

  • target_engine_name (Optional[String], default: None ) –

    Name of a database engine that the specified replication instance supports as a target.

  • migration_type (Optional[MigrationTypeValue], default: None ) –

    Name of the migration type that each provided individual assessment must support.

  • max_records (Optional[IntegerOptional], default: None ) –

    Maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

  • marker (Optional[String], default: None ) –

    Optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Raises:

Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py
def describe_applicable_individual_assessments(
    self,
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
    replication_task_arn: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    replication_instance_arn: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    replication_config_arn: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    source_engine_name: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    target_engine_name: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    migration_type: Optional[
        "capo_database_migration_service.types.migration_type_value.MigrationTypeValue"
    ] = None,
    max_records: Optional[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_database_migration_service.types.string.String"] = None,
) -> "capo_database_migration_service.types.describe_applicable_individual_assessments_response.DescribeApplicableIndividualAssessmentsResponse":
    """<p>Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.</p> <p>If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.</p> <p>To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.</p> <p>If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.</p>

    Args:
        replication_task_arn: <p>Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.</p>
        replication_instance_arn: <p>ARN of a replication instance on which you want to base the default list of individual assessments.</p>
        replication_config_arn: <p>Amazon Resource Name (ARN) of a serverless replication on which you want to base the default list of individual assessments.</p>
        source_engine_name: <p>Name of a database engine that the specified replication instance supports as a source.</p>
        target_engine_name: <p>Name of a database engine that the specified replication instance supports as a target.</p>
        migration_type: <p>Name of the migration type that each provided individual assessment must support.</p>
        max_records: <p>Maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</p>
        marker: <p>Optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>

    Raises:
        capo_database_migration_service.errors.access_denied_fault.AccessDeniedFault: <p>DMS was denied access to the endpoint. Check that the role is correctly configured.</p>
        capo_database_migration_service.errors.invalid_resource_state_fault.InvalidResourceStateFault: <p>The resource is in a state that prevents it from being used for database migration.</p>
        capo_database_migration_service.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The resource could not be found.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_database_migration_service.types.describe_applicable_individual_assessments_message.DescribeApplicableIndividualAssessmentsMessage]",
    ) -> OperationResponse[
        "capo_database_migration_service.types.describe_applicable_individual_assessments_response.DescribeApplicableIndividualAssessmentsResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_applicable_individual_assessments

        output, http_response = (
            capo_database_migration_service._operations.amazon_dm_sv20160101.describe_applicable_individual_assessments.describe_applicable_individual_assessments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeApplicableIndividualAssessments"),
    )
    input_: capo_database_migration_service.types.describe_applicable_individual_assessments_message.DescribeApplicableIndividualAssessmentsMessage = {}
    if replication_task_arn is not None:
        input_["replication_task_arn"] = replication_task_arn
    if replication_instance_arn is not None:
        input_["replication_instance_arn"] = replication_instance_arn
    if replication_config_arn is not None:
        input_["replication_config_arn"] = replication_config_arn
    if source_engine_name is not None:
        input_["source_engine_name"] = source_engine_name
    if target_engine_name is not None:
        input_["target_engine_name"] = target_engine_name
    if migration_type is not None:
        input_["migration_type"] = migration_type
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output