create_custom_metadata

WorkDocs.Client.create_custom_metadata(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_custom_metadata(
    AuthenticationToken='string',
    ResourceId='string',
    VersionId='string',
    CustomMetadata={
        'string': 'string'
    }
)

Parameters

• AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
• ResourceId (string) --

  [REQUIRED]

  The ID of the resource.

• VersionId (string) -- The ID of the version, if the custom metadata is being added to a document version.
• CustomMetadata (dict) --

  [REQUIRED]

  Custom metadata in the form of name-value pairs.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• WorkDocs.Client.exceptions.EntityNotExistsException
• WorkDocs.Client.exceptions.UnauthorizedOperationException
• WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
• WorkDocs.Client.exceptions.ProhibitedStateException
• WorkDocs.Client.exceptions.CustomMetadataLimitExceededException
• WorkDocs.Client.exceptions.FailedDependencyException
• WorkDocs.Client.exceptions.ServiceUnavailableException