Menu
Amazon WorkDocs
API Reference (API Version 2016-05-01)

FolderMetadata

Describes a folder.

Contents

CreatedTimestamp

The time when the folder was created.

Type: Timestamp

Required: No

CreatorId

The ID of the creator.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [&\w+-.@]+

Required: No

Id

The ID of the folder.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+-.@]+

Required: No

Labels

List of labels on the folder.

Type: Array of strings

Array Members: Maximum number of 20 items.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*

Required: No

LatestVersionSize

The size of the latest version of the folder metadata.

Type: Long

Required: No

ModifiedTimestamp

The time when the folder was updated.

Type: Timestamp

Required: No

Name

The name of the folder.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\u202D\u202F-\uFFFF]+

Required: No

ParentFolderId

The ID of the parent folder.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+-.@]+

Required: No

ResourceState

The resource state of the folder.

Type: String

Valid Values: ACTIVE | RESTORING | RECYCLING | RECYCLED

Required: No

Signature

The unique identifier created from the subfolders and documents of the folder.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [&\w+-.@]+

Required: No

Size

The size of the folder metadata.

Type: Long

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: