workdocs

package
v1.54.20 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 18, 2024 License: Apache-2.0 Imports: 10 Imported by: 52

Documentation

Overview

Package workdocs provides the client and types for making API requests to Amazon WorkDocs.

The Amazon WorkDocs API is designed for the following use cases:

  • File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.

  • Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.

  • eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.

All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.

The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:

  • READ (Get*)

  • WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)

  • LIST (Describe*)

  • DELETE*, CANCEL

For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing (https://aws.amazon.com/workdocs/pricing/).

See https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01 for more information on this service.

See workdocs package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/workdocs/

Using the Client

To contact Amazon WorkDocs with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon WorkDocs client WorkDocs for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/workdocs/#New

Index

Constants

View Source 
const (
	// ActivityTypeDocumentCheckedIn is a ActivityType enum value
	ActivityTypeDocumentCheckedIn = "DOCUMENT_CHECKED_IN"

	// ActivityTypeDocumentCheckedOut is a ActivityType enum value
	ActivityTypeDocumentCheckedOut = "DOCUMENT_CHECKED_OUT"

	// ActivityTypeDocumentRenamed is a ActivityType enum value
	ActivityTypeDocumentRenamed = "DOCUMENT_RENAMED"

	// ActivityTypeDocumentVersionUploaded is a ActivityType enum value
	ActivityTypeDocumentVersionUploaded = "DOCUMENT_VERSION_UPLOADED"

	// ActivityTypeDocumentVersionDeleted is a ActivityType enum value
	ActivityTypeDocumentVersionDeleted = "DOCUMENT_VERSION_DELETED"

	// ActivityTypeDocumentVersionViewed is a ActivityType enum value
	ActivityTypeDocumentVersionViewed = "DOCUMENT_VERSION_VIEWED"

	// ActivityTypeDocumentVersionDownloaded is a ActivityType enum value
	ActivityTypeDocumentVersionDownloaded = "DOCUMENT_VERSION_DOWNLOADED"

	// ActivityTypeDocumentRecycled is a ActivityType enum value
	ActivityTypeDocumentRecycled = "DOCUMENT_RECYCLED"

	// ActivityTypeDocumentRestored is a ActivityType enum value
	ActivityTypeDocumentRestored = "DOCUMENT_RESTORED"

	// ActivityTypeDocumentReverted is a ActivityType enum value
	ActivityTypeDocumentReverted = "DOCUMENT_REVERTED"

	// ActivityTypeDocumentShared is a ActivityType enum value
	ActivityTypeDocumentShared = "DOCUMENT_SHARED"

	// ActivityTypeDocumentUnshared is a ActivityType enum value
	ActivityTypeDocumentUnshared = "DOCUMENT_UNSHARED"

	// ActivityTypeDocumentSharePermissionChanged is a ActivityType enum value
	ActivityTypeDocumentSharePermissionChanged = "DOCUMENT_SHARE_PERMISSION_CHANGED"

	// ActivityTypeDocumentShareableLinkCreated is a ActivityType enum value
	ActivityTypeDocumentShareableLinkCreated = "DOCUMENT_SHAREABLE_LINK_CREATED"

	// ActivityTypeDocumentShareableLinkRemoved is a ActivityType enum value
	ActivityTypeDocumentShareableLinkRemoved = "DOCUMENT_SHAREABLE_LINK_REMOVED"

	// ActivityTypeDocumentShareableLinkPermissionChanged is a ActivityType enum value
	ActivityTypeDocumentShareableLinkPermissionChanged = "DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED"

	// ActivityTypeDocumentMoved is a ActivityType enum value
	ActivityTypeDocumentMoved = "DOCUMENT_MOVED"

	// ActivityTypeDocumentCommentAdded is a ActivityType enum value
	ActivityTypeDocumentCommentAdded = "DOCUMENT_COMMENT_ADDED"

	// ActivityTypeDocumentCommentDeleted is a ActivityType enum value
	ActivityTypeDocumentCommentDeleted = "DOCUMENT_COMMENT_DELETED"

	// ActivityTypeDocumentAnnotationAdded is a ActivityType enum value
	ActivityTypeDocumentAnnotationAdded = "DOCUMENT_ANNOTATION_ADDED"

	// ActivityTypeDocumentAnnotationDeleted is a ActivityType enum value
	ActivityTypeDocumentAnnotationDeleted = "DOCUMENT_ANNOTATION_DELETED"

	// ActivityTypeFolderCreated is a ActivityType enum value
	ActivityTypeFolderCreated = "FOLDER_CREATED"

	// ActivityTypeFolderDeleted is a ActivityType enum value
	ActivityTypeFolderDeleted = "FOLDER_DELETED"

	// ActivityTypeFolderRenamed is a ActivityType enum value
	ActivityTypeFolderRenamed = "FOLDER_RENAMED"

	// ActivityTypeFolderRecycled is a ActivityType enum value
	ActivityTypeFolderRecycled = "FOLDER_RECYCLED"

	// ActivityTypeFolderRestored is a ActivityType enum value
	ActivityTypeFolderRestored = "FOLDER_RESTORED"

	// ActivityTypeFolderShared is a ActivityType enum value
	ActivityTypeFolderShared = "FOLDER_SHARED"

	// ActivityTypeFolderUnshared is a ActivityType enum value
	ActivityTypeFolderUnshared = "FOLDER_UNSHARED"

	// ActivityTypeFolderSharePermissionChanged is a ActivityType enum value
	ActivityTypeFolderSharePermissionChanged = "FOLDER_SHARE_PERMISSION_CHANGED"

	// ActivityTypeFolderShareableLinkCreated is a ActivityType enum value
	ActivityTypeFolderShareableLinkCreated = "FOLDER_SHAREABLE_LINK_CREATED"

	// ActivityTypeFolderShareableLinkRemoved is a ActivityType enum value
	ActivityTypeFolderShareableLinkRemoved = "FOLDER_SHAREABLE_LINK_REMOVED"

	// ActivityTypeFolderShareableLinkPermissionChanged is a ActivityType enum value
	ActivityTypeFolderShareableLinkPermissionChanged = "FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED"

	// ActivityTypeFolderMoved is a ActivityType enum value
	ActivityTypeFolderMoved = "FOLDER_MOVED"
)
View Source 
const (
	// BooleanEnumTypeTrue is a BooleanEnumType enum value
	BooleanEnumTypeTrue = "TRUE"

	// BooleanEnumTypeFalse is a BooleanEnumType enum value
	BooleanEnumTypeFalse = "FALSE"
)
View Source 
const (
	// CommentStatusTypeDraft is a CommentStatusType enum value
	CommentStatusTypeDraft = "DRAFT"

	// CommentStatusTypePublished is a CommentStatusType enum value
	CommentStatusTypePublished = "PUBLISHED"

	// CommentStatusTypeDeleted is a CommentStatusType enum value
	CommentStatusTypeDeleted = "DELETED"
)
View Source 
const (
	// CommentVisibilityTypePublic is a CommentVisibilityType enum value
	CommentVisibilityTypePublic = "PUBLIC"

	// CommentVisibilityTypePrivate is a CommentVisibilityType enum value
	CommentVisibilityTypePrivate = "PRIVATE"
)
View Source 
const (
	// ContentCategoryTypeImage is a ContentCategoryType enum value
	ContentCategoryTypeImage = "IMAGE"

	// ContentCategoryTypeDocument is a ContentCategoryType enum value
	ContentCategoryTypeDocument = "DOCUMENT"

	// ContentCategoryTypePdf is a ContentCategoryType enum value
	ContentCategoryTypePdf = "PDF"

	// ContentCategoryTypeSpreadsheet is a ContentCategoryType enum value
	ContentCategoryTypeSpreadsheet = "SPREADSHEET"

	// ContentCategoryTypePresentation is a ContentCategoryType enum value
	ContentCategoryTypePresentation = "PRESENTATION"

	// ContentCategoryTypeAudio is a ContentCategoryType enum value
	ContentCategoryTypeAudio = "AUDIO"

	// ContentCategoryTypeVideo is a ContentCategoryType enum value
	ContentCategoryTypeVideo = "VIDEO"

	// ContentCategoryTypeSourceCode is a ContentCategoryType enum value
	ContentCategoryTypeSourceCode = "SOURCE_CODE"

	// ContentCategoryTypeOther is a ContentCategoryType enum value
	ContentCategoryTypeOther = "OTHER"
)
View Source 
const (
	// DocumentSourceTypeOriginal is a DocumentSourceType enum value
	DocumentSourceTypeOriginal = "ORIGINAL"

	// DocumentSourceTypeWithComments is a DocumentSourceType enum value
	DocumentSourceTypeWithComments = "WITH_COMMENTS"
)
View Source 
const (
	// DocumentStatusTypeInitialized is a DocumentStatusType enum value
	DocumentStatusTypeInitialized = "INITIALIZED"

	// DocumentStatusTypeActive is a DocumentStatusType enum value
	DocumentStatusTypeActive = "ACTIVE"
)
View Source 
const (
	// DocumentThumbnailTypeSmall is a DocumentThumbnailType enum value
	DocumentThumbnailTypeSmall = "SMALL"

	// DocumentThumbnailTypeSmallHq is a DocumentThumbnailType enum value
	DocumentThumbnailTypeSmallHq = "SMALL_HQ"

	// DocumentThumbnailTypeLarge is a DocumentThumbnailType enum value
	DocumentThumbnailTypeLarge = "LARGE"
)
View Source 
const (
	// FolderContentTypeAll is a FolderContentType enum value
	FolderContentTypeAll = "ALL"

	// FolderContentTypeDocument is a FolderContentType enum value
	FolderContentTypeDocument = "DOCUMENT"

	// FolderContentTypeFolder is a FolderContentType enum value
	FolderContentTypeFolder = "FOLDER"
)
View Source 
const (
	// LanguageCodeTypeAr is a LanguageCodeType enum value
	LanguageCodeTypeAr = "AR"

	// LanguageCodeTypeBg is a LanguageCodeType enum value
	LanguageCodeTypeBg = "BG"

	// LanguageCodeTypeBn is a LanguageCodeType enum value
	LanguageCodeTypeBn = "BN"

	// LanguageCodeTypeDa is a LanguageCodeType enum value
	LanguageCodeTypeDa = "DA"

	// LanguageCodeTypeDe is a LanguageCodeType enum value
	LanguageCodeTypeDe = "DE"

	// LanguageCodeTypeCs is a LanguageCodeType enum value
	LanguageCodeTypeCs = "CS"

	// LanguageCodeTypeEl is a LanguageCodeType enum value
	LanguageCodeTypeEl = "EL"

	// LanguageCodeTypeEn is a LanguageCodeType enum value
	LanguageCodeTypeEn = "EN"

	// LanguageCodeTypeEs is a LanguageCodeType enum value
	LanguageCodeTypeEs = "ES"

	// LanguageCodeTypeFa is a LanguageCodeType enum value
	LanguageCodeTypeFa = "FA"

	// LanguageCodeTypeFi is a LanguageCodeType enum value
	LanguageCodeTypeFi = "FI"

	// LanguageCodeTypeFr is a LanguageCodeType enum value
	LanguageCodeTypeFr = "FR"

	// LanguageCodeTypeHi is a LanguageCodeType enum value
	LanguageCodeTypeHi = "HI"

	// LanguageCodeTypeHu is a LanguageCodeType enum value
	LanguageCodeTypeHu = "HU"

	// LanguageCodeTypeId is a LanguageCodeType enum value
	LanguageCodeTypeId = "ID"

	// LanguageCodeTypeIt is a LanguageCodeType enum value
	LanguageCodeTypeIt = "IT"

	// LanguageCodeTypeJa is a LanguageCodeType enum value
	LanguageCodeTypeJa = "JA"

	// LanguageCodeTypeKo is a LanguageCodeType enum value
	LanguageCodeTypeKo = "KO"

	// LanguageCodeTypeLt is a LanguageCodeType enum value
	LanguageCodeTypeLt = "LT"

	// LanguageCodeTypeLv is a LanguageCodeType enum value
	LanguageCodeTypeLv = "LV"

	// LanguageCodeTypeNl is a LanguageCodeType enum value
	LanguageCodeTypeNl = "NL"

	// LanguageCodeTypeNo is a LanguageCodeType enum value
	LanguageCodeTypeNo = "NO"

	// LanguageCodeTypePt is a LanguageCodeType enum value
	LanguageCodeTypePt = "PT"

	// LanguageCodeTypeRo is a LanguageCodeType enum value
	LanguageCodeTypeRo = "RO"

	// LanguageCodeTypeRu is a LanguageCodeType enum value
	LanguageCodeTypeRu = "RU"

	// LanguageCodeTypeSv is a LanguageCodeType enum value
	LanguageCodeTypeSv = "SV"

	// LanguageCodeTypeSw is a LanguageCodeType enum value
	LanguageCodeTypeSw = "SW"

	// LanguageCodeTypeTh is a LanguageCodeType enum value
	LanguageCodeTypeTh = "TH"

	// LanguageCodeTypeTr is a LanguageCodeType enum value
	LanguageCodeTypeTr = "TR"

	// LanguageCodeTypeZh is a LanguageCodeType enum value
	LanguageCodeTypeZh = "ZH"

	// LanguageCodeTypeDefault is a LanguageCodeType enum value
	LanguageCodeTypeDefault = "DEFAULT"
)
View Source 
const (
	// LocaleTypeEn is a LocaleType enum value
	LocaleTypeEn = "en"

	// LocaleTypeFr is a LocaleType enum value
	LocaleTypeFr = "fr"

	// LocaleTypeKo is a LocaleType enum value
	LocaleTypeKo = "ko"

	// LocaleTypeDe is a LocaleType enum value
	LocaleTypeDe = "de"

	// LocaleTypeEs is a LocaleType enum value
	LocaleTypeEs = "es"

	// LocaleTypeJa is a LocaleType enum value
	LocaleTypeJa = "ja"

	// LocaleTypeRu is a LocaleType enum value
	LocaleTypeRu = "ru"

	// LocaleTypeZhCn is a LocaleType enum value
	LocaleTypeZhCn = "zh_CN"

	// LocaleTypeZhTw is a LocaleType enum value
	LocaleTypeZhTw = "zh_TW"

	// LocaleTypePtBr is a LocaleType enum value
	LocaleTypePtBr = "pt_BR"

	// LocaleTypeDefault is a LocaleType enum value
	LocaleTypeDefault = "default"
)
View Source 
const (
	// OrderByFieldTypeRelevance is a OrderByFieldType enum value
	OrderByFieldTypeRelevance = "RELEVANCE"

	// OrderByFieldTypeName is a OrderByFieldType enum value
	OrderByFieldTypeName = "NAME"

	// OrderByFieldTypeSize is a OrderByFieldType enum value
	OrderByFieldTypeSize = "SIZE"

	// OrderByFieldTypeCreatedTimestamp is a OrderByFieldType enum value
	OrderByFieldTypeCreatedTimestamp = "CREATED_TIMESTAMP"

	// OrderByFieldTypeModifiedTimestamp is a OrderByFieldType enum value
	OrderByFieldTypeModifiedTimestamp = "MODIFIED_TIMESTAMP"
)
View Source 
const (
	// OrderTypeAscending is a OrderType enum value
	OrderTypeAscending = "ASCENDING"

	// OrderTypeDescending is a OrderType enum value
	OrderTypeDescending = "DESCENDING"
)
View Source 
const (
	// PrincipalRoleTypeViewer is a PrincipalRoleType enum value
	PrincipalRoleTypeViewer = "VIEWER"

	// PrincipalRoleTypeContributor is a PrincipalRoleType enum value
	PrincipalRoleTypeContributor = "CONTRIBUTOR"

	// PrincipalRoleTypeOwner is a PrincipalRoleType enum value
	PrincipalRoleTypeOwner = "OWNER"

	// PrincipalRoleTypeCoowner is a PrincipalRoleType enum value
	PrincipalRoleTypeCoowner = "COOWNER"
)
View Source 
const (
	// PrincipalTypeUser is a PrincipalType enum value
	PrincipalTypeUser = "USER"

	// PrincipalTypeGroup is a PrincipalType enum value
	PrincipalTypeGroup = "GROUP"

	// PrincipalTypeInvite is a PrincipalType enum value
	PrincipalTypeInvite = "INVITE"

	// PrincipalTypeAnonymous is a PrincipalType enum value
	PrincipalTypeAnonymous = "ANONYMOUS"

	// PrincipalTypeOrganization is a PrincipalType enum value
	PrincipalTypeOrganization = "ORGANIZATION"
)
View Source 
const (
	// ResourceSortTypeDate is a ResourceSortType enum value
	ResourceSortTypeDate = "DATE"

	// ResourceSortTypeName is a ResourceSortType enum value
	ResourceSortTypeName = "NAME"
)
View Source 
const (
	// ResourceStateTypeActive is a ResourceStateType enum value
	ResourceStateTypeActive = "ACTIVE"

	// ResourceStateTypeRestoring is a ResourceStateType enum value
	ResourceStateTypeRestoring = "RESTORING"

	// ResourceStateTypeRecycling is a ResourceStateType enum value
	ResourceStateTypeRecycling = "RECYCLING"

	// ResourceStateTypeRecycled is a ResourceStateType enum value
	ResourceStateTypeRecycled = "RECYCLED"
)
View Source 
const (
	// ResourceTypeFolder is a ResourceType enum value
	ResourceTypeFolder = "FOLDER"

	// ResourceTypeDocument is a ResourceType enum value
	ResourceTypeDocument = "DOCUMENT"
)
View Source 
const (
	// ResponseItemTypeDocument is a ResponseItemType enum value
	ResponseItemTypeDocument = "DOCUMENT"

	// ResponseItemTypeFolder is a ResponseItemType enum value
	ResponseItemTypeFolder = "FOLDER"

	// ResponseItemTypeComment is a ResponseItemType enum value
	ResponseItemTypeComment = "COMMENT"

	// ResponseItemTypeDocumentVersion is a ResponseItemType enum value
	ResponseItemTypeDocumentVersion = "DOCUMENT_VERSION"
)
View Source 
const (
	// RolePermissionTypeDirect is a RolePermissionType enum value
	RolePermissionTypeDirect = "DIRECT"

	// RolePermissionTypeInherited is a RolePermissionType enum value
	RolePermissionTypeInherited = "INHERITED"
)
View Source 
const (
	// RoleTypeViewer is a RoleType enum value
	RoleTypeViewer = "VIEWER"

	// RoleTypeContributor is a RoleType enum value
	RoleTypeContributor = "CONTRIBUTOR"

	// RoleTypeOwner is a RoleType enum value
	RoleTypeOwner = "OWNER"

	// RoleTypeCoowner is a RoleType enum value
	RoleTypeCoowner = "COOWNER"
)
View Source 
const (
	// SearchCollectionTypeOwned is a SearchCollectionType enum value
	SearchCollectionTypeOwned = "OWNED"

	// SearchCollectionTypeSharedWithMe is a SearchCollectionType enum value
	SearchCollectionTypeSharedWithMe = "SHARED_WITH_ME"
)
View Source 
const (
	// SearchQueryScopeTypeName is a SearchQueryScopeType enum value
	SearchQueryScopeTypeName = "NAME"

	// SearchQueryScopeTypeContent is a SearchQueryScopeType enum value
	SearchQueryScopeTypeContent = "CONTENT"
)
View Source 
const (
	// SearchResourceTypeFolder is a SearchResourceType enum value
	SearchResourceTypeFolder = "FOLDER"

	// SearchResourceTypeDocument is a SearchResourceType enum value
	SearchResourceTypeDocument = "DOCUMENT"

	// SearchResourceTypeComment is a SearchResourceType enum value
	SearchResourceTypeComment = "COMMENT"

	// SearchResourceTypeDocumentVersion is a SearchResourceType enum value
	SearchResourceTypeDocumentVersion = "DOCUMENT_VERSION"
)
View Source 
const (
	// ShareStatusTypeSuccess is a ShareStatusType enum value
	ShareStatusTypeSuccess = "SUCCESS"

	// ShareStatusTypeFailure is a ShareStatusType enum value
	ShareStatusTypeFailure = "FAILURE"
)
View Source 
const (
	// SortOrderAsc is a SortOrder enum value
	SortOrderAsc = "ASC"

	// SortOrderDesc is a SortOrder enum value
	SortOrderDesc = "DESC"
)
View Source 
const (
	// StorageTypeUnlimited is a StorageType enum value
	StorageTypeUnlimited = "UNLIMITED"

	// StorageTypeQuota is a StorageType enum value
	StorageTypeQuota = "QUOTA"
)
View Source 
const (
	// SubscriptionProtocolTypeHttps is a SubscriptionProtocolType enum value
	SubscriptionProtocolTypeHttps = "HTTPS"

	// SubscriptionProtocolTypeSqs is a SubscriptionProtocolType enum value
	SubscriptionProtocolTypeSqs = "SQS"
)
View Source 
const (
	// UserFilterTypeAll is a UserFilterType enum value
	UserFilterTypeAll = "ALL"

	// UserFilterTypeActivePending is a UserFilterType enum value
	UserFilterTypeActivePending = "ACTIVE_PENDING"
)
View Source 
const (
	// UserSortTypeUserName is a UserSortType enum value
	UserSortTypeUserName = "USER_NAME"

	// UserSortTypeFullName is a UserSortType enum value
	UserSortTypeFullName = "FULL_NAME"

	// UserSortTypeStorageLimit is a UserSortType enum value
	UserSortTypeStorageLimit = "STORAGE_LIMIT"

	// UserSortTypeUserStatus is a UserSortType enum value
	UserSortTypeUserStatus = "USER_STATUS"

	// UserSortTypeStorageUsed is a UserSortType enum value
	UserSortTypeStorageUsed = "STORAGE_USED"
)
View Source 
const (
	// UserStatusTypeActive is a UserStatusType enum value
	UserStatusTypeActive = "ACTIVE"

	// UserStatusTypeInactive is a UserStatusType enum value
	UserStatusTypeInactive = "INACTIVE"

	// UserStatusTypePending is a UserStatusType enum value
	UserStatusTypePending = "PENDING"
)
View Source 
const (
	// UserTypeUser is a UserType enum value
	UserTypeUser = "USER"

	// UserTypeAdmin is a UserType enum value
	UserTypeAdmin = "ADMIN"

	// UserTypePoweruser is a UserType enum value
	UserTypePoweruser = "POWERUSER"

	// UserTypeMinimaluser is a UserType enum value
	UserTypeMinimaluser = "MINIMALUSER"

	// UserTypeWorkspacesuser is a UserType enum value
	UserTypeWorkspacesuser = "WORKSPACESUSER"
)
View Source 
const (

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// The resource hierarchy is changing.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeConflictingOperationException for service response error code
	// "ConflictingOperationException".
	//
	// Another operation is in progress on the resource that conflicts with the
	// current operation.
	ErrCodeConflictingOperationException = "ConflictingOperationException"

	// ErrCodeCustomMetadataLimitExceededException for service response error code
	// "CustomMetadataLimitExceededException".
	//
	// The limit has been reached on the number of custom properties for the specified
	// resource.
	ErrCodeCustomMetadataLimitExceededException = "CustomMetadataLimitExceededException"

	// ErrCodeDeactivatingLastSystemUserException for service response error code
	// "DeactivatingLastSystemUserException".
	//
	// The last user in the organization is being deactivated.
	ErrCodeDeactivatingLastSystemUserException = "DeactivatingLastSystemUserException"

	// ErrCodeDocumentLockedForCommentsException for service response error code
	// "DocumentLockedForCommentsException".
	//
	// This exception is thrown when the document is locked for comments and user
	// tries to create or delete a comment on that document.
	ErrCodeDocumentLockedForCommentsException = "DocumentLockedForCommentsException"

	// ErrCodeDraftUploadOutOfSyncException for service response error code
	// "DraftUploadOutOfSyncException".
	//
	// 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.
	ErrCodeDraftUploadOutOfSyncException = "DraftUploadOutOfSyncException"

	// ErrCodeEntityAlreadyExistsException for service response error code
	// "EntityAlreadyExistsException".
	//
	// The resource already exists.
	ErrCodeEntityAlreadyExistsException = "EntityAlreadyExistsException"

	// ErrCodeEntityNotExistsException for service response error code
	// "EntityNotExistsException".
	//
	// The resource does not exist.
	ErrCodeEntityNotExistsException = "EntityNotExistsException"

	// ErrCodeFailedDependencyException for service response error code
	// "FailedDependencyException".
	//
	// The 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.
	ErrCodeFailedDependencyException = "FailedDependencyException"

	// ErrCodeIllegalUserStateException for service response error code
	// "IllegalUserStateException".
	//
	// The user is undergoing transfer of ownership.
	ErrCodeIllegalUserStateException = "IllegalUserStateException"

	// ErrCodeInvalidArgumentException for service response error code
	// "InvalidArgumentException".
	//
	// The pagination marker or limit fields are not valid.
	ErrCodeInvalidArgumentException = "InvalidArgumentException"

	// ErrCodeInvalidCommentOperationException for service response error code
	// "InvalidCommentOperationException".
	//
	// The requested operation is not allowed on the specified comment object.
	ErrCodeInvalidCommentOperationException = "InvalidCommentOperationException"

	// ErrCodeInvalidOperationException for service response error code
	// "InvalidOperationException".
	//
	// The operation is invalid.
	ErrCodeInvalidOperationException = "InvalidOperationException"

	// ErrCodeInvalidPasswordException for service response error code
	// "InvalidPasswordException".
	//
	// The password is invalid.
	ErrCodeInvalidPasswordException = "InvalidPasswordException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The maximum of 100,000 files and folders under the parent folder has been
	// exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeProhibitedStateException for service response error code
	// "ProhibitedStateException".
	//
	// The specified document version is not in the INITIALIZED state.
	ErrCodeProhibitedStateException = "ProhibitedStateException"

	// ErrCodeRequestedEntityTooLargeException for service response error code
	// "RequestedEntityTooLargeException".
	//
	// The response is too large to return. The request must include a filter to
	// reduce the size of the response.
	ErrCodeRequestedEntityTooLargeException = "RequestedEntityTooLargeException"

	// ErrCodeResourceAlreadyCheckedOutException for service response error code
	// "ResourceAlreadyCheckedOutException".
	//
	// The resource is already checked out.
	ErrCodeResourceAlreadyCheckedOutException = "ResourceAlreadyCheckedOutException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// One or more of the dependencies is unavailable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeStorageLimitExceededException for service response error code
	// "StorageLimitExceededException".
	//
	// The storage limit has been exceeded.
	ErrCodeStorageLimitExceededException = "StorageLimitExceededException"

	// ErrCodeStorageLimitWillExceedException for service response error code
	// "StorageLimitWillExceedException".
	//
	// The storage limit will be exceeded.
	ErrCodeStorageLimitWillExceedException = "StorageLimitWillExceedException"

	// ErrCodeTooManyLabelsException for service response error code
	// "TooManyLabelsException".
	//
	// The limit has been reached on the number of labels for the specified resource.
	ErrCodeTooManyLabelsException = "TooManyLabelsException"

	// ErrCodeTooManySubscriptionsException for service response error code
	// "TooManySubscriptionsException".
	//
	// You've reached the limit on the number of subscriptions for the WorkDocs
	// instance.
	ErrCodeTooManySubscriptionsException = "TooManySubscriptionsException"

	// ErrCodeUnauthorizedOperationException for service response error code
	// "UnauthorizedOperationException".
	//
	// The operation is not permitted.
	ErrCodeUnauthorizedOperationException = "UnauthorizedOperationException"

	// ErrCodeUnauthorizedResourceAccessException for service response error code
	// "UnauthorizedResourceAccessException".
	//
	// The caller does not have access to perform the action on the resource.
	ErrCodeUnauthorizedResourceAccessException = "UnauthorizedResourceAccessException"
)
View Source 
const (
	ServiceName = "workdocs"  // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "WorkDocs"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// AdditionalResponseFieldTypeWeburl is a AdditionalResponseFieldType enum value
	AdditionalResponseFieldTypeWeburl = "WEBURL"
)
View Source 
const (
	// DocumentVersionStatusActive is a DocumentVersionStatus enum value
	DocumentVersionStatusActive = "ACTIVE"
)
View Source 
const (
	// ResourceCollectionTypeSharedWithMe is a ResourceCollectionType enum value
	ResourceCollectionTypeSharedWithMe = "SHARED_WITH_ME"
)
View Source 
const (
	// SubscriptionTypeAll is a SubscriptionType enum value
	SubscriptionTypeAll = "ALL"
)

Variables

This section is empty.

Functions

func ActivityType_Values added in v1.34.3 

func ActivityType_Values() []string

ActivityType_Values returns all elements of the ActivityType enum

func AdditionalResponseFieldType_Values added in v1.44.225 

func AdditionalResponseFieldType_Values() []string

AdditionalResponseFieldType_Values returns all elements of the AdditionalResponseFieldType enum

func BooleanEnumType_Values added in v1.34.3 

func BooleanEnumType_Values() []string

BooleanEnumType_Values returns all elements of the BooleanEnumType enum

func CommentStatusType_Values added in v1.34.3 

func CommentStatusType_Values() []string

CommentStatusType_Values returns all elements of the CommentStatusType enum

func CommentVisibilityType_Values added in v1.34.3 

func CommentVisibilityType_Values() []string

CommentVisibilityType_Values returns all elements of the CommentVisibilityType enum

func ContentCategoryType_Values added in v1.44.225 

func ContentCategoryType_Values() []string

ContentCategoryType_Values returns all elements of the ContentCategoryType enum

func DocumentSourceType_Values added in v1.34.3 

func DocumentSourceType_Values() []string

DocumentSourceType_Values returns all elements of the DocumentSourceType enum

func DocumentStatusType_Values added in v1.34.3 

func DocumentStatusType_Values() []string

DocumentStatusType_Values returns all elements of the DocumentStatusType enum

func DocumentThumbnailType_Values added in v1.34.3 

func DocumentThumbnailType_Values() []string

DocumentThumbnailType_Values returns all elements of the DocumentThumbnailType enum

func DocumentVersionStatus_Values added in v1.34.3 

func DocumentVersionStatus_Values() []string

DocumentVersionStatus_Values returns all elements of the DocumentVersionStatus enum

func FolderContentType_Values added in v1.34.3 

func FolderContentType_Values() []string

FolderContentType_Values returns all elements of the FolderContentType enum

func LanguageCodeType_Values added in v1.44.225 

func LanguageCodeType_Values() []string

LanguageCodeType_Values returns all elements of the LanguageCodeType enum

func LocaleType_Values added in v1.34.3 

func LocaleType_Values() []string

LocaleType_Values returns all elements of the LocaleType enum

func OrderByFieldType_Values added in v1.44.225 

func OrderByFieldType_Values() []string

OrderByFieldType_Values returns all elements of the OrderByFieldType enum

func OrderType_Values added in v1.34.3 

func OrderType_Values() []string

OrderType_Values returns all elements of the OrderType enum

func PrincipalRoleType_Values added in v1.44.225 

func PrincipalRoleType_Values() []string

PrincipalRoleType_Values returns all elements of the PrincipalRoleType enum

func PrincipalType_Values added in v1.34.3 

func PrincipalType_Values() []string

PrincipalType_Values returns all elements of the PrincipalType enum

func ResourceCollectionType_Values added in v1.34.3 

func ResourceCollectionType_Values() []string

ResourceCollectionType_Values returns all elements of the ResourceCollectionType enum

func ResourceSortType_Values added in v1.34.3 

func ResourceSortType_Values() []string

ResourceSortType_Values returns all elements of the ResourceSortType enum

func ResourceStateType_Values added in v1.34.3 

func ResourceStateType_Values() []string

ResourceStateType_Values returns all elements of the ResourceStateType enum

func ResourceType_Values added in v1.34.3 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func ResponseItemType_Values added in v1.44.225 

func ResponseItemType_Values() []string

ResponseItemType_Values returns all elements of the ResponseItemType enum

func RolePermissionType_Values added in v1.34.3 

func RolePermissionType_Values() []string

RolePermissionType_Values returns all elements of the RolePermissionType enum

func RoleType_Values added in v1.34.3 

func RoleType_Values() []string

RoleType_Values returns all elements of the RoleType enum

func SearchCollectionType_Values added in v1.44.225 

func SearchCollectionType_Values() []string

SearchCollectionType_Values returns all elements of the SearchCollectionType enum

func SearchQueryScopeType_Values added in v1.44.225 

func SearchQueryScopeType_Values() []string

SearchQueryScopeType_Values returns all elements of the SearchQueryScopeType enum

func SearchResourceType_Values added in v1.44.225 

func SearchResourceType_Values() []string

SearchResourceType_Values returns all elements of the SearchResourceType enum

func ShareStatusType_Values added in v1.34.3 

func ShareStatusType_Values() []string

ShareStatusType_Values returns all elements of the ShareStatusType enum

func SortOrder_Values added in v1.44.225 

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func StorageType_Values added in v1.34.3 

func StorageType_Values() []string

StorageType_Values returns all elements of the StorageType enum

func SubscriptionProtocolType_Values added in v1.34.3 

func SubscriptionProtocolType_Values() []string

SubscriptionProtocolType_Values returns all elements of the SubscriptionProtocolType enum

func SubscriptionType_Values added in v1.34.3 

func SubscriptionType_Values() []string

SubscriptionType_Values returns all elements of the SubscriptionType enum

func UserFilterType_Values added in v1.34.3 

func UserFilterType_Values() []string

UserFilterType_Values returns all elements of the UserFilterType enum

func UserSortType_Values added in v1.34.3 

func UserSortType_Values() []string

UserSortType_Values returns all elements of the UserSortType enum

func UserStatusType_Values added in v1.34.3 

func UserStatusType_Values() []string

UserStatusType_Values returns all elements of the UserStatusType enum

func UserType_Values added in v1.34.3 

func UserType_Values() []string

UserType_Values returns all elements of the UserType enum

Types

type AbortDocumentVersionUploadInput 

type AbortDocumentVersionUploadInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AbortDocumentVersionUploadInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// The ID of the version.
	//
	// VersionId is a required field
	VersionId *string `location:"uri" locationName:"VersionId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AbortDocumentVersionUploadInput) GoString 

func (s AbortDocumentVersionUploadInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AbortDocumentVersionUploadInput) SetAuthenticationToken added in v1.8.34 

func (s *AbortDocumentVersionUploadInput) SetAuthenticationToken(v string) *AbortDocumentVersionUploadInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*AbortDocumentVersionUploadInput) SetDocumentId 

func (s *AbortDocumentVersionUploadInput) SetDocumentId(v string) *AbortDocumentVersionUploadInput

SetDocumentId sets the DocumentId field's value.

func (*AbortDocumentVersionUploadInput) SetVersionId 

func (s *AbortDocumentVersionUploadInput) SetVersionId(v string) *AbortDocumentVersionUploadInput

SetVersionId sets the VersionId field's value.

func (AbortDocumentVersionUploadInput) String 

func (s AbortDocumentVersionUploadInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AbortDocumentVersionUploadInput) Validate 

func (s *AbortDocumentVersionUploadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AbortDocumentVersionUploadOutput 

type AbortDocumentVersionUploadOutput struct {
	// contains filtered or unexported fields
}

func (AbortDocumentVersionUploadOutput) GoString 

func (s AbortDocumentVersionUploadOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AbortDocumentVersionUploadOutput) String 

func (s AbortDocumentVersionUploadOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivateUserInput 

type ActivateUserInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActivateUserInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the user.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ActivateUserInput) GoString 

func (s ActivateUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivateUserInput) SetAuthenticationToken added in v1.8.34 

func (s *ActivateUserInput) SetAuthenticationToken(v string) *ActivateUserInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*ActivateUserInput) SetUserId 

func (s *ActivateUserInput) SetUserId(v string) *ActivateUserInput

SetUserId sets the UserId field's value.

func (ActivateUserInput) String 

func (s ActivateUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivateUserInput) Validate 

func (s *ActivateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ActivateUserOutput 

type ActivateUserOutput struct {

	// The user information.
	User *User `type:"structure"`
	// contains filtered or unexported fields
}

func (ActivateUserOutput) GoString 

func (s ActivateUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivateUserOutput) SetUser 

func (s *ActivateUserOutput) SetUser(v *User) *ActivateUserOutput

SetUser sets the User field's value.

func (ActivateUserOutput) String 

func (s ActivateUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Activity added in v1.10.0 

type Activity struct {

	// Metadata of the commenting activity. This is an optional field and is filled
	// for commenting activities.
	CommentMetadata *CommentMetadata `type:"structure"`

	// The user who performed the action.
	Initiator *UserMetadata `type:"structure"`

	// 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 `type:"boolean"`

	// The ID of the organization.
	OrganizationId *string `min:"1" type:"string"`

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

	// 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 `type:"structure"`

	// The metadata of the resource involved in the user action.
	ResourceMetadata *ResourceMetadata `type:"structure"`

	// The timestamp when the action was performed.
	TimeStamp *time.Time `type:"timestamp"`

	// The activity type.
	Type *string `type:"string" enum:"ActivityType"`
	// contains filtered or unexported fields
}

Describes the activity information.

func (Activity) GoString added in v1.10.0 

func (s Activity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Activity) SetCommentMetadata added in v1.10.0 

func (s *Activity) SetCommentMetadata(v *CommentMetadata) *Activity

SetCommentMetadata sets the CommentMetadata field's value.

func (*Activity) SetInitiator added in v1.10.0 

func (s *Activity) SetInitiator(v *UserMetadata) *Activity

SetInitiator sets the Initiator field's value.

func (*Activity) SetIsIndirectActivity added in v1.15.79 

func (s *Activity) SetIsIndirectActivity(v bool) *Activity

SetIsIndirectActivity sets the IsIndirectActivity field's value.

func (*Activity) SetOrganizationId added in v1.10.0 

func (s *Activity) SetOrganizationId(v string) *Activity

SetOrganizationId sets the OrganizationId field's value.

func (*Activity) SetOriginalParent added in v1.10.0 

func (s *Activity) SetOriginalParent(v *ResourceMetadata) *Activity

SetOriginalParent sets the OriginalParent field's value.

func (*Activity) SetParticipants added in v1.10.0 

func (s *Activity) SetParticipants(v *Participants) *Activity

SetParticipants sets the Participants field's value.

func (*Activity) SetResourceMetadata added in v1.10.0 

func (s *Activity) SetResourceMetadata(v *ResourceMetadata) *Activity

SetResourceMetadata sets the ResourceMetadata field's value.

func (*Activity) SetTimeStamp added in v1.10.0 

func (s *Activity) SetTimeStamp(v time.Time) *Activity

SetTimeStamp sets the TimeStamp field's value.

func (*Activity) SetType added in v1.10.0 

func (s *Activity) SetType(v string) *Activity

SetType sets the Type field's value.

func (Activity) String added in v1.10.0 

func (s Activity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddResourcePermissionsInput 

type AddResourcePermissionsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AddResourcePermissionsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The notification options.
	NotificationOptions *NotificationOptions `type:"structure"`

	// The users, groups, or organization being granted permission.
	//
	// Principals is a required field
	Principals []*SharePrincipal `type:"list" required:"true"`

	// The ID of the resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AddResourcePermissionsInput) GoString 

func (s AddResourcePermissionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddResourcePermissionsInput) SetAuthenticationToken added in v1.8.34 

func (s *AddResourcePermissionsInput) SetAuthenticationToken(v string) *AddResourcePermissionsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*AddResourcePermissionsInput) SetNotificationOptions added in v1.12.31 

func (s *AddResourcePermissionsInput) SetNotificationOptions(v *NotificationOptions) *AddResourcePermissionsInput

SetNotificationOptions sets the NotificationOptions field's value.

func (*AddResourcePermissionsInput) SetPrincipals 

func (s *AddResourcePermissionsInput) SetPrincipals(v []*SharePrincipal) *AddResourcePermissionsInput

SetPrincipals sets the Principals field's value.

func (*AddResourcePermissionsInput) SetResourceId 

func (s *AddResourcePermissionsInput) SetResourceId(v string) *AddResourcePermissionsInput

SetResourceId sets the ResourceId field's value.

func (AddResourcePermissionsInput) String 

func (s AddResourcePermissionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddResourcePermissionsInput) Validate 

func (s *AddResourcePermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddResourcePermissionsOutput 

type AddResourcePermissionsOutput struct {

	// The share results.
	ShareResults []*ShareResult `type:"list"`
	// contains filtered or unexported fields
}

func (AddResourcePermissionsOutput) GoString 

func (s AddResourcePermissionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddResourcePermissionsOutput) SetShareResults 

func (s *AddResourcePermissionsOutput) SetShareResults(v []*ShareResult) *AddResourcePermissionsOutput

SetShareResults sets the ShareResults field's value.

func (AddResourcePermissionsOutput) String 

func (s AddResourcePermissionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Comment added in v1.8.34 

type Comment struct {

	// The ID of the comment.
	//
	// CommentId is a required field
	CommentId *string `min:"1" type:"string" required:"true"`

	// The details of the user who made the comment.
	Contributor *User `type:"structure"`

	// The time that the comment was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The ID of the parent comment.
	ParentId *string `min:"1" type:"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 `min:"1" type:"string"`

	// The status of the comment.
	Status *string `type:"string" enum:"CommentStatusType"`

	// The text of the comment.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Comment's
	// String and GoString methods.
	Text *string `min:"1" type:"string" sensitive:"true"`

	// The ID of the root comment in the thread.
	ThreadId *string `min:"1" type:"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 *string `type:"string" enum:"CommentVisibilityType"`
	// contains filtered or unexported fields
}

Describes a comment.

func (Comment) GoString added in v1.8.34 

func (s Comment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Comment) SetCommentId added in v1.8.34 

func (s *Comment) SetCommentId(v string) *Comment

SetCommentId sets the CommentId field's value.

func (*Comment) SetContributor added in v1.8.34 

func (s *Comment) SetContributor(v *User) *Comment

SetContributor sets the Contributor field's value.

func (*Comment) SetCreatedTimestamp added in v1.8.34 

func (s *Comment) SetCreatedTimestamp(v time.Time) *Comment

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*Comment) SetParentId added in v1.8.34 

func (s *Comment) SetParentId(v string) *Comment

SetParentId sets the ParentId field's value.

func (*Comment) SetRecipientId added in v1.8.34 

func (s *Comment) SetRecipientId(v string) *Comment

SetRecipientId sets the RecipientId field's value.

func (*Comment) SetStatus added in v1.8.34 

func (s *Comment) SetStatus(v string) *Comment

SetStatus sets the Status field's value.

func (*Comment) SetText added in v1.8.34 

func (s *Comment) SetText(v string) *Comment

SetText sets the Text field's value.

func (*Comment) SetThreadId added in v1.8.34 

func (s *Comment) SetThreadId(v string) *Comment

SetThreadId sets the ThreadId field's value.

func (*Comment) SetVisibility added in v1.8.34 

func (s *Comment) SetVisibility(v string) *Comment

SetVisibility sets the Visibility field's value.

func (Comment) String added in v1.8.34 

func (s Comment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CommentMetadata added in v1.10.0 

type CommentMetadata struct {

	// The ID of the comment.
	CommentId *string `min:"1" type:"string"`

	// The status of the comment.
	CommentStatus *string `type:"string" enum:"CommentStatusType"`

	// The user who made the comment.
	Contributor *User `type:"structure"`

	// The ID of the user who made the comment.
	ContributorId *string `min:"1" type:"string"`

	// The timestamp that the comment was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The ID of the user being replied to.
	RecipientId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the metadata of a comment.

func (CommentMetadata) GoString added in v1.10.0 

func (s CommentMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CommentMetadata) SetCommentId added in v1.10.0 

func (s *CommentMetadata) SetCommentId(v string) *CommentMetadata

SetCommentId sets the CommentId field's value.

func (*CommentMetadata) SetCommentStatus added in v1.10.0 

func (s *CommentMetadata) SetCommentStatus(v string) *CommentMetadata

SetCommentStatus sets the CommentStatus field's value.

func (*CommentMetadata) SetContributor added in v1.10.0 

func (s *CommentMetadata) SetContributor(v *User) *CommentMetadata

SetContributor sets the Contributor field's value.

func (*CommentMetadata) SetContributorId added in v1.44.225 

func (s *CommentMetadata) SetContributorId(v string) *CommentMetadata

SetContributorId sets the ContributorId field's value.

func (*CommentMetadata) SetCreatedTimestamp added in v1.10.0 

func (s *CommentMetadata) SetCreatedTimestamp(v time.Time) *CommentMetadata

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*CommentMetadata) SetRecipientId added in v1.10.0 

func (s *CommentMetadata) SetRecipientId(v string) *CommentMetadata

SetRecipientId sets the RecipientId field's value.

func (CommentMetadata) String added in v1.10.0 

func (s CommentMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConcurrentModificationException added in v1.28.0 

type ConcurrentModificationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The resource hierarchy is changing.

func (*ConcurrentModificationException) Code added in v1.28.0 

func (s *ConcurrentModificationException) Code() string

Code returns the exception type name.

func (*ConcurrentModificationException) Error added in v1.28.0 

func (s *ConcurrentModificationException) Error() string

func (ConcurrentModificationException) GoString added in v1.28.0 

func (s ConcurrentModificationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConcurrentModificationException) Message added in v1.28.0 

func (s *ConcurrentModificationException) Message() string

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr added in v1.28.0 

func (s *ConcurrentModificationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID added in v1.28.0 

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode added in v1.28.0 

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String added in v1.28.0 

func (s ConcurrentModificationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictingOperationException added in v1.28.0 

type ConflictingOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ConflictingOperationException) Code added in v1.28.0 

func (s *ConflictingOperationException) Code() string

Code returns the exception type name.

func (*ConflictingOperationException) Error added in v1.28.0 

func (s *ConflictingOperationException) Error() string

func (ConflictingOperationException) GoString added in v1.28.0 

func (s ConflictingOperationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictingOperationException) Message added in v1.28.0 

func (s *ConflictingOperationException) Message() string

Message returns the exception's message.

func (*ConflictingOperationException) OrigErr added in v1.28.0 

func (s *ConflictingOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictingOperationException) RequestID added in v1.28.0 

func (s *ConflictingOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictingOperationException) StatusCode added in v1.28.0 

func (s *ConflictingOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictingOperationException) String added in v1.28.0 

func (s ConflictingOperationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateCommentInput added in v1.8.34 

type CreateCommentInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateCommentInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// Set this parameter to TRUE to send an email out to the document collaborators
	// after the comment is created.
	NotifyCollaborators *bool `type:"boolean"`

	// The ID of the parent comment.
	ParentId *string `min:"1" type:"string"`

	// The text of the comment.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateCommentInput's
	// String and GoString methods.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The ID of the root comment in the thread.
	ThreadId *string `min:"1" type:"string"`

	// The ID of the document version.
	//
	// VersionId is a required field
	VersionId *string `location:"uri" locationName:"VersionId" min:"1" type:"string" required:"true"`

	// 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 *string `type:"string" enum:"CommentVisibilityType"`
	// contains filtered or unexported fields
}

func (CreateCommentInput) GoString added in v1.8.34 

func (s CreateCommentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCommentInput) SetAuthenticationToken added in v1.8.34 

func (s *CreateCommentInput) SetAuthenticationToken(v string) *CreateCommentInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateCommentInput) SetDocumentId added in v1.8.34 

func (s *CreateCommentInput) SetDocumentId(v string) *CreateCommentInput

SetDocumentId sets the DocumentId field's value.

func (*CreateCommentInput) SetNotifyCollaborators added in v1.8.34 

func (s *CreateCommentInput) SetNotifyCollaborators(v bool) *CreateCommentInput

SetNotifyCollaborators sets the NotifyCollaborators field's value.

func (*CreateCommentInput) SetParentId added in v1.8.34 

func (s *CreateCommentInput) SetParentId(v string) *CreateCommentInput

SetParentId sets the ParentId field's value.

func (*CreateCommentInput) SetText added in v1.8.34 

func (s *CreateCommentInput) SetText(v string) *CreateCommentInput

SetText sets the Text field's value.

func (*CreateCommentInput) SetThreadId added in v1.8.34 

func (s *CreateCommentInput) SetThreadId(v string) *CreateCommentInput

SetThreadId sets the ThreadId field's value.

func (*CreateCommentInput) SetVersionId added in v1.8.34 

func (s *CreateCommentInput) SetVersionId(v string) *CreateCommentInput

SetVersionId sets the VersionId field's value.

func (*CreateCommentInput) SetVisibility added in v1.8.34 

func (s *CreateCommentInput) SetVisibility(v string) *CreateCommentInput

SetVisibility sets the Visibility field's value.

func (CreateCommentInput) String added in v1.8.34 

func (s CreateCommentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCommentInput) Validate added in v1.8.34 

func (s *CreateCommentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCommentOutput added in v1.8.34 

type CreateCommentOutput struct {

	// The comment that has been created.
	Comment *Comment `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateCommentOutput) GoString added in v1.8.34 

