1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package workdocs
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/workdocs/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// List all the comments for the specified document version.
15func (c *Client) DescribeComments(ctx context.Context, params *DescribeCommentsInput, optFns ...func(*Options)) (*DescribeCommentsOutput, error) {
16	if params == nil {
17		params = &DescribeCommentsInput{}
18	}
19
20	result, metadata, err := c.invokeOperation(ctx, "DescribeComments", params, optFns, addOperationDescribeCommentsMiddlewares)
21	if err != nil {
22		return nil, err
23	}
24
25	out := result.(*DescribeCommentsOutput)
26	out.ResultMetadata = metadata
27	return out, nil
28}
29
30type DescribeCommentsInput struct {
31
32	// The ID of the document.
33	//
34	// This member is required.
35	DocumentId *string
36
37	// The ID of the document version.
38	//
39	// This member is required.
40	VersionId *string
41
42	// Amazon WorkDocs authentication token. Not required when using AWS administrator
43	// credentials to access the API.
44	AuthenticationToken *string
45
46	// The maximum number of items to return.
47	Limit *int32
48
49	// The marker for the next set of results. This marker was received from a previous
50	// call.
51	Marker *string
52}
53
54type DescribeCommentsOutput struct {
55
56	// The list of comments for the specified document version.
57	Comments []types.Comment
58
59	// The marker for the next set of results. This marker was received from a previous
60	// call.
61	Marker *string
62
63	// Metadata pertaining to the operation's result.
64	ResultMetadata middleware.Metadata
65}
66
67func addOperationDescribeCommentsMiddlewares(stack *middleware.Stack, options Options) (err error) {
68	err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeComments{}, middleware.After)
69	if err != nil {
70		return err
71	}
72	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeComments{}, middleware.After)
73	if err != nil {
74		return err
75	}
76	if err = addSetLoggerMiddleware(stack, options); err != nil {
77		return err
78	}
79	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
80		return err
81	}
82	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
83		return err
84	}
85	if err = addResolveEndpointMiddleware(stack, options); err != nil {
86		return err
87	}
88	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
89		return err
90	}
91	if err = addRetryMiddlewares(stack, options); err != nil {
92		return err
93	}
94	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
95		return err
96	}
97	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
101		return err
102	}
103	if err = addClientUserAgent(stack); err != nil {
104		return err
105	}
106	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
107		return err
108	}
109	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
110		return err
111	}
112	if err = addOpDescribeCommentsValidationMiddleware(stack); err != nil {
113		return err
114	}
115	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeComments(options.Region), middleware.Before); err != nil {
116		return err
117	}
118	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
119		return err
120	}
121	if err = addResponseErrorMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addRequestResponseLogging(stack, options); err != nil {
125		return err
126	}
127	return nil
128}
129
130func newServiceMetadataMiddleware_opDescribeComments(region string) *awsmiddleware.RegisterServiceMetadata {
131	return &awsmiddleware.RegisterServiceMetadata{
132		Region:        region,
133		ServiceID:     ServiceID,
134		SigningName:   "workdocs",
135		OperationName: "DescribeComments",
136	}
137}
138