Skip to content

DescribeTaskResponse

Source code in docs_src/capo_datasync/types/describe_task_response.py
class DescribeTaskResponse(TypedDict, closed=True):
    task_arn: NotRequired["capo_datasync.types.task_arn.TaskArn"]
    """<p>The ARN of your task.</p>"""
    status: NotRequired["capo_datasync.types.task_status.TaskStatus"]
    """<p>The status of your task. For information about what each status means, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task-how-to.html#understand-task-creation-statuses">Task statuses</a>.</p>"""
    name: NotRequired["capo_datasync.types.tag_value.TagValue"]
    """<p>The name of your task.</p>"""
    current_task_execution_arn: NotRequired[
        "capo_datasync.types.task_execution_arn.TaskExecutionArn"
    ]
    """<p>The ARN of the most recent task execution.</p>"""
    source_location_arn: NotRequired["capo_datasync.types.location_arn.LocationArn"]
    """<p>The ARN of your transfer's source location.</p>"""
    destination_location_arn: NotRequired[
        "capo_datasync.types.location_arn.LocationArn"
    ]
    """<p>The ARN of your transfer's destination location.</p>"""
    cloud_watch_log_group_arn: NotRequired[
        "capo_datasync.types.log_group_arn.LogGroupArn"
    ]
    """<p>The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html">Monitoring data transfers with CloudWatch Logs</a>.</p>"""
    source_network_interface_arns: NotRequired[
        "capo_datasync.types.source_network_interface_arns.SourceNetworkInterfaceArns"
    ]
    """<p>The ARNs of the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network interfaces</a> that DataSync created for your source location.</p>"""
    destination_network_interface_arns: NotRequired[
        "capo_datasync.types.destination_network_interface_arns.DestinationNetworkInterfaceArns"
    ]
    """<p>The ARNs of the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network interfaces</a> that DataSync created for your destination location.</p>"""
    options: NotRequired["capo_datasync.types.options.Options"]
    """<p>The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.</p>"""
    excludes: NotRequired["capo_datasync.types.filter_list.FilterList"]
    """<p>The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>"""
    schedule: NotRequired["capo_datasync.types.task_schedule.TaskSchedule"]
    """<p>The schedule for when you want your task to run. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your task</a>.</p>"""
    error_code: NotRequired["capo_datasync.types.string.string"]
    """<p>If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">Troubleshooting issues with DataSync transfers</a>.</p>"""
    error_detail: NotRequired["capo_datasync.types.string.string"]
    """<p>If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">Troubleshooting issues with DataSync transfers</a>.</p>"""
    creation_time: NotRequired["capo_datasync.types.time.Time"]
    """<p>The time that the task was created.</p>"""
    includes: NotRequired["capo_datasync.types.filter_list.FilterList"]
    """<p>The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>"""
    manifest_config: NotRequired["capo_datasync.types.manifest_config.ManifestConfig"]
    """<p>The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html">Specifying what DataSync transfers by using a manifest</a>.</p>"""
    task_report_config: NotRequired[
        "capo_datasync.types.task_report_config.TaskReportConfig"
    ]
    """<p>The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Monitoring your DataSync transfers with task reports</a>.</p>"""
    schedule_details: NotRequired[
        "capo_datasync.types.task_schedule_details.TaskScheduleDetails"
    ]
    """<p>The details about your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">task schedule</a>.</p>"""
    task_mode: NotRequired["capo_datasync.types.task_mode.TaskMode"]
    """<p>The task mode that you're using. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Choosing a task mode for your data transfer</a>.</p>"""

cloud_watch_log_group_arn instance-attribute

cloud_watch_log_group_arn: NotRequired[LogGroupArn]

The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For more information, see Monitoring data transfers with CloudWatch Logs.

creation_time instance-attribute

creation_time: NotRequired[Time]

The time that the task was created.

current_task_execution_arn instance-attribute

current_task_execution_arn: NotRequired[TaskExecutionArn]

The ARN of the most recent task execution.

destination_location_arn instance-attribute

destination_location_arn: NotRequired[LocationArn]

The ARN of your transfer's destination location.

destination_network_interface_arns instance-attribute

destination_network_interface_arns: NotRequired[DestinationNetworkInterfaceArns]

The ARNs of the network interfaces that DataSync created for your destination location.

error_code instance-attribute

error_code: NotRequired[string]

If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

error_detail instance-attribute

error_detail: NotRequired[string]

If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

excludes instance-attribute

excludes: NotRequired[FilterList]

The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

includes instance-attribute

includes: NotRequired[FilterList]

The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

manifest_config instance-attribute

manifest_config: NotRequired[ManifestConfig]

The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

name instance-attribute

name: NotRequired[TagValue]

The name of your task.

options instance-attribute

options: NotRequired[Options]

The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.

schedule instance-attribute

schedule: NotRequired[TaskSchedule]

The schedule for when you want your task to run. For more information, see Scheduling your task.

schedule_details instance-attribute

schedule_details: NotRequired[TaskScheduleDetails]

The details about your task schedule.

source_location_arn instance-attribute

source_location_arn: NotRequired[LocationArn]

The ARN of your transfer's source location.

source_network_interface_arns instance-attribute

source_network_interface_arns: NotRequired[SourceNetworkInterfaceArns]

The ARNs of the network interfaces that DataSync created for your source location.

status instance-attribute

status: NotRequired[TaskStatus]

The status of your task. For information about what each status means, see Task statuses.

task_arn instance-attribute

task_arn: NotRequired[TaskArn]

The ARN of your task.

task_mode instance-attribute

task_mode: NotRequired[TaskMode]

The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

task_report_config instance-attribute

task_report_config: NotRequired[TaskReportConfig]

The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.