package types

import "github.com/aws/aws-sdk-go-v2/service/workdocs/types"

Index

Types

type Activity 

type Activity struct {

	// Metadata of the commenting activity. This is an optional field and is filled for
	// commenting activities.
	CommentMetadata *CommentMetadata

	// The user who performed the action.
	Initiator *UserMetadata

	// Indicates whether an activity is indirect or direct. An indirect activity
	// results from a direct activity performed on a parent resource. For example,
	// sharing a parent folder (the direct activity) shares all of the subfolders and
	// documents within the parent folder (the indirect activity).
	IsIndirectActivity bool

	// The ID of the organization.
	OrganizationId *string

	// The original parent of the resource. This is an optional field and is filled for
	// move activities.
	OriginalParent *ResourceMetadata

	// The list of users or groups impacted by this action. This is an optional field
	// and is filled for the following sharing activities: DOCUMENT_SHARED,
	// DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.
	Participants *Participants

	// The metadata of the resource involved in the user action.
	ResourceMetadata *ResourceMetadata

	// The timestamp when the action was performed.
	TimeStamp *time.Time

	// The activity type.
	Type ActivityType
}

Describes the activity information.

type ActivityType 

type ActivityType string
const (
	ActivityTypeDocumentCheckedIn                      ActivityType = "DOCUMENT_CHECKED_IN"
	ActivityTypeDocumentCheckedOut                     ActivityType = "DOCUMENT_CHECKED_OUT"
	ActivityTypeDocumentRenamed                        ActivityType = "DOCUMENT_RENAMED"
	ActivityTypeDocumentVersionUploaded                ActivityType = "DOCUMENT_VERSION_UPLOADED"
	ActivityTypeDocumentVersionDeleted                 ActivityType = "DOCUMENT_VERSION_DELETED"
	ActivityTypeDocumentVersionViewed                  ActivityType = "DOCUMENT_VERSION_VIEWED"
	ActivityTypeDocumentVersionDownloaded              ActivityType = "DOCUMENT_VERSION_DOWNLOADED"
	ActivityTypeDocumentRecycled                       ActivityType = "DOCUMENT_RECYCLED"
	ActivityTypeDocumentRestored                       ActivityType = "DOCUMENT_RESTORED"
	ActivityTypeDocumentReverted                       ActivityType = "DOCUMENT_REVERTED"
	ActivityTypeDocumentShared                         ActivityType = "DOCUMENT_SHARED"
	ActivityTypeDocumentUnshared                       ActivityType = "DOCUMENT_UNSHARED"
	ActivityTypeDocumentSharePermissionChanged         ActivityType = "DOCUMENT_SHARE_PERMISSION_CHANGED"
	ActivityTypeDocumentShareableLinkCreated           ActivityType = "DOCUMENT_SHAREABLE_LINK_CREATED"
	ActivityTypeDocumentShareableLinkRemoved           ActivityType = "DOCUMENT_SHAREABLE_LINK_REMOVED"
	ActivityTypeDocumentShareableLinkPermissionChanged ActivityType = "DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED"
	ActivityTypeDocumentMoved                          ActivityType = "DOCUMENT_MOVED"
	ActivityTypeDocumentCommentAdded                   ActivityType = "DOCUMENT_COMMENT_ADDED"
	ActivityTypeDocumentCommentDeleted                 ActivityType = "DOCUMENT_COMMENT_DELETED"
	ActivityTypeDocumentAnnotationAdded                ActivityType = "DOCUMENT_ANNOTATION_ADDED"
	ActivityTypeDocumentAnnotationDeleted              ActivityType = "DOCUMENT_ANNOTATION_DELETED"
	ActivityTypeFolderCreated                          ActivityType = "FOLDER_CREATED"
	ActivityTypeFolderDeleted                          ActivityType = "FOLDER_DELETED"
	ActivityTypeFolderRenamed                          ActivityType = "FOLDER_RENAMED"
	ActivityTypeFolderRecycled                         ActivityType = "FOLDER_RECYCLED"
	ActivityTypeFolderRestored                         ActivityType = "FOLDER_RESTORED"
	ActivityTypeFolderShared                           ActivityType = "FOLDER_SHARED"
	ActivityTypeFolderUnshared                         ActivityType = "FOLDER_UNSHARED"
	ActivityTypeFolderSharePermissionChanged           ActivityType = "FOLDER_SHARE_PERMISSION_CHANGED"
	ActivityTypeFolderShareableLinkCreated             ActivityType = "FOLDER_SHAREABLE_LINK_CREATED"
	ActivityTypeFolderShareableLinkRemoved             ActivityType = "FOLDER_SHAREABLE_LINK_REMOVED"
	ActivityTypeFolderShareableLinkPermissionChanged   ActivityType = "FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED"
	ActivityTypeFolderMoved                            ActivityType = "FOLDER_MOVED"
)

