Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Deletes custom metadata from the specified resource.
Synopsis
- deleteCustomMetadata :: Text -> DeleteCustomMetadata
- data DeleteCustomMetadata
- dcmVersionId :: Lens' DeleteCustomMetadata (Maybe Text)
- dcmDeleteAll :: Lens' DeleteCustomMetadata (Maybe Bool)
- dcmAuthenticationToken :: Lens' DeleteCustomMetadata (Maybe Text)
- dcmKeys :: Lens' DeleteCustomMetadata [Text]
- dcmResourceId :: Lens' DeleteCustomMetadata Text
- deleteCustomMetadataResponse :: Int -> DeleteCustomMetadataResponse
- data DeleteCustomMetadataResponse
- dcmrsResponseStatus :: Lens' DeleteCustomMetadataResponse Int
Creating a Request
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 Source #
See: deleteCustomMetadata
smart constructor.
Instances
Request Lenses
dcmVersionId :: Lens' DeleteCustomMetadata (Maybe Text) Source #
The ID of the version, if the custom metadata is being deleted from a document version.
dcmDeleteAll :: Lens' DeleteCustomMetadata (Maybe Bool) Source #
Flag to indicate removal of all custom metadata properties from the specified resource.
dcmAuthenticationToken :: Lens' DeleteCustomMetadata (Maybe Text) Source #
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
dcmResourceId :: Lens' DeleteCustomMetadata Text Source #
The ID of the resource, either a document or folder.
Destructuring the Response
deleteCustomMetadataResponse Source #
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 Source #
See: deleteCustomMetadataResponse
smart constructor.
Instances
Response Lenses
dcmrsResponseStatus :: Lens' DeleteCustomMetadataResponse Int Source #
- - | The response status code.