NotificationOptions
Set of options which defines notification preferences of given action.
Contents
EmailMessage
Text value to be included in the email body.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No SendEmail
Boolean value to indicate an email notification should be sent to the receipients.
Type: Boolean Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Participants
Participants
Describes the users or user groups.
Contents
Groups
The list of user groups.
Type: Array of GroupMetadata (p. 141) objects Required: No
Users
The list of users.
Type: Array of UserMetadata (p. 159) objects Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PermissionInfo
PermissionInfo
Describes the permissions.
Contents
Role
The role of the user.
Type: String
Valid Values: VIEWER | CONTRIBUTOR | OWNER | COOWNER Required: No
Type
The type of permissions.
Type: String
Valid Values: DIRECT | INHERITED Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Principal
Principal
Describes a resource.
Contents
Id
The ID of the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: No Roles
The permission information for the resource.
Type: Array of PermissionInfo (p. 144) objects Required: No
Type
The type of resource.
Type: String
Valid Values: USER | GROUP | INVITE | ANONYMOUS | ORGANIZATION Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResourceMetadata
ResourceMetadata
Describes the metadata of a resource.
Contents
Id
The ID of the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w+-.@]+
Required: No Name
The name of the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: [\u0020-\u202D\u202F-\uFFFF]+
Required: No OriginalName
The original name of the resource before a rename operation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: [\u0020-\u202D\u202F-\uFFFF]+
Required: No Owner
The owner of the resource.
Type: UserMetadata (p. 159) object Required: No
ParentId
The parent ID of the resource before a rename operation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w+-.@]+
Required: No
See Also
Type
The type of resource.
Type: String
Valid Values: FOLDER | DOCUMENT Required: No
VersionId
The version ID of the resource. This is an optional field and is filled for action on document version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w+-.@]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResourcePath
ResourcePath
Describes the path information of a resource.
Contents
Components
The components of the resource path.
Type: Array of ResourcePathComponent (p. 149) objects Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResourcePathComponent
ResourcePathComponent
Describes the resource path.
Contents
Id
The ID of the resource path.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: No Name
The name of the resource path.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: [\u0020-\u202D\u202F-\uFFFF]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SharePrincipal
SharePrincipal
Describes the recipient type and ID, if available.
Contents
Id
The ID of the recipient.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: Yes Role
The role of the recipient.
Type: String
Valid Values: VIEWER | CONTRIBUTOR | OWNER | COOWNER Required: Yes
Type
The type of the recipient.
Type: String
Valid Values: USER | GROUP | INVITE | ANONYMOUS | ORGANIZATION Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ShareResult
ShareResult
Describes the share results of a resource.
Contents
InviteePrincipalId
The ID of the invited user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: No PrincipalId
The ID of the principal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: No Role
The role.
Type: String
Valid Values: VIEWER | CONTRIBUTOR | OWNER | COOWNER Required: No
ShareId
The ID of the resource that was shared.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w+-.@]+
Required: No Status
The status.
Type: String
Valid Values: SUCCESS | FAILURE Required: No
See Also
StatusMessage
The status message.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
StorageRuleType
StorageRuleType
Describes the storage for a user.
Contents
StorageAllocatedInBytes
The amount of storage allocated, in bytes.
Type: Long
Valid Range: Minimum value of 0.
Required: No StorageType
The type of storage.
Type: String
Valid Values: UNLIMITED | QUOTA Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Subscription
Subscription
Describes a subscription.
Contents
EndPoint
The endpoint of the subscription.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No Protocol
The protocol of the subscription.
Type: String
Valid Values: HTTPS Required: No SubscriptionId
The ID of the subscription.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
UploadMetadata
UploadMetadata
Describes the upload.
Contents
SignedHeaders
The signed headers.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern: [\w-]+
Value Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No UploadUrl
The URL of the upload.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
User
User
Describes a user.
Contents
CreatedTimestamp
The time when the user was created.
Type: Timestamp Required: No EmailAddress
The email address of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}
Required: No GivenName
The given name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No Id
The ID of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: No Locale
The locale of the user.
Type: String
Valid Values: en | fr | ko | de | es | ja | ru | zh_CN | zh_TW | pt_BR | default
Required: No ModifiedTimestamp
The time when the user was modified.
Contents
Type: Timestamp Required: No OrganizationId
The ID of the organization.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: No RecycleBinFolderId
The ID of the recycle bin folder.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w+-.@]+
Required: No RootFolderId
The ID of the root folder.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w+-.@]+
Required: No Status
The status of the user.
Type: String
Valid Values: ACTIVE | INACTIVE | PENDING Required: No
Storage
The storage for the user.
Type: UserStorageMetadata (p. 161) object Required: No
Surname
The surname of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
See Also
TimeZoneId
The time zone ID of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No Type
The type of user.
Type: String
Valid Values: USER | ADMIN | POWERUSER | MINIMALUSER | WORKSPACESUSER Required: No
Username
The login name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w\-+.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z]+)?
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
UserMetadata
UserMetadata
Describes the metadata of the user.
Contents
EmailAddress
The email address of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}
Required: No GivenName
The given name of the user before a rename operation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No Id
The ID of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: No Surname
The surname of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No Username
The name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w\-+.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z]+)?
Required: No
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
UserStorageMetadata
UserStorageMetadata
Describes the storage for a user.
Contents
StorageRule
The storage for a user.
Type: StorageRuleType (p. 153) object Required: No
StorageUtilizedInBytes
The amount of storage used, in bytes.
Type: Long Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3