Skip to content

TaskReportConfig

Source code in docs_src/capo_datasync/types/task_report_config.py
class TaskReportConfig(TypedDict, closed=True):
    destination: NotRequired["capo_datasync.types.report_destination.ReportDestination"]
    """<p>Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access">Task reports</a>.</p>"""
    output_type: NotRequired["capo_datasync.types.report_output_type.ReportOutputType"]
    """<p>Specifies the type of task report that you want:</p> <ul> <li> <p> <code>SUMMARY_ONLY</code>: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.</p> </li> <li> <p> <code>STANDARD</code>: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.</p> </li> </ul>"""
    report_level: NotRequired["capo_datasync.types.report_level.ReportLevel"]
    """<p>Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.</p> <ul> <li> <p> <code>ERRORS_ONLY</code>: A report shows what DataSync was unable to transfer, skip, verify, and delete.</p> </li> <li> <p> <code>SUCCESSES_AND_ERRORS</code>: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.</p> </li> </ul>"""
    object_version_ids: NotRequired[
        "capo_datasync.types.object_version_ids.ObjectVersionIds"
    ]
    """<p>Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html">enable versioning on your bucket</a>. Keep in mind that setting this to <code>INCLUDE</code> can increase the duration of your task execution.</p>"""
    overrides: NotRequired["capo_datasync.types.report_overrides.ReportOverrides"]
    """<p>Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.</p>"""

destination instance-attribute

destination: NotRequired[ReportDestination]

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

object_version_ids instance-attribute

object_version_ids: NotRequired[ObjectVersionIds]

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

output_type instance-attribute

output_type: NotRequired[ReportOutputType]

Specifies the type of task report that you want:

  • SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

  • STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

overrides instance-attribute

overrides: NotRequired[ReportOverrides]

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

report_level instance-attribute

report_level: NotRequired[ReportLevel]

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

  • ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

  • SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.