Network.AWS.WorkDocs.DeleteCustomMetadata

Deletes custom metadata from the specified resource.

Creating a Request

deleteCustomMetadata

Arguments

:: Text

dcmResourceId

-> DeleteCustomMetadata

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

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

• dcmVersionId - The ID of the version, if the custom metadata is being deleted from a document version.
• dcmDeleteAll - Flag to indicate removal of all custom metadata properties from the specified resource.
• dcmAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
• dcmKeys - List of properties to remove.
• dcmResourceId - The ID of the resource, either a document or folder.

data DeleteCustomMetadata

See: deleteCustomMetadata smart constructor.

Instances

Eq DeleteCustomMetadata

Methods

(==) :: DeleteCustomMetadata -> DeleteCustomMetadata -> Bool

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

Data DeleteCustomMetadata

Methods

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

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

toConstr :: DeleteCustomMetadata -> Constr

dataTypeOf :: DeleteCustomMetadata -> DataType

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

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

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

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

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

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

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

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

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

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

Show DeleteCustomMetadata

Methods

showsPrec :: Int -> DeleteCustomMetadata -> ShowS

show :: DeleteCustomMetadata -> String

showList :: [DeleteCustomMetadata] -> ShowS

Generic DeleteCustomMetadata

Associated Types

type Rep DeleteCustomMetadata :: * -> *

Methods

from :: DeleteCustomMetadata -> Rep DeleteCustomMetadata x

to :: Rep DeleteCustomMetadata x -> DeleteCustomMetadata

Hashable DeleteCustomMetadata

Methods

hashWithSalt :: Int -> DeleteCustomMetadata -> Int

hash :: DeleteCustomMetadata -> Int

NFData DeleteCustomMetadata

Methods

rnf :: DeleteCustomMetadata -> ()

AWSRequest DeleteCustomMetadata

Associated Types

type Rs DeleteCustomMetadata :: *

Methods

request :: DeleteCustomMetadata -> Request DeleteCustomMetadata

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

ToHeaders DeleteCustomMetadata

Methods

toHeaders :: DeleteCustomMetadata -> [Header]

ToPath DeleteCustomMetadata

Methods

toPath :: DeleteCustomMetadata -> ByteString

ToQuery DeleteCustomMetadata

Methods

toQuery :: DeleteCustomMetadata -> QueryString

type Rep DeleteCustomMetadata

type Rep DeleteCustomMetadata = D1 * (MetaData "DeleteCustomMetadata" "Network.AWS.WorkDocs.DeleteCustomMetadata" "amazonka-workdocs-1.6.0-1U8VphMWtKAbdAmu8y8qj" False) (C1 * (MetaCons "DeleteCustomMetadata'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dcmVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dcmDeleteAll") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dcmAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dcmKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_dcmResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs DeleteCustomMetadata

type Rs DeleteCustomMetadata = DeleteCustomMetadataResponse

Request Lenses

dcmVersionId :: Lens' DeleteCustomMetadata (Maybe Text)

The ID of the version, if the custom metadata is being deleted from a document version.

dcmDeleteAll :: Lens' DeleteCustomMetadata (Maybe Bool)

Flag to indicate removal of all custom metadata properties from the specified resource.

dcmAuthenticationToken :: Lens' DeleteCustomMetadata (Maybe Text)

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

dcmKeys :: Lens' DeleteCustomMetadata [Text]

List of properties to remove.

dcmResourceId :: Lens' DeleteCustomMetadata Text

The ID of the resource, either a document or folder.

Destructuring the Response

deleteCustomMetadataResponse

Arguments

:: Int

dcmrsResponseStatus

-> DeleteCustomMetadataResponse

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

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

• dcmrsResponseStatus - -- | The response status code.

data DeleteCustomMetadataResponse

See: deleteCustomMetadataResponse smart constructor.

Instances

Eq DeleteCustomMetadataResponse

Methods

(==) :: DeleteCustomMetadataResponse -> DeleteCustomMetadataResponse -> Bool

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

Data DeleteCustomMetadataResponse

Methods

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

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

toConstr :: DeleteCustomMetadataResponse -> Constr

dataTypeOf :: DeleteCustomMetadataResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DeleteCustomMetadataResponse

Methods

readsPrec :: Int -> ReadS DeleteCustomMetadataResponse

readList :: ReadS [DeleteCustomMetadataResponse]

readPrec :: ReadPrec DeleteCustomMetadataResponse

readListPrec :: ReadPrec [DeleteCustomMetadataResponse]

Show DeleteCustomMetadataResponse

Methods

showsPrec :: Int -> DeleteCustomMetadataResponse -> ShowS

show :: DeleteCustomMetadataResponse -> String

showList :: [DeleteCustomMetadataResponse] -> ShowS

Generic DeleteCustomMetadataResponse

Associated Types

type Rep DeleteCustomMetadataResponse :: * -> *

Methods

from :: DeleteCustomMetadataResponse -> Rep DeleteCustomMetadataResponse x

to :: Rep DeleteCustomMetadataResponse x -> DeleteCustomMetadataResponse

NFData DeleteCustomMetadataResponse

Methods

rnf :: DeleteCustomMetadataResponse -> ()

type Rep DeleteCustomMetadataResponse

type Rep DeleteCustomMetadataResponse = D1 * (MetaData "DeleteCustomMetadataResponse" "Network.AWS.WorkDocs.DeleteCustomMetadata" "amazonka-workdocs-1.6.0-1U8VphMWtKAbdAmu8y8qj" True) (C1 * (MetaCons "DeleteCustomMetadataResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dcmrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses

dcmrsResponseStatus :: Lens' DeleteCustomMetadataResponse Int

• - | The response status code.