Enum values for ActivityType

func (ActivityType) Values 

func (ActivityType) Values() []ActivityType

Values returns all known values for ActivityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BooleanEnumType 

type BooleanEnumType string
const (
	BooleanEnumTypeTrue  BooleanEnumType = "TRUE"
	BooleanEnumTypeFalse BooleanEnumType = "FALSE"
)

Enum values for BooleanEnumType

func (BooleanEnumType) Values 

func (BooleanEnumType) Values() []BooleanEnumType

Values returns all known values for BooleanEnumType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Comment 

type Comment struct {

	// The ID of the comment.
	//
	// This member is required.
	CommentId *string

	// The details of the user who made the comment.
	Contributor *User

	// The time that the comment was created.
	CreatedTimestamp *time.Time

	// The ID of the parent comment.
	ParentId *string

	// If the comment is a reply to another user's comment, this field contains the
	// user ID of the user being replied to.
	RecipientId *string

	// The status of the comment.
	Status CommentStatusType

	// The text of the comment.
	Text *string

	// The ID of the root comment in the thread.
	ThreadId *string

	// The visibility of the comment. Options are either PRIVATE, where the comment is
	// visible only to the comment author and document owner and co-owners, or PUBLIC,
	// where the comment is visible to document owners, co-owners, and contributors.
	Visibility CommentVisibilityType
}

Describes a comment.

type CommentMetadata 

type CommentMetadata struct {

	// The ID of the comment.
	CommentId *string

	// The status of the comment.
	CommentStatus CommentStatusType

	// The user who made the comment.
	Contributor *User

	// The timestamp that the comment was created.
	CreatedTimestamp *time.Time

	// The ID of the user being replied to.
	RecipientId *string
}

Describes the metadata of a comment.

type CommentStatusType 

type CommentStatusType string
const (
	CommentStatusTypeDraft     CommentStatusType = "DRAFT"
	CommentStatusTypePublished CommentStatusType = "PUBLISHED"
	CommentStatusTypeDeleted   CommentStatusType = "DELETED"
)

Enum values for CommentStatusType

func (CommentStatusType) Values 

func (CommentStatusType) Values() []CommentStatusType

Values returns all known values for CommentStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CommentVisibilityType 

type CommentVisibilityType string
const (
	CommentVisibilityTypePublic  CommentVisibilityType = "PUBLIC"
	CommentVisibilityTypePrivate CommentVisibilityType = "PRIVATE"
)

Enum values for CommentVisibilityType

func (CommentVisibilityType) Values 

func (CommentVisibilityType) Values() []CommentVisibilityType

Values returns all known values for CommentVisibilityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConcurrentModificationException 

type ConcurrentModificationException struct {
	Message *string
}

The resource hierarchy is changing.

func (*ConcurrentModificationException) Error 

func (e *ConcurrentModificationException) Error() string

func (*ConcurrentModificationException) ErrorCode 

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault 

func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault

func (*ConcurrentModificationException) ErrorMessage 

func (e *ConcurrentModificationException) ErrorMessage() string

type ConflictingOperationException 

type ConflictingOperationException struct {
	Message *string
}

Another operation is in progress on the resource that conflicts with the current operation.

func (*ConflictingOperationException) Error 

func (e *ConflictingOperationException) Error() string

func (*ConflictingOperationException) ErrorCode 

func (e *ConflictingOperationException) ErrorCode() string

func (*ConflictingOperationException) ErrorFault 

func (e *ConflictingOperationException) ErrorFault() smithy.ErrorFault

func (*ConflictingOperationException) ErrorMessage 

func (e *ConflictingOperationException) ErrorMessage() string

type CustomMetadataLimitExceededException 

type CustomMetadataLimitExceededException struct {
	Message *string
}

The limit has been reached on the number of custom properties for the specified resource.

func (*CustomMetadataLimitExceededException) Error 

func (e *CustomMetadataLimitExceededException) Error() string

func (*CustomMetadataLimitExceededException) ErrorCode 

func (e *CustomMetadataLimitExceededException) ErrorCode() string

func (*CustomMetadataLimitExceededException) ErrorFault 

func (e *CustomMetadataLimitExceededException) ErrorFault() smithy.ErrorFault

func (*CustomMetadataLimitExceededException) ErrorMessage 

func (e *CustomMetadataLimitExceededException) ErrorMessage() string

type DeactivatingLastSystemUserException 

type DeactivatingLastSystemUserException struct {
	Message *string

	Code *string
}

The last user in the organization is being deactivated.

func (*DeactivatingLastSystemUserException) Error 

func (e *DeactivatingLastSystemUserException) Error() string

func (*DeactivatingLastSystemUserException) ErrorCode 

