Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.CreateIndex

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.

Synopsis

data CreateIndex = CreateIndex' {
- clientToken :: Maybe Text
- description :: Maybe Text
- edition :: Maybe IndexEdition
- serverSideEncryptionConfiguration :: Maybe ServerSideEncryptionConfiguration
- tags :: Maybe [Tag]
- userContextPolicy :: Maybe UserContextPolicy
- userGroupResolutionConfiguration :: Maybe UserGroupResolutionConfiguration
- userTokenConfigurations :: Maybe [UserTokenConfiguration]
- name :: Text
- roleArn :: Text
}
newCreateIndex :: Text -> Text -> CreateIndex
createIndex_clientToken :: Lens' CreateIndex (Maybe Text)
createIndex_description :: Lens' CreateIndex (Maybe Text)
createIndex_edition :: Lens' CreateIndex (Maybe IndexEdition)
createIndex_serverSideEncryptionConfiguration :: Lens' CreateIndex (Maybe ServerSideEncryptionConfiguration)
createIndex_tags :: Lens' CreateIndex (Maybe [Tag])
createIndex_userContextPolicy :: Lens' CreateIndex (Maybe UserContextPolicy)
createIndex_userGroupResolutionConfiguration :: Lens' CreateIndex (Maybe UserGroupResolutionConfiguration)
createIndex_userTokenConfigurations :: Lens' CreateIndex (Maybe [UserTokenConfiguration])
createIndex_name :: Lens' CreateIndex Text
createIndex_roleArn :: Lens' CreateIndex Text
data CreateIndexResponse = CreateIndexResponse' {
- id :: Maybe Text
- httpStatus :: Int
}
newCreateIndexResponse :: Int -> CreateIndexResponse
createIndexResponse_id :: Lens' CreateIndexResponse (Maybe Text)
createIndexResponse_httpStatus :: Lens' CreateIndexResponse Int

Creating a Request

data CreateIndex Source #

See: newCreateIndex smart constructor.

Constructors

CreateIndex'

Fields

clientToken :: Maybe Text
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.
description :: Maybe Text
A description for the index.
edition :: Maybe IndexEdition
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.
serverSideEncryptionConfiguration :: Maybe ServerSideEncryptionConfiguration
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.
tags :: Maybe [Tag]
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.
userContextPolicy :: Maybe UserContextPolicy
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.
userGroupResolutionConfiguration :: Maybe UserGroupResolutionConfiguration
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.
userTokenConfigurations :: Maybe [UserTokenConfiguration]
The user token configuration.
name :: Text
A name for the index.
roleArn :: Text
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.

Instances

Instances details

