amazonka-clouddirectory-1.6.0: Amazon CloudDirectory SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudDirectory.CreateIndex

Contents

Description

Creates an index object. See Indexing for more information.

Synopsis

Creating a Request

createIndex Source #

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 Source #

See: createIndex smart constructor.

Instances

Eq CreateIndex Source # 
Data CreateIndex Source # 

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 Source # 
Show CreateIndex Source # 
Generic CreateIndex Source # 

Associated Types

type Rep CreateIndex :: * -> * #

Hashable CreateIndex Source # 
ToJSON CreateIndex Source # 
NFData CreateIndex Source # 

Methods

rnf :: CreateIndex -> () #

AWSRequest CreateIndex Source # 
ToHeaders CreateIndex Source # 

Methods

toHeaders :: CreateIndex -> [Header] #

ToPath CreateIndex Source # 
ToQuery CreateIndex Source # 
type Rep CreateIndex Source # 
type Rep CreateIndex = D1 * (MetaData "CreateIndex" "Network.AWS.CloudDirectory.CreateIndex" "amazonka-clouddirectory-1.6.0-8IFjLCYNMx175Dinq6Lqlq" False) (C1 * (MetaCons "CreateIndex'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ciParentReference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ObjectReference))) (S1 * (MetaSel (Just Symbol "_ciLinkName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ciDirectoryARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_ciOrderedIndexedAttributeList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [AttributeKey])) (S1 * (MetaSel (Just Symbol "_ciIsUnique") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Bool))))))
type Rs CreateIndex Source # 

Request Lenses

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

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

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

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

ciDirectoryARN :: Lens' CreateIndex Text Source #

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

ciOrderedIndexedAttributeList :: Lens' CreateIndex [AttributeKey] Source #

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

ciIsUnique :: Lens' CreateIndex Bool Source #

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

Destructuring the Response

createIndexResponse Source #

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:

data CreateIndexResponse Source #

See: createIndexResponse smart constructor.

Instances

Eq CreateIndexResponse Source # 
Data CreateIndexResponse Source # 

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 Source # 
Show CreateIndexResponse Source # 
Generic CreateIndexResponse Source # 
NFData CreateIndexResponse Source # 

Methods

rnf :: CreateIndexResponse -> () #

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

Response Lenses

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

The ObjectIdentifier of the index created by this operation.

cirsResponseStatus :: Lens' CreateIndexResponse Int Source #

  • - | The response status code.