// Code generated by smithy-go-codegen DO NOT EDIT.

package datasync

import (
	"context"
	"fmt"
	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
	"github.com/aws/aws-sdk-go-v2/service/datasync/types"
	"github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
	"time"
)

// Provides information about an execution of your DataSync task. You can use this
// operation to help monitor the progress of an ongoing data transfer or check the
// results of the transfer.
//
// Some DescribeTaskExecution response elements are only relevant to a specific
// task mode. For information, see [Understanding task mode differences]and [Understanding data transfer performance counters].
//
// [Understanding task mode differences]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences
// [Understanding data transfer performance counters]: https://docs.aws.amazon.com/datasync/latest/userguide/transfer-performance-counters.html
func (c *Client) DescribeTaskExecution(ctx context.Context, params *DescribeTaskExecutionInput, optFns ...func(*Options)) (*DescribeTaskExecutionOutput, error) {
	if params == nil {
		params = &DescribeTaskExecutionInput{}
	}

	result, metadata, err := c.invokeOperation(ctx, "DescribeTaskExecution", params, optFns, c.addOperationDescribeTaskExecutionMiddlewares)
	if err != nil {
		return nil, err
	}

	out := result.(*DescribeTaskExecutionOutput)
	out.ResultMetadata = metadata
	return out, nil
}

// DescribeTaskExecutionRequest
type DescribeTaskExecutionInput struct {

	// Specifies the Amazon Resource Name (ARN) of the task execution that you want
	// information about.
	//
	// This member is required.
	TaskExecutionArn *string

	noSmithyDocumentSerde
}