func (e *DeactivatingLastSystemUserException) ErrorCode() string

func (*DeactivatingLastSystemUserException) ErrorFault 

func (e *DeactivatingLastSystemUserException) ErrorFault() smithy.ErrorFault

func (*DeactivatingLastSystemUserException) ErrorMessage 

func (e *DeactivatingLastSystemUserException) ErrorMessage() string

type DocumentLockedForCommentsException 

type DocumentLockedForCommentsException struct {
	Message *string
}

This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.

func (*DocumentLockedForCommentsException) Error 

func (e *DocumentLockedForCommentsException) Error() string

func (*DocumentLockedForCommentsException) ErrorCode 

func (e *DocumentLockedForCommentsException) ErrorCode() string

func (*DocumentLockedForCommentsException) ErrorFault 

func (e *DocumentLockedForCommentsException) ErrorFault() smithy.ErrorFault

func (*DocumentLockedForCommentsException) ErrorMessage 

func (e *DocumentLockedForCommentsException) ErrorMessage() string

type DocumentMetadata 

type DocumentMetadata struct {

	// The time when the document was created.
	CreatedTimestamp *time.Time

	// The ID of the creator.
	CreatorId *string

	// The ID of the document.
	Id *string

	// List of labels on the document.
	Labels []string

	// The latest version of the document.
	LatestVersionMetadata *DocumentVersionMetadata

	// The time when the document was updated.
	ModifiedTimestamp *time.Time

	// The ID of the parent folder.
	ParentFolderId *string

	// The resource state.
	ResourceState ResourceStateType
}

Describes the document.

type DocumentSourceType 

type DocumentSourceType string
const (
	DocumentSourceTypeOriginal     DocumentSourceType = "ORIGINAL"
	DocumentSourceTypeWithComments DocumentSourceType = "WITH_COMMENTS"
)

Enum values for DocumentSourceType

func (DocumentSourceType) Values 

func (DocumentSourceType) Values() []DocumentSourceType

Values returns all known values for DocumentSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DocumentStatusType 

type DocumentStatusType string
const (
	DocumentStatusTypeInitialized DocumentStatusType = "INITIALIZED"
	DocumentStatusTypeActive      DocumentStatusType = "ACTIVE"
)

Enum values for DocumentStatusType

func (DocumentStatusType) Values 

func (DocumentStatusType) Values() []DocumentStatusType

Values returns all known values for DocumentStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DocumentThumbnailType 

type DocumentThumbnailType string
const (
	DocumentThumbnailTypeSmall   DocumentThumbnailType = "SMALL"
	DocumentThumbnailTypeSmallHq DocumentThumbnailType = "SMALL_HQ"
	DocumentThumbnailTypeLarge   DocumentThumbnailType = "LARGE"
)

Enum values for DocumentThumbnailType

func (DocumentThumbnailType) Values 

func (DocumentThumbnailType) Values() []DocumentThumbnailType

Values returns all known values for DocumentThumbnailType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DocumentVersionMetadata 

type DocumentVersionMetadata struct {

	// The timestamp when the content of the document was originally created.
	ContentCreatedTimestamp *time.Time

	// The timestamp when the content of the document was modified.
	ContentModifiedTimestamp *time.Time

	// The content type of the document.
	ContentType *string

	// The timestamp when the document was first uploaded.
	CreatedTimestamp *time.Time

	// The ID of the creator.
	CreatorId *string

	// The ID of the version.
	Id *string

	// The timestamp when the document was last uploaded.
	ModifiedTimestamp *time.Time

	// The name of the version.
	Name *string

	// The signature of the document.
	Signature *string

	// The size of the document, in bytes.
	Size *int64

	// The source of the document.
	Source map[string]string

	// The status of the document.
	Status DocumentStatusType

	// The thumbnail of the document.
	Thumbnail map[string]string
}

Describes a version of a document.

type DocumentVersionStatus 

type DocumentVersionStatus string
const (
	DocumentVersionStatusActive DocumentVersionStatus = "ACTIVE"
)

Enum values for DocumentVersionStatus

func (DocumentVersionStatus) Values 

func (DocumentVersionStatus) Values() []DocumentVersionStatus

Values returns all known values for DocumentVersionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DraftUploadOutOfSyncException 

type DraftUploadOutOfSyncException struct {
	Message *string
}

This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.

func (*DraftUploadOutOfSyncException) Error 

func (e *DraftUploadOutOfSyncException) Error() string

func (*DraftUploadOutOfSyncException) ErrorCode 

func (e *DraftUploadOutOfSyncException) ErrorCode() string

func (*DraftUploadOutOfSyncException) ErrorFault 

func (e *DraftUploadOutOfSyncException) ErrorFault() smithy.ErrorFault

