workdocs

package
v1.10.43 Latest Latest
Warning

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

 Go to latest Published: Sep 12, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

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

The 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-premise or off-premise 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 anti-virus or data loss prevention. The APIs, in conjunction with Amazon CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs, so the application can take the necessary actions and replace the target file. The application can also choose to email the user if the target file violates the policy.

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

All Amazon WorkDocs APIs are Amazon authenticated, certificate-signed APIs. They not only require the use of the AWS 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.

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 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"

	// 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 (
	// 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 (
	// 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 (
	// 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 (
	// OrderTypeAscending is a OrderType enum value
	OrderTypeAscending = "ASCENDING"

	// OrderTypeDescending is a OrderType enum value
	OrderTypeDescending = "DESCENDING"
)
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 (
	// 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 (
	// ShareStatusTypeSuccess is a ShareStatusType enum value
	ShareStatusTypeSuccess = "SUCCESS"

	// ShareStatusTypeFailure is a ShareStatusType enum value
	ShareStatusTypeFailure = "FAILURE"
)
View Source 
const (
	// StorageTypeUnlimited is a StorageType enum value
	StorageTypeUnlimited = "UNLIMITED"

	// StorageTypeQuota is a StorageType enum value
	StorageTypeQuota = "QUOTA"
)
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"
)
View Source 
const (

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

	// 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 AWS Directory Service cannot reach an on-premises instance. Or a dependency
	// under the control of the organization is failing, such as a connected active
	// directory.
	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 and/or limit fields are not valid.
	ErrCodeInvalidArgumentException = "InvalidArgumentException"

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

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The maximum of 100,000 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"

	// 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"  // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

View Source 
const (
	// DocumentVersionStatusActive is a DocumentVersionStatus enum value
	DocumentVersionStatusActive = "ACTIVE"
)
View Source 
const (
	// SubscriptionProtocolTypeHttps is a SubscriptionProtocolType enum value
	SubscriptionProtocolTypeHttps = "HTTPS"
)
View Source 
const (
	// SubscriptionTypeAll is a SubscriptionType enum value
	SubscriptionTypeAll = "ALL"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AbortDocumentVersionUploadInput 

type AbortDocumentVersionUploadInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AbortDocumentVersionUploadRequest

func (AbortDocumentVersionUploadInput) GoString 

func (s AbortDocumentVersionUploadInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AbortDocumentVersionUploadOutput

func (AbortDocumentVersionUploadOutput) GoString 

func (s AbortDocumentVersionUploadOutput) GoString() string

GoString returns the string representation

func (AbortDocumentVersionUploadOutput) String 

func (s AbortDocumentVersionUploadOutput) String() string

String returns the string representation

type ActivateUserInput 

type ActivateUserInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUserRequest

func (ActivateUserInput) GoString 

func (s ActivateUserInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUserResponse

func (ActivateUserOutput) GoString 

func (s ActivateUserOutput) GoString() string

GoString returns the string representation

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

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"`

	// 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" timestampFormat:"unix"`

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

Describes the activity information. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Activity

func (Activity) GoString added in v1.10.0 

func (s Activity) GoString() string

GoString returns the string representation

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) 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

type AddResourcePermissionsInput 

type AddResourcePermissionsInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AddResourcePermissionsRequest

func (AddResourcePermissionsInput) GoString 

func (s AddResourcePermissionsInput) GoString() string

GoString returns the string representation

func (*AddResourcePermissionsInput) SetAuthenticationToken added in v1.8.34 

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

SetAuthenticationToken sets the AuthenticationToken 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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AddResourcePermissionsResponse

func (AddResourcePermissionsOutput) GoString 

func (s AddResourcePermissionsOutput) GoString() string

GoString returns the string representation

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

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" timestampFormat:"unix"`

	// 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 *string `min:"1" type:"string"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Comment

func (Comment) GoString added in v1.8.34 

func (s Comment) GoString() string

GoString returns the string representation

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

type CommentMetadata added in v1.10.0 

type CommentMetadata struct {

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

	CommentStatus *string `type:"string" enum:"CommentStatusType"`

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

	CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CommentMetadata

func (CommentMetadata) GoString added in v1.10.0 

func (s CommentMetadata) GoString() string

GoString returns the string representation

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) 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

type CreateCommentInput added in v1.8.34 

type CreateCommentInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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 required field
	Text *string `min:"1" type:"string" required:"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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCommentRequest

func (CreateCommentInput) GoString added in v1.8.34 

func (s CreateCommentInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCommentResponse

func (CreateCommentOutput) GoString added in v1.8.34 

func (s CreateCommentOutput) GoString() string

GoString returns the string representation

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

type CreateCustomMetadataInput added in v1.8.34 

type CreateCustomMetadataInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCustomMetadataRequest

func (CreateCustomMetadataInput) GoString added in v1.8.34 

func (s CreateCustomMetadataInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCustomMetadataResponse

func (CreateCustomMetadataOutput) GoString added in v1.8.34 

func (s CreateCustomMetadataOutput) GoString() string

GoString returns the string representation

func (CreateCustomMetadataOutput) String added in v1.8.34 

func (s CreateCustomMetadataOutput) String() string

String returns the string representation

type CreateFolderInput 

type CreateFolderInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// The name of the new folder.
	Name *string `min:"1" type:"string"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateFolderRequest

func (CreateFolderInput) GoString 

func (s CreateFolderInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateFolderResponse

func (CreateFolderOutput) GoString 

func (s CreateFolderOutput) GoString() string

GoString returns the string representation

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

type CreateLabelsInput added in v1.8.34 

type CreateLabelsInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabelsRequest

func (CreateLabelsInput) GoString added in v1.8.34 

func (s CreateLabelsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabelsResponse

func (CreateLabelsOutput) GoString added in v1.8.34 

func (s CreateLabelsOutput) GoString() string

GoString returns the string representation

func (CreateLabelsOutput) String added in v1.8.34 

func (s CreateLabelsOutput) String() string

String returns the string representation

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
	// messasges 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateNotificationSubscriptionRequest

func (CreateNotificationSubscriptionInput) GoString 

func (s CreateNotificationSubscriptionInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateNotificationSubscriptionResponse

func (CreateNotificationSubscriptionOutput) GoString 

func (s CreateNotificationSubscriptionOutput) GoString() string

GoString returns the string representation

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

type CreateUserInput 

type CreateUserInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// The email address of the user.
	EmailAddress *string `min:"1" type:"string"`

	// The given name of the user.
	//
	// GivenName is a required field
	GivenName *string `min:"1" type:"string" required:"true"`

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

	// The password of the user.
	//
	// Password is a required field
	Password *string `min:"4" type:"string" required:"true"`

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

	// The surname of the user.
	//
	// Surname is a required field
	Surname *string `min:"1" type:"string" required:"true"`

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

	// The login name of the user.
	//
	// Username is a required field
	Username *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUserRequest

func (CreateUserInput) GoString 

func (s CreateUserInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUserResponse

func (CreateUserOutput) GoString 

func (s CreateUserOutput) GoString() string

GoString returns the string representation

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

type DeactivateUserInput 

type DeactivateUserInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUserRequest

func (DeactivateUserInput) GoString 

func (s DeactivateUserInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUserOutput

func (DeactivateUserOutput) GoString 

func (s DeactivateUserOutput) GoString() string

GoString returns the string representation

func (DeactivateUserOutput) String 

func (s DeactivateUserOutput) String() string

String returns the string representation

type DeleteCommentInput added in v1.8.34 

type DeleteCommentInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCommentRequest

func (DeleteCommentInput) GoString added in v1.8.34 

func (s DeleteCommentInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCommentOutput

func (DeleteCommentOutput) GoString added in v1.8.34 

func (s DeleteCommentOutput) GoString() string

GoString returns the string representation

func (DeleteCommentOutput) String added in v1.8.34 

func (s DeleteCommentOutput) String() string

String returns the string representation

type DeleteCustomMetadataInput added in v1.8.34 

type DeleteCustomMetadataInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCustomMetadataRequest

func (DeleteCustomMetadataInput) GoString added in v1.8.34 

func (s DeleteCustomMetadataInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCustomMetadataResponse

func (DeleteCustomMetadataOutput) GoString added in v1.8.34 

func (s DeleteCustomMetadataOutput) GoString() string

GoString returns the string representation

func (DeleteCustomMetadataOutput) String added in v1.8.34 

func (s DeleteCustomMetadataOutput) String() string

String returns the string representation

type DeleteDocumentInput 

type DeleteDocumentInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentRequest

func (DeleteDocumentInput) GoString 

func (s DeleteDocumentInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentOutput

func (DeleteDocumentOutput) GoString 

func (s DeleteDocumentOutput) GoString() string

GoString returns the string representation

func (DeleteDocumentOutput) String 

func (s DeleteDocumentOutput) String() string

String returns the string representation

type DeleteFolderContentsInput 

type DeleteFolderContentsInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" 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"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderContentsRequest

func (DeleteFolderContentsInput) GoString 

func (s DeleteFolderContentsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderContentsOutput

func (DeleteFolderContentsOutput) GoString 

func (s DeleteFolderContentsOutput) GoString() string

GoString returns the string representation

func (DeleteFolderContentsOutput) String 

func (s DeleteFolderContentsOutput) String() string

String returns the string representation

type DeleteFolderInput 

type DeleteFolderInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" 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"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderRequest

func (DeleteFolderInput) GoString 

func (s DeleteFolderInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderOutput

func (DeleteFolderOutput) GoString 

func (s DeleteFolderOutput) GoString() string

GoString returns the string representation

func (DeleteFolderOutput) String 

func (s DeleteFolderOutput) String() string

String returns the string representation

type DeleteLabelsInput added in v1.8.34 

type DeleteLabelsInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteLabelsRequest

func (DeleteLabelsInput) GoString added in v1.8.34 

func (s DeleteLabelsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteLabelsResponse

func (DeleteLabelsOutput) GoString added in v1.8.34 

func (s DeleteLabelsOutput) GoString() string

GoString returns the string representation

func (DeleteLabelsOutput) String added in v1.8.34 

func (s DeleteLabelsOutput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteNotificationSubscriptionRequest

func (DeleteNotificationSubscriptionInput) GoString 

func (s DeleteNotificationSubscriptionInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteNotificationSubscriptionOutput

func (DeleteNotificationSubscriptionOutput) GoString 

func (s DeleteNotificationSubscriptionOutput) GoString() string

GoString returns the string representation

func (DeleteNotificationSubscriptionOutput) String 

func (s DeleteNotificationSubscriptionOutput) String() string

String returns the string representation

type DeleteUserInput 

type DeleteUserInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteUserRequest

func (DeleteUserInput) GoString 

func (s DeleteUserInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteUserOutput

func (DeleteUserOutput) GoString 

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (DeleteUserOutput) String 

func (s DeleteUserOutput) String() string

String returns the string representation

type DescribeActivitiesInput added in v1.10.0 

type DescribeActivitiesInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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" timestampFormat:"unix"`

	// 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 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 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" timestampFormat:"unix"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeActivitiesRequest

func (DescribeActivitiesInput) GoString added in v1.10.0 

func (s DescribeActivitiesInput) GoString() string

GoString returns the string representation

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) 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) 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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeActivitiesResponse

func (DescribeActivitiesOutput) GoString added in v1.10.0 

func (s DescribeActivitiesOutput) GoString() string

GoString returns the string representation

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

type DescribeCommentsInput added in v1.8.34 

type DescribeCommentsInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeCommentsRequest

func (DescribeCommentsInput) GoString added in v1.8.34 

func (s DescribeCommentsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeCommentsResponse

func (DescribeCommentsOutput) GoString added in v1.8.34 

func (s DescribeCommentsOutput) GoString() string

GoString returns the string representation

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

type DescribeDocumentVersionsInput 

type DescribeDocumentVersionsInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeDocumentVersionsRequest

func (DescribeDocumentVersionsInput) GoString 

func (s DescribeDocumentVersionsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeDocumentVersionsResponse

func (DescribeDocumentVersionsOutput) GoString 

func (s DescribeDocumentVersionsOutput) GoString() string

GoString returns the string representation

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

type DescribeFolderContentsInput 

type DescribeFolderContentsInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" 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 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeFolderContentsRequest

func (DescribeFolderContentsInput) GoString 

func (s DescribeFolderContentsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeFolderContentsResponse

func (DescribeFolderContentsOutput) GoString 

func (s DescribeFolderContentsOutput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeNotificationSubscriptionsRequest

func (DescribeNotificationSubscriptionsInput) GoString 

func (s DescribeNotificationSubscriptionsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeNotificationSubscriptionsResponse

func (DescribeNotificationSubscriptionsOutput) GoString 

func (s DescribeNotificationSubscriptionsOutput) GoString() string

GoString returns the string representation

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

type DescribeResourcePermissionsInput 

type DescribeResourcePermissionsInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" 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. (You received this marker from a
	// previous call)
	Marker *string `location:"querystring" locationName:"marker" 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeResourcePermissionsRequest

func (DescribeResourcePermissionsInput) GoString 

func (s DescribeResourcePermissionsInput) GoString() string

GoString returns the string representation

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) 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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeResourcePermissionsResponse

func (DescribeResourcePermissionsOutput) GoString 

func (s DescribeResourcePermissionsOutput) GoString() string

GoString returns the string representation

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

type DescribeRootFoldersInput added in v1.10.0 

type DescribeRootFoldersInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	//
	// AuthenticationToken is a required field
	AuthenticationToken *string `location:"header" locationName:"Authentication" 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. (You received this marker from a
	// previous call.)
	Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeRootFoldersRequest

func (DescribeRootFoldersInput) GoString added in v1.10.0 

func (s DescribeRootFoldersInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeRootFoldersResponse

func (DescribeRootFoldersOutput) GoString added in v1.10.0 

func (s DescribeRootFoldersOutput) GoString() string

GoString returns the string representation

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

type DescribeUsersInput 

type DescribeUsersInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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.
	Query *string `location:"querystring" locationName:"query" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeUsersRequest

func (DescribeUsersInput) GoString 

func (s DescribeUsersInput) GoString() string

GoString returns the string representation

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

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.
	TotalNumberOfUsers *int64 `type:"long"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeUsersResponse

func (DescribeUsersOutput) GoString 

func (s DescribeUsersOutput) GoString() string

GoString returns the string representation

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

type DocumentMetadata 

type DocumentMetadata struct {

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

	// 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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DocumentMetadata

func (DocumentMetadata) GoString 

func (s DocumentMetadata) GoString() string

GoString returns the string representation

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

type DocumentVersionMetadata 

type DocumentVersionMetadata struct {

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

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

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

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

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

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

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

	// The name of the version.
	Name *string `min:"1" type:"string"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DocumentVersionMetadata

func (DocumentVersionMetadata) GoString 

func (s DocumentVersionMetadata) GoString() string

GoString returns the string representation

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

type FolderMetadata 

type FolderMetadata struct {

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

	// 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" timestampFormat:"unix"`

	// The name of the folder.
	Name *string `min:"1" type:"string"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/FolderMetadata

func (FolderMetadata) GoString 

func (s FolderMetadata) GoString() string

GoString returns the string representation

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

type GetCurrentUserInput added in v1.10.0 

type GetCurrentUserInput struct {

	// Amazon WorkDocs authentication token.
	//
	// AuthenticationToken is a required field
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetCurrentUserRequest

func (GetCurrentUserInput) GoString added in v1.10.0 

func (s GetCurrentUserInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetCurrentUserResponse

func (GetCurrentUserOutput) GoString added in v1.10.0 

func (s GetCurrentUserOutput) GoString() string

GoString returns the string representation

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

type GetDocumentInput 

type GetDocumentInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentRequest

func (GetDocumentInput) GoString 

func (s GetDocumentInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentResponse

func (GetDocumentOutput) GoString 

func (s GetDocumentOutput) GoString() string

GoString returns the string representation

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

type GetDocumentPathInput 

type GetDocumentPathInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentPathRequest

func (GetDocumentPathInput) GoString 

func (s GetDocumentPathInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentPathResponse

func (GetDocumentPathOutput) GoString 

func (s GetDocumentPathOutput) GoString() string

GoString returns the string representation

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

type GetDocumentVersionInput 

type GetDocumentVersionInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentVersionRequest

func (GetDocumentVersionInput) GoString 

func (s GetDocumentVersionInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentVersionResponse

func (GetDocumentVersionOutput) GoString 

func (s GetDocumentVersionOutput) GoString() string

GoString returns the string representation

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

type GetFolderInput 

type GetFolderInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" 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"`

	// Set to TRUE to include custom metadata in the response.
	IncludeCustomMetadata *bool `location:"querystring" locationName:"includeCustomMetadata" type:"boolean"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderRequest

func (GetFolderInput) GoString 

func (s GetFolderInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderResponse

func (GetFolderOutput) GoString 

func (s GetFolderOutput) GoString() string

GoString returns the string representation

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

type GetFolderPathInput 

type GetFolderPathInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderPathRequest

func (GetFolderPathInput) GoString 

func (s GetFolderPathInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderPathResponse

func (GetFolderPathOutput) GoString 

func (s GetFolderPathOutput) GoString() string

GoString returns the string representation

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GroupMetadata

func (GroupMetadata) GoString added in v1.10.0 

func (s GroupMetadata) GoString() string

GoString returns the string representation

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

type InitiateDocumentVersionUploadInput 

type InitiateDocumentVersionUploadInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

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

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

	// 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 *string `min:"1" type:"string"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/InitiateDocumentVersionUploadRequest

func (InitiateDocumentVersionUploadInput) GoString 

func (s InitiateDocumentVersionUploadInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/InitiateDocumentVersionUploadResponse

func (InitiateDocumentVersionUploadOutput) GoString 

func (s InitiateDocumentVersionUploadOutput) GoString() string

GoString returns the string representation

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

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 and/or user groups. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Participants

func (Participants) GoString added in v1.10.0 

func (s Participants) GoString() string

GoString returns the string representation

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/PermissionInfo

func (PermissionInfo) GoString 

func (s PermissionInfo) GoString() string

GoString returns the string representation

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Principal

func (Principal) GoString 

func (s Principal) GoString() string

GoString returns the string representation

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

type RemoveAllResourcePermissionsInput 

type RemoveAllResourcePermissionsInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveAllResourcePermissionsRequest

func (RemoveAllResourcePermissionsInput) GoString 

func (s RemoveAllResourcePermissionsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveAllResourcePermissionsOutput

func (RemoveAllResourcePermissionsOutput) GoString 

func (s RemoveAllResourcePermissionsOutput) GoString() string

GoString returns the string representation

func (RemoveAllResourcePermissionsOutput) String 

func (s RemoveAllResourcePermissionsOutput) String() string

String returns the string representation

type RemoveResourcePermissionInput 

type RemoveResourcePermissionInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveResourcePermissionRequest

func (RemoveResourcePermissionInput) GoString 

func (s RemoveResourcePermissionInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveResourcePermissionOutput

func (RemoveResourcePermissionOutput) GoString 

func (s RemoveResourcePermissionOutput) GoString() string

GoString returns the string representation

func (RemoveResourcePermissionOutput) String 

func (s RemoveResourcePermissionOutput) String() string

String returns the string representation

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 *string `min:"1" type:"string"`

	// The original name of the resource prior to a rename operation.
	OriginalName *string `min:"1" type:"string"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ResourceMetadata

func (ResourceMetadata) GoString added in v1.10.0 

func (s ResourceMetadata) GoString() string

GoString returns the string representation

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ResourcePath

func (ResourcePath) GoString 

func (s ResourcePath) GoString() string

GoString returns the string representation

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

type ResourcePathComponent 

type ResourcePathComponent struct {

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

	// The name of the resource path.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the resource path. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ResourcePathComponent

func (ResourcePathComponent) GoString 

func (s ResourcePathComponent) GoString() string

GoString returns the string representation

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/SharePrincipal

func (SharePrincipal) GoString 

func (s SharePrincipal) GoString() string

GoString returns the string representation

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

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

Describes the share results of a resource. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ShareResult

func (ShareResult) GoString 

func (s ShareResult) GoString() string

GoString returns the string representation

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/StorageRuleType

func (StorageRuleType) GoString 

func (s StorageRuleType) GoString() string

GoString returns the string representation

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Subscription

func (Subscription) GoString 

func (s Subscription) GoString() string

GoString returns the string representation

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

type UpdateDocumentInput 

type UpdateDocumentInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

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

	// The resource state of the document. Note that only ACTIVE and RECYCLED are
	// supported.
	ResourceState *string `type:"string" enum:"ResourceStateType"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentRequest

func (UpdateDocumentInput) GoString 

func (s UpdateDocumentInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentOutput

func (UpdateDocumentOutput) GoString 

func (s UpdateDocumentOutput) GoString() string

GoString returns the string representation

func (UpdateDocumentOutput) String 

func (s UpdateDocumentOutput) String() string

String returns the string representation

type UpdateDocumentVersionInput 

type UpdateDocumentVersionInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentVersionRequest

func (UpdateDocumentVersionInput) GoString 

func (s UpdateDocumentVersionInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentVersionOutput

func (UpdateDocumentVersionOutput) GoString 

func (s UpdateDocumentVersionOutput) GoString() string

GoString returns the string representation

func (UpdateDocumentVersionOutput) String 

func (s UpdateDocumentVersionOutput) String() string

String returns the string representation

type UpdateFolderInput 

type UpdateFolderInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" 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 name of the folder.
	Name *string `min:"1" type:"string"`

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

	// The resource state of the folder. Note that only ACTIVE and RECYCLED are
	// accepted values from the API.
	ResourceState *string `type:"string" enum:"ResourceStateType"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateFolderRequest

func (UpdateFolderInput) GoString 

func (s UpdateFolderInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateFolderOutput

func (UpdateFolderOutput) GoString 

func (s UpdateFolderOutput) GoString() string

GoString returns the string representation

func (UpdateFolderOutput) String 

func (s UpdateFolderOutput) String() string

String returns the string representation

type UpdateUserInput 

type UpdateUserInput struct {

	// Amazon WorkDocs authentication token. This field should not be set when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string"`

	// The given name of the user.
	GivenName *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateUserRequest

func (UpdateUserInput) GoString 

func (s UpdateUserInput) GoString() string

GoString returns the string representation

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) 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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateUserResponse

func (UpdateUserOutput) GoString 

func (s UpdateUserOutput) GoString() string

GoString returns the string representation

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

type UploadMetadata 

type UploadMetadata struct {

	// The signed headers.
	SignedHeaders map[string]*string `type:"map"`

	// The URL of the upload.
	UploadUrl *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the upload. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UploadMetadata

func (UploadMetadata) GoString 

func (s UploadMetadata) GoString() string

GoString returns the string representation

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

type User 

type User struct {

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

	// The email address of the user.
	EmailAddress *string `min:"1" type:"string"`

	// The given name of the user.
	GivenName *string `min:"1" type:"string"`

	// 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" timestampFormat:"unix"`

	// 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 *string `min:"1" type:"string"`

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

Describes a user. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/User

func (User) GoString 

func (s User) GoString() string

GoString returns the string representation

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

type UserMetadata added in v1.10.0 

type UserMetadata struct {

	// The email address of the user.
	EmailAddress *string `min:"1" type:"string"`

	// The given name of the user before a rename operation.
	GivenName *string `min:"1" type:"string"`

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

	// The surname of the user.
	Surname *string `min:"1" type:"string"`

	// The username of the user.
	Username *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the metadata of the user. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UserMetadata

func (UserMetadata) GoString added in v1.10.0 

func (s UserMetadata) GoString() string

GoString returns the string representation

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

type UserStorageMetadata 

type UserStorageMetadata struct {

	// The storage for a user.
	StorageRule *StorageRuleType `type:"structure"`

	// The amount of storage utilized, in bytes.
	StorageUtilizedInBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

Describes the storage for a user. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UserStorageMetadata

func (UserStorageMetadata) GoString 

func (s UserStorageMetadata) GoString() string

GoString returns the string representation

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

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: 

// 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

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

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeCustomMetadataLimitExceededException "CustomMetadataLimitExceededException" The limit has been reached on the number of custom properties for the specified resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The resource already exists.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeLimitExceededException "LimitExceededException" The maximum of 100,000 folders under the parent folder has been exceeded.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

  • ErrCodeTooManyLabelsException "TooManyLabelsException" The limit has been reached on the number of labels for the specified resource.

Please also see 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 complets successfuly.

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)
}

Please also see 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 WorkDocs to use Amazon SNS notifications.

The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Confirm the Subscription (http://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.html#SendMessageToHttp.confirm) in the Amazon Simple Notification Service 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 Codes:

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeTooManySubscriptionsException "TooManySubscriptionsException" You've reached the limit on the number of subscriptions for the WorkDocs instance.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The resource already exists.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

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

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" The resource hierarchy is changing.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocument

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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" The resource hierarchy is changing.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

Please also see 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 complets successfuly.

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)
}

Please also see 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.

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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The pagination marker and/or limit fields are not valid.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeActivities

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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeComments

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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The pagination marker and/or limit fields are not valid.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

Please also see 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 *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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The pagination marker and/or limit fields are not valid.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

Please also see 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 *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 complets successfuly.

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)
}

Please also see 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) 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 Codes:

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeNotificationSubscriptions

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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeResourcePermissions

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 complets successfuly.

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)
}

Please also see 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 RecyleBin. RootFolder is the root of user's files and folders and RecyleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

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 Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The pagination marker and/or limit fields are not valid.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeRootFolders

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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The pagination marker and/or limit fields are not valid.

Please also see 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 *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 complets successfuly.

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)
}

Please also see 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.

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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The pagination marker and/or limit fields are not valid.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The pagination marker and/or limit fields are not valid.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 complets successfuly.

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)
}

Please also see 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) 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The resource already exists.

  • ErrCodeStorageLimitExceededException "StorageLimitExceededException" The storage limit has been exceeded.

  • ErrCodeStorageLimitWillExceedException "StorageLimitWillExceedException" The storage limit will be exceeded.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

  • ErrCodeDraftUploadOutOfSyncException "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.

  • ErrCodeResourceAlreadyCheckedOutException "ResourceAlreadyCheckedOutException" The resource is already checked out.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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) 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The resource already exists.

  • ErrCodeLimitExceededException "LimitExceededException" The maximum of 100,000 folders under the parent folder has been exceeded.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" The resource hierarchy is changing.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" The resource hierarchy is changing.

  • ErrCodeInvalidOperationException "InvalidOperationException" The operation is invalid.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The resource already exists.

  • ErrCodeProhibitedStateException "ProhibitedStateException" The specified document version is not in the INITIALIZED state.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" The resource hierarchy is changing.

  • ErrCodeLimitExceededException "LimitExceededException" The maximum of 100,000 folders under the parent folder has been exceeded.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

Please also see 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 complets successfuly.

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)
}

Please also see 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 Codes:

  • ErrCodeEntityNotExistsException "EntityNotExistsException" The resource does not exist.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" The operation is not permitted.

  • ErrCodeUnauthorizedResourceAccessException "UnauthorizedResourceAccessException" The caller does not have access to perform the action on the resource.

  • ErrCodeIllegalUserStateException "IllegalUserStateException" The user is undergoing transfer of ownership.

  • ErrCodeFailedDependencyException "FailedDependencyException" The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected active directory.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" One or more of the dependencies is unavailable.

  • ErrCodeDeactivatingLastSystemUserException "DeactivatingLastSystemUserException" The last user in the organization is being deactivated.

Please also see 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 complets successfuly.

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)
}

Please also see 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.