Amazonka.WorkDocs.CreateCustomMetadata

Adds one or more custom properties to the specified resource (a folder, document, or version).

Creating a Request

data CreateCustomMetadata

See: newCreateCustomMetadata smart constructor.

Constructors

CreateCustomMetadata'

Fields

• authenticationToken :: Maybe (Sensitive Text)

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

• versionId :: Maybe Text

  The ID of the version, if the custom metadata is being added to a document version.

• resourceId :: Text

  The ID of the resource.

• customMetadata :: HashMap Text Text

  Custom metadata in the form of name-value pairs.

Instances

ToJSON CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

toJSON :: CreateCustomMetadata -> Value

toEncoding :: CreateCustomMetadata -> Encoding

toJSONList :: [CreateCustomMetadata] -> Value

toEncodingList :: [CreateCustomMetadata] -> Encoding

ToHeaders CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

toHeaders :: CreateCustomMetadata -> [Header]

ToPath CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

toPath :: CreateCustomMetadata -> ByteString

ToQuery CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

toQuery :: CreateCustomMetadata -> QueryString

AWSRequest CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Associated Types

type AWSResponse CreateCustomMetadata

Methods

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

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

Generic CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Associated Types

type Rep CreateCustomMetadata :: Type -> Type

Methods

from :: CreateCustomMetadata -> Rep CreateCustomMetadata x

to :: Rep CreateCustomMetadata x -> CreateCustomMetadata

Show CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

showsPrec :: Int -> CreateCustomMetadata -> ShowS

show :: CreateCustomMetadata -> String

showList :: [CreateCustomMetadata] -> ShowS

NFData CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

rnf :: CreateCustomMetadata -> ()

Eq CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

(==) :: CreateCustomMetadata -> CreateCustomMetadata -> Bool

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

Hashable CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

hashWithSalt :: Int -> CreateCustomMetadata -> Int

hash :: CreateCustomMetadata -> Int

type AWSResponse CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

type AWSResponse CreateCustomMetadata = CreateCustomMetadataResponse

type Rep CreateCustomMetadata

Defined in Amazonka.WorkDocs.CreateCustomMetadata

type Rep CreateCustomMetadata = D1 ('MetaData "CreateCustomMetadata" "Amazonka.WorkDocs.CreateCustomMetadata" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "CreateCustomMetadata'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "customMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)))))

newCreateCustomMetadata

Arguments

:: Text

$sel:resourceId:CreateCustomMetadata'

-> CreateCustomMetadata

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

CreateCustomMetadata, createCustomMetadata_versionId - The ID of the version, if the custom metadata is being added to a document version.

$sel:resourceId:CreateCustomMetadata', createCustomMetadata_resourceId - The ID of the resource.

$sel:customMetadata:CreateCustomMetadata', createCustomMetadata_customMetadata - Custom metadata in the form of name-value pairs.

Request Lenses

createCustomMetadata_authenticationToken :: Lens' CreateCustomMetadata (Maybe Text)

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

createCustomMetadata_versionId :: Lens' CreateCustomMetadata (Maybe Text)

The ID of the version, if the custom metadata is being added to a document version.

createCustomMetadata_resourceId :: Lens' CreateCustomMetadata Text

The ID of the resource.

createCustomMetadata_customMetadata :: Lens' CreateCustomMetadata (HashMap Text Text)

Custom metadata in the form of name-value pairs.

Destructuring the Response

data CreateCustomMetadataResponse

See: newCreateCustomMetadataResponse smart constructor.

Constructors

CreateCustomMetadataResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateCustomMetadataResponse

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Associated Types

type Rep CreateCustomMetadataResponse :: Type -> Type

Methods

from :: CreateCustomMetadataResponse -> Rep CreateCustomMetadataResponse x

to :: Rep CreateCustomMetadataResponse x -> CreateCustomMetadataResponse

Read CreateCustomMetadataResponse

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

readsPrec :: Int -> ReadS CreateCustomMetadataResponse

readList :: ReadS [CreateCustomMetadataResponse]

readPrec :: ReadPrec CreateCustomMetadataResponse

readListPrec :: ReadPrec [CreateCustomMetadataResponse]

Show CreateCustomMetadataResponse

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

showsPrec :: Int -> CreateCustomMetadataResponse -> ShowS

show :: CreateCustomMetadataResponse -> String

showList :: [CreateCustomMetadataResponse] -> ShowS

NFData CreateCustomMetadataResponse

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

rnf :: CreateCustomMetadataResponse -> ()

Eq CreateCustomMetadataResponse

Defined in Amazonka.WorkDocs.CreateCustomMetadata

Methods

(==) :: CreateCustomMetadataResponse -> CreateCustomMetadataResponse -> Bool

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

type Rep CreateCustomMetadataResponse

Defined in Amazonka.WorkDocs.CreateCustomMetadata

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

newCreateCustomMetadataResponse

Arguments

:: Int

$sel:httpStatus:CreateCustomMetadataResponse'

-> CreateCustomMetadataResponse

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

Response Lenses

createCustomMetadataResponse_httpStatus :: Lens' CreateCustomMetadataResponse Int

The response's http status code.