Skip to content

describe_replication_task_assessment_results async

describe_replication_task_assessment_results(
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    replication_task_arn: Optional[String] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> DescribeReplicationTaskAssessmentResultsResponse

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest results.

For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.

Parameters:

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

    The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified, the API returns only one result and ignore the values of the MaxRecords and Marker parameters.

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

    The 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.

    Default: 100

    Constraints: Minimum 20, maximum 100.

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

    An 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/async_database_migration_service.py
async def describe_replication_task_assessment_results(
    self,
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    replication_task_arn: Optional[
        "capo_database_migration_service.types.string.String"
    ] = 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_replication_task_assessment_results_response.DescribeReplicationTaskAssessmentResultsResponse":
    """<p>Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest results.</p> <p>For more information about DMS task assessments, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html">Creating a task assessment report</a> in the <i>Database Migration Service User Guide</i>.</p>

    Args:
        replication_task_arn: <p>The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified, the API returns only one result and ignore the values of the <code>MaxRecords</code> and <code>Marker</code> parameters. </p>
        max_records: <p> The 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> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>
        marker: <p> An 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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_database_migration_service.types.describe_replication_task_assessment_results_message.DescribeReplicationTaskAssessmentResultsMessage]",
    ) -> AsyncOperationResponse[
        "capo_database_migration_service.types.describe_replication_task_assessment_results_response.DescribeReplicationTaskAssessmentResultsResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_replication_task_assessment_results

        (
            output,
            http_response,
        ) = await capo_database_migration_service._operations.amazon_dm_sv20160101.describe_replication_task_assessment_results.async_describe_replication_task_assessment_results(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_database_migration_service.types.describe_replication_task_assessment_results_response.DescribeReplicationTaskAssessmentResultsResponse",
    ) -> dict[str, Any]:
        import capo_database_migration_service.types.describe_replication_task_assessment_results_response

        return capo_database_migration_service.types.describe_replication_task_assessment_results_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "DescribeReplicationTaskAssessmentResults", redact_output=_redact_output
        ),
    )
    input_: capo_database_migration_service.types.describe_replication_task_assessment_results_message.DescribeReplicationTaskAssessmentResultsMessage = {}
    if replication_task_arn is not None:
        input_["replication_task_arn"] = replication_task_arn
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output