Amazonka.WorkDocs.DeleteLabels

Deletes the specified list of labels from a resource.

Creating a Request

data DeleteLabels

See: newDeleteLabels smart constructor.

Constructors

DeleteLabels'

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 request removal of all labels from the specified resource.

• labels :: Maybe [Text]

  List of labels to delete from the resource.

• resourceId :: Text

  The ID of the resource.

Instances

ToHeaders DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

toHeaders :: DeleteLabels -> [Header]

ToPath DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

toPath :: DeleteLabels -> ByteString

ToQuery DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

toQuery :: DeleteLabels -> QueryString

AWSRequest DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

Associated Types

type AWSResponse DeleteLabels

Methods

request :: (Service -> Service) -> DeleteLabels -> Request DeleteLabels

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteLabels -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteLabels)))

Generic DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

Associated Types

type Rep DeleteLabels :: Type -> Type

Methods

from :: DeleteLabels -> Rep DeleteLabels x

to :: Rep DeleteLabels x -> DeleteLabels

Show DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

showsPrec :: Int -> DeleteLabels -> ShowS

show :: DeleteLabels -> String

showList :: [DeleteLabels] -> ShowS

NFData DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

rnf :: DeleteLabels -> ()

Eq DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

(==) :: DeleteLabels -> DeleteLabels -> Bool

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

Hashable DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

hashWithSalt :: Int -> DeleteLabels -> Int

hash :: DeleteLabels -> Int

type AWSResponse DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

type AWSResponse DeleteLabels = DeleteLabelsResponse

type Rep DeleteLabels

Defined in Amazonka.WorkDocs.DeleteLabels

type Rep DeleteLabels = D1 ('MetaData "DeleteLabels" "Amazonka.WorkDocs.DeleteLabels" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DeleteLabels'" '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 "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteLabels

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:authenticationToken:DeleteLabels', deleteLabels_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:deleteAll:DeleteLabels', deleteLabels_deleteAll - Flag to request removal of all labels from the specified resource.

DeleteLabels, deleteLabels_labels - List of labels to delete from the resource.

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

Request Lenses

deleteLabels_authenticationToken :: Lens' DeleteLabels (Maybe Text)

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

deleteLabels_deleteAll :: Lens' DeleteLabels (Maybe Bool)

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

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

List of labels to delete from the resource.

deleteLabels_resourceId :: Lens' DeleteLabels Text

The ID of the resource.

Destructuring the Response

data DeleteLabelsResponse

See: newDeleteLabelsResponse smart constructor.

Constructors

DeleteLabelsResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteLabelsResponse

Defined in Amazonka.WorkDocs.DeleteLabels

Associated Types

type Rep DeleteLabelsResponse :: Type -> Type

Methods

from :: DeleteLabelsResponse -> Rep DeleteLabelsResponse x

to :: Rep DeleteLabelsResponse x -> DeleteLabelsResponse

Read DeleteLabelsResponse

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

readsPrec :: Int -> ReadS DeleteLabelsResponse

readList :: ReadS [DeleteLabelsResponse]

readPrec :: ReadPrec DeleteLabelsResponse

readListPrec :: ReadPrec [DeleteLabelsResponse]

Show DeleteLabelsResponse

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

showsPrec :: Int -> DeleteLabelsResponse -> ShowS

show :: DeleteLabelsResponse -> String

showList :: [DeleteLabelsResponse] -> ShowS

NFData DeleteLabelsResponse

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

rnf :: DeleteLabelsResponse -> ()

Eq DeleteLabelsResponse

Defined in Amazonka.WorkDocs.DeleteLabels

Methods

(==) :: DeleteLabelsResponse -> DeleteLabelsResponse -> Bool

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

type Rep DeleteLabelsResponse

Defined in Amazonka.WorkDocs.DeleteLabels

type Rep DeleteLabelsResponse = D1 ('MetaData "DeleteLabelsResponse" "Amazonka.WorkDocs.DeleteLabels" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DeleteLabelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteLabelsResponse

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

The response's http status code.