func (*DraftUploadOutOfSyncException) ErrorMessage 

func (e *DraftUploadOutOfSyncException) ErrorMessage() string

type EntityAlreadyExistsException 

type EntityAlreadyExistsException struct {
	Message *string
}

The resource already exists.

func (*EntityAlreadyExistsException) Error 

func (e *EntityAlreadyExistsException) Error() string

func (*EntityAlreadyExistsException) ErrorCode 

func (e *EntityAlreadyExistsException) ErrorCode() string

func (*EntityAlreadyExistsException) ErrorFault 

func (e *EntityAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*EntityAlreadyExistsException) ErrorMessage 

func (e *EntityAlreadyExistsException) ErrorMessage() string

type EntityNotExistsException 

type EntityNotExistsException struct {
	Message *string

	EntityIds []string
}

The resource does not exist.

func (*EntityNotExistsException) Error 

func (e *EntityNotExistsException) Error() string

func (*EntityNotExistsException) ErrorCode 

func (e *EntityNotExistsException) ErrorCode() string

func (*EntityNotExistsException) ErrorFault 

func (e *EntityNotExistsException) ErrorFault() smithy.ErrorFault

func (*EntityNotExistsException) ErrorMessage 

func (e *EntityNotExistsException) ErrorMessage() string

type FailedDependencyException 

type FailedDependencyException struct {
	Message *string
}

The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

func (*FailedDependencyException) Error 

func (e *FailedDependencyException) Error() string

func (*FailedDependencyException) ErrorCode 

func (e *FailedDependencyException) ErrorCode() string

func (*FailedDependencyException) ErrorFault 

func (e *FailedDependencyException) ErrorFault() smithy.ErrorFault

func (*FailedDependencyException) ErrorMessage 

func (e *FailedDependencyException) ErrorMessage() string

type FolderContentType 

type FolderContentType string
const (
	FolderContentTypeAll      FolderContentType = "ALL"
	FolderContentTypeDocument FolderContentType = "DOCUMENT"
	FolderContentTypeFolder   FolderContentType = "FOLDER"
)

Enum values for FolderContentType

func (FolderContentType) Values 

func (FolderContentType) Values() []FolderContentType

Values returns all known values for FolderContentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FolderMetadata 

type FolderMetadata struct {

	// The time when the folder was created.
	CreatedTimestamp *time.Time

	// The ID of the creator.
	CreatorId *string

	// The ID of the folder.
	Id *string

	// List of labels on the folder.
	Labels []string

	// The size of the latest version of the folder metadata.
	LatestVersionSize *int64

	// The time when the folder was updated.
	ModifiedTimestamp *time.Time

	// The name of the folder.
	Name *string

	// The ID of the parent folder.
	ParentFolderId *string

	// The resource state of the folder.
	ResourceState ResourceStateType

	// The unique identifier created from the subfolders and documents of the folder.
	Signature *string

	// The size of the folder metadata.
	Size *int64
}

Describes a folder.

type GroupMetadata 

type GroupMetadata struct {

	// The ID of the user group.
	Id *string

	// The name of the group.
	Name *string
}

Describes the metadata of a user group.

type IllegalUserStateException 

type IllegalUserStateException struct {
	Message *string
}

The user is undergoing transfer of ownership.

func (*IllegalUserStateException) Error 

func (e *IllegalUserStateException) Error() string

func (*IllegalUserStateException) ErrorCode 

func (e *IllegalUserStateException) ErrorCode() string

func (*IllegalUserStateException) ErrorFault 

func (e *IllegalUserStateException) ErrorFault() smithy.ErrorFault

func (*IllegalUserStateException) ErrorMessage 

func (e *IllegalUserStateException) ErrorMessage() string

type InvalidArgumentException 

type InvalidArgumentException struct {
	Message *string
}

The pagination marker or limit fields are not valid.

func (*InvalidArgumentException) Error 

func (e *InvalidArgumentException) Error() string

func (*InvalidArgumentException) ErrorCode 

func (e *InvalidArgumentException) ErrorCode() string

func (*InvalidArgumentException) ErrorFault 

func (e *InvalidArgumentException) ErrorFault() smithy.ErrorFault

func (*InvalidArgumentException) ErrorMessage 

func (e *InvalidArgumentException) ErrorMessage() string

type InvalidCommentOperationException 

type InvalidCommentOperationException struct {
	Message *string
}

The requested operation is not allowed on the specified comment object.

func (*InvalidCommentOperationException) Error 

func (e *InvalidCommentOperationException) Error() string

func (*InvalidCommentOperationException) ErrorCode 

func (e *InvalidCommentOperationException) ErrorCode() string

func (*InvalidCommentOperationException) ErrorFault 

func (e *InvalidCommentOperationException) ErrorFault() smithy.ErrorFault