func (s CreateCommentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCommentOutput) SetComment added in v1.8.34 

func (s *CreateCommentOutput) SetComment(v *Comment) *CreateCommentOutput

SetComment sets the Comment field's value.

func (CreateCommentOutput) String added in v1.8.34 

func (s CreateCommentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateCustomMetadataInput added in v1.8.34 

type CreateCustomMetadataInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateCustomMetadataInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// Custom metadata in the form of name-value pairs.
	//
	// CustomMetadata is a required field
	CustomMetadata map[string]*string `min:"1" type:"map" required:"true"`

	// The ID of the resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" min:"1" type:"string" required:"true"`

	// The ID of the version, if the custom metadata is being added to a document
	// version.
	VersionId *string `location:"querystring" locationName:"versionid" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateCustomMetadataInput) GoString added in v1.8.34 

func (s CreateCustomMetadataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCustomMetadataInput) SetAuthenticationToken added in v1.8.34 

func (s *CreateCustomMetadataInput) SetAuthenticationToken(v string) *CreateCustomMetadataInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateCustomMetadataInput) SetCustomMetadata added in v1.8.34 

func (s *CreateCustomMetadataInput) SetCustomMetadata(v map[string]*string) *CreateCustomMetadataInput

SetCustomMetadata sets the CustomMetadata field's value.

func (*CreateCustomMetadataInput) SetResourceId added in v1.8.34 

func (s *CreateCustomMetadataInput) SetResourceId(v string) *CreateCustomMetadataInput

SetResourceId sets the ResourceId field's value.

func (*CreateCustomMetadataInput) SetVersionId added in v1.8.34 

func (s *CreateCustomMetadataInput) SetVersionId(v string) *CreateCustomMetadataInput

SetVersionId sets the VersionId field's value.

func (CreateCustomMetadataInput) String added in v1.8.34 

func (s CreateCustomMetadataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCustomMetadataInput) Validate added in v1.8.34 

func (s *CreateCustomMetadataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCustomMetadataOutput added in v1.8.34 

type CreateCustomMetadataOutput struct {
	// contains filtered or unexported fields
}

func (CreateCustomMetadataOutput) GoString added in v1.8.34 

func (s CreateCustomMetadataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateCustomMetadataOutput) String added in v1.8.34 

func (s CreateCustomMetadataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFolderInput 

type CreateFolderInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateFolderInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The name of the new folder.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateFolderInput's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The ID of the parent folder.
	//
	// ParentFolderId is a required field
	ParentFolderId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateFolderInput) GoString 

func (s CreateFolderInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFolderInput) SetAuthenticationToken added in v1.8.34 

func (s *CreateFolderInput) SetAuthenticationToken(v string) *CreateFolderInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateFolderInput) SetName 

func (s *CreateFolderInput) SetName(v string) *CreateFolderInput

SetName sets the Name field's value.

func (*CreateFolderInput) SetParentFolderId 

func (s *CreateFolderInput) SetParentFolderId(v string) *CreateFolderInput

SetParentFolderId sets the ParentFolderId field's value.

func (CreateFolderInput) String 

func (s CreateFolderInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFolderInput) Validate 

func (s *CreateFolderInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFolderOutput 

type CreateFolderOutput struct {

	// The metadata of the folder.
	Metadata *FolderMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateFolderOutput) GoString 

func (s CreateFolderOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFolderOutput) SetMetadata 

func (s *CreateFolderOutput) SetMetadata(v *FolderMetadata) *CreateFolderOutput

SetMetadata sets the Metadata field's value.

func (CreateFolderOutput) String 

func (s CreateFolderOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLabelsInput added in v1.8.34 

type CreateLabelsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateLabelsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// List of labels to add to the resource.
	//
	// Labels is a required field
	Labels []*string `type:"list" required:"true"`

	// The ID of the resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateLabelsInput) GoString added in v1.8.34 

func (s CreateLabelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLabelsInput) SetAuthenticationToken added in v1.8.34 

func (s *CreateLabelsInput) SetAuthenticationToken(v string) *CreateLabelsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateLabelsInput) SetLabels added in v1.8.34 

func (s *CreateLabelsInput) SetLabels(v []*string) *CreateLabelsInput

SetLabels sets the Labels field's value.

func (*CreateLabelsInput) SetResourceId added in v1.8.34 

func (s *CreateLabelsInput) SetResourceId(v string) *CreateLabelsInput

SetResourceId sets the ResourceId field's value.

func (CreateLabelsInput) String added in v1.8.34 

func (s CreateLabelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLabelsInput) Validate added in v1.8.34 

func (s *CreateLabelsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLabelsOutput added in v1.8.34 

type CreateLabelsOutput struct {
	// contains filtered or unexported fields
}

func (CreateLabelsOutput) GoString added in v1.8.34 

func (s CreateLabelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateLabelsOutput) String added in v1.8.34 

func (s CreateLabelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateNotificationSubscriptionInput 

type CreateNotificationSubscriptionInput struct {

	// The endpoint to receive the notifications. If the protocol is HTTPS, the
	// endpoint is a URL that begins with https.
	//
	// Endpoint is a required field
	Endpoint *string `min:"1" type:"string" required:"true"`

	// The ID of the organization.
	//
	// OrganizationId is a required field
	OrganizationId *string `location:"uri" locationName:"OrganizationId" min:"1" type:"string" required:"true"`

	// The protocol to use. The supported value is https, which delivers JSON-encoded
	// messages using HTTPS POST.
	//
	// Protocol is a required field
	Protocol *string `type:"string" required:"true" enum:"SubscriptionProtocolType"`

	// The notification type.
	//
	// SubscriptionType is a required field
	SubscriptionType *string `type:"string" required:"true" enum:"SubscriptionType"`
	// contains filtered or unexported fields
}

func (CreateNotificationSubscriptionInput) GoString 

func (s CreateNotificationSubscriptionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNotificationSubscriptionInput) SetEndpoint 

func (s *CreateNotificationSubscriptionInput) SetEndpoint(v string) *CreateNotificationSubscriptionInput

SetEndpoint sets the Endpoint field's value.

func (*CreateNotificationSubscriptionInput) SetOrganizationId 

func (s *CreateNotificationSubscriptionInput) SetOrganizationId(v string) *CreateNotificationSubscriptionInput

SetOrganizationId sets the OrganizationId field's value.

func (*CreateNotificationSubscriptionInput) SetProtocol 

func (s *CreateNotificationSubscriptionInput) SetProtocol(v string) *CreateNotificationSubscriptionInput

SetProtocol sets the Protocol field's value.

func (*CreateNotificationSubscriptionInput) SetSubscriptionType 

func (s *CreateNotificationSubscriptionInput) SetSubscriptionType(v string) *CreateNotificationSubscriptionInput

SetSubscriptionType sets the SubscriptionType field's value.

func (CreateNotificationSubscriptionInput) String 

func (s CreateNotificationSubscriptionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNotificationSubscriptionInput) Validate 

func (s *CreateNotificationSubscriptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateNotificationSubscriptionOutput 

type CreateNotificationSubscriptionOutput struct {

	// The subscription.
	Subscription *Subscription `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateNotificationSubscriptionOutput) GoString 

func (s CreateNotificationSubscriptionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNotificationSubscriptionOutput) SetSubscription 

func (s *CreateNotificationSubscriptionOutput) SetSubscription(v *Subscription) *CreateNotificationSubscriptionOutput

SetSubscription sets the Subscription field's value.

func (CreateNotificationSubscriptionOutput) String 

func (s CreateNotificationSubscriptionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateUserInput 

type CreateUserInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUserInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The email address of the user.
	//
	// EmailAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUserInput's
	// String and GoString methods.
	EmailAddress *string `min:"1" type:"string" sensitive:"true"`

	// The given name of the user.
	//
	// GivenName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUserInput's
	// String and GoString methods.
	//
	// GivenName is a required field
	GivenName *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The ID of the organization.
	OrganizationId *string `min:"1" type:"string"`

	// The password of the user.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUserInput's
	// String and GoString methods.
	//
	// Password is a required field
	Password *string `min:"4" type:"string" required:"true" sensitive:"true"`

	// The amount of storage for the user.
	StorageRule *StorageRuleType `type:"structure"`

	// The surname of the user.
	//
	// Surname is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUserInput's
	// String and GoString methods.
	//
	// Surname is a required field
	Surname *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The time zone ID of the user.
	TimeZoneId *string `min:"1" type:"string"`

	// The login name of the user.
	//
	// Username is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUserInput's
	// String and GoString methods.
	//
	// Username is a required field
	Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreateUserInput) GoString 

func (s CreateUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserInput) SetAuthenticationToken added in v1.8.34 

func (s *CreateUserInput) SetAuthenticationToken(v string) *CreateUserInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateUserInput) SetEmailAddress added in v1.8.34 

func (s *CreateUserInput) SetEmailAddress(v string) *CreateUserInput

SetEmailAddress sets the EmailAddress field's value.

func (*CreateUserInput) SetGivenName 

func (s *CreateUserInput) SetGivenName(v string) *CreateUserInput

SetGivenName sets the GivenName field's value.

func (*CreateUserInput) SetOrganizationId 

func (s *CreateUserInput) SetOrganizationId(v string) *CreateUserInput

SetOrganizationId sets the OrganizationId field's value.

func (*CreateUserInput) SetPassword 

func (s *CreateUserInput) SetPassword(v string) *CreateUserInput

SetPassword sets the Password field's value.

func (*CreateUserInput) SetStorageRule 

func (s *CreateUserInput) SetStorageRule(v *StorageRuleType) *CreateUserInput

SetStorageRule sets the StorageRule field's value.

func (*CreateUserInput) SetSurname 

func (s *CreateUserInput) SetSurname(v string) *CreateUserInput

SetSurname sets the Surname field's value.

func (*CreateUserInput) SetTimeZoneId 

func (s *CreateUserInput) SetTimeZoneId(v string) *CreateUserInput

SetTimeZoneId sets the TimeZoneId field's value.

func (*CreateUserInput) SetUsername 

func (s *CreateUserInput) SetUsername(v string) *CreateUserInput

SetUsername sets the Username field's value.

func (CreateUserInput) String 

func (s CreateUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserInput) Validate 

