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.WorkDocs.DeleteCustomMetadata

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes custom metadata from the specified resource.

Synopsis

Creating a Request

data DeleteCustomMetadata Source #

See: newDeleteCustomMetadata smart constructor.

Constructors

DeleteCustomMetadata'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
deleteAll :: Maybe Bool
Flag to indicate removal of all custom metadata properties from the specified resource.
keys :: Maybe [Text]
List of properties to remove.
versionId :: Maybe Text
The ID of the version, if the custom metadata is being deleted from a document version.
resourceId :: Text
The ID of the resource, either a document or folder.

Instances

Instances details

ToHeaders DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods toHeaders :: DeleteCustomMetadata -> [Header] #
ToPath DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods toPath :: DeleteCustomMetadata -> ByteString #
ToQuery DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods toQuery :: DeleteCustomMetadata -> QueryString #
AWSRequest DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Associated Types type AWSResponse DeleteCustomMetadata # Methods request :: (Service -> Service) -> DeleteCustomMetadata -> Request DeleteCustomMetadata # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteCustomMetadata -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteCustomMetadata))) #
Generic DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Associated Types type Rep DeleteCustomMetadata :: Type -> Type # Methods from :: DeleteCustomMetadata -> Rep DeleteCustomMetadata x # to :: Rep DeleteCustomMetadata x -> DeleteCustomMetadata #
Show DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods showsPrec :: Int -> DeleteCustomMetadata -> ShowS # show :: DeleteCustomMetadata -> String # showList :: [DeleteCustomMetadata] -> ShowS #
NFData DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods rnf :: DeleteCustomMetadata -> () #
Eq DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods (==) :: DeleteCustomMetadata -> DeleteCustomMetadata -> Bool # (/=) :: DeleteCustomMetadata -> DeleteCustomMetadata -> Bool #
Hashable DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods hashWithSalt :: Int -> DeleteCustomMetadata -> Int # hash :: DeleteCustomMetadata -> Int #
type AWSResponse DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata type AWSResponse DeleteCustomMetadata = DeleteCustomMetadataResponse
type Rep DeleteCustomMetadata Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata type Rep DeleteCustomMetadata = D1 ('MetaData "DeleteCustomMetadata" "Amazonka.WorkDocs.DeleteCustomMetadata" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DeleteCustomMetadata'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "deleteAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "keys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDeleteCustomMetadata Source #

Arguments

:: Text	`$sel:resourceId:DeleteCustomMetadata'`
-> DeleteCustomMetadata

Create a value of DeleteCustomMetadata 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:

$sel:authenticationToken:DeleteCustomMetadata', deleteCustomMetadata_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:deleteAll:DeleteCustomMetadata', deleteCustomMetadata_deleteAll - Flag to indicate removal of all custom metadata properties from the specified resource.

$sel:keys:DeleteCustomMetadata', deleteCustomMetadata_keys - List of properties to remove.

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

$sel:resourceId:DeleteCustomMetadata', deleteCustomMetadata_resourceId - The ID of the resource, either a document or folder.

Request Lenses

deleteCustomMetadata_authenticationToken :: Lens' DeleteCustomMetadata (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

deleteCustomMetadata_deleteAll :: Lens' DeleteCustomMetadata (Maybe Bool) Source #

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

deleteCustomMetadata_keys :: Lens' DeleteCustomMetadata (Maybe [Text]) Source #

List of properties to remove.

deleteCustomMetadata_versionId :: Lens' DeleteCustomMetadata (Maybe Text) Source #

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

deleteCustomMetadata_resourceId :: Lens' DeleteCustomMetadata Text Source #

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

Destructuring the Response

data DeleteCustomMetadataResponse Source #

See: newDeleteCustomMetadataResponse smart constructor.

Constructors

DeleteCustomMetadataResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DeleteCustomMetadataResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Associated Types type Rep DeleteCustomMetadataResponse :: Type -> Type # Methods from :: DeleteCustomMetadataResponse -> Rep DeleteCustomMetadataResponse x # to :: Rep DeleteCustomMetadataResponse x -> DeleteCustomMetadataResponse #
Read DeleteCustomMetadataResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods readsPrec :: Int -> ReadS DeleteCustomMetadataResponse # readList :: ReadS [DeleteCustomMetadataResponse] # readPrec :: ReadPrec DeleteCustomMetadataResponse # readListPrec :: ReadPrec [DeleteCustomMetadataResponse] #
Show DeleteCustomMetadataResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods showsPrec :: Int -> DeleteCustomMetadataResponse -> ShowS # show :: DeleteCustomMetadataResponse -> String # showList :: [DeleteCustomMetadataResponse] -> ShowS #
NFData DeleteCustomMetadataResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods rnf :: DeleteCustomMetadataResponse -> () #
Eq DeleteCustomMetadataResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata Methods (==) :: DeleteCustomMetadataResponse -> DeleteCustomMetadataResponse -> Bool # (/=) :: DeleteCustomMetadataResponse -> DeleteCustomMetadataResponse -> Bool #
type Rep DeleteCustomMetadataResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteCustomMetadata type Rep DeleteCustomMetadataResponse = D1 ('MetaData "DeleteCustomMetadataResponse" "Amazonka.WorkDocs.DeleteCustomMetadata" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DeleteCustomMetadataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteCustomMetadataResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteCustomMetadataResponse'`
-> DeleteCustomMetadataResponse

Create a value of DeleteCustomMetadataResponse 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:

$sel:httpStatus:DeleteCustomMetadataResponse', deleteCustomMetadataResponse_httpStatus - The response's http status code.

Response Lenses

deleteCustomMetadataResponse_httpStatus :: Lens' DeleteCustomMetadataResponse Int Source #

The response's http status code.