Network.AWS.WorkDocs.CreateCustomMetadata

Adds one or more custom properties to the specified resource (a folder, document, or version).

Creating a Request

createCustomMetadata

Arguments

:: Text

ccmResourceId

-> CreateCustomMetadata

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

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

• ccmVersionId - The ID of the version, if the custom metadata is being added to a document version.
• ccmAuthenticationToken - Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.
• ccmResourceId - The ID of the resource.
• ccmCustomMetadata - Custom metadata in the form of name-value pairs.

data CreateCustomMetadata

See: createCustomMetadata smart constructor.

Instances

Eq CreateCustomMetadata

Methods

(==) :: CreateCustomMetadata -> CreateCustomMetadata -> Bool

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

Data CreateCustomMetadata

Methods

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

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

toConstr :: CreateCustomMetadata -> Constr

dataTypeOf :: CreateCustomMetadata -> DataType

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

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

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

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

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

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

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

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

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

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

Show CreateCustomMetadata

Methods

showsPrec :: Int -> CreateCustomMetadata -> ShowS

show :: CreateCustomMetadata -> String

showList :: [CreateCustomMetadata] -> ShowS

Generic CreateCustomMetadata

Associated Types

type Rep CreateCustomMetadata :: * -> *

Methods

from :: CreateCustomMetadata -> Rep CreateCustomMetadata x

to :: Rep CreateCustomMetadata x -> CreateCustomMetadata

Hashable CreateCustomMetadata

Methods

hashWithSalt :: Int -> CreateCustomMetadata -> Int

hash :: CreateCustomMetadata -> Int

ToJSON CreateCustomMetadata

Methods

toJSON :: CreateCustomMetadata -> Value

toEncoding :: CreateCustomMetadata -> Encoding

toJSONList :: [CreateCustomMetadata] -> Value

toEncodingList :: [CreateCustomMetadata] -> Encoding

NFData CreateCustomMetadata

Methods

rnf :: CreateCustomMetadata -> ()

AWSRequest CreateCustomMetadata

Associated Types

type Rs CreateCustomMetadata :: *

Methods

request :: CreateCustomMetadata -> Request CreateCustomMetadata

response :: MonadResource m => Logger -> Service -> Proxy * CreateCustomMetadata -> ClientResponse -> m (Response CreateCustomMetadata)

ToQuery CreateCustomMetadata

Methods

toQuery :: CreateCustomMetadata -> QueryString

ToPath CreateCustomMetadata

Methods

toPath :: CreateCustomMetadata -> ByteString

ToHeaders CreateCustomMetadata

Methods

toHeaders :: CreateCustomMetadata -> [Header]

type Rep CreateCustomMetadata

type Rep CreateCustomMetadata = D1 (MetaData "CreateCustomMetadata" "Network.AWS.WorkDocs.CreateCustomMetadata" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "CreateCustomMetadata'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccmVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccmAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_ccmResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ccmCustomMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map Text Text))))))

type Rs CreateCustomMetadata

type Rs CreateCustomMetadata = CreateCustomMetadataResponse

Request Lenses

ccmVersionId :: Lens' CreateCustomMetadata (Maybe Text)

The ID of the version, if the custom metadata is being added to a document version.

ccmAuthenticationToken :: Lens' CreateCustomMetadata (Maybe Text)

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

ccmResourceId :: Lens' CreateCustomMetadata Text

The ID of the resource.

ccmCustomMetadata :: Lens' CreateCustomMetadata (HashMap Text Text)

Custom metadata in the form of name-value pairs.

Destructuring the Response

createCustomMetadataResponse

Arguments

:: Int

ccmrsResponseStatus

-> CreateCustomMetadataResponse

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

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

• ccmrsResponseStatus - -- | The response status code.

data CreateCustomMetadataResponse

See: createCustomMetadataResponse smart constructor.

Instances

Eq CreateCustomMetadataResponse

Methods

(==) :: CreateCustomMetadataResponse -> CreateCustomMetadataResponse -> Bool

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

Data CreateCustomMetadataResponse

Methods

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

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

toConstr :: CreateCustomMetadataResponse -> Constr

dataTypeOf :: CreateCustomMetadataResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateCustomMetadataResponse

Methods

readsPrec :: Int -> ReadS CreateCustomMetadataResponse

readList :: ReadS [CreateCustomMetadataResponse]

readPrec :: ReadPrec CreateCustomMetadataResponse

readListPrec :: ReadPrec [CreateCustomMetadataResponse]

Show CreateCustomMetadataResponse

Methods

showsPrec :: Int -> CreateCustomMetadataResponse -> ShowS

show :: CreateCustomMetadataResponse -> String

showList :: [CreateCustomMetadataResponse] -> ShowS

Generic CreateCustomMetadataResponse

Associated Types

type Rep CreateCustomMetadataResponse :: * -> *

Methods

from :: CreateCustomMetadataResponse -> Rep CreateCustomMetadataResponse x

to :: Rep CreateCustomMetadataResponse x -> CreateCustomMetadataResponse

NFData CreateCustomMetadataResponse

Methods

rnf :: CreateCustomMetadataResponse -> ()

type Rep CreateCustomMetadataResponse

type Rep CreateCustomMetadataResponse = D1 (MetaData "CreateCustomMetadataResponse" "Network.AWS.WorkDocs.CreateCustomMetadata" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" True) (C1 (MetaCons "CreateCustomMetadataResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_ccmrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

ccmrsResponseStatus :: Lens' CreateCustomMetadataResponse Int

• - | The response status code.