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// Retrieves the path information (the hierarchy from the root folder) for the
15// requested document. By default, Amazon WorkDocs returns a maximum of 100 levels
16// upwards from the requested document and only includes the IDs of the parent
17// folders in the path. You can limit the maximum number of levels. You can also
18// request the names of the parent folders.
19func (c *Client) GetDocumentPath(ctx context.Context, params *GetDocumentPathInput, optFns ...func(*Options)) (*GetDocumentPathOutput, error) {
20	if params == nil {
21		params = &GetDocumentPathInput{}
22	}
23
24	result, metadata, err := c.invokeOperation(ctx, "GetDocumentPath", params, optFns, addOperationGetDocumentPathMiddlewares)
25	if err != nil {
26		return nil, err
27	}
28
29	out := result.(*GetDocumentPathOutput)
30	out.ResultMetadata = metadata
31	return out, nil
32}
33
34type GetDocumentPathInput struct {
35
36	// The ID of the document.
37	//
38	// This member is required.
39	DocumentId *string
40
41	// Amazon WorkDocs authentication token. Not required when using AWS administrator
42	// credentials to access the API.
43	AuthenticationToken *string
44
45	// A comma-separated list of values. Specify NAME to include the names of the
46	// parent folders.
47	Fields *string
48
49	// The maximum number of levels in the hierarchy to return.
50	Limit *int32
51
52	// This value is not supported.
53	Marker *string
54}
55
56type GetDocumentPathOutput struct {
57
58	// The path information.
59	Path *types.ResourcePath
60
61	// Metadata pertaining to the operation's result.
62	ResultMetadata middleware.Metadata
63}
64
65func addOperationGetDocumentPathMiddlewares(stack *middleware.Stack, options Options) (err error) {
66	err = stack.Serialize.Add(&awsRestjson1_serializeOpGetDocumentPath{}, middleware.After)
67	if err != nil {
68		return err
69	}
70	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetDocumentPath{}, middleware.After)
71	if err != nil {
72		return err
73	}
74	if err = addSetLoggerMiddleware(stack, options); err != nil {
75		return err
76	}
77	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
78		return err
79	}
80	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
81		return err
82	}
83	if err = addResolveEndpointMiddleware(stack, options); err != nil {
84		return err
85	}
86	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
87		return err
88	}
89	if err = addRetryMiddlewares(stack, options); err != nil {
90		return err
91	}
92	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
93		return err
94	}
95	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
96		return err
97	}
98	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
99		return err
100	}
101	if err = addClientUserAgent(stack); err != nil {
102		return err
103	}
104	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
105		return err
106	}
107	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
108		return err
109	}
110	if err = addOpGetDocumentPathValidationMiddleware(stack); err != nil {
111		return err
112	}
113	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetDocumentPath(options.Region), middleware.Before); err != nil {
114		return err
115	}
116	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
117		return err
118	}
119	if err = addResponseErrorMiddleware(stack); err != nil {
120		return err
121	}
122	if err = addRequestResponseLogging(stack, options); err != nil {
123		return err
124	}
125	return nil
126}
127
128func newServiceMetadataMiddleware_opGetDocumentPath(region string) *awsmiddleware.RegisterServiceMetadata {
129	return &awsmiddleware.RegisterServiceMetadata{
130		Region:        region,
131		ServiceID:     ServiceID,
132		SigningName:   "workdocs",
133		OperationName: "GetDocumentPath",
134	}
135}
136