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
|
// 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 metadata about a task.
func (c *Client) DescribeTask(ctx context.Context, params *DescribeTaskInput, optFns ...func(*Options)) (*DescribeTaskOutput, error) {
if params == nil {
params = &DescribeTaskInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeTask", params, optFns, c.addOperationDescribeTaskMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeTaskOutput)
out.ResultMetadata = metadata
return out, nil
}
// DescribeTaskRequest
type DescribeTaskInput struct {
// The Amazon Resource Name (ARN) of the task to describe.
//
// This member is required.
TaskArn *string
noSmithyDocumentSerde
}
// DescribeTaskResponse
type DescribeTaskOutput struct {
// The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used
// to monitor and log events in the task. For more information on these groups, see
// Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.
CloudWatchLogGroupArn *string
// The time that the task was created.
CreationTime *time.Time
// The Amazon Resource Name (ARN) of the task execution that is syncing files.
CurrentTaskExecutionArn *string
// The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's
// location.
DestinationLocationArn *string
// The Amazon Resource Names (ARNs) of the destination elastic network interfaces
// (ENIs) that were created for your subnet.
DestinationNetworkInterfaceArns []string
// Errors that DataSync encountered during execution of the task. You can use this
// error code to help troubleshoot issues.
ErrorCode *string
// Detailed description of an error that was encountered during the task execution.
// You can use this information to help troubleshoot issues.
ErrorDetail *string
// 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
// A list of filter rules that determines which files to include when running a
// task. The pattern contains 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
// The name of the task that was described.
Name *string
// The set of configuration options that control the behavior of a single execution
// of the task that occurs when you call StartTaskExecution. You can configure
// these options to preserve metadata such as user ID (UID) and group (GID), file
// permissions, data integrity verification, and so on. For each individual task
// execution, you can override these options by specifying the overriding
// OverrideOptions value to StartTaskExecution
// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)
// operation.
Options *types.Options
// The schedule used to periodically transfer files from a source to a destination
// location.
Schedule *types.TaskSchedule
// The Amazon Resource Name (ARN) of the source file system's location.
SourceLocationArn *string
// The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs)
// that were created for your subnet.
SourceNetworkInterfaceArns []string
// The status of the task that was described. For detailed information about task
// execution statuses, see Understanding Task Statuses in the DataSync User Guide.
Status types.TaskStatus
// The Amazon Resource Name (ARN) of the task that was described.
TaskArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeTaskMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeTask{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeTask{}, 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 = addOpDescribeTaskValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeTask(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_opDescribeTask(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "datasync",
OperationName: "DescribeTask",
}
}
|