1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package kendra
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/kendra/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12	"time"
13)
14
15// Gets information about a Amazon Kendra data source.
16func (c *Client) DescribeDataSource(ctx context.Context, params *DescribeDataSourceInput, optFns ...func(*Options)) (*DescribeDataSourceOutput, error) {
17	if params == nil {
18		params = &DescribeDataSourceInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribeDataSource", params, optFns, addOperationDescribeDataSourceMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribeDataSourceOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribeDataSourceInput struct {
32
33	// The unique identifier of the data source to describe.
34	//
35	// This member is required.
36	Id *string
37
38	// The identifier of the index that contains the data source.
39	//
40	// This member is required.
41	IndexId *string
42}
43
44type DescribeDataSourceOutput struct {
45
46	// Information that describes where the data source is located and how the data
47	// source is configured. The specific information in the description depends on the
48	// data source provider.
49	Configuration *types.DataSourceConfiguration
50
51	// The Unix timestamp of when the data source was created.
52	CreatedAt *time.Time
53
54	// The description of the data source.
55	Description *string
56
57	// When the Status field value is FAILED, the ErrorMessage field contains a
58	// description of the error that caused the data source to fail.
59	ErrorMessage *string
60
61	// The identifier of the data source.
62	Id *string
63
64	// The identifier of the index that contains the data source.
65	IndexId *string
66
67	// The name that you gave the data source when it was created.
68	Name *string
69
70	// The Amazon Resource Name (ARN) of the role that enables the data source to
71	// access its resources.
72	RoleArn *string
73
74	// The schedule that Amazon Kendra will update the data source.
75	Schedule *string
76
77	// The current status of the data source. When the status is ACTIVE the data source
78	// is ready to use. When the status is FAILED, the ErrorMessage field contains the
79	// reason that the data source failed.
80	Status types.DataSourceStatus
81
82	// The type of the data source.
83	Type types.DataSourceType
84
85	// The Unix timestamp of when the data source was last updated.
86	UpdatedAt *time.Time
87
88	// Metadata pertaining to the operation's result.
89	ResultMetadata middleware.Metadata
90}
91
92func addOperationDescribeDataSourceMiddlewares(stack *middleware.Stack, options Options) (err error) {
93	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeDataSource{}, middleware.After)
94	if err != nil {
95		return err
96	}
97	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeDataSource{}, middleware.After)
98	if err != nil {
99		return err
100	}
101	if err = addSetLoggerMiddleware(stack, options); err != nil {
102		return err
103	}
104	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
105		return err
106	}
107	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
108		return err
109	}
110	if err = addResolveEndpointMiddleware(stack, options); err != nil {
111		return err
112	}
113	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
114		return err
115	}
116	if err = addRetryMiddlewares(stack, options); err != nil {
117		return err
118	}
119	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
120		return err
121	}
122	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
123		return err
124	}
125	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
126		return err
127	}
128	if err = addClientUserAgent(stack); err != nil {
129		return err
130	}
131	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
132		return err
133	}
134	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
135		return err
136	}
137	if err = addOpDescribeDataSourceValidationMiddleware(stack); err != nil {
138		return err
139	}
140	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDataSource(options.Region), middleware.Before); err != nil {
141		return err
142	}
143	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
144		return err
145	}
146	if err = addResponseErrorMiddleware(stack); err != nil {
147		return err
148	}
149	if err = addRequestResponseLogging(stack, options); err != nil {
150		return err
151	}
152	return nil
153}
154
155func newServiceMetadataMiddleware_opDescribeDataSource(region string) *awsmiddleware.RegisterServiceMetadata {
156	return &awsmiddleware.RegisterServiceMetadata{
157		Region:        region,
158		ServiceID:     ServiceID,
159		SigningName:   "kendra",
160		OperationName: "DescribeDataSource",
161	}
162}
163