1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package datasync 4 5import ( 6 "context" 7 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" 8 "github.com/aws/aws-sdk-go-v2/aws/signer/v4" 9 "github.com/aws/aws-sdk-go-v2/service/datasync/types" 10 "github.com/aws/smithy-go/middleware" 11 smithyhttp "github.com/aws/smithy-go/transport/http" 12 "time" 13) 14 15// Returns metadata such as the name, the network interfaces, and the status (that 16// is, whether the agent is running or not) for an agent. To specify which agent to 17// describe, use the Amazon Resource Name (ARN) of the agent in your request. 18func (c *Client) DescribeAgent(ctx context.Context, params *DescribeAgentInput, optFns ...func(*Options)) (*DescribeAgentOutput, error) { 19 if params == nil { 20 params = &DescribeAgentInput{} 21 } 22 23 result, metadata, err := c.invokeOperation(ctx, "DescribeAgent", params, optFns, addOperationDescribeAgentMiddlewares) 24 if err != nil { 25 return nil, err 26 } 27 28 out := result.(*DescribeAgentOutput) 29 out.ResultMetadata = metadata 30 return out, nil 31} 32 33// DescribeAgent 34type DescribeAgentInput struct { 35 36 // The Amazon Resource Name (ARN) of the agent to describe. 37 // 38 // This member is required. 39 AgentArn *string 40} 41 42// DescribeAgentResponse 43type DescribeAgentOutput struct { 44 45 // The Amazon Resource Name (ARN) of the agent. 46 AgentArn *string 47 48 // The time that the agent was activated (that is, created in your account). 49 CreationTime *time.Time 50 51 // The type of endpoint that your agent is connected to. If the endpoint is a VPC 52 // endpoint, the agent is not accessible over the public internet. 53 EndpointType types.EndpointType 54 55 // The time that the agent last connected to DataSyc. 56 LastConnectionTime *time.Time 57 58 // The name of the agent. 59 Name *string 60 61 // The subnet and the security group that DataSync used to access a VPC endpoint. 62 PrivateLinkConfig *types.PrivateLinkConfig 63 64 // The status of the agent. If the status is ONLINE, then the agent is configured 65 // properly and is available to use. The Running status is the normal running 66 // status for an agent. If the status is OFFLINE, the agent's VM is turned off or 67 // the agent is in an unhealthy state. When the issue that caused the unhealthy 68 // state is resolved, the agent returns to ONLINE status. 69 Status types.AgentStatus 70 71 // Metadata pertaining to the operation's result. 72 ResultMetadata middleware.Metadata 73} 74 75func addOperationDescribeAgentMiddlewares(stack *middleware.Stack, options Options) (err error) { 76 err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeAgent{}, middleware.After) 77 if err != nil { 78 return err 79 } 80 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeAgent{}, middleware.After) 81 if err != nil { 82 return err 83 } 84 if err = addSetLoggerMiddleware(stack, options); err != nil { 85 return err 86 } 87 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 88 return err 89 } 90 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 91 return err 92 } 93 if err = addResolveEndpointMiddleware(stack, options); err != nil { 94 return err 95 } 96 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 97 return err 98 } 99 if err = addRetryMiddlewares(stack, options); err != nil { 100 return err 101 } 102 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 103 return err 104 } 105 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 106 return err 107 } 108 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 109 return err 110 } 111 if err = addClientUserAgent(stack); err != nil { 112 return err 113 } 114 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 115 return err 116 } 117 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 118 return err 119 } 120 if err = addOpDescribeAgentValidationMiddleware(stack); err != nil { 121 return err 122 } 123 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeAgent(options.Region), middleware.Before); err != nil { 124 return err 125 } 126 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 127 return err 128 } 129 if err = addResponseErrorMiddleware(stack); err != nil { 130 return err 131 } 132 if err = addRequestResponseLogging(stack, options); err != nil { 133 return err 134 } 135 return nil 136} 137 138func newServiceMetadataMiddleware_opDescribeAgent(region string) *awsmiddleware.RegisterServiceMetadata { 139 return &awsmiddleware.RegisterServiceMetadata{ 140 Region: region, 141 ServiceID: ServiceID, 142 SigningName: "datasync", 143 OperationName: "DescribeAgent", 144 } 145} 146