func (*InvalidCommentOperationException) ErrorMessage 

func (e *InvalidCommentOperationException) ErrorMessage() string

type InvalidOperationException 

type InvalidOperationException struct {
	Message *string
}

The operation is invalid.

func (*InvalidOperationException) Error 

func (e *InvalidOperationException) Error() string

func (*InvalidOperationException) ErrorCode 

func (e *InvalidOperationException) ErrorCode() string

func (*InvalidOperationException) ErrorFault 

func (e *InvalidOperationException) ErrorFault() smithy.ErrorFault

func (*InvalidOperationException) ErrorMessage 

func (e *InvalidOperationException) ErrorMessage() string

type InvalidPasswordException 

type InvalidPasswordException struct {
	Message *string
}

The password is invalid.

func (*InvalidPasswordException) Error 

func (e *InvalidPasswordException) Error() string

func (*InvalidPasswordException) ErrorCode 

func (e *InvalidPasswordException) ErrorCode() string

func (*InvalidPasswordException) ErrorFault 

func (e *InvalidPasswordException) ErrorFault() smithy.ErrorFault

func (*InvalidPasswordException) ErrorMessage 

func (e *InvalidPasswordException) ErrorMessage() string

type LimitExceededException 

type LimitExceededException struct {
	Message *string
}

The maximum of 100,000 folders under the parent folder has been exceeded.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type LocaleType 

type LocaleType string
const (
	LocaleTypeEn      LocaleType = "en"
	LocaleTypeFr      LocaleType = "fr"
	LocaleTypeKo      LocaleType = "ko"
	LocaleTypeDe      LocaleType = "de"
	LocaleTypeEs      LocaleType = "es"
	LocaleTypeJa      LocaleType = "ja"
	LocaleTypeRu      LocaleType = "ru"
	LocaleTypeZhCn    LocaleType = "zh_CN"
	LocaleTypeZhTw    LocaleType = "zh_TW"
	LocaleTypePtBr    LocaleType = "pt_BR"
	LocaleTypeDefault LocaleType = "default"
)

Enum values for LocaleType

func (LocaleType) Values 

func (LocaleType) Values() []LocaleType

Values returns all known values for LocaleType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NotificationOptions 

type NotificationOptions struct {

	// Text value to be included in the email body.
	EmailMessage *string

	// Boolean value to indicate an email notification should be sent to the
	// receipients.
	SendEmail bool
}

Set of options which defines notification preferences of given action.

type OrderType 

type OrderType string
const (
	OrderTypeAscending  OrderType = "ASCENDING"
	OrderTypeDescending OrderType = "DESCENDING"
)

Enum values for OrderType

func (OrderType) Values 

func (OrderType) Values() []OrderType

Values returns all known values for OrderType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Participants 

type Participants struct {

	// The list of user groups.
	Groups []GroupMetadata

	// The list of users.
	Users []UserMetadata
}

Describes the users or user groups.

type PermissionInfo 

type PermissionInfo struct {

	// The role of the user.
	Role RoleType

	// The type of permissions.
	Type RolePermissionType
}

Describes the permissions.

type Principal 

type Principal struct {

	// The ID of the resource.
	Id *string

	// The permission information for the resource.
	Roles []PermissionInfo

	// The type of resource.
	Type PrincipalType
}

Describes a resource.

type PrincipalType 

type PrincipalType string
const (
	PrincipalTypeUser         PrincipalType = "USER"
	PrincipalTypeGroup        PrincipalType = "GROUP"
	PrincipalTypeInvite       PrincipalType = "INVITE"
	PrincipalTypeAnonymous    PrincipalType = "ANONYMOUS"
	PrincipalTypeOrganization PrincipalType = "ORGANIZATION"
)

Enum values for PrincipalType

func (PrincipalType) Values 

func (PrincipalType) Values() []PrincipalType

Values returns all known values for PrincipalType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ProhibitedStateException 

type ProhibitedStateException struct {
	Message *string
}

The specified document version is not in the INITIALIZED state.

func (*ProhibitedStateException) Error 

func (e *ProhibitedStateException) Error() string

func (*ProhibitedStateException) ErrorCode 

func (e *ProhibitedStateException) ErrorCode() string

func (*ProhibitedStateException) ErrorFault 

func (e *ProhibitedStateException) ErrorFault() smithy.ErrorFault

func (*ProhibitedStateException) ErrorMessage 

func (e *ProhibitedStateException) ErrorMessage() string

type RequestedEntityTooLargeException 

type RequestedEntityTooLargeException struct {
	Message *string
}

The response is too large to return. The request must include a filter to reduce the size of the response.

func (*RequestedEntityTooLargeException) Error 

func (e *RequestedEntityTooLargeException) Error() string

