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.CreateLabels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds the specified list of labels to the given resource (a document or folder)

Synopsis

Creating a Request

data CreateLabels Source #

See: newCreateLabels smart constructor.

Constructors

CreateLabels'
Fields authenticationToken :: Maybe (Sensitive Text) Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. resourceId :: Text The ID of the resource. labels :: [Text] List of labels to add to the resource.

Instances

Instances details

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

newCreateLabels Source #

Arguments

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

Create a value of CreateLabels 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:CreateLabels', createLabels_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:resourceId:CreateLabels', createLabels_resourceId - The ID of the resource.

CreateLabels, createLabels_labels - List of labels to add to the resource.

Request Lenses

createLabels_authenticationToken :: Lens' CreateLabels (Maybe Text) Source #

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

createLabels_resourceId :: Lens' CreateLabels Text Source #

The ID of the resource.

createLabels_labels :: Lens' CreateLabels [Text] Source #

List of labels to add to the resource.

Destructuring the Response

data CreateLabelsResponse Source #

See: newCreateLabelsResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateLabelsResponse Source #

Arguments

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

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

Response Lenses

createLabelsResponse_httpStatus :: Lens' CreateLabelsResponse Int Source #

The response's http status code.