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.CloudDirectory.CreateIndex

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an index object. See Indexing and search for more information.

Creating a Request

data CreateIndex Source #

See: newCreateIndex smart constructor.

Constructors

CreateIndex'

Fields

linkName :: Maybe Text
The name of the link between the parent object and the index object.
parentReference :: Maybe ObjectReference
A reference to the parent object that contains the index object.
directoryArn :: Text
The ARN of the directory where the index should be created.
orderedIndexedAttributeList :: [AttributeKey]
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
isUnique :: Bool
Indicates whether the attribute that is being indexed has unique values or not.

Instances

Instances details

ToJSON CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods toJSON :: CreateIndex -> Value # toEncoding :: CreateIndex -> Encoding # toJSONList :: [CreateIndex] -> Value # toEncodingList :: [CreateIndex] -> Encoding #
ToHeaders CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods toHeaders :: CreateIndex -> [Header] #
ToPath CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods toPath :: CreateIndex -> ByteString #
ToQuery CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods toQuery :: CreateIndex -> QueryString #
AWSRequest CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.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.CloudDirectory.CreateIndex Associated Types type Rep CreateIndex :: Type -> Type # Methods from :: CreateIndex -> Rep CreateIndex x # to :: Rep CreateIndex x -> CreateIndex #
Read CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods readsPrec :: Int -> ReadS CreateIndex # readList :: ReadS [CreateIndex] # readPrec :: ReadPrec CreateIndex # readListPrec :: ReadPrec [CreateIndex] #
Show CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods showsPrec :: Int -> CreateIndex -> ShowS # show :: CreateIndex -> String # showList :: [CreateIndex] -> ShowS #
NFData CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods rnf :: CreateIndex -> () #
Eq CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods (==) :: CreateIndex -> CreateIndex -> Bool # (/=) :: CreateIndex -> CreateIndex -> Bool #
Hashable CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods hashWithSalt :: Int -> CreateIndex -> Int # hash :: CreateIndex -> Int #
type AWSResponse CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex type AWSResponse CreateIndex = CreateIndexResponse
type Rep CreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex type Rep CreateIndex = D1 ('MetaData "CreateIndex" "Amazonka.CloudDirectory.CreateIndex" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "CreateIndex'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "linkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parentReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectReference))) :: (S1 ('MetaSel ('Just "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "orderedIndexedAttributeList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AttributeKey]) :: S1 ('MetaSel ('Just "isUnique") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

newCreateIndex Source #

Arguments

:: Text	`CreateIndex`
-> Bool	`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:

CreateIndex, createIndex_linkName - The name of the link between the parent object and the index object.

CreateIndex, createIndex_parentReference - A reference to the parent object that contains the index object.

CreateIndex, createIndex_directoryArn - The ARN of the directory where the index should be created.

CreateIndex, createIndex_orderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

CreateIndex, createIndex_isUnique - Indicates whether the attribute that is being indexed has unique values or not.

Request Lenses

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

The name of the link between the parent object and the index object.

createIndex_parentReference :: Lens' CreateIndex (Maybe ObjectReference) Source #

A reference to the parent object that contains the index object.

createIndex_directoryArn :: Lens' CreateIndex Text Source #

The ARN of the directory where the index should be created.

createIndex_orderedIndexedAttributeList :: Lens' CreateIndex [AttributeKey] Source #

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

createIndex_isUnique :: Lens' CreateIndex Bool Source #

Indicates whether the attribute that is being indexed has unique values or not.

Destructuring the Response

data CreateIndexResponse Source #

See: newCreateIndexResponse smart constructor.

Constructors

CreateIndexResponse'
Fields objectIdentifier :: Maybe Text The `ObjectIdentifier` of the index created by this operation. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.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.CloudDirectory.CreateIndex Methods readsPrec :: Int -> ReadS CreateIndexResponse # readList :: ReadS [CreateIndexResponse] # readPrec :: ReadPrec CreateIndexResponse # readListPrec :: ReadPrec [CreateIndexResponse] #
Show CreateIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods showsPrec :: Int -> CreateIndexResponse -> ShowS # show :: CreateIndexResponse -> String # showList :: [CreateIndexResponse] -> ShowS #
NFData CreateIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods rnf :: CreateIndexResponse -> () #
Eq CreateIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex Methods (==) :: CreateIndexResponse -> CreateIndexResponse -> Bool # (/=) :: CreateIndexResponse -> CreateIndexResponse -> Bool #
type Rep CreateIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.CreateIndex type Rep CreateIndexResponse = D1 ('MetaData "CreateIndexResponse" "Amazonka.CloudDirectory.CreateIndex" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "CreateIndexResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "objectIdentifier") '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_objectIdentifier - The ObjectIdentifier of the index created by this operation.

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

Response Lenses

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

The ObjectIdentifier of the index created by this operation.

createIndexResponse_httpStatus :: Lens' CreateIndexResponse Int Source #

The response's http status code.