func (*RequestedEntityTooLargeException) ErrorCode 

func (e *RequestedEntityTooLargeException) ErrorCode() string

func (*RequestedEntityTooLargeException) ErrorFault 

func (e *RequestedEntityTooLargeException) ErrorFault() smithy.ErrorFault

func (*RequestedEntityTooLargeException) ErrorMessage 

func (e *RequestedEntityTooLargeException) ErrorMessage() string

type ResourceAlreadyCheckedOutException 

type ResourceAlreadyCheckedOutException struct {
	Message *string
}

The resource is already checked out.

func (*ResourceAlreadyCheckedOutException) Error 

func (e *ResourceAlreadyCheckedOutException) Error() string

func (*ResourceAlreadyCheckedOutException) ErrorCode 

func (e *ResourceAlreadyCheckedOutException) ErrorCode() string

func (*ResourceAlreadyCheckedOutException) ErrorFault 

func (e *ResourceAlreadyCheckedOutException) ErrorFault() smithy.ErrorFault

func (*ResourceAlreadyCheckedOutException) ErrorMessage 

func (e *ResourceAlreadyCheckedOutException) ErrorMessage() string

type ResourceCollectionType 

type ResourceCollectionType string
const (
	ResourceCollectionTypeSharedWithMe ResourceCollectionType = "SHARED_WITH_ME"
)

Enum values for ResourceCollectionType

func (ResourceCollectionType) Values 

func (ResourceCollectionType) Values() []ResourceCollectionType

Values returns all known values for ResourceCollectionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceMetadata 

type ResourceMetadata struct {

	// The ID of the resource.
	Id *string

	// The name of the resource.
	Name *string

	// The original name of the resource before a rename operation.
	OriginalName *string

	// The owner of the resource.
	Owner *UserMetadata

	// The parent ID of the resource before a rename operation.
	ParentId *string

	// The type of resource.
	Type ResourceType

	// The version ID of the resource. This is an optional field and is filled for
	// action on document version.
	VersionId *string
}

Describes the metadata of a resource.

type ResourcePath 

type ResourcePath struct {

	// The components of the resource path.
	Components []ResourcePathComponent
}

Describes the path information of a resource.

type ResourcePathComponent 

type ResourcePathComponent struct {

	// The ID of the resource path.
	Id *string

	// The name of the resource path.
	Name *string
}

Describes the resource path.

type ResourceSortType 

type ResourceSortType string
const (
	ResourceSortTypeDate ResourceSortType = "DATE"
	ResourceSortTypeName ResourceSortType = "NAME"
)

Enum values for ResourceSortType

func (ResourceSortType) Values 

func (ResourceSortType) Values() []ResourceSortType

Values returns all known values for ResourceSortType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceStateType 

type ResourceStateType string
const (
	ResourceStateTypeActive    ResourceStateType = "ACTIVE"
	ResourceStateTypeRestoring ResourceStateType = "RESTORING"
	ResourceStateTypeRecycling ResourceStateType = "RECYCLING"
	ResourceStateTypeRecycled  ResourceStateType = "RECYCLED"
)

Enum values for ResourceStateType

func (ResourceStateType) Values 

func (ResourceStateType) Values() []ResourceStateType

Values returns all known values for ResourceStateType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceType 

type ResourceType string
const (
	ResourceTypeFolder   ResourceType = "FOLDER"
	ResourceTypeDocument ResourceType = "DOCUMENT"
)

Enum values for ResourceType

func (ResourceType) Values 

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RolePermissionType 

type RolePermissionType string
const (
	RolePermissionTypeDirect    RolePermissionType = "DIRECT"
	RolePermissionTypeInherited RolePermissionType = "INHERITED"
)

Enum values for RolePermissionType

func (RolePermissionType) Values 

func (RolePermissionType) Values() []RolePermissionType

Values returns all known values for RolePermissionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RoleType 

type RoleType string
const (
	RoleTypeViewer      RoleType = "VIEWER"
	RoleTypeContributor RoleType = "CONTRIBUTOR"
	RoleTypeOwner       RoleType = "OWNER"
	RoleTypeCoowner     RoleType = "COOWNER"
)

Enum values for RoleType

func (RoleType) Values 

func (RoleType) Values() []RoleType

Values returns all known values for RoleType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string
}

One or more of the dependencies is unavailable.

func (*ServiceUnavailableException) Error 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type SharePrincipal 

type SharePrincipal struct {

	// The ID of the recipient.
	//
	// This member is required.
	Id *string

	// The role of the recipient.
	//
	// This member is required.
	Role RoleType

	// The type of the recipient.
	//
	// This member is required.
	Type PrincipalType
}

Describes the recipient type and ID, if available.

type ShareResult 

