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 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
|
// 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"
)
// Creates an Amazon Kendra index. Index creation is an asynchronous API. To
// determine if index creation has completed, check the Status field returned from
// a call to DescribeIndex. The Status field is set to ACTIVE when the index is
// ready to use. Once the index is active you can index your documents using the
// BatchPutDocument API or using one of the supported data sources. For an example
// of creating an index and data source using the Python SDK, see Getting started
// with Python SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html).
// For an example of creating an index and data source using the Java SDK, see
// Getting started with Java SDK
// (https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html).
func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error) {
if params == nil {
params = &CreateIndexInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateIndex", params, optFns, c.addOperationCreateIndexMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateIndexOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateIndexInput struct {
// A name for the index.
//
// This member is required.
Name *string
// An Identity and Access Management (IAM) role that gives Amazon Kendra
// permissions to access your Amazon CloudWatch logs and metrics. This is also the
// role you use when you call the BatchPutDocument API to index documents from an
// Amazon S3 bucket.
//
// This member is required.
RoleArn *string
// A token that you provide to identify the request to create an index. Multiple
// calls to the CreateIndex API with the same client token will create only one
// index.
ClientToken *string
// A description for the index.
Description *string
// The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for
// indexes intended for development, testing, or proof of concept. Use
// ENTERPRISE_EDITION for your production databases. Once you set the edition for
// an index, it can't be changed. The Edition parameter is optional. If you don't
// supply a value, the default is ENTERPRISE_EDITION. For more information on quota
// limits for enterprise and developer editions, see Quotas
// (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
Edition types.IndexEdition
// The identifier of the KMS customer managed key (CMK) that's used to encrypt data
// indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration
// A list of key-value pairs that identify the index. You can use the tags to
// identify and organize your resources and to control access to resources.
Tags []types.Tag
// The user context policy. ATTRIBUTE_FILTER All indexed content is searchable and
// displayable for all users. If you want to filter search results on user context,
// you can use the attribute filters of _user_id and _group_ids or you can provide
// user and group information in UserContext. USER_TOKEN Enables token-based user
// access control to filter search results on user context. All documents with no
// access control and all documents accessible to the user will be searchable and
// displayable.
UserContextPolicy types.UserContextPolicy
// Enables fetching access levels of groups and users from an IAM Identity Center
// (successor to Single Sign-On) identity source. To configure this, see
// UserGroupResolutionConfiguration
// (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html).
UserGroupResolutionConfiguration *types.UserGroupResolutionConfiguration
// The user token configuration.
UserTokenConfigurations []types.UserTokenConfiguration
noSmithyDocumentSerde
}
type CreateIndexOutput struct {
// The unique identifier of the index. Use this identifier when you query an index,
// set up a data source, or index a document.
Id *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateIndexMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateIndex{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateIndex{}, middleware.After)
if 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 = addHTTPSignerV4Middleware(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); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addIdempotencyToken_opCreateIndexMiddleware(stack, options); err != nil {
return err
}
if err = addOpCreateIndexValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateIndex(options.Region), middleware.Before); 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
}
return nil
}
type idempotencyToken_initializeOpCreateIndex struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpCreateIndex) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpCreateIndex) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*CreateIndexInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *CreateIndexInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opCreateIndexMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpCreateIndex{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opCreateIndex(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "kendra",
OperationName: "CreateIndex",
}
}
|