ToJSON CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods toJSON :: CreateIndex -> Value # toEncoding :: CreateIndex -> Encoding # toJSONList :: [CreateIndex] -> Value # toEncodingList :: [CreateIndex] -> Encoding #
ToHeaders CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods toHeaders :: CreateIndex -> [Header] #
ToPath CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods toPath :: CreateIndex -> ByteString #
ToQuery CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods toQuery :: CreateIndex -> QueryString #
AWSRequest CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Associated Types type AWSResponse CreateIndex # Methods request :: (Service -> Service) -> CreateIndex -> Request CreateIndex # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateIndex -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateIndex))) #
Generic CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Associated Types type Rep CreateIndex :: Type -> Type # Methods from :: CreateIndex -> Rep CreateIndex x # to :: Rep CreateIndex x -> CreateIndex #
Show CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods showsPrec :: Int -> CreateIndex -> ShowS # show :: CreateIndex -> String # showList :: [CreateIndex] -> ShowS #
NFData CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods rnf :: CreateIndex -> () #
Eq CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods (==) :: CreateIndex -> CreateIndex -> Bool # (/=) :: CreateIndex -> CreateIndex -> Bool #
Hashable CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods hashWithSalt :: Int -> CreateIndex -> Int # hash :: CreateIndex -> Int #
type AWSResponse CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex type AWSResponse CreateIndex = CreateIndexResponse
type Rep CreateIndex Source #
Instance details Defined in Amazonka.Kendra.CreateIndex type Rep CreateIndex = D1 ('MetaData "CreateIndex" "Amazonka.Kendra.CreateIndex" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateIndex'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "edition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexEdition)) :: (S1 ('MetaSel ('Just "serverSideEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerSideEncryptionConfiguration)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))))) :: ((S1 ('MetaSel ('Just "userContextPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContextPolicy)) :: S1 ('MetaSel ('Just "userGroupResolutionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserGroupResolutionConfiguration))) :: (S1 ('MetaSel ('Just "userTokenConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserTokenConfiguration])) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateIndex Source #

Arguments

:: Text	`CreateIndex`
-> Text	`CreateIndex`
-> CreateIndex

Create a value of CreateIndex with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateIndex', createIndex_clientToken - 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.

$sel:description:CreateIndex', createIndex_description - A description for the index.

CreateIndex, createIndex_edition - 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.

$sel:serverSideEncryptionConfiguration:CreateIndex', createIndex_serverSideEncryptionConfiguration - 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.

$sel:tags:CreateIndex', createIndex_tags - 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.

$sel:userContextPolicy:CreateIndex', createIndex_userContextPolicy - 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.

$sel:userGroupResolutionConfiguration:CreateIndex', createIndex_userGroupResolutionConfiguration - 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.

$sel:userTokenConfigurations:CreateIndex', createIndex_userTokenConfigurations - The user token configuration.

CreateIndex, createIndex_name - A name for the index.

CreateIndex, createIndex_roleArn - 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.

Request Lenses

createIndex_clientToken :: Lens' CreateIndex (Maybe Text) Source #

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.

createIndex_description :: Lens' CreateIndex (Maybe Text) Source #

A description for the index.

createIndex_edition :: Lens' CreateIndex (Maybe IndexEdition) Source #

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.

createIndex_serverSideEncryptionConfiguration :: Lens' CreateIndex (Maybe ServerSideEncryptionConfiguration) Source #

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.

createIndex_tags :: Lens' CreateIndex (Maybe [Tag]) Source #

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.

createIndex_userContextPolicy :: Lens' CreateIndex (Maybe UserContextPolicy) Source #

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.

createIndex_userGroupResolutionConfiguration :: Lens' CreateIndex (Maybe UserGroupResolutionConfiguration) Source #

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.

createIndex_userTokenConfigurations :: Lens' CreateIndex (Maybe [UserTokenConfiguration]) Source #

The user token configuration.

createIndex_name :: Lens' CreateIndex Text Source #

A name for the index.

createIndex_roleArn :: Lens' CreateIndex Text Source #

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.

Destructuring the Response

data CreateIndexResponse Source #

See: newCreateIndexResponse smart constructor.

Constructors

CreateIndexResponse'
Fields id :: Maybe Text The identifier of the index. Use this identifier when you query an index, set up a data source, or index a document. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Associated Types type Rep CreateIndexResponse :: Type -> Type # Methods from :: CreateIndexResponse -> Rep CreateIndexResponse x # to :: Rep CreateIndexResponse x -> CreateIndexResponse #
Read CreateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods readsPrec :: Int -> ReadS CreateIndexResponse # readList :: ReadS [CreateIndexResponse] # readPrec :: ReadPrec CreateIndexResponse # readListPrec :: ReadPrec [CreateIndexResponse] #
Show CreateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods showsPrec :: Int -> CreateIndexResponse -> ShowS # show :: CreateIndexResponse -> String # showList :: [CreateIndexResponse] -> ShowS #
NFData CreateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods rnf :: CreateIndexResponse -> () #
Eq CreateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.CreateIndex Methods (==) :: CreateIndexResponse -> CreateIndexResponse -> Bool # (/=) :: CreateIndexResponse -> CreateIndexResponse -> Bool #
type Rep CreateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.CreateIndex type Rep CreateIndexResponse = D1 ('MetaData "CreateIndexResponse" "Amazonka.Kendra.CreateIndex" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateIndexResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateIndexResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateIndexResponse'`
-> CreateIndexResponse

Create a value of CreateIndexResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateIndexResponse, createIndexResponse_id - The identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.

$sel:httpStatus:CreateIndexResponse', createIndexResponse_httpStatus - The response's http status code.

Response Lenses

createIndexResponse_id :: Lens' CreateIndexResponse (Maybe Text) Source #

The identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.

createIndexResponse_httpStatus :: Lens' CreateIndexResponse Int Source #

The response's http status code.