// DescribeTaskExecutionResponse
type DescribeTaskExecutionOutput struct {

	// The number of physical bytes that DataSync transfers over the network after
	// compression (if compression is possible). This number is typically less than [BytesTransferred]
	// unless the data isn't compressible.
	//
	// [BytesTransferred]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesTransferred
	BytesCompressed int64

	// The number of bytes that DataSync sends to the network before compression (if
	// compression is possible). For the number of bytes transferred over the network,
	// see [BytesCompressed].
	//
	// [BytesCompressed]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesCompressed
	BytesTransferred int64

	// The number of logical bytes that DataSync actually writes to the destination
	// location.
	BytesWritten int64

	// The time that the transfer task ends.
	EndTime *time.Time

	// The number of logical bytes that DataSync expects to write to the destination
	// location.
	EstimatedBytesToTransfer int64

	// The number of files, objects, and directories that DataSync expects to delete
	// in your destination location. If you don't configure your task to [delete data in the destination that isn't in the source], the value
	// is always 0 .
	//
	// For [Enhanced mode tasks], this counter only includes files or objects. Directories are counted in [EstimatedFoldersToDelete].
	//
	// [EstimatedFoldersToDelete]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-EstimatedFoldersToDelete
	// [delete data in the destination that isn't in the source]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	EstimatedFilesToDelete int64

	// The number of files, objects, and directories that DataSync expects to transfer
	// over the network. This value is calculated while DataSync [prepares]the transfer.
	//
	// How this gets calculated depends primarily on your task’s [transfer mode] configuration:
	//
	//   - If TranserMode is set to CHANGED - The calculation is based on comparing the
	//   content of the source and destination locations and determining the difference
	//   that needs to be transferred. The difference can include:
	//
	//   - Anything that's added or modified at the source location.
	//
	//   - Anything that's in both locations and modified at the destination after an
	//   initial transfer (unless [OverwriteMode]is set to NEVER ).
	//
	//   - (Basic task mode only) The number of items that DataSync expects to delete
	//   (if [PreserveDeletedFiles]is set to REMOVE ).
	//
	//   - If TranserMode is set to ALL - The calculation is based only on the items
	//   that DataSync finds at the source location.
	//
	// For [Enhanced mode tasks], this counter only includes files or objects. Directories are counted in [EstimatedFoldersToTransfer].
	//
	// [transfer mode]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode
	// [OverwriteMode]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode
	// [EstimatedFoldersToTransfer]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-EstimatedFoldersToTransfer
	// [prepares]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	// [PreserveDeletedFiles]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-PreserveDeletedFiles
	EstimatedFilesToTransfer int64

	// The number of directories that DataSync expects to delete in your destination
	// location. If you don't configure your task to [delete data in the destination that isn't in the source], the value is always 0 .
	//
	// Applies only to [Enhanced mode tasks].
	//
	// [delete data in the destination that isn't in the source]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	EstimatedFoldersToDelete *int64

	// The number of directories that DataSync expects to transfer over the network.
	// This value is calculated as DataSync [prepares]directories to transfer.
	//
	// How this gets calculated depends primarily on your task’s [transfer mode] configuration:
	//
	//   - If TranserMode is set to CHANGED - The calculation is based on comparing the
	//   content of the source and destination locations and determining the difference
	//   that needs to be transferred. The difference can include:
	//
	//   - Anything that's added or modified at the source location.
	//
	//   - Anything that's in both locations and modified at the destination after an
	//   initial transfer (unless [OverwriteMode]is set to NEVER ).
	//
	//   - If TranserMode is set to ALL - The calculation is based only on the items
	//   that DataSync finds at the source location.
	//
	// Applies only to [Enhanced mode tasks].
	//
	// [transfer mode]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode
	// [OverwriteMode]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode
	// [prepares]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	EstimatedFoldersToTransfer *int64

	// A list of filter rules that exclude specific data during your transfer. For
	// more information and examples, see [Filtering data transferred by DataSync].
	//
	// [Filtering data transferred by DataSync]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
	Excludes []types.FilterRule

	// The number of files, objects, and directories that DataSync actually deletes in
	// your destination location. If you don't configure your task to [delete data in the destination that isn't in the source], the value is
	// always 0 .
	//
	// For [Enhanced mode tasks], this counter only includes files or objects. Directories are counted in [FoldersDeleted].
	//
	// [delete data in the destination that isn't in the source]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	// [FoldersDeleted]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersDeleted
	FilesDeleted int64

	// The number of files or objects that DataSync fails to prepare, transfer,
	// verify, and delete during your task execution.
	//
	// Applies only to [Enhanced mode tasks].
	//
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FilesFailed *types.TaskExecutionFilesFailedDetail

	// The number of files or objects that DataSync finds at your locations.
	//
	// Applies only to [Enhanced mode tasks].
	//
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FilesListed *types.TaskExecutionFilesListedDetail

	// The number of files or objects that DataSync will attempt to transfer after
	// comparing your source and destination locations.
	//
	// Applies only to [Enhanced mode tasks].
	//
	// This counter isn't applicable if you configure your task to [transfer all data]. In that scenario,
	// DataSync copies everything from the source to the destination without comparing
	// differences between the locations.
	//
	// [transfer all data]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FilesPrepared int64

	// The number of files, objects, and directories that DataSync skips during your
	// transfer.
	//
	// For [Enhanced mode tasks], this counter only includes files or objects. Directories are counted in [FoldersSkipped].
	//
	// [FoldersSkipped]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersSkipped
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FilesSkipped int64

	// The number of files, objects, and directories that DataSync actually transfers
	// over the network. This value is updated periodically during your task execution
	// when something is read from the source and sent over the network.
	//
	// If DataSync fails to transfer something, this value can be less than
	// EstimatedFilesToTransfer . In some cases, this value can also be greater than
	// EstimatedFilesToTransfer . This element is implementation-specific for some
	// location types, so don't use it as an exact indication of what's transferring or
	// to monitor your task execution.
	//
	// For [Enhanced mode tasks], this counter only includes files or objects. Directories are counted in [FoldersTransferred].
	//
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	// [FoldersTransferred]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersTransferred
	FilesTransferred int64

	// The number of files, objects, and directories that DataSync verifies during
	// your transfer.
	//
	// When you configure your task to [verify only the data that's transferred], DataSync doesn't verify directories in some
	// situations or files that fail to transfer.
	//
	// For [Enhanced mode tasks], this counter only includes files or objects. Directories are counted in [FoldersVerified].
	//
	// [FoldersVerified]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersVerified
	// [verify only the data that's transferred]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FilesVerified int64

	// The number of directories that DataSync actually deletes in your destination
	// location. If you don't configure your task to [delete data in the destination that isn't in the source], the value is always 0 .
	//
	// Applies only to [Enhanced mode tasks].
	//
	// [delete data in the destination that isn't in the source]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FoldersDeleted *int64

	// The number of directories that DataSync fails to list, prepare, transfer,
	// verify, and delete during your task execution.
	//
	// Applies only to [Enhanced mode tasks].
	//
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FoldersFailed *types.TaskExecutionFoldersFailedDetail

	// The number of directories that DataSync finds at your locations.
	//
	// Applies only to [Enhanced mode tasks].
	//
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FoldersListed *types.TaskExecutionFoldersListedDetail

	// The number of directories that DataSync will attempt to transfer after
	// comparing your source and destination locations.
	//
	// Applies only to [Enhanced mode tasks].
	//
	// This counter isn't applicable if you configure your task to [transfer all data]. In that scenario,
	// DataSync copies everything from the source to the destination without comparing
	// differences between the locations.
	//
	// [transfer all data]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FoldersPrepared *int64

	// The number of directories that DataSync skips during your transfer.
	//
	// Applies only to [Enhanced mode tasks].
	//
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FoldersSkipped *int64

	// The number of directories that DataSync actually transfers over the network.
	// This value is updated periodically during your task execution when something is
	// read from the source and sent over the network.
	//
	// If DataSync fails to transfer something, this value can be less than
	// EstimatedFoldersToTransfer . In some cases, this value can also be greater than
	// EstimatedFoldersToTransfer .
	//
	// Applies only to [Enhanced mode tasks].
	//
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FoldersTransferred *int64

	// The number of directories that DataSync verifies during your transfer.
	//
	// Applies only to [Enhanced mode tasks].
	//
	// [Enhanced mode tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	FoldersVerified *int64

	// A list of filter rules that include specific data during your transfer. For
	// more information and examples, see [Filtering data transferred by DataSync].
	//
	// [Filtering data transferred by DataSync]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
	Includes []types.FilterRule

	// The time that the task execution actually begins. For non-queued tasks,
	// LaunchTime and StartTime are typically the same. For queued tasks, LaunchTime
	// is typically later than StartTime because previously queued tasks must finish
	// running before newer tasks can begin.
	LaunchTime *time.Time

	// The configuration of the manifest that lists the files or objects to transfer.
	// For more information, see [Specifying what DataSync transfers by using a manifest].
	//
	// [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
	ManifestConfig *types.ManifestConfig

	// Indicates how your transfer task is configured. These options include how
	// DataSync handles files, objects, and their associated metadata during your
	// transfer. You also can specify how to verify data integrity, set bandwidth
	// limits for your task, among other options.
	//
	// Each option has a default value. Unless you need to, you don't have to
	// configure any option before calling [StartTaskExecution].
	//
	// You also can override your task options for each task execution. For example,
	// you might want to adjust the LogLevel for an individual execution.
	//
	// [StartTaskExecution]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
	Options *types.Options

	// Indicates whether DataSync generated a complete [task report] for your transfer.
	//
	// [task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
	ReportResult *types.ReportResult

	// The result of the task execution.
	Result *types.TaskExecutionResultDetail

	// The time that DataSync sends the request to start the task execution. For
	// non-queued tasks, LaunchTime and StartTime are typically the same. For queued
	// tasks, LaunchTime is typically later than StartTime because previously queued
	// tasks must finish running before newer tasks can begin.
	StartTime *time.Time

	// The status of the task execution.
	Status types.TaskExecutionStatus

	// The ARN of the task execution that you wanted information about.
	// TaskExecutionArn is hierarchical and includes TaskArn for the task that was
	// executed.
	//
	// For example, a TaskExecution value with the ARN
	// arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
	// executed the task with the ARN
	// arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2 .
	TaskExecutionArn *string

	// The task mode that you're using. For more information, see [Choosing a task mode for your data transfer].
	//
	// [Choosing a task mode for your data transfer]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
	TaskMode types.TaskMode

	// The configuration of your task report, which provides detailed information
	// about for your DataSync transfer. For more information, see [Creating a task report].
	//
	// [Creating a task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
	TaskReportConfig *types.TaskReportConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata

	noSmithyDocumentSerde
}