type ShareResult struct {

	// The ID of the invited user.
	InviteePrincipalId *string

	// The ID of the principal.
	PrincipalId *string

	// The role.
	Role RoleType

	// The ID of the resource that was shared.
	ShareId *string

	// The status.
	Status ShareStatusType

	// The status message.
	StatusMessage *string
}

Describes the share results of a resource.

type ShareStatusType 

type ShareStatusType string
const (
	ShareStatusTypeSuccess ShareStatusType = "SUCCESS"
	ShareStatusTypeFailure ShareStatusType = "FAILURE"
)

Enum values for ShareStatusType

func (ShareStatusType) Values 

func (ShareStatusType) Values() []ShareStatusType

Values returns all known values for ShareStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type StorageLimitExceededException 

type StorageLimitExceededException struct {
	Message *string
}

The storage limit has been exceeded.

func (*StorageLimitExceededException) Error 

func (e *StorageLimitExceededException) Error() string

func (*StorageLimitExceededException) ErrorCode 

func (e *StorageLimitExceededException) ErrorCode() string

func (*StorageLimitExceededException) ErrorFault 

func (e *StorageLimitExceededException) ErrorFault() smithy.ErrorFault

func (*StorageLimitExceededException) ErrorMessage 

func (e *StorageLimitExceededException) ErrorMessage() string

type StorageLimitWillExceedException 

type StorageLimitWillExceedException struct {
	Message *string
}

The storage limit will be exceeded.

func (*StorageLimitWillExceedException) Error 

func (e *StorageLimitWillExceedException) Error() string

func (*StorageLimitWillExceedException) ErrorCode 

func (e *StorageLimitWillExceedException) ErrorCode() string

func (*StorageLimitWillExceedException) ErrorFault 

func (e *StorageLimitWillExceedException) ErrorFault() smithy.ErrorFault

func (*StorageLimitWillExceedException) ErrorMessage 

func (e *StorageLimitWillExceedException) ErrorMessage() string

type StorageRuleType 

type StorageRuleType struct {

	// The amount of storage allocated, in bytes.
	StorageAllocatedInBytes *int64

	// The type of storage.
	StorageType StorageType
}

Describes the storage for a user.

type StorageType 

type StorageType string
const (
	StorageTypeUnlimited StorageType = "UNLIMITED"
	StorageTypeQuota     StorageType = "QUOTA"
)

Enum values for StorageType

func (StorageType) Values 

func (StorageType) Values() []StorageType

Values returns all known values for StorageType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Subscription 

type Subscription struct {

	// The endpoint of the subscription.
	EndPoint *string

	// The protocol of the subscription.
	Protocol SubscriptionProtocolType

	// The ID of the subscription.
	SubscriptionId *string
}

Describes a subscription.

type SubscriptionProtocolType 

type SubscriptionProtocolType string
const (
	SubscriptionProtocolTypeHttps SubscriptionProtocolType = "HTTPS"
)

Enum values for SubscriptionProtocolType

func (SubscriptionProtocolType) Values 

func (SubscriptionProtocolType) Values() []SubscriptionProtocolType

Values returns all known values for SubscriptionProtocolType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SubscriptionType 

type SubscriptionType string
const (
	SubscriptionTypeAll SubscriptionType = "ALL"
)

Enum values for SubscriptionType

func (SubscriptionType) Values 

func (SubscriptionType) Values() []SubscriptionType

Values returns all known values for SubscriptionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TooManyLabelsException 

type TooManyLabelsException struct {
	Message *string
}

The limit has been reached on the number of labels for the specified resource.

func (*TooManyLabelsException) Error 

func (e *TooManyLabelsException) Error() string

func (*TooManyLabelsException) ErrorCode 

func (e *TooManyLabelsException) ErrorCode() string

func (*TooManyLabelsException) ErrorFault 

func (e *TooManyLabelsException) ErrorFault() smithy.ErrorFault

func (*TooManyLabelsException) ErrorMessage 

func (e *TooManyLabelsException) ErrorMessage() string

type TooManySubscriptionsException 

type TooManySubscriptionsException struct {
	Message *string
}

You've reached the limit on the number of subscriptions for the WorkDocs instance.

func (*TooManySubscriptionsException) Error 

func (e *TooManySubscriptionsException) Error() string

func (*TooManySubscriptionsException) ErrorCode 

func (e *TooManySubscriptionsException) ErrorCode() string

func (*TooManySubscriptionsException) ErrorFault 

func (e *TooManySubscriptionsException) ErrorFault() smithy.ErrorFault

func (*TooManySubscriptionsException) ErrorMessage 

func (e *TooManySubscriptionsException) ErrorMessage() string

type UnauthorizedOperationException 

type UnauthorizedOperationException struct {
	Message *string

	Code *string
}

The operation is not permitted.

func (*UnauthorizedOperationException) Error 

