1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package datasync
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"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"
)
// Returns detailed metadata about a task that is being executed.
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 {
// The Amazon Resource Name (ARN) of the task that is being executed.
//
// This member is required.
TaskExecutionArn *string
noSmithyDocumentSerde
}
// DescribeTaskExecutionResponse
type DescribeTaskExecutionOutput struct {
// The physical number of bytes transferred over the network after compression was
// applied. In most cases, this number is less than BytesTransferred.
BytesCompressed int64
// The physical number of bytes transferred over the network.
BytesTransferred int64
// The number of logical bytes written to the destination Amazon Web Services
// storage resource.
BytesWritten int64
// The estimated physical number of bytes that is to be transferred over the
// network.
EstimatedBytesToTransfer int64
// The expected number of files that is to be transferred over the network. This
// value is calculated during the PREPARING phase, before the TRANSFERRING phase.
// This value is the expected number of files to be transferred. It's calculated
// based on comparing the content of the source and destination locations and
// finding the delta that needs to be transferred.
EstimatedFilesToTransfer int64
// A list of filter rules that determines which files to exclude from a task. The
// list should contain a single filter string that consists of the patterns to
// exclude. The patterns are delimited by "|" (that is, a pipe), for example:
// "/folder1|/folder2"
Excludes []types.FilterRule
// The actual number of files that was transferred over the network. This value is
// calculated and updated on an ongoing basis during the TRANSFERRING phase. It's
// updated periodically when each file is read from the source and sent over the
// network. If failures occur during a transfer, this value can be less than
// EstimatedFilesToTransfer. This value can also be greater than
// EstimatedFilesTransferred in some cases. This element is implementation-specific
// for some location types, so don't use it as an indicator for a correct file
// number or to monitor your task execution.
FilesTransferred int64
// A list of filter rules that determines which files to include when running a
// task. The list should contain a single filter string that consists of the
// patterns to include. The patterns are delimited by "|" (that is, a pipe), for
// example: "/folder1|/folder2"
Includes []types.FilterRule
// Represents the options that are available to control the behavior of a
// StartTaskExecution
// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)
// operation. Behavior includes preserving metadata such as user ID (UID), group ID
// (GID), and file permissions, and also overwriting files in the destination, data
// integrity verification, and so on. A task has a set of default options
// associated with it. If you don't specify an option in StartTaskExecution
// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html),
// the default value is used. You can override the defaults options on each task
// execution by specifying an overriding Options value to StartTaskExecution
// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).
Options *types.Options
// The result of the task execution.
Result *types.TaskExecutionResultDetail
// The time that the task execution was started.
StartTime *time.Time
// The status of the task execution. For detailed information about task execution
// statuses, see Understanding Task Statuses in the DataSync User Guide.
Status types.TaskExecutionStatus
// The Amazon Resource Name (ARN) of the task execution that was described.
// 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
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeTaskExecutionMiddlewares(stack *middleware.Stack, options Options) (err error) {
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 = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); 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 = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeTaskExecution(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "datasync",
OperationName: "DescribeTaskExecution",
}
}
|