func (c *Client) addOperationDescribeTaskExecutionMiddlewares(stack *middleware.Stack, options Options) (err error) {
	if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
		return err
	}
	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeTaskExecution{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeTaskExecution{}, middleware.After)
	if err != nil {
		return err
	}
	if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeTaskExecution"); err != nil {
		return fmt.Errorf("add protocol finalizers: %v", err)
	}

	if err = addlegacyEndpointContextSetter(stack, options); err != nil {
		return err
	}
	if err = addSetLoggerMiddleware(stack, options); err != nil {
		return err
	}
	if err = addClientRequestID(stack); err != nil {
		return err
	}
	if err = addComputeContentLength(stack); err != nil {
		return err
	}
	if err = addResolveEndpointMiddleware(stack, options); err != nil {
		return err
	}
	if err = addComputePayloadSHA256(stack); err != nil {
		return err
	}
	if err = addRetry(stack, options); err != nil {
		return err
	}
	if err = addRawResponseToMetadata(stack); err != nil {
		return err
	}
	if err = addRecordResponseTiming(stack); err != nil {
		return err
	}
	if err = addSpanRetryLoop(stack, options); err != nil {
		return err
	}
	if err = addClientUserAgent(stack, options); err != nil {
		return err
	}
	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
		return err
	}
	if err = addTimeOffsetBuild(stack, c); err != nil {
		return err
	}
	if err = addUserAgentRetryMode(stack, options); err != nil {
		return err
	}
	if err = addCredentialSource(stack, options); err != nil {
		return err
	}
	if err = addOpDescribeTaskExecutionValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeTaskExecution(options.Region), middleware.Before); err != nil {
		return err
	}
	if err = addRecursionDetection(stack); err != nil {
		return err
	}
	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
		return err
	}
	if err = addResponseErrorMiddleware(stack); err != nil {
		return err
	}
	if err = addRequestResponseLogging(stack, options); err != nil {
		return err
	}
	if err = addDisableHTTPSMiddleware(stack, options); err != nil {
		return err
	}
	if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
		return err
	}
	if err = addInterceptAttempt(stack, options); err != nil {
		return err
	}
	if err = addInterceptors(stack, options); err != nil {
		return err
	}
	return nil
}

func newServiceMetadataMiddleware_opDescribeTaskExecution(region string) *awsmiddleware.RegisterServiceMetadata {
	return &awsmiddleware.RegisterServiceMetadata{
		Region:        region,
		ServiceID:     ServiceID,
		OperationName: "DescribeTaskExecution",
	}
}