func (e *UnauthorizedOperationException) Error() string

func (*UnauthorizedOperationException) ErrorCode 

func (e *UnauthorizedOperationException) ErrorCode() string

func (*UnauthorizedOperationException) ErrorFault 

func (e *UnauthorizedOperationException) ErrorFault() smithy.ErrorFault

func (*UnauthorizedOperationException) ErrorMessage 

func (e *UnauthorizedOperationException) ErrorMessage() string

type UnauthorizedResourceAccessException 

type UnauthorizedResourceAccessException struct {
	Message *string
}

The caller does not have access to perform the action on the resource.

func (*UnauthorizedResourceAccessException) Error 

func (e *UnauthorizedResourceAccessException) Error() string

func (*UnauthorizedResourceAccessException) ErrorCode 

func (e *UnauthorizedResourceAccessException) ErrorCode() string

func (*UnauthorizedResourceAccessException) ErrorFault 

func (e *UnauthorizedResourceAccessException) ErrorFault() smithy.ErrorFault

func (*UnauthorizedResourceAccessException) ErrorMessage 

func (e *UnauthorizedResourceAccessException) ErrorMessage() string

type UploadMetadata 

type UploadMetadata struct {

	// The signed headers.
	SignedHeaders map[string]string

	// The URL of the upload.
	UploadUrl *string
}

Describes the upload.

type User 

type User struct {

	// The time when the user was created.
	CreatedTimestamp *time.Time

	// The email address of the user.
	EmailAddress *string

	// The given name of the user.
	GivenName *string

	// The ID of the user.
	Id *string

	// The locale of the user.
	Locale LocaleType

	// The time when the user was modified.
	ModifiedTimestamp *time.Time

	// The ID of the organization.
	OrganizationId *string

	// The ID of the recycle bin folder.
	RecycleBinFolderId *string

	// The ID of the root folder.
	RootFolderId *string

	// The status of the user.
	Status UserStatusType

	// The storage for the user.
	Storage *UserStorageMetadata

	// The surname of the user.
	Surname *string

	// The time zone ID of the user.
	TimeZoneId *string

	// The type of user.
	Type UserType

	// The login name of the user.
	Username *string
}

Describes a user.

type UserFilterType 

type UserFilterType string
const (
	UserFilterTypeAll           UserFilterType = "ALL"
	UserFilterTypeActivePending UserFilterType = "ACTIVE_PENDING"
)

Enum values for UserFilterType

func (UserFilterType) Values 

func (UserFilterType) Values() []UserFilterType

Values returns all known values for UserFilterType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UserMetadata 

type UserMetadata struct {

	// The email address of the user.
	EmailAddress *string

	// The given name of the user before a rename operation.
	GivenName *string

	// The ID of the user.
	Id *string

	// The surname of the user.
	Surname *string

	// The name of the user.
	Username *string
}

Describes the metadata of the user.

type UserSortType 

type UserSortType string
const (
	UserSortTypeUserName     UserSortType = "USER_NAME"
	UserSortTypeFullName     UserSortType = "FULL_NAME"
	UserSortTypeStorageLimit UserSortType = "STORAGE_LIMIT"
	UserSortTypeUserStatus   UserSortType = "USER_STATUS"
	UserSortTypeStorageUsed  UserSortType = "STORAGE_USED"
)

Enum values for UserSortType

func (UserSortType) Values 

func (UserSortType) Values() []UserSortType

Values returns all known values for UserSortType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UserStatusType 

type UserStatusType string
const (
	UserStatusTypeActive   UserStatusType = "ACTIVE"
	UserStatusTypeInactive UserStatusType = "INACTIVE"
	UserStatusTypePending  UserStatusType = "PENDING"
)

Enum values for UserStatusType

func (UserStatusType) Values 

func (UserStatusType) Values() []UserStatusType

Values returns all known values for UserStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UserStorageMetadata 

type UserStorageMetadata struct {

	// The storage for a user.
	StorageRule *StorageRuleType

	// The amount of storage used, in bytes.
	StorageUtilizedInBytes *int64
}

Describes the storage for a user.

type UserType 

type UserType string
const (
	UserTypeUser           UserType = "USER"
	UserTypeAdmin          UserType = "ADMIN"
	UserTypePoweruser      UserType = "POWERUSER"
	UserTypeMinimaluser    UserType = "MINIMALUSER"
	UserTypeWorkspacesuser UserType = "WORKSPACESUSER"
)

Enum values for UserType

func (UserType) Values 

func (UserType) Values() []UserType

Values returns all known values for UserType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

Source Files

enums.go errors.go types.go

Version
v1.3.1
Published
Jul 15, 2021
Platform
linux/amd64
Imports
3 packages
Last checked
8 hours ago –

Tools for package owners.