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 192 193 194 195 196 197 198 199 200 201 202
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package kendra
import (
"context"
"fmt"
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/kendra/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Gets information about an Amazon Kendra data source connector.
func (c *Client) DescribeDataSource(ctx context.Context, params *DescribeDataSourceInput, optFns ...func(*Options)) (*DescribeDataSourceOutput, error) {
if params == nil {
params = &DescribeDataSourceInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeDataSource", params, optFns, c.addOperationDescribeDataSourceMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeDataSourceOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeDataSourceInput struct {
// The identifier of the data source connector.
//
// This member is required.
Id *string
// The identifier of the index used with the data source connector.
//
// This member is required.
IndexId *string
noSmithyDocumentSerde
}
type DescribeDataSourceOutput struct {
// Configuration details for the data source connector. This shows how the data
// source is configured. The configuration options for a data source depend on the
// data source provider.
Configuration *types.DataSourceConfiguration
// The Unix timestamp when the data source connector was created.
CreatedAt *time.Time
// Configuration information for altering document metadata and content during the
// document ingestion process when you describe a data source. For more information
// on how to create, modify and delete document metadata, or make other content
// alterations when you ingest documents into Amazon Kendra, see Customizing
// document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html)
// .
CustomDocumentEnrichmentConfiguration *types.CustomDocumentEnrichmentConfiguration
// The description for the data source connector.
Description *string
// When the Status field value is FAILED , the ErrorMessage field contains a
// description of the error that caused the data source to fail.
ErrorMessage *string
// The identifier of the data source connector.
Id *string
// The identifier of the index used with the data source connector.
IndexId *string
// The code for a language. This shows a supported language for all documents in
// the data source. English is supported by default. For more information on
// supported languages, including their codes, see Adding documents in languages
// other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html)
// .
LanguageCode *string
// The name for the data source connector.
Name *string
// The Amazon Resource Name (ARN) of the role with permission to access the data
// source and required resources.
RoleArn *string
// The schedule for Amazon Kendra to update the index.
Schedule *string
// The current status of the data source connector. When the status is ACTIVE the
// data source is ready to use. When the status is FAILED , the ErrorMessage field
// contains the reason that the data source failed.
Status types.DataSourceStatus
// The type of the data source. For example, SHAREPOINT .
Type types.DataSourceType
// The Unix timestamp when the data source connector was last updated.
UpdatedAt *time.Time
// Configuration information for an Amazon Virtual Private Cloud to connect to
// your data source. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)
// .
VpcConfiguration *types.DataSourceVpcConfiguration
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeDataSourceMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeDataSource{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeDataSource{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeDataSource"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); 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 = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeDataSourceValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDataSource(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeDataSource(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeDataSource",
}
}
|