Network.AWS.CloudDirectory.CreateIndex

Creates an index object. See Indexing for more information.

Creating a Request

createIndex

Arguments

:: Text

ciDirectoryARN

-> Bool

ciIsUnique

-> CreateIndex

Creates a value of CreateIndex with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ciParentReference - A reference to the parent object that contains the index object.
• ciLinkName - The name of the link between the parent object and the index object.
• ciDirectoryARN - The ARN of the directory where the index should be created.
• ciOrderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
• ciIsUnique - Indicates whether the attribute that is being indexed has unique values or not.

data CreateIndex

See: createIndex smart constructor.

Instances

Eq CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

(==) :: CreateIndex -> CreateIndex -> Bool

(/=) :: CreateIndex -> CreateIndex -> Bool

Data CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateIndex -> c CreateIndex

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateIndex

toConstr :: CreateIndex -> Constr

dataTypeOf :: CreateIndex -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateIndex)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateIndex)

gmapT :: (forall b. Data b => b -> b) -> CreateIndex -> CreateIndex

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateIndex -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateIndex -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateIndex -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateIndex -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateIndex -> m CreateIndex

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateIndex -> m CreateIndex

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateIndex -> m CreateIndex

Read CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

readsPrec :: Int -> ReadS CreateIndex

readList :: ReadS [CreateIndex]

readPrec :: ReadPrec CreateIndex

readListPrec :: ReadPrec [CreateIndex]

Show CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

showsPrec :: Int -> CreateIndex -> ShowS

show :: CreateIndex -> String

showList :: [CreateIndex] -> ShowS

Generic CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Associated Types

type Rep CreateIndex :: Type -> Type

Methods

from :: CreateIndex -> Rep CreateIndex x

to :: Rep CreateIndex x -> CreateIndex

Hashable CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

hashWithSalt :: Int -> CreateIndex -> Int

hash :: CreateIndex -> Int

ToJSON CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

toJSON :: CreateIndex -> Value

toEncoding :: CreateIndex -> Encoding

toJSONList :: [CreateIndex] -> Value

toEncodingList :: [CreateIndex] -> Encoding

AWSRequest CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Associated Types

type Rs CreateIndex :: Type

Methods

request :: CreateIndex -> Request CreateIndex

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateIndex -> ClientResponse -> m (Response CreateIndex)

ToHeaders CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

toHeaders :: CreateIndex -> [Header]

ToPath CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

toPath :: CreateIndex -> ByteString

ToQuery CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

toQuery :: CreateIndex -> QueryString

NFData CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

rnf :: CreateIndex -> ()

type Rep CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

type Rep CreateIndex = D1 (MetaData "CreateIndex" "Network.AWS.CloudDirectory.CreateIndex" "amazonka-clouddirectory-1.6.1-JrYxtgIzVKD25mU0ZgOTPe" False) (C1 (MetaCons "CreateIndex'" PrefixI True) ((S1 (MetaSel (Just "_ciParentReference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ObjectReference)) :*: S1 (MetaSel (Just "_ciLinkName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ciDirectoryARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_ciOrderedIndexedAttributeList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [AttributeKey]) :*: S1 (MetaSel (Just "_ciIsUnique") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))))

type Rs CreateIndex

Defined in Network.AWS.CloudDirectory.CreateIndex

type Rs CreateIndex = CreateIndexResponse

Request Lenses

ciParentReference :: Lens' CreateIndex (Maybe ObjectReference)

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

ciLinkName :: Lens' CreateIndex (Maybe Text)

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

ciDirectoryARN :: Lens' CreateIndex Text

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

ciOrderedIndexedAttributeList :: Lens' CreateIndex [AttributeKey]

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

ciIsUnique :: Lens' CreateIndex Bool

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

Destructuring the Response

createIndexResponse

Arguments

:: Int

cirsResponseStatus

-> CreateIndexResponse

Creates a value of CreateIndexResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cirsObjectIdentifier - The ObjectIdentifier of the index created by this operation.
• cirsResponseStatus - -- | The response status code.

data CreateIndexResponse

See: createIndexResponse smart constructor.

Instances

Eq CreateIndexResponse

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

(==) :: CreateIndexResponse -> CreateIndexResponse -> Bool

(/=) :: CreateIndexResponse -> CreateIndexResponse -> Bool

Data CreateIndexResponse

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateIndexResponse -> c CreateIndexResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateIndexResponse

toConstr :: CreateIndexResponse -> Constr

dataTypeOf :: CreateIndexResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateIndexResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateIndexResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateIndexResponse -> CreateIndexResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateIndexResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateIndexResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateIndexResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateIndexResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateIndexResponse -> m CreateIndexResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateIndexResponse -> m CreateIndexResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateIndexResponse -> m CreateIndexResponse

Read CreateIndexResponse

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

readsPrec :: Int -> ReadS CreateIndexResponse

readList :: ReadS [CreateIndexResponse]

readPrec :: ReadPrec CreateIndexResponse

readListPrec :: ReadPrec [CreateIndexResponse]

Show CreateIndexResponse

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

showsPrec :: Int -> CreateIndexResponse -> ShowS

show :: CreateIndexResponse -> String

showList :: [CreateIndexResponse] -> ShowS

Generic CreateIndexResponse

Defined in Network.AWS.CloudDirectory.CreateIndex

Associated Types

type Rep CreateIndexResponse :: Type -> Type

Methods

from :: CreateIndexResponse -> Rep CreateIndexResponse x

to :: Rep CreateIndexResponse x -> CreateIndexResponse

NFData CreateIndexResponse

Defined in Network.AWS.CloudDirectory.CreateIndex

Methods

rnf :: CreateIndexResponse -> ()

type Rep CreateIndexResponse

Defined in Network.AWS.CloudDirectory.CreateIndex

type Rep CreateIndexResponse = D1 (MetaData "CreateIndexResponse" "Network.AWS.CloudDirectory.CreateIndex" "amazonka-clouddirectory-1.6.1-JrYxtgIzVKD25mU0ZgOTPe" False) (C1 (MetaCons "CreateIndexResponse'" PrefixI True) (S1 (MetaSel (Just "_cirsObjectIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

cirsObjectIdentifier :: Lens' CreateIndexResponse (Maybe Text)

The ObjectIdentifier of the index created by this operation.

cirsResponseStatus :: Lens' CreateIndexResponse Int

• - | The response status code.