Copyright	(c) 2013-2021 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

Amazonka.WorkDocs.DeleteLabels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes the specified list of labels from a resource.

Synopsis

Creating a Request

data DeleteLabels Source #

See: newDeleteLabels smart constructor.

Constructors

DeleteLabels'
Fields deleteAll :: Maybe Bool Flag to request removal of all labels from the specified resource. authenticationToken :: Maybe (Sensitive Text) Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. labels :: Maybe [Text] List of labels to delete from the resource. resourceId :: Text The ID of the resource.

Instances

Instances details

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

newDeleteLabels Source #

Arguments

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

Create a value of DeleteLabels 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:deleteAll:DeleteLabels', deleteLabels_deleteAll - Flag to request removal of all labels from the specified resource.

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

$sel:labels:DeleteLabels', deleteLabels_labels - List of labels to delete from the resource.

$sel:resourceId:DeleteLabels', deleteLabels_resourceId - The ID of the resource.

Request Lenses

deleteLabels_deleteAll :: Lens' DeleteLabels (Maybe Bool) Source #

Flag to request removal of all labels from the specified resource.

deleteLabels_authenticationToken :: Lens' DeleteLabels (Maybe Text) Source #

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

deleteLabels_labels :: Lens' DeleteLabels (Maybe [Text]) Source #

List of labels to delete from the resource.

deleteLabels_resourceId :: Lens' DeleteLabels Text Source #

The ID of the resource.

Destructuring the Response

data DeleteLabelsResponse Source #

See: newDeleteLabelsResponse smart constructor.

Constructors

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

Instances

Instances details

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

newDeleteLabelsResponse Source #

Arguments

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

Create a value of DeleteLabelsResponse 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:DeleteLabelsResponse', deleteLabelsResponse_httpStatus - The response's http status code.

Response Lenses

deleteLabelsResponse_httpStatus :: Lens' DeleteLabelsResponse Int Source #

The response's http status code.