func (s *CreateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateUserOutput 

type CreateUserOutput struct {

	// The user information.
	User *User `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateUserOutput) GoString 

func (s CreateUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserOutput) SetUser 

func (s *CreateUserOutput) SetUser(v *User) *CreateUserOutput

SetUser sets the User field's value.

func (CreateUserOutput) String 

func (s CreateUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomMetadataLimitExceededException added in v1.28.0 

type CustomMetadataLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*CustomMetadataLimitExceededException) Code added in v1.28.0 

func (s *CustomMetadataLimitExceededException) Code() string

Code returns the exception type name.

func (*CustomMetadataLimitExceededException) Error added in v1.28.0 

func (s *CustomMetadataLimitExceededException) Error() string

func (CustomMetadataLimitExceededException) GoString added in v1.28.0 

func (s CustomMetadataLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomMetadataLimitExceededException) Message added in v1.28.0 

func (s *CustomMetadataLimitExceededException) Message() string

Message returns the exception's message.

func (*CustomMetadataLimitExceededException) OrigErr added in v1.28.0 

func (s *CustomMetadataLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CustomMetadataLimitExceededException) RequestID added in v1.28.0 

func (s *CustomMetadataLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CustomMetadataLimitExceededException) StatusCode added in v1.28.0 

func (s *CustomMetadataLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CustomMetadataLimitExceededException) String added in v1.28.0 

func (s CustomMetadataLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DateRangeType added in v1.44.225 

type DateRangeType struct {

	// Timestamp range end value (in epochs).
	EndValue *time.Time `type:"timestamp"`

	// Timestamp range start value (in epochs)
	StartValue *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Filters results based on timestamp range (in epochs).

func (DateRangeType) GoString added in v1.44.225 

func (s DateRangeType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DateRangeType) SetEndValue added in v1.44.225 

func (s *DateRangeType) SetEndValue(v time.Time) *DateRangeType

SetEndValue sets the EndValue field's value.

func (*DateRangeType) SetStartValue added in v1.44.225 

func (s *DateRangeType) SetStartValue(v time.Time) *DateRangeType

SetStartValue sets the StartValue field's value.

func (DateRangeType) String added in v1.44.225 

func (s DateRangeType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeactivateUserInput 

type DeactivateUserInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeactivateUserInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the user.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeactivateUserInput) GoString 

func (s DeactivateUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeactivateUserInput) SetAuthenticationToken added in v1.8.34 

func (s *DeactivateUserInput) SetAuthenticationToken(v string) *DeactivateUserInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeactivateUserInput) SetUserId 

func (s *DeactivateUserInput) SetUserId(v string) *DeactivateUserInput

SetUserId sets the UserId field's value.

func (DeactivateUserInput) String 

func (s DeactivateUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeactivateUserInput) Validate 

func (s *DeactivateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeactivateUserOutput 

type DeactivateUserOutput struct {
	// contains filtered or unexported fields
}

func (DeactivateUserOutput) GoString 

func (s DeactivateUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeactivateUserOutput) String 

func (s DeactivateUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeactivatingLastSystemUserException added in v1.28.0 

type DeactivatingLastSystemUserException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The last user in the organization is being deactivated.

func (*DeactivatingLastSystemUserException) Code added in v1.28.0 

func (s *DeactivatingLastSystemUserException) Code() string

Code returns the exception type name.

func (*DeactivatingLastSystemUserException) Error added in v1.28.0 

func (s *DeactivatingLastSystemUserException) Error() string

func (DeactivatingLastSystemUserException) GoString added in v1.28.0 

func (s DeactivatingLastSystemUserException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeactivatingLastSystemUserException) Message added in v1.28.0 

func (s *DeactivatingLastSystemUserException) Message() string

Message returns the exception's message.

func (*DeactivatingLastSystemUserException) OrigErr added in v1.28.0 

func (s *DeactivatingLastSystemUserException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DeactivatingLastSystemUserException) RequestID added in v1.28.0 

func (s *DeactivatingLastSystemUserException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DeactivatingLastSystemUserException) StatusCode added in v1.28.0 

func (s *DeactivatingLastSystemUserException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DeactivatingLastSystemUserException) String added in v1.28.0 

func (s DeactivatingLastSystemUserException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteCommentInput added in v1.8.34 

type DeleteCommentInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeleteCommentInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the comment.
	//
	// CommentId is a required field
	CommentId *string `location:"uri" locationName:"CommentId" min:"1" type:"string" required:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// The ID of the document version.
	//
	// VersionId is a required field
	VersionId *string `location:"uri" locationName:"VersionId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCommentInput) GoString added in v1.8.34 

func (s DeleteCommentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCommentInput) SetAuthenticationToken added in v1.8.34 

func (s *DeleteCommentInput) SetAuthenticationToken(v string) *DeleteCommentInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteCommentInput) SetCommentId added in v1.8.34 

func (s *DeleteCommentInput) SetCommentId(v string) *DeleteCommentInput

SetCommentId sets the CommentId field's value.

func (*DeleteCommentInput) SetDocumentId added in v1.8.34 

func (s *DeleteCommentInput) SetDocumentId(v string) *DeleteCommentInput

SetDocumentId sets the DocumentId field's value.

func (*DeleteCommentInput) SetVersionId added in v1.8.34 

func (s *DeleteCommentInput) SetVersionId(v string) *DeleteCommentInput

SetVersionId sets the VersionId field's value.

func (DeleteCommentInput) String added in v1.8.34 

func (s DeleteCommentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCommentInput) Validate added in v1.8.34 

func (s *DeleteCommentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCommentOutput added in v1.8.34 

type DeleteCommentOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCommentOutput) GoString added in v1.8.34 

func (s DeleteCommentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCommentOutput) String added in v1.8.34 

func (s DeleteCommentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteCustomMetadataInput added in v1.8.34 

type DeleteCustomMetadataInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeleteCustomMetadataInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// Flag to indicate removal of all custom metadata properties from the specified
	// resource.
	DeleteAll *bool `location:"querystring" locationName:"deleteAll" type:"boolean"`

	// List of properties to remove.
	Keys []*string `location:"querystring" locationName:"keys" type:"list"`

	// The ID of the resource, either a document or folder.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" min:"1" type:"string" required:"true"`

	// The ID of the version, if the custom metadata is being deleted from a document
	// version.
	VersionId *string `location:"querystring" locationName:"versionId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteCustomMetadataInput) GoString added in v1.8.34 

func (s DeleteCustomMetadataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCustomMetadataInput) SetAuthenticationToken added in v1.8.34 

func (s *DeleteCustomMetadataInput) SetAuthenticationToken(v string) *DeleteCustomMetadataInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteCustomMetadataInput) SetDeleteAll added in v1.8.34 

func (s *DeleteCustomMetadataInput) SetDeleteAll(v bool) *DeleteCustomMetadataInput

SetDeleteAll sets the DeleteAll field's value.

func (*DeleteCustomMetadataInput) SetKeys added in v1.8.34 

func (s *DeleteCustomMetadataInput) SetKeys(v []*string) *DeleteCustomMetadataInput

SetKeys sets the Keys field's value.

func (*DeleteCustomMetadataInput) SetResourceId added in v1.8.34 

func (s *DeleteCustomMetadataInput) SetResourceId(v string) *DeleteCustomMetadataInput

SetResourceId sets the ResourceId field's value.

func (*DeleteCustomMetadataInput) SetVersionId added in v1.8.34 

func (s *DeleteCustomMetadataInput) SetVersionId(v string) *DeleteCustomMetadataInput

SetVersionId sets the VersionId field's value.

func (DeleteCustomMetadataInput) String added in v1.8.34 

func (s DeleteCustomMetadataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCustomMetadataInput) Validate added in v1.8.34 

func (s *DeleteCustomMetadataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCustomMetadataOutput added in v1.8.34 

type DeleteCustomMetadataOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCustomMetadataOutput) GoString added in v1.8.34 

func (s DeleteCustomMetadataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCustomMetadataOutput) String added in v1.8.34 

func (s DeleteCustomMetadataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDocumentInput 

type DeleteDocumentInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeleteDocumentInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDocumentInput) GoString 

func (s DeleteDocumentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDocumentInput) SetAuthenticationToken added in v1.8.34 

func (s *DeleteDocumentInput) SetAuthenticationToken(v string) *DeleteDocumentInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteDocumentInput) SetDocumentId 

func (s *DeleteDocumentInput) SetDocumentId(v string) *DeleteDocumentInput

SetDocumentId sets the DocumentId field's value.

func (DeleteDocumentInput) String 

func (s DeleteDocumentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDocumentInput) Validate 

func (s *DeleteDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDocumentOutput 

type DeleteDocumentOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDocumentOutput) GoString 

func (s DeleteDocumentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDocumentOutput) String 

func (s DeleteDocumentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDocumentVersionInput added in v1.44.137 

type DeleteDocumentVersionInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeleteDocumentVersionInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// Deletes all versions of a document prior to the current version.
	//
	// DeletePriorVersions is a required field
	DeletePriorVersions *bool `location:"querystring" locationName:"deletePriorVersions" type:"boolean" required:"true"`

	// The ID of the document associated with the version being deleted.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// The ID of the version being deleted.
	//
	// VersionId is a required field
	VersionId *string `location:"uri" locationName:"VersionId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDocumentVersionInput) GoString added in v1.44.137 

func (s DeleteDocumentVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDocumentVersionInput) SetAuthenticationToken added in v1.44.137 

func (s *DeleteDocumentVersionInput) SetAuthenticationToken(v string) *DeleteDocumentVersionInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteDocumentVersionInput) SetDeletePriorVersions added in v1.44.137 

func (s *DeleteDocumentVersionInput) SetDeletePriorVersions(v bool) *DeleteDocumentVersionInput

SetDeletePriorVersions sets the DeletePriorVersions field's value.

func (*DeleteDocumentVersionInput) SetDocumentId added in v1.44.137 

func (s *DeleteDocumentVersionInput) SetDocumentId(v string) *DeleteDocumentVersionInput

SetDocumentId sets the DocumentId field's value.

func (*DeleteDocumentVersionInput) SetVersionId added in v1.44.137 

func (s *DeleteDocumentVersionInput) SetVersionId(v string) *DeleteDocumentVersionInput

SetVersionId sets the VersionId field's value.

func (DeleteDocumentVersionInput) String added in v1.44.137 

func (s DeleteDocumentVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDocumentVersionInput) Validate added in v1.44.137 

func (s *DeleteDocumentVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDocumentVersionOutput added in v1.44.137 

type DeleteDocumentVersionOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDocumentVersionOutput) GoString added in v1.44.137 

func (s DeleteDocumentVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDocumentVersionOutput) String added in v1.44.137 

func (s DeleteDocumentVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFolderContentsInput 

type DeleteFolderContentsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeleteFolderContentsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the folder.
	//
	// FolderId is a required field
	FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFolderContentsInput) GoString 

func (s DeleteFolderContentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFolderContentsInput) SetAuthenticationToken added in v1.8.34 

func (s *DeleteFolderContentsInput) SetAuthenticationToken(v string) *DeleteFolderContentsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteFolderContentsInput) SetFolderId 

func (s *DeleteFolderContentsInput) SetFolderId(v string) *DeleteFolderContentsInput

SetFolderId sets the FolderId field's value.

func (DeleteFolderContentsInput) String 

func (s DeleteFolderContentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFolderContentsInput) Validate 

func (s *DeleteFolderContentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFolderContentsOutput 

type DeleteFolderContentsOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFolderContentsOutput) GoString 

func (s DeleteFolderContentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFolderContentsOutput) String 

func (s DeleteFolderContentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFolderInput 

type DeleteFolderInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeleteFolderInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the folder.
	//
	// FolderId is a required field
	FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFolderInput) GoString 

func (s DeleteFolderInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFolderInput) SetAuthenticationToken added in v1.8.34 

func (s *DeleteFolderInput) SetAuthenticationToken(v string) *DeleteFolderInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteFolderInput) SetFolderId 

func (s *DeleteFolderInput) SetFolderId(v string) *DeleteFolderInput

SetFolderId sets the FolderId field's value.

func (DeleteFolderInput) String 

func (s DeleteFolderInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFolderInput) Validate 

func (s *DeleteFolderInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFolderOutput 

type DeleteFolderOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFolderOutput) GoString 

func (s DeleteFolderOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFolderOutput) String 

func (s DeleteFolderOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLabelsInput added in v1.8.34 

type DeleteLabelsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeleteLabelsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// Flag to request removal of all labels from the specified resource.
	DeleteAll *bool `location:"querystring" locationName:"deleteAll" type:"boolean"`

	// List of labels to delete from the resource.
	Labels []*string `location:"querystring" locationName:"labels" type:"list"`

	// The ID of the resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLabelsInput) GoString added in v1.8.34 

func (s DeleteLabelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLabelsInput) SetAuthenticationToken added in v1.8.34 

func (s *DeleteLabelsInput) SetAuthenticationToken(v string) *DeleteLabelsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteLabelsInput) SetDeleteAll added in v1.8.34 

func (s *DeleteLabelsInput) SetDeleteAll(v bool) *DeleteLabelsInput

SetDeleteAll sets the DeleteAll field's value.

func (*DeleteLabelsInput) SetLabels added in v1.8.34 

func (s *DeleteLabelsInput) SetLabels(v []*string) *DeleteLabelsInput

SetLabels sets the Labels field's value.

func (*DeleteLabelsInput) SetResourceId added in v1.8.34 

func (s *DeleteLabelsInput) SetResourceId(v string) *DeleteLabelsInput

SetResourceId sets the ResourceId field's value.

func (DeleteLabelsInput) String added in v1.8.34 

func (s DeleteLabelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLabelsInput) Validate added in v1.8.34 

func (s *DeleteLabelsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLabelsOutput added in v1.8.34 

type DeleteLabelsOutput struct {
	// contains filtered or unexported fields
}

func (DeleteLabelsOutput) GoString added in v1.8.34 

func (s DeleteLabelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLabelsOutput) String added in v1.8.34 

func (s DeleteLabelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteNotificationSubscriptionInput 

type DeleteNotificationSubscriptionInput struct {

	// The ID of the organization.
	//
	// OrganizationId is a required field
	OrganizationId *string `location:"uri" locationName:"OrganizationId" min:"1" type:"string" required:"true"`

	// The ID of the subscription.
	//
	// SubscriptionId is a required field
	SubscriptionId *string `location:"uri" locationName:"SubscriptionId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteNotificationSubscriptionInput) GoString 

func (s DeleteNotificationSubscriptionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteNotificationSubscriptionInput) SetOrganizationId 

func (s *DeleteNotificationSubscriptionInput) SetOrganizationId(v string) *DeleteNotificationSubscriptionInput

SetOrganizationId sets the OrganizationId field's value.

func (*DeleteNotificationSubscriptionInput) SetSubscriptionId 

func (s *DeleteNotificationSubscriptionInput) SetSubscriptionId(v string) *DeleteNotificationSubscriptionInput

SetSubscriptionId sets the SubscriptionId field's value.

func (DeleteNotificationSubscriptionInput) String 

func (s DeleteNotificationSubscriptionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteNotificationSubscriptionInput) Validate 

func (s *DeleteNotificationSubscriptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteNotificationSubscriptionOutput 

type DeleteNotificationSubscriptionOutput struct {
	// contains filtered or unexported fields
}

func (DeleteNotificationSubscriptionOutput) GoString 

func (s DeleteNotificationSubscriptionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteNotificationSubscriptionOutput) String 

func (s DeleteNotificationSubscriptionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteUserInput 

type DeleteUserInput struct {

	// Amazon WorkDocs authentication token. Do not set this field when using administrative
	// API actions, as in accessing the API using Amazon Web Services credentials.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeleteUserInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the user.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserInput) GoString 

func (s DeleteUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserInput) SetAuthenticationToken added in v1.8.34 

func (s *DeleteUserInput) SetAuthenticationToken(v string) *DeleteUserInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteUserInput) SetUserId 

func (s *DeleteUserInput) SetUserId(v string) *DeleteUserInput

SetUserId sets the UserId field's value.

func (DeleteUserInput) String 

func (s DeleteUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserInput) Validate 

func (s *DeleteUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteUserOutput 

type DeleteUserOutput struct {
	// contains filtered or unexported fields
}

func (DeleteUserOutput) GoString 

func (s DeleteUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteUserOutput) String 

func (s DeleteUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeActivitiesInput added in v1.10.0 

type DescribeActivitiesInput struct {

	// Specifies which activity types to include in the response. If this field
	// is left empty, all activity types are returned.
	ActivityTypes *string `location:"querystring" locationName:"activityTypes" min:"1" type:"string"`

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeActivitiesInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The timestamp that determines the end time of the activities. The response
	// includes the activities performed before the specified timestamp.
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp"`

	// Includes indirect activities. 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).
	IncludeIndirectActivities *bool `location:"querystring" locationName:"includeIndirectActivities" type:"boolean"`

	// The maximum number of items to return.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The marker for the next set of results.
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`

	// The ID of the organization. This is a mandatory parameter when using administrative
	// API (SigV4) requests.
	OrganizationId *string `location:"querystring" locationName:"organizationId" min:"1" type:"string"`

	// The document or folder ID for which to describe activity types.
	ResourceId *string `location:"querystring" locationName:"resourceId" min:"1" type:"string"`

	// The timestamp that determines the starting time of the activities. The response
	// includes the activities performed after the specified timestamp.
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp"`

	// The ID of the user who performed the action. The response includes activities
	// pertaining to this user. This is an optional parameter and is only applicable
	// for administrative API (SigV4) requests.
	UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeActivitiesInput) GoString added in v1.10.0 

func (s DescribeActivitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeActivitiesInput) SetActivityTypes added in v1.15.79 

func (s *DescribeActivitiesInput) SetActivityTypes(v string) *DescribeActivitiesInput

SetActivityTypes sets the ActivityTypes field's value.

func (*DescribeActivitiesInput) SetAuthenticationToken added in v1.10.0 

func (s *DescribeActivitiesInput) SetAuthenticationToken(v string) *DescribeActivitiesInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeActivitiesInput) SetEndTime added in v1.10.0 

func (s *DescribeActivitiesInput) SetEndTime(v time.Time) *DescribeActivitiesInput

SetEndTime sets the EndTime field's value.

func (*DescribeActivitiesInput) SetIncludeIndirectActivities added in v1.15.79 

func (s *DescribeActivitiesInput) SetIncludeIndirectActivities(v bool) *DescribeActivitiesInput

SetIncludeIndirectActivities sets the IncludeIndirectActivities field's value.

func (*DescribeActivitiesInput) SetLimit added in v1.10.0 

func (s *DescribeActivitiesInput) SetLimit(v int64) *DescribeActivitiesInput

SetLimit sets the Limit field's value.

func (*DescribeActivitiesInput) SetMarker added in v1.10.0 

func (s *DescribeActivitiesInput) SetMarker(v string) *DescribeActivitiesInput

SetMarker sets the Marker field's value.

func (*DescribeActivitiesInput) SetOrganizationId added in v1.10.0 

func (s *DescribeActivitiesInput) SetOrganizationId(v string) *DescribeActivitiesInput

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeActivitiesInput) SetResourceId added in v1.15.79 

func (s *DescribeActivitiesInput) SetResourceId(v string) *DescribeActivitiesInput

SetResourceId sets the ResourceId field's value.

func (*DescribeActivitiesInput) SetStartTime added in v1.10.0 

func (s *DescribeActivitiesInput) SetStartTime(v time.Time) *DescribeActivitiesInput

SetStartTime sets the StartTime field's value.

func (*DescribeActivitiesInput) SetUserId added in v1.10.0 

func (s *DescribeActivitiesInput) SetUserId(v string) *DescribeActivitiesInput

SetUserId sets the UserId field's value.

func (DescribeActivitiesInput) String added in v1.10.0 

func (s DescribeActivitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeActivitiesInput) Validate added in v1.10.0 

func (s *DescribeActivitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeActivitiesOutput added in v1.10.0 

type DescribeActivitiesOutput struct {

	// The marker for the next set of results.
	Marker *string `min:"1" type:"string"`

	// The list of activities for the specified user and time period.
	UserActivities []*Activity `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeActivitiesOutput) GoString added in v1.10.0 

func (s DescribeActivitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeActivitiesOutput) SetMarker added in v1.10.0 

func (s *DescribeActivitiesOutput) SetMarker(v string) *DescribeActivitiesOutput

SetMarker sets the Marker field's value.

func (*DescribeActivitiesOutput) SetUserActivities added in v1.10.0 

func (s *DescribeActivitiesOutput) SetUserActivities(v []*Activity) *DescribeActivitiesOutput

SetUserActivities sets the UserActivities field's value.

func (DescribeActivitiesOutput) String added in v1.10.0 

func (s DescribeActivitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeCommentsInput added in v1.8.34 

type DescribeCommentsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeCommentsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// The maximum number of items to return.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The marker for the next set of results. This marker was received from a previous
	// call.
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`

	// The ID of the document version.
	//
	// VersionId is a required field
	VersionId *string `location:"uri" locationName:"VersionId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeCommentsInput) GoString added in v1.8.34 

func (s DescribeCommentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCommentsInput) SetAuthenticationToken added in v1.8.34 

func (s *DescribeCommentsInput) SetAuthenticationToken(v string) *DescribeCommentsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeCommentsInput) SetDocumentId added in v1.8.34 

func (s *DescribeCommentsInput) SetDocumentId(v string) *DescribeCommentsInput

SetDocumentId sets the DocumentId field's value.

func (*DescribeCommentsInput) SetLimit added in v1.8.34 

func (s *DescribeCommentsInput) SetLimit(v int64) *DescribeCommentsInput

SetLimit sets the Limit field's value.

func (*DescribeCommentsInput) SetMarker added in v1.8.34 

func (s *DescribeCommentsInput) SetMarker(v string) *DescribeCommentsInput

SetMarker sets the Marker field's value.

func (*DescribeCommentsInput) SetVersionId added in v1.8.34 

func (s *DescribeCommentsInput) SetVersionId(v string) *DescribeCommentsInput

SetVersionId sets the VersionId field's value.

func (DescribeCommentsInput) String added in v1.8.34 

func (s DescribeCommentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCommentsInput) Validate added in v1.8.34 

func (s *DescribeCommentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeCommentsOutput added in v1.8.34 

type DescribeCommentsOutput struct {

	// The list of comments for the specified document version.
	Comments []*Comment `type:"list"`

	// The marker for the next set of results. This marker was received from a previous
	// call.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeCommentsOutput) GoString added in v1.8.34 

func (s DescribeCommentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCommentsOutput) SetComments added in v1.8.34 

func (s *DescribeCommentsOutput) SetComments(v []*Comment) *DescribeCommentsOutput

SetComments sets the Comments field's value.

func (*DescribeCommentsOutput) SetMarker added in v1.8.34 

func (s *DescribeCommentsOutput) SetMarker(v string) *DescribeCommentsOutput

SetMarker sets the Marker field's value.

func (DescribeCommentsOutput) String added in v1.8.34 

func (s DescribeCommentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDocumentVersionsInput 

type DescribeDocumentVersionsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeDocumentVersionsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// Specify "SOURCE" to include initialized versions and a URL for the source
	// document.
	Fields *string `location:"querystring" locationName:"fields" min:"1" type:"string"`

	// A comma-separated list of values. Specify "INITIALIZED" to include incomplete
	// versions.
	Include *string `location:"querystring" locationName:"include" min:"1" type:"string"`

	// The maximum number of versions to return with this call.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDocumentVersionsInput) GoString 

func (s DescribeDocumentVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDocumentVersionsInput) SetAuthenticationToken added in v1.8.34 

func (s *DescribeDocumentVersionsInput) SetAuthenticationToken(v string) *DescribeDocumentVersionsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeDocumentVersionsInput) SetDocumentId 

func (s *DescribeDocumentVersionsInput) SetDocumentId(v string) *DescribeDocumentVersionsInput

SetDocumentId sets the DocumentId field's value.

func (*DescribeDocumentVersionsInput) SetFields 

func (s *DescribeDocumentVersionsInput) SetFields(v string) *DescribeDocumentVersionsInput

SetFields sets the Fields field's value.

func (*DescribeDocumentVersionsInput) SetInclude 

func (s *DescribeDocumentVersionsInput) SetInclude(v string) *DescribeDocumentVersionsInput

SetInclude sets the Include field's value.

func (*DescribeDocumentVersionsInput) SetLimit 

func (s *DescribeDocumentVersionsInput) SetLimit(v int64) *DescribeDocumentVersionsInput

SetLimit sets the Limit field's value.

func (*DescribeDocumentVersionsInput) SetMarker 

func (s *DescribeDocumentVersionsInput) SetMarker(v string) *DescribeDocumentVersionsInput

SetMarker sets the Marker field's value.

func (DescribeDocumentVersionsInput) String 

func (s DescribeDocumentVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDocumentVersionsInput) Validate 

func (s *DescribeDocumentVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDocumentVersionsOutput 

type DescribeDocumentVersionsOutput struct {

	// The document versions.
	DocumentVersions []*DocumentVersionMetadata `type:"list"`

	// The marker to use when requesting the next set of results. If there are no
	// additional results, the string is empty.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDocumentVersionsOutput) GoString 

func (s DescribeDocumentVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDocumentVersionsOutput) SetDocumentVersions 

func (s *DescribeDocumentVersionsOutput) SetDocumentVersions(v []*DocumentVersionMetadata) *DescribeDocumentVersionsOutput

SetDocumentVersions sets the DocumentVersions field's value.

func (*DescribeDocumentVersionsOutput) SetMarker 

func (s *DescribeDocumentVersionsOutput) SetMarker(v string) *DescribeDocumentVersionsOutput

SetMarker sets the Marker field's value.

func (DescribeDocumentVersionsOutput) String 

func (s DescribeDocumentVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFolderContentsInput 

type DescribeFolderContentsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeFolderContentsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the folder.
	//
	// FolderId is a required field
	FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"`

	// The contents to include. Specify "INITIALIZED" to include initialized documents.
	Include *string `location:"querystring" locationName:"include" min:"1" type:"string"`

	// The maximum number of items to return with this call.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The marker for the next set of results. This marker was received from a previous
	// call.
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`

	// The order for the contents of the folder.
	Order *string `location:"querystring" locationName:"order" type:"string" enum:"OrderType"`

	// The sorting criteria.
	Sort *string `location:"querystring" locationName:"sort" type:"string" enum:"ResourceSortType"`

	// The type of items.
	Type *string `location:"querystring" locationName:"type" type:"string" enum:"FolderContentType"`
	// contains filtered or unexported fields
}

func (DescribeFolderContentsInput) GoString 

func (s DescribeFolderContentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFolderContentsInput) SetAuthenticationToken added in v1.8.34 

func (s *DescribeFolderContentsInput) SetAuthenticationToken(v string) *DescribeFolderContentsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeFolderContentsInput) SetFolderId 

func (s *DescribeFolderContentsInput) SetFolderId(v string) *DescribeFolderContentsInput

SetFolderId sets the FolderId field's value.

func (*DescribeFolderContentsInput) SetInclude 

func (s *DescribeFolderContentsInput) SetInclude(v string) *DescribeFolderContentsInput

SetInclude sets the Include field's value.

func (*DescribeFolderContentsInput) SetLimit 

func (s *DescribeFolderContentsInput) SetLimit(v int64) *DescribeFolderContentsInput

SetLimit sets the Limit field's value.

func (*DescribeFolderContentsInput) SetMarker 

func (s *DescribeFolderContentsInput) SetMarker(v string) *DescribeFolderContentsInput

SetMarker sets the Marker field's value.

func (*DescribeFolderContentsInput) SetOrder 

func (s *DescribeFolderContentsInput) SetOrder(v string) *DescribeFolderContentsInput

SetOrder sets the Order field's value.

func (*DescribeFolderContentsInput) SetSort 

func (s *DescribeFolderContentsInput) SetSort(v string) *DescribeFolderContentsInput

SetSort sets the Sort field's value.

func (*DescribeFolderContentsInput) SetType 

func (s *DescribeFolderContentsInput) SetType(v string) *DescribeFolderContentsInput

SetType sets the Type field's value.

func (DescribeFolderContentsInput) String 

func (s DescribeFolderContentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFolderContentsInput) Validate 

func (s *DescribeFolderContentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFolderContentsOutput 

type DescribeFolderContentsOutput struct {

	// The documents in the specified folder.
	Documents []*DocumentMetadata `type:"list"`

	// The subfolders in the specified folder.
	Folders []*FolderMetadata `type:"list"`

	// The marker to use when requesting the next set of results. If there are no
	// additional results, the string is empty.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFolderContentsOutput) GoString 

func (s DescribeFolderContentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFolderContentsOutput) SetDocuments 

func (s *DescribeFolderContentsOutput) SetDocuments(v []*DocumentMetadata) *DescribeFolderContentsOutput

SetDocuments sets the Documents field's value.

func (*DescribeFolderContentsOutput) SetFolders 

func (s *DescribeFolderContentsOutput) SetFolders(v []*FolderMetadata) *DescribeFolderContentsOutput

SetFolders sets the Folders field's value.

func (*DescribeFolderContentsOutput) SetMarker 

func (s *DescribeFolderContentsOutput) SetMarker(v string) *DescribeFolderContentsOutput

SetMarker sets the Marker field's value.

func (DescribeFolderContentsOutput) String 

func (s DescribeFolderContentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGroupsInput added in v1.12.31 

type DescribeGroupsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeGroupsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The maximum number of items to return with this call.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`

	// The ID of the organization.
	OrganizationId *string `location:"querystring" locationName:"organizationId" min:"1" type:"string"`

	// A query to describe groups by group name.
	//
	// SearchQuery is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeGroupsInput's
	// String and GoString methods.
	//
	// SearchQuery is a required field
	SearchQuery *string `location:"querystring" locationName:"searchQuery" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (DescribeGroupsInput) GoString added in v1.12.31 

func (s DescribeGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGroupsInput) SetAuthenticationToken added in v1.12.31 

func (s *DescribeGroupsInput) SetAuthenticationToken(v string) *DescribeGroupsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeGroupsInput) SetLimit added in v1.12.31 

func (s *DescribeGroupsInput) SetLimit(v int64) *DescribeGroupsInput

SetLimit sets the Limit field's value.

func (*DescribeGroupsInput) SetMarker added in v1.12.31 

func (s *DescribeGroupsInput) SetMarker(v string) *DescribeGroupsInput

SetMarker sets the Marker field's value.

func (*DescribeGroupsInput) SetOrganizationId added in v1.12.31 

func (s *DescribeGroupsInput) SetOrganizationId(v string) *DescribeGroupsInput

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeGroupsInput) SetSearchQuery added in v1.12.31 

func (s *DescribeGroupsInput) SetSearchQuery(v string) *DescribeGroupsInput

SetSearchQuery sets the SearchQuery field's value.

func (DescribeGroupsInput) String added in v1.12.31 

func (s DescribeGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGroupsInput) Validate added in v1.12.31 

func (s *DescribeGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeGroupsOutput added in v1.12.31 

type DescribeGroupsOutput struct {

	// The list of groups.
	Groups []*GroupMetadata `type:"list"`

	// The marker to use when requesting the next set of results. If there are no
	// additional results, the string is empty.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeGroupsOutput) GoString added in v1.12.31 

func (s DescribeGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGroupsOutput) SetGroups added in v1.12.31 

func (s *DescribeGroupsOutput) SetGroups(v []*GroupMetadata) *DescribeGroupsOutput

SetGroups sets the Groups field's value.

func (*DescribeGroupsOutput) SetMarker added in v1.12.31 

func (s *DescribeGroupsOutput) SetMarker(v string) *DescribeGroupsOutput

SetMarker sets the Marker field's value.

func (DescribeGroupsOutput) String added in v1.12.31 

func (s DescribeGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeNotificationSubscriptionsInput 

type DescribeNotificationSubscriptionsInput struct {

	// The maximum number of items to return with this call.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`

	// The ID of the organization.
	//
	// OrganizationId is a required field
	OrganizationId *string `location:"uri" locationName:"OrganizationId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeNotificationSubscriptionsInput) GoString 

func (s DescribeNotificationSubscriptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationSubscriptionsInput) SetLimit 

func (s *DescribeNotificationSubscriptionsInput) SetLimit(v int64) *DescribeNotificationSubscriptionsInput

SetLimit sets the Limit field's value.

func (*DescribeNotificationSubscriptionsInput) SetMarker 

func (s *DescribeNotificationSubscriptionsInput) SetMarker(v string) *DescribeNotificationSubscriptionsInput

SetMarker sets the Marker field's value.

func (*DescribeNotificationSubscriptionsInput) SetOrganizationId 

func (s *DescribeNotificationSubscriptionsInput) SetOrganizationId(v string) *DescribeNotificationSubscriptionsInput

SetOrganizationId sets the OrganizationId field's value.

func (DescribeNotificationSubscriptionsInput) String 

func (s DescribeNotificationSubscriptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationSubscriptionsInput) Validate 

func (s *DescribeNotificationSubscriptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeNotificationSubscriptionsOutput 

type DescribeNotificationSubscriptionsOutput struct {

	// The marker to use when requesting the next set of results. If there are no
	// additional results, the string is empty.
	Marker *string `min:"1" type:"string"`

	// The subscriptions.
	Subscriptions []*Subscription `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeNotificationSubscriptionsOutput) GoString 

func (s DescribeNotificationSubscriptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationSubscriptionsOutput) SetMarker 

func (s *DescribeNotificationSubscriptionsOutput) SetMarker(v string) *DescribeNotificationSubscriptionsOutput

SetMarker sets the Marker field's value.

func (*DescribeNotificationSubscriptionsOutput) SetSubscriptions 

func (s *DescribeNotificationSubscriptionsOutput) SetSubscriptions(v []*Subscription) *DescribeNotificationSubscriptionsOutput

SetSubscriptions sets the Subscriptions field's value.

func (DescribeNotificationSubscriptionsOutput) String 

func (s DescribeNotificationSubscriptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeResourcePermissionsInput 

type DescribeResourcePermissionsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeResourcePermissionsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The maximum number of items to return with this call.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The marker for the next set of results. (You received this marker from a
	// previous call)
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`

	// The ID of the principal to filter permissions by.
	PrincipalId *string `location:"querystring" locationName:"principalId" min:"1" type:"string"`

	// The ID of the resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeResourcePermissionsInput) GoString 

func (s DescribeResourcePermissionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePermissionsInput) SetAuthenticationToken added in v1.8.34 

func (s *DescribeResourcePermissionsInput) SetAuthenticationToken(v string) *DescribeResourcePermissionsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeResourcePermissionsInput) SetLimit 

func (s *DescribeResourcePermissionsInput) SetLimit(v int64) *DescribeResourcePermissionsInput

SetLimit sets the Limit field's value.

func (*DescribeResourcePermissionsInput) SetMarker 

func (s *DescribeResourcePermissionsInput) SetMarker(v string) *DescribeResourcePermissionsInput

SetMarker sets the Marker field's value.

func (*DescribeResourcePermissionsInput) SetPrincipalId added in v1.12.31 

func (s *DescribeResourcePermissionsInput) SetPrincipalId(v string) *DescribeResourcePermissionsInput

SetPrincipalId sets the PrincipalId field's value.

func (*DescribeResourcePermissionsInput) SetResourceId 

func (s *DescribeResourcePermissionsInput) SetResourceId(v string) *DescribeResourcePermissionsInput

SetResourceId sets the ResourceId field's value.

func (DescribeResourcePermissionsInput) String 

func (s DescribeResourcePermissionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePermissionsInput) Validate 

func (s *DescribeResourcePermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeResourcePermissionsOutput 

type DescribeResourcePermissionsOutput struct {

	// The marker to use when requesting the next set of results. If there are no
	// additional results, the string is empty.
	Marker *string `min:"1" type:"string"`

	// The principals.
	Principals []*Principal `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeResourcePermissionsOutput) GoString 

func (s DescribeResourcePermissionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePermissionsOutput) SetMarker 

func (s *DescribeResourcePermissionsOutput) SetMarker(v string) *DescribeResourcePermissionsOutput

SetMarker sets the Marker field's value.

func (*DescribeResourcePermissionsOutput) SetPrincipals 

func (s *DescribeResourcePermissionsOutput) SetPrincipals(v []*Principal) *DescribeResourcePermissionsOutput

SetPrincipals sets the Principals field's value.

func (DescribeResourcePermissionsOutput) String 

func (s DescribeResourcePermissionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeRootFoldersInput added in v1.10.0 

type DescribeRootFoldersInput struct {

	// Amazon WorkDocs authentication token.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeRootFoldersInput's
	// String and GoString methods.
	//
	// AuthenticationToken is a required field
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" required:"true" sensitive:"true"`

	// The maximum number of items to return.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeRootFoldersInput) GoString added in v1.10.0 

func (s DescribeRootFoldersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRootFoldersInput) SetAuthenticationToken added in v1.10.0 

func (s *DescribeRootFoldersInput) SetAuthenticationToken(v string) *DescribeRootFoldersInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeRootFoldersInput) SetLimit added in v1.10.0 

func (s *DescribeRootFoldersInput) SetLimit(v int64) *DescribeRootFoldersInput

SetLimit sets the Limit field's value.

func (*DescribeRootFoldersInput) SetMarker added in v1.10.0 

func (s *DescribeRootFoldersInput) SetMarker(v string) *DescribeRootFoldersInput

SetMarker sets the Marker field's value.

func (DescribeRootFoldersInput) String added in v1.10.0 

func (s DescribeRootFoldersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRootFoldersInput) Validate added in v1.10.0 

func (s *DescribeRootFoldersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRootFoldersOutput added in v1.10.0 

type DescribeRootFoldersOutput struct {

	// The user's special folders.
	Folders []*FolderMetadata `type:"list"`

	// The marker for the next set of results.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeRootFoldersOutput) GoString added in v1.10.0 

func (s DescribeRootFoldersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRootFoldersOutput) SetFolders added in v1.10.0 

func (s *DescribeRootFoldersOutput) SetFolders(v []*FolderMetadata) *DescribeRootFoldersOutput

SetFolders sets the Folders field's value.

func (*DescribeRootFoldersOutput) SetMarker added in v1.10.0 

func (s *DescribeRootFoldersOutput) SetMarker(v string) *DescribeRootFoldersOutput

SetMarker sets the Marker field's value.

func (DescribeRootFoldersOutput) String added in v1.10.0 

func (s DescribeRootFoldersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeUsersInput 

type DescribeUsersInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeUsersInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// A comma-separated list of values. Specify "STORAGE_METADATA" to include the
	// user storage quota and utilization information.
	Fields *string `location:"querystring" locationName:"fields" min:"1" type:"string"`

	// The state of the users. Specify "ALL" to include inactive users.
	Include *string `location:"querystring" locationName:"include" type:"string" enum:"UserFilterType"`

	// The maximum number of items to return.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`

	// The order for the results.
	Order *string `location:"querystring" locationName:"order" type:"string" enum:"OrderType"`

	// The ID of the organization.
	OrganizationId *string `location:"querystring" locationName:"organizationId" min:"1" type:"string"`

	// A query to filter users by user name. Remember the following about the Userids
	// and Query parameters:
	//
	//    * If you don't use either parameter, the API returns a paginated list
	//    of all users on the site.
	//
	//    * If you use both parameters, the API ignores the Query parameter.
	//
	//    * The Userid parameter only returns user names that match a corresponding
	//    user ID.
	//
	//    * The Query parameter runs a "prefix" search for users by the GivenName,
	//    SurName, or UserName fields included in a CreateUser (https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html)
	//    API call. For example, querying on Ma returns Márcia Oliveira, María
	//    García, and Mateo Jackson. If you use multiple characters, the API only
	//    returns data that matches all characters. For example, querying on Ma
	//    J only returns Mateo Jackson.
	//
	// Query is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeUsersInput's
	// String and GoString methods.
	Query *string `location:"querystring" locationName:"query" min:"1" type:"string" sensitive:"true"`

	// The sorting criteria.
	Sort *string `location:"querystring" locationName:"sort" type:"string" enum:"UserSortType"`

	// The IDs of the users.
	UserIds *string `location:"querystring" locationName:"userIds" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeUsersInput) GoString 

func (s DescribeUsersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUsersInput) SetAuthenticationToken added in v1.8.34 

func (s *DescribeUsersInput) SetAuthenticationToken(v string) *DescribeUsersInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeUsersInput) SetFields 

func (s *DescribeUsersInput) SetFields(v string) *DescribeUsersInput

SetFields sets the Fields field's value.

func (*DescribeUsersInput) SetInclude 

func (s *DescribeUsersInput) SetInclude(v string) *DescribeUsersInput

SetInclude sets the Include field's value.

func (*DescribeUsersInput) SetLimit 

func (s *DescribeUsersInput) SetLimit(v int64) *DescribeUsersInput

SetLimit sets the Limit field's value.

func (*DescribeUsersInput) SetMarker 

func (s *DescribeUsersInput) SetMarker(v string) *DescribeUsersInput

SetMarker sets the Marker field's value.

func (*DescribeUsersInput) SetOrder 

func (s *DescribeUsersInput) SetOrder(v string) *DescribeUsersInput

SetOrder sets the Order field's value.

func (*DescribeUsersInput) SetOrganizationId 

func (s *DescribeUsersInput) SetOrganizationId(v string) *DescribeUsersInput

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeUsersInput) SetQuery 

func (s *DescribeUsersInput) SetQuery(v string) *DescribeUsersInput

SetQuery sets the Query field's value.

func (*DescribeUsersInput) SetSort 

func (s *DescribeUsersInput) SetSort(v string) *DescribeUsersInput

SetSort sets the Sort field's value.

func (*DescribeUsersInput) SetUserIds 

func (s *DescribeUsersInput) SetUserIds(v string) *DescribeUsersInput

SetUserIds sets the UserIds field's value.

func (DescribeUsersInput) String 

func (s DescribeUsersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUsersInput) Validate 

func (s *DescribeUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeUsersOutput 

type DescribeUsersOutput struct {

	// The marker to use when requesting the next set of results. If there are no
	// additional results, the string is empty.
	Marker *string `min:"1" type:"string"`

	// The total number of users included in the results.
	//
	// Deprecated: TotalNumberOfUsers has been deprecated
	TotalNumberOfUsers *int64 `deprecated:"true" type:"long"`

	// The users.
	Users []*User `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeUsersOutput) GoString 

func (s DescribeUsersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUsersOutput) SetMarker 

func (s *DescribeUsersOutput) SetMarker(v string) *DescribeUsersOutput

SetMarker sets the Marker field's value.

func (*DescribeUsersOutput) SetTotalNumberOfUsers 

func (s *DescribeUsersOutput) SetTotalNumberOfUsers(v int64) *DescribeUsersOutput

SetTotalNumberOfUsers sets the TotalNumberOfUsers field's value.

func (*DescribeUsersOutput) SetUsers 

func (s *DescribeUsersOutput) SetUsers(v []*User) *DescribeUsersOutput

SetUsers sets the Users field's value.

func (DescribeUsersOutput) String 

func (s DescribeUsersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocumentLockedForCommentsException added in v1.28.0 

type DocumentLockedForCommentsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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) Code added in v1.28.0 

func (s *DocumentLockedForCommentsException) Code() string

Code returns the exception type name.

func (*DocumentLockedForCommentsException) Error added in v1.28.0 

func (s *DocumentLockedForCommentsException) Error() string

func (DocumentLockedForCommentsException) GoString added in v1.28.0 

func (s DocumentLockedForCommentsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentLockedForCommentsException) Message added in v1.28.0 

func (s *DocumentLockedForCommentsException) Message() string

Message returns the exception's message.

func (*DocumentLockedForCommentsException) OrigErr added in v1.28.0 

func (s *DocumentLockedForCommentsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DocumentLockedForCommentsException) RequestID added in v1.28.0 

func (s *DocumentLockedForCommentsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DocumentLockedForCommentsException) StatusCode added in v1.28.0 

func (s *DocumentLockedForCommentsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DocumentLockedForCommentsException) String added in v1.28.0 

func (s DocumentLockedForCommentsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocumentMetadata 

type DocumentMetadata struct {

	// The time when the document was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The ID of the creator.
	CreatorId *string `min:"1" type:"string"`

	// The ID of the document.
	Id *string `min:"1" type:"string"`

	// List of labels on the document.
	Labels []*string `type:"list"`

	// The latest version of the document.
	LatestVersionMetadata *DocumentVersionMetadata `type:"structure"`

	// The time when the document was updated.
	ModifiedTimestamp *time.Time `type:"timestamp"`

	// The ID of the parent folder.
	ParentFolderId *string `min:"1" type:"string"`

	// The resource state.
	ResourceState *string `type:"string" enum:"ResourceStateType"`
	// contains filtered or unexported fields
}

Describes the document.

func (DocumentMetadata) GoString 

func (s DocumentMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentMetadata) SetCreatedTimestamp 

func (s *DocumentMetadata) SetCreatedTimestamp(v time.Time) *DocumentMetadata

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*DocumentMetadata) SetCreatorId 

func (s *DocumentMetadata) SetCreatorId(v string) *DocumentMetadata

SetCreatorId sets the CreatorId field's value.

func (*DocumentMetadata) SetId 

func (s *DocumentMetadata) SetId(v string) *DocumentMetadata

SetId sets the Id field's value.

func (*DocumentMetadata) SetLabels added in v1.8.34 

func (s *DocumentMetadata) SetLabels(v []*string) *DocumentMetadata

SetLabels sets the Labels field's value.

func (*DocumentMetadata) SetLatestVersionMetadata 

func (s *DocumentMetadata) SetLatestVersionMetadata(v *DocumentVersionMetadata) *DocumentMetadata

SetLatestVersionMetadata sets the LatestVersionMetadata field's value.

func (*DocumentMetadata) SetModifiedTimestamp 

func (s *DocumentMetadata) SetModifiedTimestamp(v time.Time) *DocumentMetadata

SetModifiedTimestamp sets the ModifiedTimestamp field's value.

func (*DocumentMetadata) SetParentFolderId 

func (s *DocumentMetadata) SetParentFolderId(v string) *DocumentMetadata

SetParentFolderId sets the ParentFolderId field's value.

func (*DocumentMetadata) SetResourceState 

func (s *DocumentMetadata) SetResourceState(v string) *DocumentMetadata

SetResourceState sets the ResourceState field's value.

func (DocumentMetadata) String 

func (s DocumentMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocumentVersionMetadata 

type DocumentVersionMetadata struct {

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

	// The timestamp when the content of the document was modified.
	ContentModifiedTimestamp *time.Time `type:"timestamp"`

	// The content type of the document.
	ContentType *string `min:"1" type:"string"`

	// The timestamp when the document was first uploaded.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The ID of the creator.
	CreatorId *string `min:"1" type:"string"`

	// The ID of the version.
	Id *string `min:"1" type:"string"`

	// The timestamp when the document was last uploaded.
	ModifiedTimestamp *time.Time `type:"timestamp"`

	// The name of the version.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DocumentVersionMetadata's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The signature of the document.
	Signature *string `type:"string"`

	// The size of the document, in bytes.
	Size *int64 `type:"long"`

	// The source of the document.
	Source map[string]*string `type:"map"`

	// The status of the document.
	Status *string `type:"string" enum:"DocumentStatusType"`

	// The thumbnail of the document.
	Thumbnail map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Describes a version of a document.

func (DocumentVersionMetadata) GoString 

func (s DocumentVersionMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentVersionMetadata) SetContentCreatedTimestamp 

func (s *DocumentVersionMetadata) SetContentCreatedTimestamp(v time.Time) *DocumentVersionMetadata

SetContentCreatedTimestamp sets the ContentCreatedTimestamp field's value.

func (*DocumentVersionMetadata) SetContentModifiedTimestamp 

func (s *DocumentVersionMetadata) SetContentModifiedTimestamp(v time.Time) *DocumentVersionMetadata

SetContentModifiedTimestamp sets the ContentModifiedTimestamp field's value.

func (*DocumentVersionMetadata) SetContentType 

func (s *DocumentVersionMetadata) SetContentType(v string) *DocumentVersionMetadata

SetContentType sets the ContentType field's value.

func (*DocumentVersionMetadata) SetCreatedTimestamp 

func (s *DocumentVersionMetadata) SetCreatedTimestamp(v time.Time) *DocumentVersionMetadata

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*DocumentVersionMetadata) SetCreatorId 

func (s *DocumentVersionMetadata) SetCreatorId(v string) *DocumentVersionMetadata

SetCreatorId sets the CreatorId field's value.

func (*DocumentVersionMetadata) SetId 

func (s *DocumentVersionMetadata) SetId(v string) *DocumentVersionMetadata

SetId sets the Id field's value.

func (*DocumentVersionMetadata) SetModifiedTimestamp 

func (s *DocumentVersionMetadata) SetModifiedTimestamp(v time.Time) *DocumentVersionMetadata

SetModifiedTimestamp sets the ModifiedTimestamp field's value.

func (*DocumentVersionMetadata) SetName 

func (s *DocumentVersionMetadata) SetName(v string) *DocumentVersionMetadata

SetName sets the Name field's value.

func (*DocumentVersionMetadata) SetSignature 

func (s *DocumentVersionMetadata) SetSignature(v string) *DocumentVersionMetadata

SetSignature sets the Signature field's value.

func (*DocumentVersionMetadata) SetSize 

func (s *DocumentVersionMetadata) SetSize(v int64) *DocumentVersionMetadata

SetSize sets the Size field's value.

func (*DocumentVersionMetadata) SetSource 

func (s *DocumentVersionMetadata) SetSource(v map[string]*string) *DocumentVersionMetadata

SetSource sets the Source field's value.

func (*DocumentVersionMetadata) SetStatus 

func (s *DocumentVersionMetadata) SetStatus(v string) *DocumentVersionMetadata

SetStatus sets the Status field's value.

func (*DocumentVersionMetadata) SetThumbnail 

func (s *DocumentVersionMetadata) SetThumbnail(v map[string]*string) *DocumentVersionMetadata

SetThumbnail sets the Thumbnail field's value.

func (DocumentVersionMetadata) String 

func (s DocumentVersionMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DraftUploadOutOfSyncException added in v1.28.0 

type DraftUploadOutOfSyncException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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) Code added in v1.28.0 

func (s *DraftUploadOutOfSyncException) Code() string

Code returns the exception type name.

func (*DraftUploadOutOfSyncException) Error added in v1.28.0 

func (s *DraftUploadOutOfSyncException) Error() string

func (DraftUploadOutOfSyncException) GoString added in v1.28.0 

func (s DraftUploadOutOfSyncException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DraftUploadOutOfSyncException) Message added in v1.28.0 

func (s *DraftUploadOutOfSyncException) Message() string

Message returns the exception's message.

func (*DraftUploadOutOfSyncException) OrigErr added in v1.28.0 

func (s *DraftUploadOutOfSyncException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DraftUploadOutOfSyncException) RequestID added in v1.28.0 

func (s *DraftUploadOutOfSyncException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DraftUploadOutOfSyncException) StatusCode added in v1.28.0 

func (s *DraftUploadOutOfSyncException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DraftUploadOutOfSyncException) String added in v1.28.0 

func (s DraftUploadOutOfSyncException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EntityAlreadyExistsException added in v1.28.0 

type EntityAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The resource already exists.

func (*EntityAlreadyExistsException) Code added in v1.28.0 

func (s *EntityAlreadyExistsException) Code() string

Code returns the exception type name.

func (*EntityAlreadyExistsException) Error added in v1.28.0 

func (s *EntityAlreadyExistsException) Error() string

func (EntityAlreadyExistsException) GoString added in v1.28.0 

func (s EntityAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityAlreadyExistsException) Message added in v1.28.0 

func (s *EntityAlreadyExistsException) Message() string

Message returns the exception's message.

func (*EntityAlreadyExistsException) OrigErr added in v1.28.0 

func (s *EntityAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EntityAlreadyExistsException) RequestID added in v1.28.0 

func (s *EntityAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EntityAlreadyExistsException) StatusCode added in v1.28.0 

func (s *EntityAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (EntityAlreadyExistsException) String added in v1.28.0 

func (s EntityAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EntityNotExistsException added in v1.28.0 

type EntityNotExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The IDs of the non-existent resources.
	EntityIds []*string `type:"list"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The resource does not exist.

func (*EntityNotExistsException) Code added in v1.28.0 

func (s *EntityNotExistsException) Code() string

Code returns the exception type name.

func (*EntityNotExistsException) Error added in v1.28.0 

func (s *EntityNotExistsException) Error() string

func (EntityNotExistsException) GoString added in v1.28.0 

func (s EntityNotExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityNotExistsException) Message added in v1.28.0 

func (s *EntityNotExistsException) Message() string

Message returns the exception's message.

func (*EntityNotExistsException) OrigErr added in v1.28.0 

func (s *EntityNotExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EntityNotExistsException) RequestID added in v1.28.0 

func (s *EntityNotExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EntityNotExistsException) StatusCode added in v1.28.0 

func (s *EntityNotExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (EntityNotExistsException) String added in v1.28.0 

func (s EntityNotExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailedDependencyException added in v1.28.0 

type FailedDependencyException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The 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) Code added in v1.28.0 

func (s *FailedDependencyException) Code() string

Code returns the exception type name.

func (*FailedDependencyException) Error added in v1.28.0 

func (s *FailedDependencyException) Error() string

func (FailedDependencyException) GoString added in v1.28.0 

func (s FailedDependencyException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailedDependencyException) Message added in v1.28.0 

func (s *FailedDependencyException) Message() string

Message returns the exception's message.

func (*FailedDependencyException) OrigErr added in v1.28.0 

func (s *FailedDependencyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*FailedDependencyException) RequestID added in v1.28.0 

func (s *FailedDependencyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*FailedDependencyException) StatusCode added in v1.28.0 

func (s *FailedDependencyException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (FailedDependencyException) String added in v1.28.0 

func (s FailedDependencyException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Filters added in v1.44.225 

type Filters struct {

	// Filter based on resource’s path.
	AncestorIds []*string `type:"list"`

	// Filters by content category.
	ContentCategories []*string `type:"list" enum:"ContentCategoryType"`

	// Filter based on resource’s creation timestamp.
	CreatedRange *DateRangeType `type:"structure"`

	// Filter by labels using exact match.
	Labels []*string `type:"list"`

	// Filter based on resource’s modified timestamp.
	ModifiedRange *DateRangeType `type:"structure"`

	// Filter based on UserIds or GroupIds.
	Principals []*SearchPrincipalType `type:"list"`

	// Filters based on entity type.
	ResourceTypes []*string `type:"list" enum:"SearchResourceType"`

	// Filter based on file groupings.
	SearchCollectionTypes []*string `type:"list" enum:"SearchCollectionType"`

	// Filter based on size (in bytes).
	SizeRange *LongRangeType `type:"structure"`

	// Filters by the locale of the content or comment.
	TextLocales []*string `type:"list" enum:"LanguageCodeType"`
	// contains filtered or unexported fields
}

Filters results based on entity metadata.

func (Filters) GoString added in v1.44.225 

func (s Filters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filters) SetAncestorIds added in v1.44.225 

func (s *Filters) SetAncestorIds(v []*string) *Filters

SetAncestorIds sets the AncestorIds field's value.

func (*Filters) SetContentCategories added in v1.44.225 

func (s *Filters) SetContentCategories(v []*string) *Filters

SetContentCategories sets the ContentCategories field's value.

func (*Filters) SetCreatedRange added in v1.44.225 

func (s *Filters) SetCreatedRange(v *DateRangeType) *Filters

SetCreatedRange sets the CreatedRange field's value.

func (*Filters) SetLabels added in v1.44.225 

func (s *Filters) SetLabels(v []*string) *Filters

SetLabels sets the Labels field's value.

func (*Filters) SetModifiedRange added in v1.44.225 

func (s *Filters) SetModifiedRange(v *DateRangeType) *Filters

SetModifiedRange sets the ModifiedRange field's value.

func (*Filters) SetPrincipals added in v1.44.225 

func (s *Filters) SetPrincipals(v []*SearchPrincipalType) *Filters

SetPrincipals sets the Principals field's value.

func (*Filters) SetResourceTypes added in v1.44.225 

func (s *Filters) SetResourceTypes(v []*string) *Filters

SetResourceTypes sets the ResourceTypes field's value.

func (*Filters) SetSearchCollectionTypes added in v1.44.225 

func (s *Filters) SetSearchCollectionTypes(v []*string) *Filters

SetSearchCollectionTypes sets the SearchCollectionTypes field's value.

func (*Filters) SetSizeRange added in v1.44.225 

func (s *Filters) SetSizeRange(v *LongRangeType) *Filters

SetSizeRange sets the SizeRange field's value.

func (*Filters) SetTextLocales added in v1.44.225 

func (s *Filters) SetTextLocales(v []*string) *Filters

SetTextLocales sets the TextLocales field's value.

func (Filters) String added in v1.44.225 

func (s Filters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filters) Validate added in v1.44.225 

func (s *Filters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FolderMetadata 

type FolderMetadata struct {

	// The time when the folder was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The ID of the creator.
	CreatorId *string `min:"1" type:"string"`

	// The ID of the folder.
	Id *string `min:"1" type:"string"`

	// List of labels on the folder.
	Labels []*string `type:"list"`

	// The size of the latest version of the folder metadata.
	LatestVersionSize *int64 `type:"long"`

	// The time when the folder was updated.
	ModifiedTimestamp *time.Time `type:"timestamp"`

	// The name of the folder.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by FolderMetadata's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The ID of the parent folder.
	ParentFolderId *string `min:"1" type:"string"`

	// The resource state of the folder.
	ResourceState *string `type:"string" enum:"ResourceStateType"`

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

	// The size of the folder metadata.
	Size *int64 `type:"long"`
	// contains filtered or unexported fields
}

Describes a folder.

func (FolderMetadata) GoString 

func (s FolderMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FolderMetadata) SetCreatedTimestamp 

func (s *FolderMetadata) SetCreatedTimestamp(v time.Time) *FolderMetadata

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*FolderMetadata) SetCreatorId 

func (s *FolderMetadata) SetCreatorId(v string) *FolderMetadata

SetCreatorId sets the CreatorId field's value.

func (*FolderMetadata) SetId 

func (s *FolderMetadata) SetId(v string) *FolderMetadata

SetId sets the Id field's value.

func (*FolderMetadata) SetLabels added in v1.8.34 

func (s *FolderMetadata) SetLabels(v []*string) *FolderMetadata

SetLabels sets the Labels field's value.

func (*FolderMetadata) SetLatestVersionSize added in v1.8.34 

func (s *FolderMetadata) SetLatestVersionSize(v int64) *FolderMetadata

SetLatestVersionSize sets the LatestVersionSize field's value.

func (*FolderMetadata) SetModifiedTimestamp 

func (s *FolderMetadata) SetModifiedTimestamp(v time.Time) *FolderMetadata

SetModifiedTimestamp sets the ModifiedTimestamp field's value.

func (*FolderMetadata) SetName 

func (s *FolderMetadata) SetName(v string) *FolderMetadata

SetName sets the Name field's value.

func (*FolderMetadata) SetParentFolderId 

func (s *FolderMetadata) SetParentFolderId(v string) *FolderMetadata

SetParentFolderId sets the ParentFolderId field's value.

func (*FolderMetadata) SetResourceState 

func (s *FolderMetadata) SetResourceState(v string) *FolderMetadata

SetResourceState sets the ResourceState field's value.

func (*FolderMetadata) SetSignature 

func (s *FolderMetadata) SetSignature(v string) *FolderMetadata

SetSignature sets the Signature field's value.

func (*FolderMetadata) SetSize added in v1.8.34 

func (s *FolderMetadata) SetSize(v int64) *FolderMetadata

SetSize sets the Size field's value.

func (FolderMetadata) String 

func (s FolderMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCurrentUserInput added in v1.10.0 

type GetCurrentUserInput struct {

	// Amazon WorkDocs authentication token.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetCurrentUserInput's
	// String and GoString methods.
	//
	// AuthenticationToken is a required field
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (GetCurrentUserInput) GoString added in v1.10.0 

func (s GetCurrentUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCurrentUserInput) SetAuthenticationToken added in v1.10.0 

func (s *GetCurrentUserInput) SetAuthenticationToken(v string) *GetCurrentUserInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (GetCurrentUserInput) String added in v1.10.0 

func (s GetCurrentUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCurrentUserInput) Validate added in v1.10.0 

func (s *GetCurrentUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCurrentUserOutput added in v1.10.0 

type GetCurrentUserOutput struct {

	// Metadata of the user.
	User *User `type:"structure"`
	// contains filtered or unexported fields
}

func (GetCurrentUserOutput) GoString added in v1.10.0 

func (s GetCurrentUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCurrentUserOutput) SetUser added in v1.10.0 

func (s *GetCurrentUserOutput) SetUser(v *User) *GetCurrentUserOutput

SetUser sets the User field's value.

func (GetCurrentUserOutput) String added in v1.10.0 

func (s GetCurrentUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDocumentInput 

type GetDocumentInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetDocumentInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// Set this to TRUE to include custom metadata in the response.
	IncludeCustomMetadata *bool `location:"querystring" locationName:"includeCustomMetadata" type:"boolean"`
	// contains filtered or unexported fields
}

func (GetDocumentInput) GoString 

func (s GetDocumentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentInput) SetAuthenticationToken added in v1.8.34 

func (s *GetDocumentInput) SetAuthenticationToken(v string) *GetDocumentInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetDocumentInput) SetDocumentId 

func (s *GetDocumentInput) SetDocumentId(v string) *GetDocumentInput

SetDocumentId sets the DocumentId field's value.

func (*GetDocumentInput) SetIncludeCustomMetadata added in v1.8.34 

func (s *GetDocumentInput) SetIncludeCustomMetadata(v bool) *GetDocumentInput

SetIncludeCustomMetadata sets the IncludeCustomMetadata field's value.

func (GetDocumentInput) String 

func (s GetDocumentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentInput) Validate 

func (s *GetDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDocumentOutput 

type GetDocumentOutput struct {

	// The custom metadata on the document.
	CustomMetadata map[string]*string `min:"1" type:"map"`

	// The metadata details of the document.
	Metadata *DocumentMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetDocumentOutput) GoString 

func (s GetDocumentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentOutput) SetCustomMetadata added in v1.8.34 

func (s *GetDocumentOutput) SetCustomMetadata(v map[string]*string) *GetDocumentOutput

SetCustomMetadata sets the CustomMetadata field's value.

func (*GetDocumentOutput) SetMetadata 

func (s *GetDocumentOutput) SetMetadata(v *DocumentMetadata) *GetDocumentOutput

SetMetadata sets the Metadata field's value.

func (GetDocumentOutput) String 

func (s GetDocumentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDocumentPathInput 

type GetDocumentPathInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetDocumentPathInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// A comma-separated list of values. Specify NAME to include the names of the
	// parent folders.
	Fields *string `location:"querystring" locationName:"fields" min:"1" type:"string"`

	// The maximum number of levels in the hierarchy to return.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// This value is not supported.
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetDocumentPathInput) GoString 

func (s GetDocumentPathInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentPathInput) SetAuthenticationToken added in v1.8.34 

func (s *GetDocumentPathInput) SetAuthenticationToken(v string) *GetDocumentPathInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetDocumentPathInput) SetDocumentId 

func (s *GetDocumentPathInput) SetDocumentId(v string) *GetDocumentPathInput

SetDocumentId sets the DocumentId field's value.

func (*GetDocumentPathInput) SetFields 

func (s *GetDocumentPathInput) SetFields(v string) *GetDocumentPathInput

SetFields sets the Fields field's value.

func (*GetDocumentPathInput) SetLimit 

func (s *GetDocumentPathInput) SetLimit(v int64) *GetDocumentPathInput

SetLimit sets the Limit field's value.

func (*GetDocumentPathInput) SetMarker 

func (s *GetDocumentPathInput) SetMarker(v string) *GetDocumentPathInput

SetMarker sets the Marker field's value.

func (GetDocumentPathInput) String 

func (s GetDocumentPathInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentPathInput) Validate 

func (s *GetDocumentPathInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDocumentPathOutput 

type GetDocumentPathOutput struct {

	// The path information.
	Path *ResourcePath `type:"structure"`
	// contains filtered or unexported fields
}

func (GetDocumentPathOutput) GoString 

func (s GetDocumentPathOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentPathOutput) SetPath 

func (s *GetDocumentPathOutput) SetPath(v *ResourcePath) *GetDocumentPathOutput

SetPath sets the Path field's value.

func (GetDocumentPathOutput) String 

func (s GetDocumentPathOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDocumentVersionInput 

type GetDocumentVersionInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetDocumentVersionInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// A comma-separated list of values. Specify "SOURCE" to include a URL for the
	// source document.
	Fields *string `location:"querystring" locationName:"fields" min:"1" type:"string"`

	// Set this to TRUE to include custom metadata in the response.
	IncludeCustomMetadata *bool `location:"querystring" locationName:"includeCustomMetadata" type:"boolean"`

	// The version ID of the document.
	//
	// VersionId is a required field
	VersionId *string `location:"uri" locationName:"VersionId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDocumentVersionInput) GoString 

func (s GetDocumentVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentVersionInput) SetAuthenticationToken added in v1.8.34 

func (s *GetDocumentVersionInput) SetAuthenticationToken(v string) *GetDocumentVersionInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetDocumentVersionInput) SetDocumentId 

func (s *GetDocumentVersionInput) SetDocumentId(v string) *GetDocumentVersionInput

SetDocumentId sets the DocumentId field's value.

func (*GetDocumentVersionInput) SetFields 

func (s *GetDocumentVersionInput) SetFields(v string) *GetDocumentVersionInput

SetFields sets the Fields field's value.

func (*GetDocumentVersionInput) SetIncludeCustomMetadata added in v1.8.34 

func (s *GetDocumentVersionInput) SetIncludeCustomMetadata(v bool) *GetDocumentVersionInput

SetIncludeCustomMetadata sets the IncludeCustomMetadata field's value.

func (*GetDocumentVersionInput) SetVersionId 

func (s *GetDocumentVersionInput) SetVersionId(v string) *GetDocumentVersionInput

SetVersionId sets the VersionId field's value.

func (GetDocumentVersionInput) String 

func (s GetDocumentVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentVersionInput) Validate 

func (s *GetDocumentVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDocumentVersionOutput 

type GetDocumentVersionOutput struct {

	// The custom metadata on the document version.
	CustomMetadata map[string]*string `min:"1" type:"map"`

	// The version metadata.
	Metadata *DocumentVersionMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetDocumentVersionOutput) GoString 

func (s GetDocumentVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDocumentVersionOutput) SetCustomMetadata added in v1.8.34 

func (s *GetDocumentVersionOutput) SetCustomMetadata(v map[string]*string) *GetDocumentVersionOutput

SetCustomMetadata sets the CustomMetadata field's value.

func (*GetDocumentVersionOutput) SetMetadata 

func (s *GetDocumentVersionOutput) SetMetadata(v *DocumentVersionMetadata) *GetDocumentVersionOutput

SetMetadata sets the Metadata field's value.

func (GetDocumentVersionOutput) String 

func (s GetDocumentVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetFolderInput 

type GetFolderInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetFolderInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the folder.
	//
	// FolderId is a required field
	FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"`

	// Set to TRUE to include custom metadata in the response.
	IncludeCustomMetadata *bool `location:"querystring" locationName:"includeCustomMetadata" type:"boolean"`
	// contains filtered or unexported fields
}

func (GetFolderInput) GoString 

func (s GetFolderInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFolderInput) SetAuthenticationToken added in v1.8.34 

func (s *GetFolderInput) SetAuthenticationToken(v string) *GetFolderInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetFolderInput) SetFolderId 

func (s *GetFolderInput) SetFolderId(v string) *GetFolderInput

SetFolderId sets the FolderId field's value.

func (*GetFolderInput) SetIncludeCustomMetadata added in v1.8.34 

func (s *GetFolderInput) SetIncludeCustomMetadata(v bool) *GetFolderInput

SetIncludeCustomMetadata sets the IncludeCustomMetadata field's value.

func (GetFolderInput) String 

func (s GetFolderInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFolderInput) Validate 

func (s *GetFolderInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFolderOutput 

type GetFolderOutput struct {

	// The custom metadata on the folder.
	CustomMetadata map[string]*string `min:"1" type:"map"`

	// The metadata of the folder.
	Metadata *FolderMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetFolderOutput) GoString 

func (s GetFolderOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFolderOutput) SetCustomMetadata added in v1.8.34 

func (s *GetFolderOutput) SetCustomMetadata(v map[string]*string) *GetFolderOutput

SetCustomMetadata sets the CustomMetadata field's value.

func (*GetFolderOutput) SetMetadata 

func (s *GetFolderOutput) SetMetadata(v *FolderMetadata) *GetFolderOutput

SetMetadata sets the Metadata field's value.

func (GetFolderOutput) String 

func (s GetFolderOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetFolderPathInput 

type GetFolderPathInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetFolderPathInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// A comma-separated list of values. Specify "NAME" to include the names of
	// the parent folders.
	Fields *string `location:"querystring" locationName:"fields" min:"1" type:"string"`

	// The ID of the folder.
	//
	// FolderId is a required field
	FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"`

	// The maximum number of levels in the hierarchy to return.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// This value is not supported.
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetFolderPathInput) GoString 

func (s GetFolderPathInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFolderPathInput) SetAuthenticationToken added in v1.8.34 

func (s *GetFolderPathInput) SetAuthenticationToken(v string) *GetFolderPathInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetFolderPathInput) SetFields 

func (s *GetFolderPathInput) SetFields(v string) *GetFolderPathInput

SetFields sets the Fields field's value.

func (*GetFolderPathInput) SetFolderId 

func (s *GetFolderPathInput) SetFolderId(v string) *GetFolderPathInput

SetFolderId sets the FolderId field's value.

func (*GetFolderPathInput) SetLimit 

func (s *GetFolderPathInput) SetLimit(v int64) *GetFolderPathInput

SetLimit sets the Limit field's value.

func (*GetFolderPathInput) SetMarker 

func (s *GetFolderPathInput) SetMarker(v string) *GetFolderPathInput

SetMarker sets the Marker field's value.

func (GetFolderPathInput) String 

func (s GetFolderPathInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFolderPathInput) Validate 

func (s *GetFolderPathInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFolderPathOutput 

type GetFolderPathOutput struct {

	// The path information.
	Path *ResourcePath `type:"structure"`
	// contains filtered or unexported fields
}

func (GetFolderPathOutput) GoString 

func (s GetFolderPathOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFolderPathOutput) SetPath 

func (s *GetFolderPathOutput) SetPath(v *ResourcePath) *GetFolderPathOutput

SetPath sets the Path field's value.

func (GetFolderPathOutput) String 

func (s GetFolderPathOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetResourcesInput added in v1.15.79 

type GetResourcesInput struct {

	// The Amazon WorkDocs authentication token. Not required when using Amazon
	// Web Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetResourcesInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The collection type.
	CollectionType *string `location:"querystring" locationName:"collectionType" type:"string" enum:"ResourceCollectionType"`

	// The maximum number of resources to return.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The marker for the next set of results. This marker was received from a previous
	// call.
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`

	// The user ID for the resource collection. This is a required field for accessing
	// the API operation using IAM credentials.
	UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetResourcesInput) GoString added in v1.15.79 

func (s GetResourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourcesInput) SetAuthenticationToken added in v1.15.79 

func (s *GetResourcesInput) SetAuthenticationToken(v string) *GetResourcesInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetResourcesInput) SetCollectionType added in v1.15.79 

func (s *GetResourcesInput) SetCollectionType(v string) *GetResourcesInput

SetCollectionType sets the CollectionType field's value.

func (*GetResourcesInput) SetLimit added in v1.15.79 

func (s *GetResourcesInput) SetLimit(v int64) *GetResourcesInput

SetLimit sets the Limit field's value.

func (*GetResourcesInput) SetMarker added in v1.15.79 

func (s *GetResourcesInput) SetMarker(v string) *GetResourcesInput

SetMarker sets the Marker field's value.

func (*GetResourcesInput) SetUserId added in v1.15.79 

func (s *GetResourcesInput) SetUserId(v string) *GetResourcesInput

SetUserId sets the UserId field's value.

func (GetResourcesInput) String added in v1.15.79 

func (s GetResourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourcesInput) Validate added in v1.15.79 

func (s *GetResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetResourcesOutput added in v1.15.79 

type GetResourcesOutput struct {

	// The documents in the specified collection.
	Documents []*DocumentMetadata `type:"list"`

	// The folders in the specified folder.
	Folders []*FolderMetadata `type:"list"`

	// The marker to use when requesting the next set of results. If there are no
	// additional results, the string is empty.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetResourcesOutput) GoString added in v1.15.79 

func (s GetResourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourcesOutput) SetDocuments added in v1.15.79 

func (s *GetResourcesOutput) SetDocuments(v []*DocumentMetadata) *GetResourcesOutput

SetDocuments sets the Documents field's value.

func (*GetResourcesOutput) SetFolders added in v1.15.79 

func (s *GetResourcesOutput) SetFolders(v []*FolderMetadata) *GetResourcesOutput

SetFolders sets the Folders field's value.

func (*GetResourcesOutput) SetMarker added in v1.15.79 

func (s *GetResourcesOutput) SetMarker(v string) *GetResourcesOutput

SetMarker sets the Marker field's value.

func (GetResourcesOutput) String added in v1.15.79 

func (s GetResourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GroupMetadata added in v1.10.0 

type GroupMetadata struct {

	// The ID of the user group.
	Id *string `min:"1" type:"string"`

	// The name of the group.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the metadata of a user group.

func (GroupMetadata) GoString added in v1.10.0 

func (s GroupMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupMetadata) SetId added in v1.10.0 

func (s *GroupMetadata) SetId(v string) *GroupMetadata

SetId sets the Id field's value.

func (*GroupMetadata) SetName added in v1.10.0 

func (s *GroupMetadata) SetName(v string) *GroupMetadata

SetName sets the Name field's value.

func (GroupMetadata) String added in v1.10.0 

func (s GroupMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IllegalUserStateException added in v1.28.0 

type IllegalUserStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The user is undergoing transfer of ownership.

func (*IllegalUserStateException) Code added in v1.28.0 

func (s *IllegalUserStateException) Code() string

Code returns the exception type name.

func (*IllegalUserStateException) Error added in v1.28.0 

func (s *IllegalUserStateException) Error() string

func (IllegalUserStateException) GoString added in v1.28.0 

func (s IllegalUserStateException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IllegalUserStateException) Message added in v1.28.0 

func (s *IllegalUserStateException) Message() string

Message returns the exception's message.

func (*IllegalUserStateException) OrigErr added in v1.28.0 

func (s *IllegalUserStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IllegalUserStateException) RequestID added in v1.28.0 

func (s *IllegalUserStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IllegalUserStateException) StatusCode added in v1.28.0 

func (s *IllegalUserStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IllegalUserStateException) String added in v1.28.0 

func (s IllegalUserStateException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InitiateDocumentVersionUploadInput 

type InitiateDocumentVersionUploadInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InitiateDocumentVersionUploadInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

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

	// The timestamp when the content of the document was modified.
	ContentModifiedTimestamp *time.Time `type:"timestamp"`

	// The content type of the document.
	ContentType *string `min:"1" type:"string"`

	// The size of the document, in bytes.
	DocumentSizeInBytes *int64 `type:"long"`

	// The ID of the document.
	Id *string `min:"1" type:"string"`

	// The name of the document.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InitiateDocumentVersionUploadInput's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The ID of the parent folder.
	ParentFolderId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (InitiateDocumentVersionUploadInput) GoString 

func (s InitiateDocumentVersionUploadInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InitiateDocumentVersionUploadInput) SetAuthenticationToken added in v1.8.34 

func (s *InitiateDocumentVersionUploadInput) SetAuthenticationToken(v string) *InitiateDocumentVersionUploadInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*InitiateDocumentVersionUploadInput) SetContentCreatedTimestamp 

func (s *InitiateDocumentVersionUploadInput) SetContentCreatedTimestamp(v time.Time) *InitiateDocumentVersionUploadInput

SetContentCreatedTimestamp sets the ContentCreatedTimestamp field's value.

func (*InitiateDocumentVersionUploadInput) SetContentModifiedTimestamp 

func (s *InitiateDocumentVersionUploadInput) SetContentModifiedTimestamp(v time.Time) *InitiateDocumentVersionUploadInput

SetContentModifiedTimestamp sets the ContentModifiedTimestamp field's value.

func (*InitiateDocumentVersionUploadInput) SetContentType 

func (s *InitiateDocumentVersionUploadInput) SetContentType(v string) *InitiateDocumentVersionUploadInput

SetContentType sets the ContentType field's value.

func (*InitiateDocumentVersionUploadInput) SetDocumentSizeInBytes 

func (s *InitiateDocumentVersionUploadInput) SetDocumentSizeInBytes(v int64) *InitiateDocumentVersionUploadInput

SetDocumentSizeInBytes sets the DocumentSizeInBytes field's value.

func (*InitiateDocumentVersionUploadInput) SetId 

func (s *InitiateDocumentVersionUploadInput) SetId(v string) *InitiateDocumentVersionUploadInput

SetId sets the Id field's value.

func (*InitiateDocumentVersionUploadInput) SetName 

func (s *InitiateDocumentVersionUploadInput) SetName(v string) *InitiateDocumentVersionUploadInput

SetName sets the Name field's value.

func (*InitiateDocumentVersionUploadInput) SetParentFolderId 

func (s *InitiateDocumentVersionUploadInput) SetParentFolderId(v string) *InitiateDocumentVersionUploadInput

SetParentFolderId sets the ParentFolderId field's value.

func (InitiateDocumentVersionUploadInput) String 

func (s InitiateDocumentVersionUploadInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InitiateDocumentVersionUploadInput) Validate 

func (s *InitiateDocumentVersionUploadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InitiateDocumentVersionUploadOutput 

type InitiateDocumentVersionUploadOutput struct {

	// The document metadata.
	Metadata *DocumentMetadata `type:"structure"`

	// The upload metadata.
	UploadMetadata *UploadMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (InitiateDocumentVersionUploadOutput) GoString 

func (s InitiateDocumentVersionUploadOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InitiateDocumentVersionUploadOutput) SetMetadata 

func (s *InitiateDocumentVersionUploadOutput) SetMetadata(v *DocumentMetadata) *InitiateDocumentVersionUploadOutput

SetMetadata sets the Metadata field's value.

func (*InitiateDocumentVersionUploadOutput) SetUploadMetadata 

func (s *InitiateDocumentVersionUploadOutput) SetUploadMetadata(v *UploadMetadata) *InitiateDocumentVersionUploadOutput

SetUploadMetadata sets the UploadMetadata field's value.

func (InitiateDocumentVersionUploadOutput) String 

func (s InitiateDocumentVersionUploadOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidArgumentException added in v1.28.0 

type InvalidArgumentException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The pagination marker or limit fields are not valid.

func (*InvalidArgumentException) Code added in v1.28.0 

func (s *InvalidArgumentException) Code() string

Code returns the exception type name.

func (*InvalidArgumentException) Error added in v1.28.0 

func (s *InvalidArgumentException) Error() string

func (InvalidArgumentException) GoString added in v1.28.0 

func (s InvalidArgumentException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidArgumentException) Message added in v1.28.0 

func (s *InvalidArgumentException) Message() string

Message returns the exception's message.

func (*InvalidArgumentException) OrigErr added in v1.28.0 

func (s *InvalidArgumentException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidArgumentException) RequestID added in v1.28.0 

func (s *InvalidArgumentException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidArgumentException) StatusCode added in v1.28.0 

func (s *InvalidArgumentException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidArgumentException) String added in v1.28.0 

func (s InvalidArgumentException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidCommentOperationException added in v1.28.0 

type InvalidCommentOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidCommentOperationException) Code added in v1.28.0 

func (s *InvalidCommentOperationException) Code() string

Code returns the exception type name.

func (*InvalidCommentOperationException) Error added in v1.28.0 

func (s *InvalidCommentOperationException) Error() string

func (InvalidCommentOperationException) GoString added in v1.28.0 

func (s InvalidCommentOperationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidCommentOperationException) Message added in v1.28.0 

func (s *InvalidCommentOperationException) Message() string

Message returns the exception's message.

func (*InvalidCommentOperationException) OrigErr added in v1.28.0 

func (s *InvalidCommentOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidCommentOperationException) RequestID added in v1.28.0 

func (s *InvalidCommentOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidCommentOperationException) StatusCode added in v1.28.0 

func (s *InvalidCommentOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidCommentOperationException) String added in v1.28.0 

func (s InvalidCommentOperationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidOperationException added in v1.28.0 

type InvalidOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation is invalid.

func (*InvalidOperationException) Code added in v1.28.0 

func (s *InvalidOperationException) Code() string

Code returns the exception type name.

func (*InvalidOperationException) Error added in v1.28.0 

func (s *InvalidOperationException) Error() string

func (InvalidOperationException) GoString added in v1.28.0 

func (s InvalidOperationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidOperationException) Message added in v1.28.0 

func (s *InvalidOperationException) Message() string

Message returns the exception's message.

func (*InvalidOperationException) OrigErr added in v1.28.0 

func (s *InvalidOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidOperationException) RequestID added in v1.28.0 

func (s *InvalidOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidOperationException) StatusCode added in v1.28.0 

func (s *InvalidOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidOperationException) String added in v1.28.0 

func (s InvalidOperationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidPasswordException added in v1.28.0 

type InvalidPasswordException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The password is invalid.

func (*InvalidPasswordException) Code added in v1.28.0 

func (s *InvalidPasswordException) Code() string

Code returns the exception type name.

func (*InvalidPasswordException) Error added in v1.28.0 

func (s *InvalidPasswordException) Error() string

func (InvalidPasswordException) GoString added in v1.28.0 

func (s InvalidPasswordException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidPasswordException) Message added in v1.28.0 

func (s *InvalidPasswordException) Message() string

Message returns the exception's message.

func (*InvalidPasswordException) OrigErr added in v1.28.0 

func (s *InvalidPasswordException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPasswordException) RequestID added in v1.28.0 

func (s *InvalidPasswordException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPasswordException) StatusCode added in v1.28.0 

func (s *InvalidPasswordException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidPasswordException) String added in v1.28.0 

func (s InvalidPasswordException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LongRangeType added in v1.44.225 

type LongRangeType struct {

	// The size end range (in bytes).
	EndValue *int64 `type:"long"`

	// The size start range (in bytes).
	StartValue *int64 `type:"long"`
	// contains filtered or unexported fields
}

Filter based on size (in bytes).

func (LongRangeType) GoString added in v1.44.225 

func (s LongRangeType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LongRangeType) SetEndValue added in v1.44.225 

func (s *LongRangeType) SetEndValue(v int64) *LongRangeType

SetEndValue sets the EndValue field's value.

func (*LongRangeType) SetStartValue added in v1.44.225 

func (s *LongRangeType) SetStartValue(v int64) *LongRangeType

SetStartValue sets the StartValue field's value.

func (LongRangeType) String added in v1.44.225 

func (s LongRangeType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotificationOptions added in v1.12.31 

type NotificationOptions struct {

	// Text value to be included in the email body.
	//
	// EmailMessage is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by NotificationOptions's
	// String and GoString methods.
	EmailMessage *string `type:"string" sensitive:"true"`

	// Boolean value to indicate an email notification should be sent to the recipients.
	SendEmail *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Set of options which defines notification preferences of given action.

func (NotificationOptions) GoString added in v1.12.31 

func (s NotificationOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationOptions) SetEmailMessage added in v1.12.31 

func (s *NotificationOptions) SetEmailMessage(v string) *NotificationOptions

SetEmailMessage sets the EmailMessage field's value.

func (*NotificationOptions) SetSendEmail added in v1.12.31 

func (s *NotificationOptions) SetSendEmail(v bool) *NotificationOptions

SetSendEmail sets the SendEmail field's value.

func (NotificationOptions) String added in v1.12.31 

func (s NotificationOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Participants added in v1.10.0 

type Participants struct {

	// The list of user groups.
	Groups []*GroupMetadata `type:"list"`

	// The list of users.
	Users []*UserMetadata `type:"list"`
	// contains filtered or unexported fields
}

Describes the users or user groups.

func (Participants) GoString added in v1.10.0 

func (s Participants) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Participants) SetGroups added in v1.10.0 

func (s *Participants) SetGroups(v []*GroupMetadata) *Participants

SetGroups sets the Groups field's value.

func (*Participants) SetUsers added in v1.10.0 

func (s *Participants) SetUsers(v []*UserMetadata) *Participants

SetUsers sets the Users field's value.

func (Participants) String added in v1.10.0 

func (s Participants) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PermissionInfo 

type PermissionInfo struct {

	// The role of the user.
	Role *string `type:"string" enum:"RoleType"`

	// The type of permissions.
	Type *string `type:"string" enum:"RolePermissionType"`
	// contains filtered or unexported fields
}

Describes the permissions.

func (PermissionInfo) GoString 

func (s PermissionInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PermissionInfo) SetRole 

func (s *PermissionInfo) SetRole(v string) *PermissionInfo

SetRole sets the Role field's value.

func (*PermissionInfo) SetType 

func (s *PermissionInfo) SetType(v string) *PermissionInfo

SetType sets the Type field's value.

func (PermissionInfo) String 

func (s PermissionInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Principal 

type Principal struct {

	// The ID of the resource.
	Id *string `min:"1" type:"string"`

	// The permission information for the resource.
	Roles []*PermissionInfo `type:"list"`

	// The type of resource.
	Type *string `type:"string" enum:"PrincipalType"`
	// contains filtered or unexported fields
}

Describes a resource.

func (Principal) GoString 

func (s Principal) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Principal) SetId 

func (s *Principal) SetId(v string) *Principal

SetId sets the Id field's value.

func (*Principal) SetRoles 

func (s *Principal) SetRoles(v []*PermissionInfo) *Principal

SetRoles sets the Roles field's value.

func (*Principal) SetType 

func (s *Principal) SetType(v string) *Principal

SetType sets the Type field's value.

func (Principal) String 

func (s Principal) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProhibitedStateException added in v1.28.0 

type ProhibitedStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The specified document version is not in the INITIALIZED state.

func (*ProhibitedStateException) Code added in v1.28.0 

func (s *ProhibitedStateException) Code() string

Code returns the exception type name.

func (*ProhibitedStateException) Error added in v1.28.0 

func (s *ProhibitedStateException) Error() string

func (ProhibitedStateException) GoString added in v1.28.0 

func (s ProhibitedStateException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProhibitedStateException) Message added in v1.28.0 

func (s *ProhibitedStateException) Message() string

Message returns the exception's message.

func (*ProhibitedStateException) OrigErr added in v1.28.0 

func (s *ProhibitedStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ProhibitedStateException) RequestID added in v1.28.0 

func (s *ProhibitedStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ProhibitedStateException) StatusCode added in v1.28.0 

func (s *ProhibitedStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ProhibitedStateException) String added in v1.28.0 

func (s ProhibitedStateException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveAllResourcePermissionsInput 

type RemoveAllResourcePermissionsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RemoveAllResourcePermissionsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveAllResourcePermissionsInput) GoString 

func (s RemoveAllResourcePermissionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveAllResourcePermissionsInput) SetAuthenticationToken added in v1.8.34 

func (s *RemoveAllResourcePermissionsInput) SetAuthenticationToken(v string) *RemoveAllResourcePermissionsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*RemoveAllResourcePermissionsInput) SetResourceId 

func (s *RemoveAllResourcePermissionsInput) SetResourceId(v string) *RemoveAllResourcePermissionsInput

SetResourceId sets the ResourceId field's value.

func (RemoveAllResourcePermissionsInput) String 

func (s RemoveAllResourcePermissionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveAllResourcePermissionsInput) Validate 

func (s *RemoveAllResourcePermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveAllResourcePermissionsOutput 

type RemoveAllResourcePermissionsOutput struct {
	// contains filtered or unexported fields
}

func (RemoveAllResourcePermissionsOutput) GoString 

func (s RemoveAllResourcePermissionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemoveAllResourcePermissionsOutput) String 

func (s RemoveAllResourcePermissionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveResourcePermissionInput 

type RemoveResourcePermissionInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RemoveResourcePermissionInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The principal ID of the resource.
	//
	// PrincipalId is a required field
	PrincipalId *string `location:"uri" locationName:"PrincipalId" min:"1" type:"string" required:"true"`

	// The principal type of the resource.
	PrincipalType *string `location:"querystring" locationName:"type" type:"string" enum:"PrincipalType"`

	// The ID of the resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveResourcePermissionInput) GoString 

func (s RemoveResourcePermissionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveResourcePermissionInput) SetAuthenticationToken added in v1.8.34 

func (s *RemoveResourcePermissionInput) SetAuthenticationToken(v string) *RemoveResourcePermissionInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*RemoveResourcePermissionInput) SetPrincipalId 

func (s *RemoveResourcePermissionInput) SetPrincipalId(v string) *RemoveResourcePermissionInput

SetPrincipalId sets the PrincipalId field's value.

func (*RemoveResourcePermissionInput) SetPrincipalType 

func (s *RemoveResourcePermissionInput) SetPrincipalType(v string) *RemoveResourcePermissionInput

SetPrincipalType sets the PrincipalType field's value.

func (*RemoveResourcePermissionInput) SetResourceId 

func (s *RemoveResourcePermissionInput) SetResourceId(v string) *RemoveResourcePermissionInput

SetResourceId sets the ResourceId field's value.

func (RemoveResourcePermissionInput) String 

func (s RemoveResourcePermissionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveResourcePermissionInput) Validate 

func (s *RemoveResourcePermissionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveResourcePermissionOutput 

type RemoveResourcePermissionOutput struct {
	// contains filtered or unexported fields
}

func (RemoveResourcePermissionOutput) GoString 

func (s RemoveResourcePermissionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemoveResourcePermissionOutput) String 

func (s RemoveResourcePermissionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RequestedEntityTooLargeException added in v1.28.0 

type RequestedEntityTooLargeException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*RequestedEntityTooLargeException) Code added in v1.28.0 

func (s *RequestedEntityTooLargeException) Code() string

Code returns the exception type name.

func (*RequestedEntityTooLargeException) Error added in v1.28.0 

func (s *RequestedEntityTooLargeException) Error() string

func (RequestedEntityTooLargeException) GoString added in v1.28.0 

func (s RequestedEntityTooLargeException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RequestedEntityTooLargeException) Message added in v1.28.0 

func (s *RequestedEntityTooLargeException) Message() string

Message returns the exception's message.

func (*RequestedEntityTooLargeException) OrigErr added in v1.28.0 

func (s *RequestedEntityTooLargeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestedEntityTooLargeException) RequestID added in v1.28.0 

func (s *RequestedEntityTooLargeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestedEntityTooLargeException) StatusCode added in v1.28.0 

func (s *RequestedEntityTooLargeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RequestedEntityTooLargeException) String added in v1.28.0 

func (s RequestedEntityTooLargeException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceAlreadyCheckedOutException added in v1.28.0 

type ResourceAlreadyCheckedOutException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The resource is already checked out.

func (*ResourceAlreadyCheckedOutException) Code added in v1.28.0 

func (s *ResourceAlreadyCheckedOutException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyCheckedOutException) Error added in v1.28.0 

func (s *ResourceAlreadyCheckedOutException) Error() string

func (ResourceAlreadyCheckedOutException) GoString added in v1.28.0 

func (s ResourceAlreadyCheckedOutException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyCheckedOutException) Message added in v1.28.0 

func (s *ResourceAlreadyCheckedOutException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyCheckedOutException) OrigErr added in v1.28.0 

func (s *ResourceAlreadyCheckedOutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyCheckedOutException) RequestID added in v1.28.0 

func (s *ResourceAlreadyCheckedOutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyCheckedOutException) StatusCode added in v1.28.0 

func (s *ResourceAlreadyCheckedOutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyCheckedOutException) String added in v1.28.0 

func (s ResourceAlreadyCheckedOutException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceMetadata added in v1.10.0 

type ResourceMetadata struct {

	// The ID of the resource.
	Id *string `min:"1" type:"string"`

	// The name of the resource.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ResourceMetadata's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The original name of the resource before a rename operation.
	//
	// OriginalName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ResourceMetadata's
	// String and GoString methods.
	OriginalName *string `min:"1" type:"string" sensitive:"true"`

	// The owner of the resource.
	Owner *UserMetadata `type:"structure"`

	// The parent ID of the resource before a rename operation.
	ParentId *string `min:"1" type:"string"`

	// The type of resource.
	Type *string `type:"string" enum:"ResourceType"`

	// The version ID of the resource. This is an optional field and is filled for
	// action on document version.
	VersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the metadata of a resource.

func (ResourceMetadata) GoString added in v1.10.0 

func (s ResourceMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceMetadata) SetId added in v1.10.0 

func (s *ResourceMetadata) SetId(v string) *ResourceMetadata

SetId sets the Id field's value.

func (*ResourceMetadata) SetName added in v1.10.0 

func (s *ResourceMetadata) SetName(v string) *ResourceMetadata

SetName sets the Name field's value.

func (*ResourceMetadata) SetOriginalName added in v1.10.0 

func (s *ResourceMetadata) SetOriginalName(v string) *ResourceMetadata

SetOriginalName sets the OriginalName field's value.

func (*ResourceMetadata) SetOwner added in v1.10.0 

func (s *ResourceMetadata) SetOwner(v *UserMetadata) *ResourceMetadata

SetOwner sets the Owner field's value.

func (*ResourceMetadata) SetParentId added in v1.10.0 

func (s *ResourceMetadata) SetParentId(v string) *ResourceMetadata

SetParentId sets the ParentId field's value.

func (*ResourceMetadata) SetType added in v1.10.0 

func (s *ResourceMetadata) SetType(v string) *ResourceMetadata

SetType sets the Type field's value.

func (*ResourceMetadata) SetVersionId added in v1.10.0 

func (s *ResourceMetadata) SetVersionId(v string) *ResourceMetadata

SetVersionId sets the VersionId field's value.

func (ResourceMetadata) String added in v1.10.0 

func (s ResourceMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourcePath 

type ResourcePath struct {

	// The components of the resource path.
	Components []*ResourcePathComponent `type:"list"`
	// contains filtered or unexported fields
}

Describes the path information of a resource.

func (ResourcePath) GoString 

func (s ResourcePath) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourcePath) SetComponents 

func (s *ResourcePath) SetComponents(v []*ResourcePathComponent) *ResourcePath

SetComponents sets the Components field's value.

func (ResourcePath) String 

func (s ResourcePath) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourcePathComponent 

type ResourcePathComponent struct {

	// The ID of the resource path.
	Id *string `min:"1" type:"string"`

	// The name of the resource path.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ResourcePathComponent's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Describes the resource path.

func (ResourcePathComponent) GoString 

func (s ResourcePathComponent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourcePathComponent) SetId 

func (s *ResourcePathComponent) SetId(v string) *ResourcePathComponent

SetId sets the Id field's value.

func (*ResourcePathComponent) SetName 

func (s *ResourcePathComponent) SetName(v string) *ResourcePathComponent

SetName sets the Name field's value.

func (ResourcePathComponent) String 

func (s ResourcePathComponent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResponseItem added in v1.44.225 

type ResponseItem struct {

	// The comment that matches the query.
	CommentMetadata *CommentMetadata `type:"structure"`

	// The document that matches the query.
	DocumentMetadata *DocumentMetadata `type:"structure"`

	// The document version that matches the metadata.
	DocumentVersionMetadata *DocumentVersionMetadata `type:"structure"`

	// The folder that matches the query.
	FolderMetadata *FolderMetadata `type:"structure"`

	// The type of item being returned.
	ResourceType *string `type:"string" enum:"ResponseItemType"`

	// The webUrl of the item being returned.
	//
	// WebUrl is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ResponseItem's
	// String and GoString methods.
	WebUrl *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

List of Documents, Folders, Comments, and Document Versions matching the query.

func (ResponseItem) GoString added in v1.44.225 

func (s ResponseItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResponseItem) SetCommentMetadata added in v1.44.225 

func (s *ResponseItem) SetCommentMetadata(v *CommentMetadata) *ResponseItem

SetCommentMetadata sets the CommentMetadata field's value.

func (*ResponseItem) SetDocumentMetadata added in v1.44.225 

func (s *ResponseItem) SetDocumentMetadata(v *DocumentMetadata) *ResponseItem

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*ResponseItem) SetDocumentVersionMetadata added in v1.44.225 

func (s *ResponseItem) SetDocumentVersionMetadata(v *DocumentVersionMetadata) *ResponseItem

SetDocumentVersionMetadata sets the DocumentVersionMetadata field's value.

func (*ResponseItem) SetFolderMetadata added in v1.44.225 

func (s *ResponseItem) SetFolderMetadata(v *FolderMetadata) *ResponseItem

SetFolderMetadata sets the FolderMetadata field's value.

func (*ResponseItem) SetResourceType added in v1.44.225 

func (s *ResponseItem) SetResourceType(v string) *ResponseItem

SetResourceType sets the ResourceType field's value.

func (*ResponseItem) SetWebUrl added in v1.44.225 

func (s *ResponseItem) SetWebUrl(v string) *ResponseItem

SetWebUrl sets the WebUrl field's value.

func (ResponseItem) String added in v1.44.225 

func (s ResponseItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreDocumentVersionsInput added in v1.44.137 

type RestoreDocumentVersionsInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RestoreDocumentVersionsInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RestoreDocumentVersionsInput) GoString added in v1.44.137 

func (s RestoreDocumentVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDocumentVersionsInput) SetAuthenticationToken added in v1.44.137 

func (s *RestoreDocumentVersionsInput) SetAuthenticationToken(v string) *RestoreDocumentVersionsInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*RestoreDocumentVersionsInput) SetDocumentId added in v1.44.137 

func (s *RestoreDocumentVersionsInput) SetDocumentId(v string) *RestoreDocumentVersionsInput

SetDocumentId sets the DocumentId field's value.

func (RestoreDocumentVersionsInput) String added in v1.44.137 

func (s RestoreDocumentVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDocumentVersionsInput) Validate added in v1.44.137 

func (s *RestoreDocumentVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreDocumentVersionsOutput added in v1.44.137 

type RestoreDocumentVersionsOutput struct {
	// contains filtered or unexported fields
}

func (RestoreDocumentVersionsOutput) GoString added in v1.44.137 

func (s RestoreDocumentVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RestoreDocumentVersionsOutput) String added in v1.44.137 

func (s RestoreDocumentVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchPrincipalType added in v1.44.225 

type SearchPrincipalType struct {

	// UserIds or GroupIds.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The Role of a User or Group.
	Roles []*string `type:"list" enum:"PrincipalRoleType"`
	// contains filtered or unexported fields
}

Filter based on UserIds or GroupIds.

func (SearchPrincipalType) GoString added in v1.44.225 

func (s SearchPrincipalType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPrincipalType) SetId added in v1.44.225 

func (s *SearchPrincipalType) SetId(v string) *SearchPrincipalType

SetId sets the Id field's value.

func (*SearchPrincipalType) SetRoles added in v1.44.225 

func (s *SearchPrincipalType) SetRoles(v []*string) *SearchPrincipalType

SetRoles sets the Roles field's value.

func (SearchPrincipalType) String added in v1.44.225 

func (s SearchPrincipalType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchPrincipalType) Validate added in v1.44.225 

func (s *SearchPrincipalType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchResourcesInput added in v1.44.225 

type SearchResourcesInput struct {

	// A list of attributes to include in the response. Used to request fields that
	// are not normally returned in a standard response.
	AdditionalResponseFields []*string `type:"list" enum:"AdditionalResponseFieldType"`

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchResourcesInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// Filters results based on entity metadata.
	Filters *Filters `type:"structure"`

	// Max results count per page.
	Limit *int64 `min:"1" type:"integer"`

	// The marker for the next set of results.
	Marker *string `min:"1" type:"string"`

	// Order by results in one or more categories.
	OrderBy []*SearchSortResult `type:"list"`

	// Filters based on the resource owner OrgId. This is a mandatory parameter
	// when using Admin SigV4 credentials.
	OrganizationId *string `min:"1" type:"string"`

	// Filter based on the text field type. A Folder has only a name and no content.
	// A Comment has only content and no name. A Document or Document Version has
	// a name and content
	QueryScopes []*string `type:"list" enum:"SearchQueryScopeType"`

	// The String to search for. Searches across different text fields based on
	// request parameters. Use double quotes around the query string for exact phrase
	// matches.
	//
	// QueryText is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchResourcesInput's
	// String and GoString methods.
	QueryText *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (SearchResourcesInput) GoString added in v1.44.225 

func (s SearchResourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchResourcesInput) SetAdditionalResponseFields added in v1.44.225 

func (s *SearchResourcesInput) SetAdditionalResponseFields(v []*string) *SearchResourcesInput

SetAdditionalResponseFields sets the AdditionalResponseFields field's value.

func (*SearchResourcesInput) SetAuthenticationToken added in v1.44.225 

func (s *SearchResourcesInput) SetAuthenticationToken(v string) *SearchResourcesInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*SearchResourcesInput) SetFilters added in v1.44.225 

func (s *SearchResourcesInput) SetFilters(v *Filters) *SearchResourcesInput

SetFilters sets the Filters field's value.

func (*SearchResourcesInput) SetLimit added in v1.44.225 

func (s *SearchResourcesInput) SetLimit(v int64) *SearchResourcesInput

SetLimit sets the Limit field's value.

func (*SearchResourcesInput) SetMarker added in v1.44.225 

func (s *SearchResourcesInput) SetMarker(v string) *SearchResourcesInput

SetMarker sets the Marker field's value.

func (*SearchResourcesInput) SetOrderBy added in v1.44.225 

func (s *SearchResourcesInput) SetOrderBy(v []*SearchSortResult) *SearchResourcesInput

SetOrderBy sets the OrderBy field's value.

func (*SearchResourcesInput) SetOrganizationId added in v1.44.225 

func (s *SearchResourcesInput) SetOrganizationId(v string) *SearchResourcesInput

SetOrganizationId sets the OrganizationId field's value.

func (*SearchResourcesInput) SetQueryScopes added in v1.44.225 

func (s *SearchResourcesInput) SetQueryScopes(v []*string) *SearchResourcesInput

SetQueryScopes sets the QueryScopes field's value.

func (*SearchResourcesInput) SetQueryText added in v1.44.225 

func (s *SearchResourcesInput) SetQueryText(v string) *SearchResourcesInput

SetQueryText sets the QueryText field's value.

func (SearchResourcesInput) String added in v1.44.225 

func (s SearchResourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchResourcesInput) Validate added in v1.44.225 

func (s *SearchResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchResourcesOutput added in v1.44.225 

type SearchResourcesOutput struct {

	// List of Documents, Folders, Comments, and Document Versions matching the
	// query.
	Items []*ResponseItem `type:"list"`

	// The marker to use when requesting the next set of results. If there are no
	// additional results, the string is empty.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (SearchResourcesOutput) GoString added in v1.44.225 

func (s SearchResourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchResourcesOutput) SetItems added in v1.44.225 

func (s *SearchResourcesOutput) SetItems(v []*ResponseItem) *SearchResourcesOutput

SetItems sets the Items field's value.

func (*SearchResourcesOutput) SetMarker added in v1.44.225 

func (s *SearchResourcesOutput) SetMarker(v string) *SearchResourcesOutput

SetMarker sets the Marker field's value.

func (SearchResourcesOutput) String added in v1.44.225 

func (s SearchResourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchSortResult added in v1.44.225 

type SearchSortResult struct {

	// Sort search results based on this field name.
	Field *string `type:"string" enum:"OrderByFieldType"`

	// Sort direction.
	Order *string `type:"string" enum:"SortOrder"`
	// contains filtered or unexported fields
}

The result of the sort operation.

func (SearchSortResult) GoString added in v1.44.225 

func (s SearchSortResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchSortResult) SetField added in v1.44.225 

func (s *SearchSortResult) SetField(v string) *SearchSortResult

SetField sets the Field field's value.

func (*SearchSortResult) SetOrder added in v1.44.225 

func (s *SearchSortResult) SetOrder(v string) *SearchSortResult

SetOrder sets the Order field's value.

func (SearchSortResult) String added in v1.44.225 

func (s SearchSortResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUnavailableException added in v1.28.0 

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

One or more of the dependencies is unavailable.

func (*ServiceUnavailableException) Code added in v1.28.0 

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0 

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString added in v1.28.0 

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) Message added in v1.28.0 

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0 

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0 

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0 

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.28.0 

func (s ServiceUnavailableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SharePrincipal 

type SharePrincipal struct {

	// The ID of the recipient.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The role of the recipient.
	//
	// Role is a required field
	Role *string `type:"string" required:"true" enum:"RoleType"`

	// The type of the recipient.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"PrincipalType"`
	// contains filtered or unexported fields
}

Describes the recipient type and ID, if available.

func (SharePrincipal) GoString 

func (s SharePrincipal) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SharePrincipal) SetId 

func (s *SharePrincipal) SetId(v string) *SharePrincipal

SetId sets the Id field's value.

func (*SharePrincipal) SetRole 

func (s *SharePrincipal) SetRole(v string) *SharePrincipal

SetRole sets the Role field's value.

func (*SharePrincipal) SetType 

func (s *SharePrincipal) SetType(v string) *SharePrincipal

SetType sets the Type field's value.

func (SharePrincipal) String 

func (s SharePrincipal) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SharePrincipal) Validate 

func (s *SharePrincipal) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ShareResult 

type ShareResult struct {

	// The ID of the invited user.
	InviteePrincipalId *string `min:"1" type:"string"`

	// The ID of the principal.
	PrincipalId *string `min:"1" type:"string"`

	// The role.
	Role *string `type:"string" enum:"RoleType"`

	// The ID of the resource that was shared.
	ShareId *string `min:"1" type:"string"`

	// The status.
	Status *string `type:"string" enum:"ShareStatusType"`

	// The status message.
	//
	// StatusMessage is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ShareResult's
	// String and GoString methods.
	StatusMessage *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Describes the share results of a resource.

func (ShareResult) GoString 

func (s ShareResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ShareResult) SetInviteePrincipalId added in v1.15.79 

func (s *ShareResult) SetInviteePrincipalId(v string) *ShareResult

SetInviteePrincipalId sets the InviteePrincipalId field's value.

func (*ShareResult) SetPrincipalId 

func (s *ShareResult) SetPrincipalId(v string) *ShareResult

SetPrincipalId sets the PrincipalId field's value.

func (*ShareResult) SetRole 

func (s *ShareResult) SetRole(v string) *ShareResult

SetRole sets the Role field's value.

func (*ShareResult) SetShareId 

func (s *ShareResult) SetShareId(v string) *ShareResult

SetShareId sets the ShareId field's value.

func (*ShareResult) SetStatus 

func (s *ShareResult) SetStatus(v string) *ShareResult

SetStatus sets the Status field's value.

func (*ShareResult) SetStatusMessage 

func (s *ShareResult) SetStatusMessage(v string) *ShareResult

SetStatusMessage sets the StatusMessage field's value.

func (ShareResult) String 

func (s ShareResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageLimitExceededException added in v1.28.0 

type StorageLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The storage limit has been exceeded.

func (*StorageLimitExceededException) Code added in v1.28.0 

func (s *StorageLimitExceededException) Code() string

Code returns the exception type name.

func (*StorageLimitExceededException) Error added in v1.28.0 

func (s *StorageLimitExceededException) Error() string

func (StorageLimitExceededException) GoString added in v1.28.0 

func (s StorageLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageLimitExceededException) Message added in v1.28.0 

func (s *StorageLimitExceededException) Message() string

Message returns the exception's message.

func (*StorageLimitExceededException) OrigErr added in v1.28.0 

func (s *StorageLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StorageLimitExceededException) RequestID added in v1.28.0 

func (s *StorageLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StorageLimitExceededException) StatusCode added in v1.28.0 

func (s *StorageLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (StorageLimitExceededException) String added in v1.28.0 

func (s StorageLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageLimitWillExceedException added in v1.28.0 

type StorageLimitWillExceedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The storage limit will be exceeded.

func (*StorageLimitWillExceedException) Code added in v1.28.0 

func (s *StorageLimitWillExceedException) Code() string

Code returns the exception type name.

func (*StorageLimitWillExceedException) Error added in v1.28.0 

func (s *StorageLimitWillExceedException) Error() string

func (StorageLimitWillExceedException) GoString added in v1.28.0 

func (s StorageLimitWillExceedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageLimitWillExceedException) Message added in v1.28.0 

func (s *StorageLimitWillExceedException) Message() string

Message returns the exception's message.

func (*StorageLimitWillExceedException) OrigErr added in v1.28.0 

func (s *StorageLimitWillExceedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StorageLimitWillExceedException) RequestID added in v1.28.0 

func (s *StorageLimitWillExceedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StorageLimitWillExceedException) StatusCode added in v1.28.0 

func (s *StorageLimitWillExceedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (StorageLimitWillExceedException) String added in v1.28.0 

func (s StorageLimitWillExceedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageRuleType 

type StorageRuleType struct {

	// The amount of storage allocated, in bytes.
	StorageAllocatedInBytes *int64 `type:"long"`

	// The type of storage.
	StorageType *string `type:"string" enum:"StorageType"`
	// contains filtered or unexported fields
}

Describes the storage for a user.

func (StorageRuleType) GoString 

func (s StorageRuleType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageRuleType) SetStorageAllocatedInBytes 

func (s *StorageRuleType) SetStorageAllocatedInBytes(v int64) *StorageRuleType

SetStorageAllocatedInBytes sets the StorageAllocatedInBytes field's value.

func (*StorageRuleType) SetStorageType 

func (s *StorageRuleType) SetStorageType(v string) *StorageRuleType

SetStorageType sets the StorageType field's value.

func (StorageRuleType) String 

func (s StorageRuleType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Subscription 

type Subscription struct {

	// The endpoint of the subscription.
	EndPoint *string `min:"1" type:"string"`

	// The protocol of the subscription.
	Protocol *string `type:"string" enum:"SubscriptionProtocolType"`

	// The ID of the subscription.
	SubscriptionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a subscription.

func (Subscription) GoString 

func (s Subscription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Subscription) SetEndPoint 

func (s *Subscription) SetEndPoint(v string) *Subscription

SetEndPoint sets the EndPoint field's value.

func (*Subscription) SetProtocol 

func (s *Subscription) SetProtocol(v string) *Subscription

SetProtocol sets the Protocol field's value.

func (*Subscription) SetSubscriptionId 

func (s *Subscription) SetSubscriptionId(v string) *Subscription

SetSubscriptionId sets the SubscriptionId field's value.

func (Subscription) String 

func (s Subscription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyLabelsException added in v1.28.0 

type TooManyLabelsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*TooManyLabelsException) Code added in v1.28.0 

func (s *TooManyLabelsException) Code() string

Code returns the exception type name.

func (*TooManyLabelsException) Error added in v1.28.0 

func (s *TooManyLabelsException) Error() string

func (TooManyLabelsException) GoString added in v1.28.0 

func (s TooManyLabelsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyLabelsException) Message added in v1.28.0 

func (s *TooManyLabelsException) Message() string

Message returns the exception's message.

func (*TooManyLabelsException) OrigErr added in v1.28.0 

func (s *TooManyLabelsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyLabelsException) RequestID added in v1.28.0 

func (s *TooManyLabelsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyLabelsException) StatusCode added in v1.28.0 

func (s *TooManyLabelsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyLabelsException) String added in v1.28.0 

func (s TooManyLabelsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManySubscriptionsException added in v1.28.0 

type TooManySubscriptionsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*TooManySubscriptionsException) Code added in v1.28.0 

func (s *TooManySubscriptionsException) Code() string

Code returns the exception type name.

func (*TooManySubscriptionsException) Error added in v1.28.0 

func (s *TooManySubscriptionsException) Error() string

func (TooManySubscriptionsException) GoString added in v1.28.0 

func (s TooManySubscriptionsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManySubscriptionsException) Message added in v1.28.0 

func (s *TooManySubscriptionsException) Message() string

Message returns the exception's message.

func (*TooManySubscriptionsException) OrigErr added in v1.28.0 

func (s *TooManySubscriptionsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManySubscriptionsException) RequestID added in v1.28.0 

func (s *TooManySubscriptionsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManySubscriptionsException) StatusCode added in v1.28.0 

func (s *TooManySubscriptionsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManySubscriptionsException) String added in v1.28.0 

func (s TooManySubscriptionsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnauthorizedOperationException added in v1.28.0 

type UnauthorizedOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The operation is not permitted.

func (*UnauthorizedOperationException) Code added in v1.28.0 

func (s *UnauthorizedOperationException) Code() string

Code returns the exception type name.

func (*UnauthorizedOperationException) Error added in v1.28.0 

func (s *UnauthorizedOperationException) Error() string

func (UnauthorizedOperationException) GoString added in v1.28.0 

func (s UnauthorizedOperationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthorizedOperationException) Message added in v1.28.0 

func (s *UnauthorizedOperationException) Message() string

Message returns the exception's message.

func (*UnauthorizedOperationException) OrigErr added in v1.28.0 

func (s *UnauthorizedOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedOperationException) RequestID added in v1.28.0 

func (s *UnauthorizedOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedOperationException) StatusCode added in v1.28.0 

func (s *UnauthorizedOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedOperationException) String added in v1.28.0 

func (s UnauthorizedOperationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnauthorizedResourceAccessException added in v1.28.0 

type UnauthorizedResourceAccessException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*UnauthorizedResourceAccessException) Code added in v1.28.0 

func (s *UnauthorizedResourceAccessException) Code() string

Code returns the exception type name.

func (*UnauthorizedResourceAccessException) Error added in v1.28.0 

func (s *UnauthorizedResourceAccessException) Error() string

func (UnauthorizedResourceAccessException) GoString added in v1.28.0 

func (s UnauthorizedResourceAccessException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthorizedResourceAccessException) Message added in v1.28.0 

func (s *UnauthorizedResourceAccessException) Message() string

Message returns the exception's message.

func (*UnauthorizedResourceAccessException) OrigErr added in v1.28.0 

func (s *UnauthorizedResourceAccessException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedResourceAccessException) RequestID added in v1.28.0 

func (s *UnauthorizedResourceAccessException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedResourceAccessException) StatusCode added in v1.28.0 

func (s *UnauthorizedResourceAccessException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedResourceAccessException) String added in v1.28.0 

func (s UnauthorizedResourceAccessException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDocumentInput 

type UpdateDocumentInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateDocumentInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// The name of the document.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateDocumentInput's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The ID of the parent folder.
	ParentFolderId *string `min:"1" type:"string"`

	// The resource state of the document. Only ACTIVE and RECYCLED are supported.
	ResourceState *string `type:"string" enum:"ResourceStateType"`
	// contains filtered or unexported fields
}

func (UpdateDocumentInput) GoString 

func (s UpdateDocumentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDocumentInput) SetAuthenticationToken added in v1.8.34 

func (s *UpdateDocumentInput) SetAuthenticationToken(v string) *UpdateDocumentInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*UpdateDocumentInput) SetDocumentId 

func (s *UpdateDocumentInput) SetDocumentId(v string) *UpdateDocumentInput

SetDocumentId sets the DocumentId field's value.

func (*UpdateDocumentInput) SetName 

func (s *UpdateDocumentInput) SetName(v string) *UpdateDocumentInput

SetName sets the Name field's value.

func (*UpdateDocumentInput) SetParentFolderId 

func (s *UpdateDocumentInput) SetParentFolderId(v string) *UpdateDocumentInput

SetParentFolderId sets the ParentFolderId field's value.

func (*UpdateDocumentInput) SetResourceState 

func (s *UpdateDocumentInput) SetResourceState(v string) *UpdateDocumentInput

SetResourceState sets the ResourceState field's value.

func (UpdateDocumentInput) String 

func (s UpdateDocumentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDocumentInput) Validate 

func (s *UpdateDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDocumentOutput 

type UpdateDocumentOutput struct {
	// contains filtered or unexported fields
}

func (UpdateDocumentOutput) GoString 

func (s UpdateDocumentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateDocumentOutput) String 

func (s UpdateDocumentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDocumentVersionInput 

type UpdateDocumentVersionInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateDocumentVersionInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the document.
	//
	// DocumentId is a required field
	DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"`

	// The version ID of the document.
	//
	// VersionId is a required field
	VersionId *string `location:"uri" locationName:"VersionId" min:"1" type:"string" required:"true"`

	// The status of the version.
	VersionStatus *string `type:"string" enum:"DocumentVersionStatus"`
	// contains filtered or unexported fields
}

func (UpdateDocumentVersionInput) GoString 

func (s UpdateDocumentVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDocumentVersionInput) SetAuthenticationToken added in v1.8.34 

func (s *UpdateDocumentVersionInput) SetAuthenticationToken(v string) *UpdateDocumentVersionInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*UpdateDocumentVersionInput) SetDocumentId 

func (s *UpdateDocumentVersionInput) SetDocumentId(v string) *UpdateDocumentVersionInput

SetDocumentId sets the DocumentId field's value.

func (*UpdateDocumentVersionInput) SetVersionId 

func (s *UpdateDocumentVersionInput) SetVersionId(v string) *UpdateDocumentVersionInput

SetVersionId sets the VersionId field's value.

func (*UpdateDocumentVersionInput) SetVersionStatus 

func (s *UpdateDocumentVersionInput) SetVersionStatus(v string) *UpdateDocumentVersionInput

SetVersionStatus sets the VersionStatus field's value.

func (UpdateDocumentVersionInput) String 

func (s UpdateDocumentVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDocumentVersionInput) Validate 

func (s *UpdateDocumentVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDocumentVersionOutput 

type UpdateDocumentVersionOutput struct {
	// contains filtered or unexported fields
}

func (UpdateDocumentVersionOutput) GoString 

func (s UpdateDocumentVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateDocumentVersionOutput) String 

func (s UpdateDocumentVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFolderInput 

type UpdateFolderInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateFolderInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The ID of the folder.
	//
	// FolderId is a required field
	FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"`

	// The name of the folder.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateFolderInput's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The ID of the parent folder.
	ParentFolderId *string `min:"1" type:"string"`

	// The resource state of the folder. Only ACTIVE and RECYCLED are accepted values
	// from the API.
	ResourceState *string `type:"string" enum:"ResourceStateType"`
	// contains filtered or unexported fields
}

func (UpdateFolderInput) GoString 

func (s UpdateFolderInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFolderInput) SetAuthenticationToken added in v1.8.34 

func (s *UpdateFolderInput) SetAuthenticationToken(v string) *UpdateFolderInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*UpdateFolderInput) SetFolderId 

func (s *UpdateFolderInput) SetFolderId(v string) *UpdateFolderInput

SetFolderId sets the FolderId field's value.

func (*UpdateFolderInput) SetName 

func (s *UpdateFolderInput) SetName(v string) *UpdateFolderInput

SetName sets the Name field's value.

func (*UpdateFolderInput) SetParentFolderId 

func (s *UpdateFolderInput) SetParentFolderId(v string) *UpdateFolderInput

SetParentFolderId sets the ParentFolderId field's value.

func (*UpdateFolderInput) SetResourceState 

func (s *UpdateFolderInput) SetResourceState(v string) *UpdateFolderInput

SetResourceState sets the ResourceState field's value.

func (UpdateFolderInput) String 

func (s UpdateFolderInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFolderInput) Validate 

func (s *UpdateFolderInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFolderOutput 

type UpdateFolderOutput struct {
	// contains filtered or unexported fields
}

func (UpdateFolderOutput) GoString 

func (s UpdateFolderOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateFolderOutput) String 

func (s UpdateFolderOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateUserInput 

type UpdateUserInput struct {

	// Amazon WorkDocs authentication token. Not required when using Amazon Web
	// Services administrator credentials to access the API.
	//
	// AuthenticationToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateUserInput's
	// String and GoString methods.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

	// The given name of the user.
	//
	// GivenName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateUserInput's
	// String and GoString methods.
	GivenName *string `min:"1" type:"string" sensitive:"true"`

	// Boolean value to determine whether the user is granted Power user privileges.
	GrantPoweruserPrivileges *string `type:"string" enum:"BooleanEnumType"`

	// The locale of the user.
	Locale *string `type:"string" enum:"LocaleType"`

	// The amount of storage for the user.
	StorageRule *StorageRuleType `type:"structure"`

	// The surname of the user.
	//
	// Surname is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateUserInput's
	// String and GoString methods.
	Surname *string `min:"1" type:"string" sensitive:"true"`

	// The time zone ID of the user.
	TimeZoneId *string `min:"1" type:"string"`

	// The type of the user.
	Type *string `type:"string" enum:"UserType"`

	// The ID of the user.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"UserId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserInput) GoString 

func (s UpdateUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateUserInput) SetAuthenticationToken added in v1.8.34 

func (s *UpdateUserInput) SetAuthenticationToken(v string) *UpdateUserInput

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*UpdateUserInput) SetGivenName 

func (s *UpdateUserInput) SetGivenName(v string) *UpdateUserInput

SetGivenName sets the GivenName field's value.

func (*UpdateUserInput) SetGrantPoweruserPrivileges added in v1.12.31 

func (s *UpdateUserInput) SetGrantPoweruserPrivileges(v string) *UpdateUserInput

SetGrantPoweruserPrivileges sets the GrantPoweruserPrivileges field's value.

func (*UpdateUserInput) SetLocale 

func (s *UpdateUserInput) SetLocale(v string) *UpdateUserInput

SetLocale sets the Locale field's value.

func (*UpdateUserInput) SetStorageRule 

func (s *UpdateUserInput) SetStorageRule(v *StorageRuleType) *UpdateUserInput

SetStorageRule sets the StorageRule field's value.

func (*UpdateUserInput) SetSurname 

func (s *UpdateUserInput) SetSurname(v string) *UpdateUserInput

SetSurname sets the Surname field's value.

func (*UpdateUserInput) SetTimeZoneId 

func (s *UpdateUserInput) SetTimeZoneId(v string) *UpdateUserInput

SetTimeZoneId sets the TimeZoneId field's value.

func (*UpdateUserInput) SetType 

func (s *UpdateUserInput) SetType(v string) *UpdateUserInput

SetType sets the Type field's value.

func (*UpdateUserInput) SetUserId 

func (s *UpdateUserInput) SetUserId(v string) *UpdateUserInput

SetUserId sets the UserId field's value.

func (UpdateUserInput) String 

func (s UpdateUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateUserInput) Validate 

func (s *UpdateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateUserOutput 

type UpdateUserOutput struct {

	// The user information.
	User *User `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateUserOutput) GoString 

func (s UpdateUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateUserOutput) SetUser 

func (s *UpdateUserOutput) SetUser(v *User) *UpdateUserOutput

SetUser sets the User field's value.

func (UpdateUserOutput) String 

func (s UpdateUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UploadMetadata 

type UploadMetadata struct {

	// The signed headers.
	SignedHeaders map[string]*string `type:"map"`

	// The URL of the upload.
	//
	// UploadUrl is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UploadMetadata's
	// String and GoString methods.
	UploadUrl *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Describes the upload.

func (UploadMetadata) GoString 

func (s UploadMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UploadMetadata) SetSignedHeaders 

func (s *UploadMetadata) SetSignedHeaders(v map[string]*string) *UploadMetadata

SetSignedHeaders sets the SignedHeaders field's value.

func (*UploadMetadata) SetUploadUrl 

func (s *UploadMetadata) SetUploadUrl(v string) *UploadMetadata

SetUploadUrl sets the UploadUrl field's value.

func (UploadMetadata) String 

func (s UploadMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type User 

type User struct {

	// The time when the user was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The email address of the user.
	//
	// EmailAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by User's
	// String and GoString methods.
	EmailAddress *string `min:"1" type:"string" sensitive:"true"`

	// The given name of the user.
	//
	// GivenName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by User's
	// String and GoString methods.
	GivenName *string `min:"1" type:"string" sensitive:"true"`

	// The ID of the user.
	Id *string `min:"1" type:"string"`

	// The locale of the user.
	Locale *string `type:"string" enum:"LocaleType"`

	// The time when the user was modified.
	ModifiedTimestamp *time.Time `type:"timestamp"`

	// The ID of the organization.
	OrganizationId *string `min:"1" type:"string"`

	// The ID of the recycle bin folder.
	RecycleBinFolderId *string `min:"1" type:"string"`

	// The ID of the root folder.
	RootFolderId *string `min:"1" type:"string"`

	// The status of the user.
	Status *string `type:"string" enum:"UserStatusType"`

	// The storage for the user.
	Storage *UserStorageMetadata `type:"structure"`

	// The surname of the user.
	//
	// Surname is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by User's
	// String and GoString methods.
	Surname *string `min:"1" type:"string" sensitive:"true"`

	// The time zone ID of the user.
	TimeZoneId *string `min:"1" type:"string"`

	// The type of user.
	Type *string `type:"string" enum:"UserType"`

	// The login name of the user.
	//
	// Username is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by User's
	// String and GoString methods.
	Username *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Describes a user.

func (User) GoString 

func (s User) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*User) SetCreatedTimestamp 

func (s *User) SetCreatedTimestamp(v time.Time) *User

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*User) SetEmailAddress 

func (s *User) SetEmailAddress(v string) *User

SetEmailAddress sets the EmailAddress field's value.

func (*User) SetGivenName 

func (s *User) SetGivenName(v string) *User

SetGivenName sets the GivenName field's value.

func (*User) SetId 

func (s *User) SetId(v string) *User

SetId sets the Id field's value.

func (*User) SetLocale 

func (s *User) SetLocale(v string) *User

SetLocale sets the Locale field's value.

func (*User) SetModifiedTimestamp 

func (s *User) SetModifiedTimestamp(v time.Time) *User

SetModifiedTimestamp sets the ModifiedTimestamp field's value.

func (*User) SetOrganizationId 

func (s *User) SetOrganizationId(v string) *User

SetOrganizationId sets the OrganizationId field's value.

func (*User) SetRecycleBinFolderId 

func (s *User) SetRecycleBinFolderId(v string) *User

SetRecycleBinFolderId sets the RecycleBinFolderId field's value.

func (*User) SetRootFolderId 

func (s *User) SetRootFolderId(v string) *User

SetRootFolderId sets the RootFolderId field's value.

func (*User) SetStatus 

func (s *User) SetStatus(v string) *User

SetStatus sets the Status field's value.

func (*User) SetStorage 

func (s *User) SetStorage(v *UserStorageMetadata) *User

SetStorage sets the Storage field's value.

func (*User) SetSurname 

func (s *User) SetSurname(v string) *User

SetSurname sets the Surname field's value.

func (*User) SetTimeZoneId 

func (s *User) SetTimeZoneId(v string) *User

SetTimeZoneId sets the TimeZoneId field's value.

func (*User) SetType 

func (s *User) SetType(v string) *User

SetType sets the Type field's value.

func (*User) SetUsername 

func (s *User) SetUsername(v string) *User

SetUsername sets the Username field's value.

func (User) String 

func (s User) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserMetadata added in v1.10.0 

type UserMetadata struct {

	// The email address of the user.
	//
	// EmailAddress is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UserMetadata's
	// String and GoString methods.
	EmailAddress *string `min:"1" type:"string" sensitive:"true"`

	// The given name of the user before a rename operation.
	//
	// GivenName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UserMetadata's
	// String and GoString methods.
	GivenName *string `min:"1" type:"string" sensitive:"true"`

	// The ID of the user.
	Id *string `min:"1" type:"string"`

	// The surname of the user.
	//
	// Surname is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UserMetadata's
	// String and GoString methods.
	Surname *string `min:"1" type:"string" sensitive:"true"`

	// The name of the user.
	//
	// Username is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UserMetadata's
	// String and GoString methods.
	Username *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Describes the metadata of the user.

func (UserMetadata) GoString added in v1.10.0 

func (s UserMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserMetadata) SetEmailAddress added in v1.10.0 

func (s *UserMetadata) SetEmailAddress(v string) *UserMetadata

SetEmailAddress sets the EmailAddress field's value.

func (*UserMetadata) SetGivenName added in v1.10.0 

func (s *UserMetadata) SetGivenName(v string) *UserMetadata

SetGivenName sets the GivenName field's value.

func (*UserMetadata) SetId added in v1.10.0 

func (s *UserMetadata) SetId(v string) *UserMetadata

SetId sets the Id field's value.

func (*UserMetadata) SetSurname added in v1.10.0 

func (s *UserMetadata) SetSurname(v string) *UserMetadata

SetSurname sets the Surname field's value.

func (*UserMetadata) SetUsername added in v1.10.0 

func (s *UserMetadata) SetUsername(v string) *UserMetadata

SetUsername sets the Username field's value.

func (UserMetadata) String added in v1.10.0 

func (s UserMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserStorageMetadata 

type UserStorageMetadata struct {

	// The storage for a user.
	StorageRule *StorageRuleType `type:"structure"`

	// The amount of storage used, in bytes.
	StorageUtilizedInBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

Describes the storage for a user.

func (UserStorageMetadata) GoString 

func (s UserStorageMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserStorageMetadata) SetStorageRule 

func (s *UserStorageMetadata) SetStorageRule(v *StorageRuleType) *UserStorageMetadata

SetStorageRule sets the StorageRule field's value.

func (*UserStorageMetadata) SetStorageUtilizedInBytes 

func (s *UserStorageMetadata) SetStorageUtilizedInBytes(v int64) *UserStorageMetadata

SetStorageUtilizedInBytes sets the StorageUtilizedInBytes field's value.

func (UserStorageMetadata) String 

func (s UserStorageMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkDocs 

type WorkDocs struct {
	*client.Client
}

WorkDocs provides the API operation methods for making requests to Amazon WorkDocs. See this package's package overview docs for details on the service.

WorkDocs methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *WorkDocs

New creates a new instance of the WorkDocs client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a WorkDocs client from just a session.
svc := workdocs.New(mySession)

// Create a WorkDocs client with additional configuration
svc := workdocs.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*WorkDocs) AbortDocumentVersionUpload 

func (c *WorkDocs) AbortDocumentVersionUpload(input *AbortDocumentVersionUploadInput) (*AbortDocumentVersionUploadOutput, error)

AbortDocumentVersionUpload API operation for Amazon WorkDocs.

Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation AbortDocumentVersionUpload for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • ConcurrentModificationException The resource hierarchy is changing.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AbortDocumentVersionUpload

func (*WorkDocs) AbortDocumentVersionUploadRequest 

func (c *WorkDocs) AbortDocumentVersionUploadRequest(input *AbortDocumentVersionUploadInput) (req *request.Request, output *AbortDocumentVersionUploadOutput)

AbortDocumentVersionUploadRequest generates a "aws/request.Request" representing the client's request for the AbortDocumentVersionUpload operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AbortDocumentVersionUpload for more information on using the AbortDocumentVersionUpload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AbortDocumentVersionUploadRequest method.
req, resp := client.AbortDocumentVersionUploadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AbortDocumentVersionUpload

func (*WorkDocs) AbortDocumentVersionUploadWithContext added in v1.8.0 

func (c *WorkDocs) AbortDocumentVersionUploadWithContext(ctx aws.Context, input *AbortDocumentVersionUploadInput, opts ...request.Option) (*AbortDocumentVersionUploadOutput, error)

AbortDocumentVersionUploadWithContext is the same as AbortDocumentVersionUpload with the addition of the ability to pass a context and additional request options.

See AbortDocumentVersionUpload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) ActivateUser 

func (c *WorkDocs) ActivateUser(input *ActivateUserInput) (*ActivateUserOutput, error)

ActivateUser API operation for Amazon WorkDocs.

Activates the specified user. Only active users can access Amazon WorkDocs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation ActivateUser for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUser

func (*WorkDocs) ActivateUserRequest 

func (c *WorkDocs) ActivateUserRequest(input *ActivateUserInput) (req *request.Request, output *ActivateUserOutput)

ActivateUserRequest generates a "aws/request.Request" representing the client's request for the ActivateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ActivateUser for more information on using the ActivateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ActivateUserRequest method.
req, resp := client.ActivateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUser

func (*WorkDocs) ActivateUserWithContext added in v1.8.0 

func (c *WorkDocs) ActivateUserWithContext(ctx aws.Context, input *ActivateUserInput, opts ...request.Option) (*ActivateUserOutput, error)

ActivateUserWithContext is the same as ActivateUser with the addition of the ability to pass a context and additional request options.

See ActivateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) AddResourcePermissions 

func (c *WorkDocs) AddResourcePermissions(input *AddResourcePermissionsInput) (*AddResourcePermissionsOutput, error)

AddResourcePermissions API operation for Amazon WorkDocs.

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation AddResourcePermissions for usage and error information.

Returned Error Types:

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AddResourcePermissions

func (*WorkDocs) AddResourcePermissionsRequest 

func (c *WorkDocs) AddResourcePermissionsRequest(input *AddResourcePermissionsInput) (req *request.Request, output *AddResourcePermissionsOutput)

AddResourcePermissionsRequest generates a "aws/request.Request" representing the client's request for the AddResourcePermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddResourcePermissions for more information on using the AddResourcePermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AddResourcePermissionsRequest method.
req, resp := client.AddResourcePermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AddResourcePermissions

func (*WorkDocs) AddResourcePermissionsWithContext added in v1.8.0 

func (c *WorkDocs) AddResourcePermissionsWithContext(ctx aws.Context, input *AddResourcePermissionsInput, opts ...request.Option) (*AddResourcePermissionsOutput, error)

AddResourcePermissionsWithContext is the same as AddResourcePermissions with the addition of the ability to pass a context and additional request options.

See AddResourcePermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) CreateComment added in v1.8.34 

func (c *WorkDocs) CreateComment(input *CreateCommentInput) (*CreateCommentOutput, error)

CreateComment API operation for Amazon WorkDocs.

Adds a new comment to the specified document version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation CreateComment for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateComment

func (*WorkDocs) CreateCommentRequest added in v1.8.34 

func (c *WorkDocs) CreateCommentRequest(input *CreateCommentInput) (req *request.Request, output *CreateCommentOutput)

CreateCommentRequest generates a "aws/request.Request" representing the client's request for the CreateComment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateComment for more information on using the CreateComment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateCommentRequest method.
req, resp := client.CreateCommentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateComment

func (*WorkDocs) CreateCommentWithContext added in v1.8.34 

func (c *WorkDocs) CreateCommentWithContext(ctx aws.Context, input *CreateCommentInput, opts ...request.Option) (*CreateCommentOutput, error)

CreateCommentWithContext is the same as CreateComment with the addition of the ability to pass a context and additional request options.

See CreateComment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) CreateCustomMetadata added in v1.8.34 

func (c *WorkDocs) CreateCustomMetadata(input *CreateCustomMetadataInput) (*CreateCustomMetadataOutput, error)

CreateCustomMetadata API operation for Amazon WorkDocs.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation CreateCustomMetadata for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCustomMetadata

func (*WorkDocs) CreateCustomMetadataRequest added in v1.8.34 

func (c *WorkDocs) CreateCustomMetadataRequest(input *CreateCustomMetadataInput) (req *request.Request, output *CreateCustomMetadataOutput)

CreateCustomMetadataRequest generates a "aws/request.Request" representing the client's request for the CreateCustomMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCustomMetadata for more information on using the CreateCustomMetadata API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateCustomMetadataRequest method.
req, resp := client.CreateCustomMetadataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCustomMetadata

func (*WorkDocs) CreateCustomMetadataWithContext added in v1.8.34 

func (c *WorkDocs) CreateCustomMetadataWithContext(ctx aws.Context, input *CreateCustomMetadataInput, opts ...request.Option) (*CreateCustomMetadataOutput, error)

CreateCustomMetadataWithContext is the same as CreateCustomMetadata with the addition of the ability to pass a context and additional request options.

See CreateCustomMetadata for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) CreateFolder 

func (c *WorkDocs) CreateFolder(input *CreateFolderInput) (*CreateFolderOutput, error)

CreateFolder API operation for Amazon WorkDocs.

Creates a folder with the specified name and parent folder.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation CreateFolder for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • EntityAlreadyExistsException The resource already exists.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

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

  • ConcurrentModificationException The resource hierarchy is changing.

  • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateFolder

func (*WorkDocs) CreateFolderRequest 

func (c *WorkDocs) CreateFolderRequest(input *CreateFolderInput) (req *request.Request, output *CreateFolderOutput)

CreateFolderRequest generates a "aws/request.Request" representing the client's request for the CreateFolder operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFolder for more information on using the CreateFolder API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateFolderRequest method.
req, resp := client.CreateFolderRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateFolder

func (*WorkDocs) CreateFolderWithContext added in v1.8.0 

func (c *WorkDocs) CreateFolderWithContext(ctx aws.Context, input *CreateFolderInput, opts ...request.Option) (*CreateFolderOutput, error)

CreateFolderWithContext is the same as CreateFolder with the addition of the ability to pass a context and additional request options.

See CreateFolder for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) CreateLabels added in v1.8.34 

func (c *WorkDocs) CreateLabels(input *CreateLabelsInput) (*CreateLabelsOutput, error)

CreateLabels API operation for Amazon WorkDocs.

Adds the specified list of labels to the given resource (a document or folder)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation CreateLabels for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabels

func (*WorkDocs) CreateLabelsRequest added in v1.8.34 

func (c *WorkDocs) CreateLabelsRequest(input *CreateLabelsInput) (req *request.Request, output *CreateLabelsOutput)

CreateLabelsRequest generates a "aws/request.Request" representing the client's request for the CreateLabels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLabels for more information on using the CreateLabels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateLabelsRequest method.
req, resp := client.CreateLabelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabels

func (*WorkDocs) CreateLabelsWithContext added in v1.8.34 

func (c *WorkDocs) CreateLabelsWithContext(ctx aws.Context, input *CreateLabelsInput, opts ...request.Option) (*CreateLabelsOutput, error)

CreateLabelsWithContext is the same as CreateLabels with the addition of the ability to pass a context and additional request options.

See CreateLabels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) CreateNotificationSubscription 

func (c *WorkDocs) CreateNotificationSubscription(input *CreateNotificationSubscriptionInput) (*CreateNotificationSubscriptionOutput, error)

CreateNotificationSubscription API operation for Amazon WorkDocs.

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

For more information, see Setting up notifications for an IAM user or role (https://docs.aws.amazon.com/workdocs/latest/developerguide/manage-notifications.html) in the Amazon WorkDocs Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation CreateNotificationSubscription for usage and error information.

Returned Error Types:

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

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

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • InvalidArgumentException The pagination marker or limit fields are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateNotificationSubscription

func (*WorkDocs) CreateNotificationSubscriptionRequest 

func (c *WorkDocs) CreateNotificationSubscriptionRequest(input *CreateNotificationSubscriptionInput) (req *request.Request, output *CreateNotificationSubscriptionOutput)

CreateNotificationSubscriptionRequest generates a "aws/request.Request" representing the client's request for the CreateNotificationSubscription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateNotificationSubscription for more information on using the CreateNotificationSubscription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateNotificationSubscriptionRequest method.
req, resp := client.CreateNotificationSubscriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateNotificationSubscription

func (*WorkDocs) CreateNotificationSubscriptionWithContext added in v1.8.0 

func (c *WorkDocs) CreateNotificationSubscriptionWithContext(ctx aws.Context, input *CreateNotificationSubscriptionInput, opts ...request.Option) (*CreateNotificationSubscriptionOutput, error)

CreateNotificationSubscriptionWithContext is the same as CreateNotificationSubscription with the addition of the ability to pass a context and additional request options.

See CreateNotificationSubscription for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) CreateUser 

func (c *WorkDocs) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)

CreateUser API operation for Amazon WorkDocs.

Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation CreateUser for usage and error information.

Returned Error Types:

  • EntityAlreadyExistsException The resource already exists.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUser

func (*WorkDocs) CreateUserRequest 

func (c *WorkDocs) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)

CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateUser for more information on using the CreateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateUserRequest method.
req, resp := client.CreateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUser

func (*WorkDocs) CreateUserWithContext added in v1.8.0 

func (c *WorkDocs) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)

CreateUserWithContext is the same as CreateUser with the addition of the ability to pass a context and additional request options.

See CreateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DeactivateUser 

func (c *WorkDocs) DeactivateUser(input *DeactivateUserInput) (*DeactivateUserOutput, error)

DeactivateUser API operation for Amazon WorkDocs.

Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DeactivateUser for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUser

func (*WorkDocs) DeactivateUserRequest 

func (c *WorkDocs) DeactivateUserRequest(input *DeactivateUserInput) (req *request.Request, output *DeactivateUserOutput)

DeactivateUserRequest generates a "aws/request.Request" representing the client's request for the DeactivateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeactivateUser for more information on using the DeactivateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeactivateUserRequest method.
req, resp := client.DeactivateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUser

func (*WorkDocs) DeactivateUserWithContext added in v1.8.0 

func (c *WorkDocs) DeactivateUserWithContext(ctx aws.Context, input *DeactivateUserInput, opts ...request.Option) (*DeactivateUserOutput, error)

DeactivateUserWithContext is the same as DeactivateUser with the addition of the ability to pass a context and additional request options.

See DeactivateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DeleteComment added in v1.8.34 

func (c *WorkDocs) DeleteComment(input *DeleteCommentInput) (*DeleteCommentOutput, error)

DeleteComment API operation for Amazon WorkDocs.

Deletes the specified comment from the document version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DeleteComment for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteComment

func (*WorkDocs) DeleteCommentRequest added in v1.8.34 

func (c *WorkDocs) DeleteCommentRequest(input *DeleteCommentInput) (req *request.Request, output *DeleteCommentOutput)

DeleteCommentRequest generates a "aws/request.Request" representing the client's request for the DeleteComment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteComment for more information on using the DeleteComment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteCommentRequest method.
req, resp := client.DeleteCommentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteComment

func (*WorkDocs) DeleteCommentWithContext added in v1.8.34 

func (c *WorkDocs) DeleteCommentWithContext(ctx aws.Context, input *DeleteCommentInput, opts ...request.Option) (*DeleteCommentOutput, error)

DeleteCommentWithContext is the same as DeleteComment with the addition of the ability to pass a context and additional request options.

See DeleteComment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DeleteCustomMetadata added in v1.8.34 

func (c *WorkDocs) DeleteCustomMetadata(input *DeleteCustomMetadataInput) (*DeleteCustomMetadataOutput, error)

DeleteCustomMetadata API operation for Amazon WorkDocs.

Deletes custom metadata from the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DeleteCustomMetadata for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCustomMetadata

func (*WorkDocs) DeleteCustomMetadataRequest added in v1.8.34 

func (c *WorkDocs) DeleteCustomMetadataRequest(input *DeleteCustomMetadataInput) (req *request.Request, output *DeleteCustomMetadataOutput)

DeleteCustomMetadataRequest generates a "aws/request.Request" representing the client's request for the DeleteCustomMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCustomMetadata for more information on using the DeleteCustomMetadata API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteCustomMetadataRequest method.
req, resp := client.DeleteCustomMetadataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCustomMetadata

func (*WorkDocs) DeleteCustomMetadataWithContext added in v1.8.34 

func (c *WorkDocs) DeleteCustomMetadataWithContext(ctx aws.Context, input *DeleteCustomMetadataInput, opts ...request.Option) (*DeleteCustomMetadataOutput, error)

DeleteCustomMetadataWithContext is the same as DeleteCustomMetadata with the addition of the ability to pass a context and additional request options.

See DeleteCustomMetadata for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DeleteDocument 

func (c *WorkDocs) DeleteDocument(input *DeleteDocumentInput) (*DeleteDocumentOutput, error)

DeleteDocument API operation for Amazon WorkDocs.

Permanently deletes the specified document and its associated metadata.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DeleteDocument for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

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

  • ConcurrentModificationException The resource hierarchy is changing.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocument

func (*WorkDocs) DeleteDocumentRequest 

func (c *WorkDocs) DeleteDocumentRequest(input *DeleteDocumentInput) (req *request.Request, output *DeleteDocumentOutput)

DeleteDocumentRequest generates a "aws/request.Request" representing the client's request for the DeleteDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDocument for more information on using the DeleteDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteDocumentRequest method.
req, resp := client.DeleteDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocument

func (*WorkDocs) DeleteDocumentVersion added in v1.44.137 

func (c *WorkDocs) DeleteDocumentVersion(input *DeleteDocumentVersionInput) (*DeleteDocumentVersionOutput, error)

DeleteDocumentVersion API operation for Amazon WorkDocs.

Deletes a specific version of a document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DeleteDocumentVersion for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

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

  • ConcurrentModificationException The resource hierarchy is changing.

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

  • FailedDependencyException The 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.

  • InvalidOperationException The operation is invalid.

  • UnauthorizedOperationException The operation is not permitted.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentVersion

func (*WorkDocs) DeleteDocumentVersionRequest added in v1.44.137 

func (c *WorkDocs) DeleteDocumentVersionRequest(input *DeleteDocumentVersionInput) (req *request.Request, output *DeleteDocumentVersionOutput)

DeleteDocumentVersionRequest generates a "aws/request.Request" representing the client's request for the DeleteDocumentVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDocumentVersion for more information on using the DeleteDocumentVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteDocumentVersionRequest method.
req, resp := client.DeleteDocumentVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentVersion

func (*WorkDocs) DeleteDocumentVersionWithContext added in v1.44.137 

func (c *WorkDocs) DeleteDocumentVersionWithContext(ctx aws.Context, input *DeleteDocumentVersionInput, opts ...request.Option) (*DeleteDocumentVersionOutput, error)

DeleteDocumentVersionWithContext is the same as DeleteDocumentVersion with the addition of the ability to pass a context and additional request options.

See DeleteDocumentVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DeleteDocumentWithContext added in v1.8.0 

func (c *WorkDocs) DeleteDocumentWithContext(ctx aws.Context, input *DeleteDocumentInput, opts ...request.Option) (*DeleteDocumentOutput, error)

DeleteDocumentWithContext is the same as DeleteDocument with the addition of the ability to pass a context and additional request options.

See DeleteDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DeleteFolder 

func (c *WorkDocs) DeleteFolder(input *DeleteFolderInput) (*DeleteFolderOutput, error)

DeleteFolder API operation for Amazon WorkDocs.

Permanently deletes the specified folder and its contents.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DeleteFolder for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

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

  • ConcurrentModificationException The resource hierarchy is changing.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolder

func (*WorkDocs) DeleteFolderContents 

func (c *WorkDocs) DeleteFolderContents(input *DeleteFolderContentsInput) (*DeleteFolderContentsOutput, error)

DeleteFolderContents API operation for Amazon WorkDocs.

Deletes the contents of the specified folder.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DeleteFolderContents for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

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

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderContents

func (*WorkDocs) DeleteFolderContentsRequest 

func (c *WorkDocs) DeleteFolderContentsRequest(input *DeleteFolderContentsInput) (req *request.Request, output *DeleteFolderContentsOutput)

DeleteFolderContentsRequest generates a "aws/request.Request" representing the client's request for the DeleteFolderContents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFolderContents for more information on using the DeleteFolderContents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteFolderContentsRequest method.
req, resp := client.DeleteFolderContentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderContents

func (*WorkDocs) DeleteFolderContentsWithContext added in v1.8.0 

func (c *WorkDocs) DeleteFolderContentsWithContext(ctx aws.Context, input *DeleteFolderContentsInput, opts ...request.Option) (*DeleteFolderContentsOutput, error)

DeleteFolderContentsWithContext is the same as DeleteFolderContents with the addition of the ability to pass a context and additional request options.

See DeleteFolderContents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DeleteFolderRequest 

func (c *WorkDocs) DeleteFolderRequest(input *DeleteFolderInput) (req *request.Request, output *DeleteFolderOutput)

DeleteFolderRequest generates a "aws/request.Request" representing the client's request for the DeleteFolder operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFolder for more information on using the DeleteFolder API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteFolderRequest method.
req, resp := client.DeleteFolderRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolder

func (*WorkDocs) DeleteFolderWithContext added in v1.8.0 

func (c *WorkDocs) DeleteFolderWithContext(ctx aws.Context, input *DeleteFolderInput, opts ...request.Option) (*DeleteFolderOutput, error)

DeleteFolderWithContext is the same as DeleteFolder with the addition of the ability to pass a context and additional request options.

See DeleteFolder for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DeleteLabels added in v1.8.34 

func (c *WorkDocs) DeleteLabels(input *DeleteLabelsInput) (*DeleteLabelsOutput, error)

DeleteLabels API operation for Amazon WorkDocs.

Deletes the specified list of labels from a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DeleteLabels for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteLabels

func (*WorkDocs) DeleteLabelsRequest added in v1.8.34 

func (c *WorkDocs) DeleteLabelsRequest(input *DeleteLabelsInput) (req *request.Request, output *DeleteLabelsOutput)

DeleteLabelsRequest generates a "aws/request.Request" representing the client's request for the DeleteLabels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLabels for more information on using the DeleteLabels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteLabelsRequest method.
req, resp := client.DeleteLabelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteLabels

func (*WorkDocs) DeleteLabelsWithContext added in v1.8.34 

func (c *WorkDocs) DeleteLabelsWithContext(ctx aws.Context, input *DeleteLabelsInput, opts ...request.Option) (*DeleteLabelsOutput, error)

DeleteLabelsWithContext is the same as DeleteLabels with the addition of the ability to pass a context and additional request options.

See DeleteLabels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DeleteNotificationSubscription 

func (c *WorkDocs) DeleteNotificationSubscription(input *DeleteNotificationSubscriptionInput) (*DeleteNotificationSubscriptionOutput, error)

DeleteNotificationSubscription API operation for Amazon WorkDocs.

Deletes the specified subscription from the specified organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DeleteNotificationSubscription for usage and error information.

Returned Error Types:

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

  • EntityNotExistsException The resource does not exist.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteNotificationSubscription

func (*WorkDocs) DeleteNotificationSubscriptionRequest 

func (c *WorkDocs) DeleteNotificationSubscriptionRequest(input *DeleteNotificationSubscriptionInput) (req *request.Request, output *DeleteNotificationSubscriptionOutput)

DeleteNotificationSubscriptionRequest generates a "aws/request.Request" representing the client's request for the DeleteNotificationSubscription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteNotificationSubscription for more information on using the DeleteNotificationSubscription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteNotificationSubscriptionRequest method.
req, resp := client.DeleteNotificationSubscriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteNotificationSubscription

func (*WorkDocs) DeleteNotificationSubscriptionWithContext added in v1.8.0 

func (c *WorkDocs) DeleteNotificationSubscriptionWithContext(ctx aws.Context, input *DeleteNotificationSubscriptionInput, opts ...request.Option) (*DeleteNotificationSubscriptionOutput, error)

DeleteNotificationSubscriptionWithContext is the same as DeleteNotificationSubscription with the addition of the ability to pass a context and additional request options.

See DeleteNotificationSubscription for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DeleteUser 

func (c *WorkDocs) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser API operation for Amazon WorkDocs.

Deletes the specified user from a Simple AD or Microsoft AD directory.

Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DeleteUser for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteUser

func (*WorkDocs) DeleteUserRequest 

func (c *WorkDocs) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUser for more information on using the DeleteUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteUserRequest method.
req, resp := client.DeleteUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteUser

func (*WorkDocs) DeleteUserWithContext added in v1.8.0 

func (c *WorkDocs) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.

See DeleteUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeActivities added in v1.10.0 

func (c *WorkDocs) DescribeActivities(input *DescribeActivitiesInput) (*DescribeActivitiesOutput, error)

DescribeActivities API operation for Amazon WorkDocs.

Describes the user activities in a specified time period.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeActivities for usage and error information.

Returned Error Types:

  • UnauthorizedOperationException The operation is not permitted.

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

  • InvalidArgumentException The pagination marker or limit fields are not valid.

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeActivities

func (*WorkDocs) DescribeActivitiesPages added in v1.44.225 

func (c *WorkDocs) DescribeActivitiesPages(input *DescribeActivitiesInput, fn func(*DescribeActivitiesOutput, bool) bool) error

DescribeActivitiesPages iterates over the pages of a DescribeActivities operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeActivities method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeActivities operation.
pageNum := 0
err := client.DescribeActivitiesPages(params,
    func(page *workdocs.DescribeActivitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeActivitiesPagesWithContext added in v1.44.225 

func (c *WorkDocs) DescribeActivitiesPagesWithContext(ctx aws.Context, input *DescribeActivitiesInput, fn func(*DescribeActivitiesOutput, bool) bool, opts ...request.Option) error

DescribeActivitiesPagesWithContext same as DescribeActivitiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeActivitiesRequest added in v1.10.0 

func (c *WorkDocs) DescribeActivitiesRequest(input *DescribeActivitiesInput) (req *request.Request, output *DescribeActivitiesOutput)

DescribeActivitiesRequest generates a "aws/request.Request" representing the client's request for the DescribeActivities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeActivities for more information on using the DescribeActivities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeActivitiesRequest method.
req, resp := client.DescribeActivitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeActivities

func (*WorkDocs) DescribeActivitiesWithContext added in v1.10.0 

func (c *WorkDocs) DescribeActivitiesWithContext(ctx aws.Context, input *DescribeActivitiesInput, opts ...request.Option) (*DescribeActivitiesOutput, error)

DescribeActivitiesWithContext is the same as DescribeActivities with the addition of the ability to pass a context and additional request options.

See DescribeActivities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeComments added in v1.8.34 

func (c *WorkDocs) DescribeComments(input *DescribeCommentsInput) (*DescribeCommentsOutput, error)

DescribeComments API operation for Amazon WorkDocs.

List all the comments for the specified document version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeComments for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeComments

func (*WorkDocs) DescribeCommentsPages added in v1.44.225 

func (c *WorkDocs) DescribeCommentsPages(input *DescribeCommentsInput, fn func(*DescribeCommentsOutput, bool) bool) error

DescribeCommentsPages iterates over the pages of a DescribeComments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeComments method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeComments operation.
pageNum := 0
err := client.DescribeCommentsPages(params,
    func(page *workdocs.DescribeCommentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeCommentsPagesWithContext added in v1.44.225 

func (c *WorkDocs) DescribeCommentsPagesWithContext(ctx aws.Context, input *DescribeCommentsInput, fn func(*DescribeCommentsOutput, bool) bool, opts ...request.Option) error

DescribeCommentsPagesWithContext same as DescribeCommentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeCommentsRequest added in v1.8.34 

func (c *WorkDocs) DescribeCommentsRequest(input *DescribeCommentsInput) (req *request.Request, output *DescribeCommentsOutput)

DescribeCommentsRequest generates a "aws/request.Request" representing the client's request for the DescribeComments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeComments for more information on using the DescribeComments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeCommentsRequest method.
req, resp := client.DescribeCommentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeComments

func (*WorkDocs) DescribeCommentsWithContext added in v1.8.34 

func (c *WorkDocs) DescribeCommentsWithContext(ctx aws.Context, input *DescribeCommentsInput, opts ...request.Option) (*DescribeCommentsOutput, error)

DescribeCommentsWithContext is the same as DescribeComments with the addition of the ability to pass a context and additional request options.

See DescribeComments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeDocumentVersions 

func (c *WorkDocs) DescribeDocumentVersions(input *DescribeDocumentVersionsInput) (*DescribeDocumentVersionsOutput, error)

DescribeDocumentVersions API operation for Amazon WorkDocs.

Retrieves the document versions for the specified document.

By default, only active versions are returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeDocumentVersions for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • InvalidArgumentException The pagination marker or limit fields are not valid.

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

  • InvalidPasswordException The password is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeDocumentVersions

func (*WorkDocs) DescribeDocumentVersionsPages 

func (c *WorkDocs) DescribeDocumentVersionsPages(input *DescribeDocumentVersionsInput, fn func(*DescribeDocumentVersionsOutput, bool) bool) error

DescribeDocumentVersionsPages iterates over the pages of a DescribeDocumentVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDocumentVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeDocumentVersions operation.
pageNum := 0
err := client.DescribeDocumentVersionsPages(params,
    func(page *workdocs.DescribeDocumentVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeDocumentVersionsPagesWithContext added in v1.8.0 

func (c *WorkDocs) DescribeDocumentVersionsPagesWithContext(ctx aws.Context, input *DescribeDocumentVersionsInput, fn func(*DescribeDocumentVersionsOutput, bool) bool, opts ...request.Option) error

DescribeDocumentVersionsPagesWithContext same as DescribeDocumentVersionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeDocumentVersionsRequest 

func (c *WorkDocs) DescribeDocumentVersionsRequest(input *DescribeDocumentVersionsInput) (req *request.Request, output *DescribeDocumentVersionsOutput)

DescribeDocumentVersionsRequest generates a "aws/request.Request" representing the client's request for the DescribeDocumentVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDocumentVersions for more information on using the DescribeDocumentVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeDocumentVersionsRequest method.
req, resp := client.DescribeDocumentVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeDocumentVersions

func (*WorkDocs) DescribeDocumentVersionsWithContext added in v1.8.0 

func (c *WorkDocs) DescribeDocumentVersionsWithContext(ctx aws.Context, input *DescribeDocumentVersionsInput, opts ...request.Option) (*DescribeDocumentVersionsOutput, error)

DescribeDocumentVersionsWithContext is the same as DescribeDocumentVersions with the addition of the ability to pass a context and additional request options.

See DescribeDocumentVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeFolderContents 

func (c *WorkDocs) DescribeFolderContents(input *DescribeFolderContentsInput) (*DescribeFolderContentsOutput, error)

DescribeFolderContents API operation for Amazon WorkDocs.

Describes the contents of the specified folder, including its documents and subfolders.

By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeFolderContents for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

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

  • InvalidArgumentException The pagination marker or limit fields are not valid.

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeFolderContents

func (*WorkDocs) DescribeFolderContentsPages 

func (c *WorkDocs) DescribeFolderContentsPages(input *DescribeFolderContentsInput, fn func(*DescribeFolderContentsOutput, bool) bool) error

DescribeFolderContentsPages iterates over the pages of a DescribeFolderContents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeFolderContents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeFolderContents operation.
pageNum := 0
err := client.DescribeFolderContentsPages(params,
    func(page *workdocs.DescribeFolderContentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeFolderContentsPagesWithContext added in v1.8.0 

func (c *WorkDocs) DescribeFolderContentsPagesWithContext(ctx aws.Context, input *DescribeFolderContentsInput, fn func(*DescribeFolderContentsOutput, bool) bool, opts ...request.Option) error

DescribeFolderContentsPagesWithContext same as DescribeFolderContentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeFolderContentsRequest 

func (c *WorkDocs) DescribeFolderContentsRequest(input *DescribeFolderContentsInput) (req *request.Request, output *DescribeFolderContentsOutput)

DescribeFolderContentsRequest generates a "aws/request.Request" representing the client's request for the DescribeFolderContents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFolderContents for more information on using the DescribeFolderContents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeFolderContentsRequest method.
req, resp := client.DescribeFolderContentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeFolderContents

func (*WorkDocs) DescribeFolderContentsWithContext added in v1.8.0 

func (c *WorkDocs) DescribeFolderContentsWithContext(ctx aws.Context, input *DescribeFolderContentsInput, opts ...request.Option) (*DescribeFolderContentsOutput, error)

DescribeFolderContentsWithContext is the same as DescribeFolderContents with the addition of the ability to pass a context and additional request options.

See DescribeFolderContents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeGroups added in v1.12.31 

func (c *WorkDocs) DescribeGroups(input *DescribeGroupsInput) (*DescribeGroupsOutput, error)

DescribeGroups API operation for Amazon WorkDocs.

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeGroups for usage and error information.

Returned Error Types:

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeGroups

func (*WorkDocs) DescribeGroupsPages added in v1.44.225 

func (c *WorkDocs) DescribeGroupsPages(input *DescribeGroupsInput, fn func(*DescribeGroupsOutput, bool) bool) error

DescribeGroupsPages iterates over the pages of a DescribeGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeGroups operation.
pageNum := 0
err := client.DescribeGroupsPages(params,
    func(page *workdocs.DescribeGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeGroupsPagesWithContext added in v1.44.225 

func (c *WorkDocs) DescribeGroupsPagesWithContext(ctx aws.Context, input *DescribeGroupsInput, fn func(*DescribeGroupsOutput, bool) bool, opts ...request.Option) error

DescribeGroupsPagesWithContext same as DescribeGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeGroupsRequest added in v1.12.31 

func (c *WorkDocs) DescribeGroupsRequest(input *DescribeGroupsInput) (req *request.Request, output *DescribeGroupsOutput)

DescribeGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGroups for more information on using the DescribeGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeGroupsRequest method.
req, resp := client.DescribeGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeGroups

func (*WorkDocs) DescribeGroupsWithContext added in v1.12.31 

func (c *WorkDocs) DescribeGroupsWithContext(ctx aws.Context, input *DescribeGroupsInput, opts ...request.Option) (*DescribeGroupsOutput, error)

DescribeGroupsWithContext is the same as DescribeGroups with the addition of the ability to pass a context and additional request options.

See DescribeGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeNotificationSubscriptions 

func (c *WorkDocs) DescribeNotificationSubscriptions(input *DescribeNotificationSubscriptionsInput) (*DescribeNotificationSubscriptionsOutput, error)

DescribeNotificationSubscriptions API operation for Amazon WorkDocs.

Lists the specified notification subscriptions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeNotificationSubscriptions for usage and error information.

Returned Error Types:

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

  • EntityNotExistsException The resource does not exist.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeNotificationSubscriptions

func (*WorkDocs) DescribeNotificationSubscriptionsPages added in v1.44.225 

func (c *WorkDocs) DescribeNotificationSubscriptionsPages(input *DescribeNotificationSubscriptionsInput, fn func(*DescribeNotificationSubscriptionsOutput, bool) bool) error

DescribeNotificationSubscriptionsPages iterates over the pages of a DescribeNotificationSubscriptions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeNotificationSubscriptions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeNotificationSubscriptions operation.
pageNum := 0
err := client.DescribeNotificationSubscriptionsPages(params,
    func(page *workdocs.DescribeNotificationSubscriptionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeNotificationSubscriptionsPagesWithContext added in v1.44.225 

func (c *WorkDocs) DescribeNotificationSubscriptionsPagesWithContext(ctx aws.Context, input *DescribeNotificationSubscriptionsInput, fn func(*DescribeNotificationSubscriptionsOutput, bool) bool, opts ...request.Option) error

DescribeNotificationSubscriptionsPagesWithContext same as DescribeNotificationSubscriptionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeNotificationSubscriptionsRequest 

func (c *WorkDocs) DescribeNotificationSubscriptionsRequest(input *DescribeNotificationSubscriptionsInput) (req *request.Request, output *DescribeNotificationSubscriptionsOutput)

DescribeNotificationSubscriptionsRequest generates a "aws/request.Request" representing the client's request for the DescribeNotificationSubscriptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeNotificationSubscriptions for more information on using the DescribeNotificationSubscriptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeNotificationSubscriptionsRequest method.
req, resp := client.DescribeNotificationSubscriptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeNotificationSubscriptions

func (*WorkDocs) DescribeNotificationSubscriptionsWithContext added in v1.8.0 

func (c *WorkDocs) DescribeNotificationSubscriptionsWithContext(ctx aws.Context, input *DescribeNotificationSubscriptionsInput, opts ...request.Option) (*DescribeNotificationSubscriptionsOutput, error)

DescribeNotificationSubscriptionsWithContext is the same as DescribeNotificationSubscriptions with the addition of the ability to pass a context and additional request options.

See DescribeNotificationSubscriptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeResourcePermissions 

func (c *WorkDocs) DescribeResourcePermissions(input *DescribeResourcePermissionsInput) (*DescribeResourcePermissionsOutput, error)

DescribeResourcePermissions API operation for Amazon WorkDocs.

Describes the permissions of a specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeResourcePermissions for usage and error information.

Returned Error Types:

  • InvalidArgumentException The pagination marker or limit fields are not valid.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeResourcePermissions

func (*WorkDocs) DescribeResourcePermissionsPages added in v1.44.225 

func (c *WorkDocs) DescribeResourcePermissionsPages(input *DescribeResourcePermissionsInput, fn func(*DescribeResourcePermissionsOutput, bool) bool) error

DescribeResourcePermissionsPages iterates over the pages of a DescribeResourcePermissions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeResourcePermissions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeResourcePermissions operation.
pageNum := 0
err := client.DescribeResourcePermissionsPages(params,
    func(page *workdocs.DescribeResourcePermissionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeResourcePermissionsPagesWithContext added in v1.44.225 

func (c *WorkDocs) DescribeResourcePermissionsPagesWithContext(ctx aws.Context, input *DescribeResourcePermissionsInput, fn func(*DescribeResourcePermissionsOutput, bool) bool, opts ...request.Option) error

DescribeResourcePermissionsPagesWithContext same as DescribeResourcePermissionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeResourcePermissionsRequest 

func (c *WorkDocs) DescribeResourcePermissionsRequest(input *DescribeResourcePermissionsInput) (req *request.Request, output *DescribeResourcePermissionsOutput)

DescribeResourcePermissionsRequest generates a "aws/request.Request" representing the client's request for the DescribeResourcePermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeResourcePermissions for more information on using the DescribeResourcePermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeResourcePermissionsRequest method.
req, resp := client.DescribeResourcePermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeResourcePermissions

func (*WorkDocs) DescribeResourcePermissionsWithContext added in v1.8.0 

func (c *WorkDocs) DescribeResourcePermissionsWithContext(ctx aws.Context, input *DescribeResourcePermissionsInput, opts ...request.Option) (*DescribeResourcePermissionsOutput, error)

DescribeResourcePermissionsWithContext is the same as DescribeResourcePermissions with the addition of the ability to pass a context and additional request options.

See DescribeResourcePermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeRootFolders added in v1.10.0 

func (c *WorkDocs) DescribeRootFolders(input *DescribeRootFoldersInput) (*DescribeRootFoldersOutput, error)

DescribeRootFolders API operation for Amazon WorkDocs.

Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html) in the Amazon WorkDocs Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeRootFolders for usage and error information.

Returned Error Types:

  • UnauthorizedOperationException The operation is not permitted.

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

  • InvalidArgumentException The pagination marker or limit fields are not valid.

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeRootFolders

func (*WorkDocs) DescribeRootFoldersPages added in v1.44.225 

func (c *WorkDocs) DescribeRootFoldersPages(input *DescribeRootFoldersInput, fn func(*DescribeRootFoldersOutput, bool) bool) error

DescribeRootFoldersPages iterates over the pages of a DescribeRootFolders operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeRootFolders method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeRootFolders operation.
pageNum := 0
err := client.DescribeRootFoldersPages(params,
    func(page *workdocs.DescribeRootFoldersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeRootFoldersPagesWithContext added in v1.44.225 

func (c *WorkDocs) DescribeRootFoldersPagesWithContext(ctx aws.Context, input *DescribeRootFoldersInput, fn func(*DescribeRootFoldersOutput, bool) bool, opts ...request.Option) error

DescribeRootFoldersPagesWithContext same as DescribeRootFoldersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeRootFoldersRequest added in v1.10.0 

func (c *WorkDocs) DescribeRootFoldersRequest(input *DescribeRootFoldersInput) (req *request.Request, output *DescribeRootFoldersOutput)

DescribeRootFoldersRequest generates a "aws/request.Request" representing the client's request for the DescribeRootFolders operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRootFolders for more information on using the DescribeRootFolders API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeRootFoldersRequest method.
req, resp := client.DescribeRootFoldersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeRootFolders

func (*WorkDocs) DescribeRootFoldersWithContext added in v1.10.0 

func (c *WorkDocs) DescribeRootFoldersWithContext(ctx aws.Context, input *DescribeRootFoldersInput, opts ...request.Option) (*DescribeRootFoldersOutput, error)

DescribeRootFoldersWithContext is the same as DescribeRootFolders with the addition of the ability to pass a context and additional request options.

See DescribeRootFolders for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeUsers 

func (c *WorkDocs) DescribeUsers(input *DescribeUsersInput) (*DescribeUsersOutput, error)

DescribeUsers API operation for Amazon WorkDocs.

Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeUsers for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • InvalidArgumentException The pagination marker or limit fields are not valid.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeUsers

func (*WorkDocs) DescribeUsersPages 

func (c *WorkDocs) DescribeUsersPages(input *DescribeUsersInput, fn func(*DescribeUsersOutput, bool) bool) error

DescribeUsersPages iterates over the pages of a DescribeUsers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeUsers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeUsers operation.
pageNum := 0
err := client.DescribeUsersPages(params,
    func(page *workdocs.DescribeUsersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeUsersPagesWithContext added in v1.8.0 

func (c *WorkDocs) DescribeUsersPagesWithContext(ctx aws.Context, input *DescribeUsersInput, fn func(*DescribeUsersOutput, bool) bool, opts ...request.Option) error

DescribeUsersPagesWithContext same as DescribeUsersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeUsersRequest 

func (c *WorkDocs) DescribeUsersRequest(input *DescribeUsersInput) (req *request.Request, output *DescribeUsersOutput)

DescribeUsersRequest generates a "aws/request.Request" representing the client's request for the DescribeUsers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUsers for more information on using the DescribeUsers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeUsersRequest method.
req, resp := client.DescribeUsersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeUsers

func (*WorkDocs) DescribeUsersWithContext added in v1.8.0 

func (c *WorkDocs) DescribeUsersWithContext(ctx aws.Context, input *DescribeUsersInput, opts ...request.Option) (*DescribeUsersOutput, error)

DescribeUsersWithContext is the same as DescribeUsers with the addition of the ability to pass a context and additional request options.

See DescribeUsers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) GetCurrentUser added in v1.10.0 

func (c *WorkDocs) GetCurrentUser(input *GetCurrentUserInput) (*GetCurrentUserOutput, error)

GetCurrentUser API operation for Amazon WorkDocs.

Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html) in the Amazon WorkDocs Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation GetCurrentUser for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetCurrentUser

func (*WorkDocs) GetCurrentUserRequest added in v1.10.0 

func (c *WorkDocs) GetCurrentUserRequest(input *GetCurrentUserInput) (req *request.Request, output *GetCurrentUserOutput)

GetCurrentUserRequest generates a "aws/request.Request" representing the client's request for the GetCurrentUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCurrentUser for more information on using the GetCurrentUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetCurrentUserRequest method.
req, resp := client.GetCurrentUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetCurrentUser

func (*WorkDocs) GetCurrentUserWithContext added in v1.10.0 

func (c *WorkDocs) GetCurrentUserWithContext(ctx aws.Context, input *GetCurrentUserInput, opts ...request.Option) (*GetCurrentUserOutput, error)

GetCurrentUserWithContext is the same as GetCurrentUser with the addition of the ability to pass a context and additional request options.

See GetCurrentUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) GetDocument 

func (c *WorkDocs) GetDocument(input *GetDocumentInput) (*GetDocumentOutput, error)

GetDocument API operation for Amazon WorkDocs.

Retrieves details of a document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation GetDocument for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • InvalidArgumentException The pagination marker or limit fields are not valid.

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • InvalidPasswordException The password is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocument

func (*WorkDocs) GetDocumentPath 

func (c *WorkDocs) GetDocumentPath(input *GetDocumentPathInput) (*GetDocumentPathOutput, error)

GetDocumentPath API operation for Amazon WorkDocs.

Retrieves the path information (the hierarchy from the root folder) for the requested document.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation GetDocumentPath for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentPath

func (*WorkDocs) GetDocumentPathRequest 

func (c *WorkDocs) GetDocumentPathRequest(input *GetDocumentPathInput) (req *request.Request, output *GetDocumentPathOutput)

GetDocumentPathRequest generates a "aws/request.Request" representing the client's request for the GetDocumentPath operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDocumentPath for more information on using the GetDocumentPath API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDocumentPathRequest method.
req, resp := client.GetDocumentPathRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentPath

func (*WorkDocs) GetDocumentPathWithContext added in v1.8.0 

func (c *WorkDocs) GetDocumentPathWithContext(ctx aws.Context, input *GetDocumentPathInput, opts ...request.Option) (*GetDocumentPathOutput, error)

GetDocumentPathWithContext is the same as GetDocumentPath with the addition of the ability to pass a context and additional request options.

See GetDocumentPath for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) GetDocumentRequest 

func (c *WorkDocs) GetDocumentRequest(input *GetDocumentInput) (req *request.Request, output *GetDocumentOutput)

GetDocumentRequest generates a "aws/request.Request" representing the client's request for the GetDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDocument for more information on using the GetDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDocumentRequest method.
req, resp := client.GetDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocument

func (*WorkDocs) GetDocumentVersion 

func (c *WorkDocs) GetDocumentVersion(input *GetDocumentVersionInput) (*GetDocumentVersionOutput, error)

GetDocumentVersion API operation for Amazon WorkDocs.

Retrieves version metadata for the specified document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation GetDocumentVersion for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

  • InvalidPasswordException The password is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentVersion

func (*WorkDocs) GetDocumentVersionRequest 

func (c *WorkDocs) GetDocumentVersionRequest(input *GetDocumentVersionInput) (req *request.Request, output *GetDocumentVersionOutput)

GetDocumentVersionRequest generates a "aws/request.Request" representing the client's request for the GetDocumentVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDocumentVersion for more information on using the GetDocumentVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDocumentVersionRequest method.
req, resp := client.GetDocumentVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentVersion

func (*WorkDocs) GetDocumentVersionWithContext added in v1.8.0 

func (c *WorkDocs) GetDocumentVersionWithContext(ctx aws.Context, input *GetDocumentVersionInput, opts ...request.Option) (*GetDocumentVersionOutput, error)

GetDocumentVersionWithContext is the same as GetDocumentVersion with the addition of the ability to pass a context and additional request options.

See GetDocumentVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) GetDocumentWithContext added in v1.8.0 

func (c *WorkDocs) GetDocumentWithContext(ctx aws.Context, input *GetDocumentInput, opts ...request.Option) (*GetDocumentOutput, error)

GetDocumentWithContext is the same as GetDocument with the addition of the ability to pass a context and additional request options.

See GetDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) GetFolder 

func (c *WorkDocs) GetFolder(input *GetFolderInput) (*GetFolderOutput, error)

GetFolder API operation for Amazon WorkDocs.

Retrieves the metadata of the specified folder.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation GetFolder for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • InvalidArgumentException The pagination marker or limit fields are not valid.

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolder

func (*WorkDocs) GetFolderPath 

func (c *WorkDocs) GetFolderPath(input *GetFolderPathInput) (*GetFolderPathOutput, error)

GetFolderPath API operation for Amazon WorkDocs.

Retrieves the path information (the hierarchy from the root folder) for the specified folder.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation GetFolderPath for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderPath

func (*WorkDocs) GetFolderPathRequest 

func (c *WorkDocs) GetFolderPathRequest(input *GetFolderPathInput) (req *request.Request, output *GetFolderPathOutput)

GetFolderPathRequest generates a "aws/request.Request" representing the client's request for the GetFolderPath operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFolderPath for more information on using the GetFolderPath API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetFolderPathRequest method.
req, resp := client.GetFolderPathRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderPath

func (*WorkDocs) GetFolderPathWithContext added in v1.8.0 

func (c *WorkDocs) GetFolderPathWithContext(ctx aws.Context, input *GetFolderPathInput, opts ...request.Option) (*GetFolderPathOutput, error)

GetFolderPathWithContext is the same as GetFolderPath with the addition of the ability to pass a context and additional request options.

See GetFolderPath for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) GetFolderRequest 

func (c *WorkDocs) GetFolderRequest(input *GetFolderInput) (req *request.Request, output *GetFolderOutput)

GetFolderRequest generates a "aws/request.Request" representing the client's request for the GetFolder operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFolder for more information on using the GetFolder API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetFolderRequest method.
req, resp := client.GetFolderRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolder

func (*WorkDocs) GetFolderWithContext added in v1.8.0 

func (c *WorkDocs) GetFolderWithContext(ctx aws.Context, input *GetFolderInput, opts ...request.Option) (*GetFolderOutput, error)

GetFolderWithContext is the same as GetFolder with the addition of the ability to pass a context and additional request options.

See GetFolder for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) GetResources added in v1.15.79 

func (c *WorkDocs) GetResources(input *GetResourcesInput) (*GetResourcesOutput, error)

GetResources API operation for Amazon WorkDocs.

Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation GetResources for usage and error information.

Returned Error Types:

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

  • UnauthorizedOperationException The operation is not permitted.

  • InvalidArgumentException The pagination marker or limit fields are not valid.

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetResources

func (*WorkDocs) GetResourcesRequest added in v1.15.79 

func (c *WorkDocs) GetResourcesRequest(input *GetResourcesInput) (req *request.Request, output *GetResourcesOutput)

GetResourcesRequest generates a "aws/request.Request" representing the client's request for the GetResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetResources for more information on using the GetResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetResourcesRequest method.
req, resp := client.GetResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetResources

func (*WorkDocs) GetResourcesWithContext added in v1.15.79 

func (c *WorkDocs) GetResourcesWithContext(ctx aws.Context, input *GetResourcesInput, opts ...request.Option) (*GetResourcesOutput, error)

GetResourcesWithContext is the same as GetResources with the addition of the ability to pass a context and additional request options.

See GetResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) InitiateDocumentVersionUpload 

func (c *WorkDocs) InitiateDocumentVersionUpload(input *InitiateDocumentVersionUploadInput) (*InitiateDocumentVersionUploadOutput, error)

InitiateDocumentVersionUpload API operation for Amazon WorkDocs.

Creates a new document object and version object.

The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.

To cancel the document upload, call AbortDocumentVersionUpload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation InitiateDocumentVersionUpload for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • EntityAlreadyExistsException The resource already exists.

  • StorageLimitExceededException The storage limit has been exceeded.

  • StorageLimitWillExceedException The storage limit will be exceeded.

  • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • DraftUploadOutOfSyncException 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.

  • ResourceAlreadyCheckedOutException The resource is already checked out.

  • InvalidPasswordException The password is invalid.

  • InvalidArgumentException The pagination marker or limit fields are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/InitiateDocumentVersionUpload

func (*WorkDocs) InitiateDocumentVersionUploadRequest 

func (c *WorkDocs) InitiateDocumentVersionUploadRequest(input *InitiateDocumentVersionUploadInput) (req *request.Request, output *InitiateDocumentVersionUploadOutput)

InitiateDocumentVersionUploadRequest generates a "aws/request.Request" representing the client's request for the InitiateDocumentVersionUpload operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InitiateDocumentVersionUpload for more information on using the InitiateDocumentVersionUpload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the InitiateDocumentVersionUploadRequest method.
req, resp := client.InitiateDocumentVersionUploadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/InitiateDocumentVersionUpload

func (*WorkDocs) InitiateDocumentVersionUploadWithContext added in v1.8.0 

func (c *WorkDocs) InitiateDocumentVersionUploadWithContext(ctx aws.Context, input *InitiateDocumentVersionUploadInput, opts ...request.Option) (*InitiateDocumentVersionUploadOutput, error)

InitiateDocumentVersionUploadWithContext is the same as InitiateDocumentVersionUpload with the addition of the ability to pass a context and additional request options.

See InitiateDocumentVersionUpload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) RemoveAllResourcePermissions 

func (c *WorkDocs) RemoveAllResourcePermissions(input *RemoveAllResourcePermissionsInput) (*RemoveAllResourcePermissionsOutput, error)

RemoveAllResourcePermissions API operation for Amazon WorkDocs.

Removes all the permissions from the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation RemoveAllResourcePermissions for usage and error information.

Returned Error Types:

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveAllResourcePermissions

func (*WorkDocs) RemoveAllResourcePermissionsRequest 

func (c *WorkDocs) RemoveAllResourcePermissionsRequest(input *RemoveAllResourcePermissionsInput) (req *request.Request, output *RemoveAllResourcePermissionsOutput)

RemoveAllResourcePermissionsRequest generates a "aws/request.Request" representing the client's request for the RemoveAllResourcePermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveAllResourcePermissions for more information on using the RemoveAllResourcePermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RemoveAllResourcePermissionsRequest method.
req, resp := client.RemoveAllResourcePermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveAllResourcePermissions

func (*WorkDocs) RemoveAllResourcePermissionsWithContext added in v1.8.0 

func (c *WorkDocs) RemoveAllResourcePermissionsWithContext(ctx aws.Context, input *RemoveAllResourcePermissionsInput, opts ...request.Option) (*RemoveAllResourcePermissionsOutput, error)

RemoveAllResourcePermissionsWithContext is the same as RemoveAllResourcePermissions with the addition of the ability to pass a context and additional request options.

See RemoveAllResourcePermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) RemoveResourcePermission 

func (c *WorkDocs) RemoveResourcePermission(input *RemoveResourcePermissionInput) (*RemoveResourcePermissionOutput, error)

RemoveResourcePermission API operation for Amazon WorkDocs.

Removes the permission for the specified principal from the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation RemoveResourcePermission for usage and error information.

Returned Error Types:

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveResourcePermission

func (*WorkDocs) RemoveResourcePermissionRequest 

func (c *WorkDocs) RemoveResourcePermissionRequest(input *RemoveResourcePermissionInput) (req *request.Request, output *RemoveResourcePermissionOutput)

RemoveResourcePermissionRequest generates a "aws/request.Request" representing the client's request for the RemoveResourcePermission operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveResourcePermission for more information on using the RemoveResourcePermission API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RemoveResourcePermissionRequest method.
req, resp := client.RemoveResourcePermissionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveResourcePermission

func (*WorkDocs) RemoveResourcePermissionWithContext added in v1.8.0 

func (c *WorkDocs) RemoveResourcePermissionWithContext(ctx aws.Context, input *RemoveResourcePermissionInput, opts ...request.Option) (*RemoveResourcePermissionOutput, error)

RemoveResourcePermissionWithContext is the same as RemoveResourcePermission with the addition of the ability to pass a context and additional request options.

See RemoveResourcePermission for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) RestoreDocumentVersions added in v1.44.137 

func (c *WorkDocs) RestoreDocumentVersions(input *RestoreDocumentVersionsInput) (*RestoreDocumentVersionsOutput, error)

RestoreDocumentVersions API operation for Amazon WorkDocs.

Recovers a deleted version of an Amazon WorkDocs document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation RestoreDocumentVersions for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

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

  • ConcurrentModificationException The resource hierarchy is changing.

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

  • FailedDependencyException The 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.

  • InvalidOperationException The operation is invalid.

  • UnauthorizedOperationException The operation is not permitted.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RestoreDocumentVersions

func (*WorkDocs) RestoreDocumentVersionsRequest added in v1.44.137 

func (c *WorkDocs) RestoreDocumentVersionsRequest(input *RestoreDocumentVersionsInput) (req *request.Request, output *RestoreDocumentVersionsOutput)

RestoreDocumentVersionsRequest generates a "aws/request.Request" representing the client's request for the RestoreDocumentVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreDocumentVersions for more information on using the RestoreDocumentVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RestoreDocumentVersionsRequest method.
req, resp := client.RestoreDocumentVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RestoreDocumentVersions

func (*WorkDocs) RestoreDocumentVersionsWithContext added in v1.44.137 

func (c *WorkDocs) RestoreDocumentVersionsWithContext(ctx aws.Context, input *RestoreDocumentVersionsInput, opts ...request.Option) (*RestoreDocumentVersionsOutput, error)

RestoreDocumentVersionsWithContext is the same as RestoreDocumentVersions with the addition of the ability to pass a context and additional request options.

See RestoreDocumentVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) SearchResources added in v1.44.225 

func (c *WorkDocs) SearchResources(input *SearchResourcesInput) (*SearchResourcesOutput, error)

SearchResources API operation for Amazon WorkDocs.

Searches metadata and the content of folders, documents, document versions, and comments.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation SearchResources for usage and error information.

Returned Error Types:

  • InvalidArgumentException The pagination marker or limit fields are not valid.

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

  • UnauthorizedOperationException The operation is not permitted.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/SearchResources

func (*WorkDocs) SearchResourcesPages added in v1.44.225 

func (c *WorkDocs) SearchResourcesPages(input *SearchResourcesInput, fn func(*SearchResourcesOutput, bool) bool) error

SearchResourcesPages iterates over the pages of a SearchResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchResources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a SearchResources operation.
pageNum := 0
err := client.SearchResourcesPages(params,
    func(page *workdocs.SearchResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) SearchResourcesPagesWithContext added in v1.44.225 

func (c *WorkDocs) SearchResourcesPagesWithContext(ctx aws.Context, input *SearchResourcesInput, fn func(*SearchResourcesOutput, bool) bool, opts ...request.Option) error

SearchResourcesPagesWithContext same as SearchResourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) SearchResourcesRequest added in v1.44.225 

func (c *WorkDocs) SearchResourcesRequest(input *SearchResourcesInput) (req *request.Request, output *SearchResourcesOutput)

SearchResourcesRequest generates a "aws/request.Request" representing the client's request for the SearchResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchResources for more information on using the SearchResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchResourcesRequest method.
req, resp := client.SearchResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/SearchResources

func (*WorkDocs) SearchResourcesWithContext added in v1.44.225 

func (c *WorkDocs) SearchResourcesWithContext(ctx aws.Context, input *SearchResourcesInput, opts ...request.Option) (*SearchResourcesOutput, error)

SearchResourcesWithContext is the same as SearchResources with the addition of the ability to pass a context and additional request options.

See SearchResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) UpdateDocument 

func (c *WorkDocs) UpdateDocument(input *UpdateDocumentInput) (*UpdateDocumentOutput, error)

UpdateDocument API operation for Amazon WorkDocs.

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation UpdateDocument for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • EntityAlreadyExistsException The resource already exists.

  • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

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

  • ConcurrentModificationException The resource hierarchy is changing.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocument

func (*WorkDocs) UpdateDocumentRequest 

func (c *WorkDocs) UpdateDocumentRequest(input *UpdateDocumentInput) (req *request.Request, output *UpdateDocumentOutput)

UpdateDocumentRequest generates a "aws/request.Request" representing the client's request for the UpdateDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDocument for more information on using the UpdateDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateDocumentRequest method.
req, resp := client.UpdateDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocument

func (*WorkDocs) UpdateDocumentVersion 

func (c *WorkDocs) UpdateDocumentVersion(input *UpdateDocumentVersionInput) (*UpdateDocumentVersionOutput, error)

UpdateDocumentVersion API operation for Amazon WorkDocs.

Changes the status of the document version to ACTIVE.

Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation UpdateDocumentVersion for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

  • ConcurrentModificationException The resource hierarchy is changing.

  • InvalidOperationException The operation is invalid.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentVersion

func (*WorkDocs) UpdateDocumentVersionRequest 

func (c *WorkDocs) UpdateDocumentVersionRequest(input *UpdateDocumentVersionInput) (req *request.Request, output *UpdateDocumentVersionOutput)

UpdateDocumentVersionRequest generates a "aws/request.Request" representing the client's request for the UpdateDocumentVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDocumentVersion for more information on using the UpdateDocumentVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateDocumentVersionRequest method.
req, resp := client.UpdateDocumentVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentVersion

func (*WorkDocs) UpdateDocumentVersionWithContext added in v1.8.0 

func (c *WorkDocs) UpdateDocumentVersionWithContext(ctx aws.Context, input *UpdateDocumentVersionInput, opts ...request.Option) (*UpdateDocumentVersionOutput, error)

UpdateDocumentVersionWithContext is the same as UpdateDocumentVersion with the addition of the ability to pass a context and additional request options.

See UpdateDocumentVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) UpdateDocumentWithContext added in v1.8.0 

func (c *WorkDocs) UpdateDocumentWithContext(ctx aws.Context, input *UpdateDocumentInput, opts ...request.Option) (*UpdateDocumentOutput, error)

UpdateDocumentWithContext is the same as UpdateDocument with the addition of the ability to pass a context and additional request options.

See UpdateDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) UpdateFolder 

func (c *WorkDocs) UpdateFolder(input *UpdateFolderInput) (*UpdateFolderOutput, error)

UpdateFolder API operation for Amazon WorkDocs.

Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation UpdateFolder for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • EntityAlreadyExistsException The resource already exists.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

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

  • ConcurrentModificationException The resource hierarchy is changing.

  • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.

  • UnauthorizedOperationException The operation is not permitted.

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

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateFolder

func (*WorkDocs) UpdateFolderRequest 

func (c *WorkDocs) UpdateFolderRequest(input *UpdateFolderInput) (req *request.Request, output *UpdateFolderOutput)

UpdateFolderRequest generates a "aws/request.Request" representing the client's request for the UpdateFolder operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFolder for more information on using the UpdateFolder API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateFolderRequest method.
req, resp := client.UpdateFolderRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateFolder

func (*WorkDocs) UpdateFolderWithContext added in v1.8.0 

func (c *WorkDocs) UpdateFolderWithContext(ctx aws.Context, input *UpdateFolderInput, opts ...request.Option) (*UpdateFolderOutput, error)

UpdateFolderWithContext is the same as UpdateFolder with the addition of the ability to pass a context and additional request options.

See UpdateFolder for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) UpdateUser 

func (c *WorkDocs) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error)

UpdateUser API operation for Amazon WorkDocs.

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation UpdateUser for usage and error information.

Returned Error Types:

  • EntityNotExistsException The resource does not exist.

  • UnauthorizedOperationException The operation is not permitted.

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

  • IllegalUserStateException The user is undergoing transfer of ownership.

  • ProhibitedStateException The specified document version is not in the INITIALIZED state.

  • FailedDependencyException The 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.

  • ServiceUnavailableException One or more of the dependencies is unavailable.

  • DeactivatingLastSystemUserException The last user in the organization is being deactivated.

  • InvalidArgumentException The pagination marker or limit fields are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateUser

func (*WorkDocs) UpdateUserRequest 

func (c *WorkDocs) UpdateUserRequest(input *UpdateUserInput) (req *request.Request, output *UpdateUserOutput)

UpdateUserRequest generates a "aws/request.Request" representing the client's request for the UpdateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateUser for more information on using the UpdateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateUserRequest method.
req, resp := client.UpdateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateUser

func (*WorkDocs) UpdateUserWithContext added in v1.8.0 

func (c *WorkDocs) UpdateUserWithContext(ctx aws.Context, input *UpdateUserInput, opts ...request.Option) (*UpdateUserOutput, error)

UpdateUserWithContext is the same as UpdateUser with the addition of the ability to pass a context and additional request options.

See UpdateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Source Files

View all Source files

Directories

Path Synopsis
Package workdocsiface provides an interface to enable mocking the Amazon WorkDocs service client for testing your code.
 Package workdocsiface provides an interface to enable mocking the Amazon WorkDocs service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.