Package workdocs

* 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.

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := workdocs.New(sess)

result, err := svc.AbortDocumentVersionUpload(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("AbortDocumentVersionUpload result:")
fmt.Println(result)

ctx := context.Background()

result, err := svc.AbortDocumentVersionUploadWithContext(ctx, params)

Constants

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

const (
    // CommentVisibilityTypePublic is a CommentVisibilityType enum value
    CommentVisibilityTypePublic = "PUBLIC"

    // CommentVisibilityTypePrivate is a CommentVisibilityType enum value
    CommentVisibilityTypePrivate = "PRIVATE"
)

const (
    // DocumentSourceTypeOriginal is a DocumentSourceType enum value
    DocumentSourceTypeOriginal = "ORIGINAL"

    // DocumentSourceTypeWithComments is a DocumentSourceType enum value
    DocumentSourceTypeWithComments = "WITH_COMMENTS"
)

const (
    // DocumentStatusTypeInitialized is a DocumentStatusType enum value
    DocumentStatusTypeInitialized = "INITIALIZED"

    // DocumentStatusTypeActive is a DocumentStatusType enum value
    DocumentStatusTypeActive = "ACTIVE"
)

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

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

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

const (
    // OrderTypeAscending is a OrderType enum value
    OrderTypeAscending = "ASCENDING"

    // OrderTypeDescending is a OrderType enum value
    OrderTypeDescending = "DESCENDING"
)

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

const (
    // ResourceSortTypeDate is a ResourceSortType enum value
    ResourceSortTypeDate = "DATE"

    // ResourceSortTypeName is a ResourceSortType enum value
    ResourceSortTypeName = "NAME"
)

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

const (
    // RolePermissionTypeDirect is a RolePermissionType enum value
    RolePermissionTypeDirect = "DIRECT"

    // RolePermissionTypeInherited is a RolePermissionType enum value
    RolePermissionTypeInherited = "INHERITED"
)

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

const (
    // ShareStatusTypeSuccess is a ShareStatusType enum value
    ShareStatusTypeSuccess = "SUCCESS"

    // ShareStatusTypeFailure is a ShareStatusType enum value
    ShareStatusTypeFailure = "FAILURE"
)

const (
    // StorageTypeUnlimited is a StorageType enum value
    StorageTypeUnlimited = "UNLIMITED"

    // StorageTypeQuota is a StorageType enum value
    StorageTypeQuota = "QUOTA"
)

const (
    // UserFilterTypeAll is a UserFilterType enum value
    UserFilterTypeAll = "ALL"

    // UserFilterTypeActivePending is a UserFilterType enum value
    UserFilterTypeActivePending = "ACTIVE_PENDING"
)

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

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

const (
    // UserTypeUser is a UserType enum value
    UserTypeUser = "USER"

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

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

Service information constants

const (
    ServiceName = "workdocs"  // Service endpoint prefix API calls made to.
    EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

const (
    // DocumentVersionStatusActive is a DocumentVersionStatus enum value
    DocumentVersionStatusActive = "ACTIVE"
)

const (
    // SubscriptionProtocolTypeHttps is a SubscriptionProtocolType enum value
    SubscriptionProtocolTypeHttps = "HTTPS"
)

const (
    // SubscriptionTypeAll is a SubscriptionType enum value
    SubscriptionTypeAll = "ALL"
)

type AbortDocumentVersionUploadInput ¶

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

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
}

func (AbortDocumentVersionUploadInput) GoString ¶

func (s AbortDocumentVersionUploadInput) GoString() string

GoString returns the string representation

func (*AbortDocumentVersionUploadInput) SetAuthenticationToken ¶

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 ¶

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

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

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 ¶

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

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
}

func (ActivateUserInput) GoString ¶

func (s ActivateUserInput) GoString() string

GoString returns the string representation

func (*ActivateUserInput) SetAuthenticationToken ¶

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 ¶

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

type ActivateUserOutput struct {

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

func (ActivateUserOutput) GoString ¶

func (s ActivateUserOutput) GoString() string

GoString returns the string representation

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 AddResourcePermissionsInput ¶

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

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
}

func (AddResourcePermissionsInput) GoString ¶

func (s AddResourcePermissionsInput) GoString() string

GoString returns the string representation

func (*AddResourcePermissionsInput) SetAuthenticationToken ¶

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 ¶

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

type AddResourcePermissionsOutput struct {

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

func (AddResourcePermissionsOutput) GoString ¶

func (s AddResourcePermissionsOutput) GoString() string

GoString returns the string representation

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 ¶

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

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
}

func (Comment) GoString ¶

func (s Comment) GoString() string

GoString returns the string representation

func (*Comment) SetCommentId ¶

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

SetCommentId sets the CommentId field's value.

func (*Comment) SetContributor ¶

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

SetContributor sets the Contributor field's value.

func (*Comment) SetCreatedTimestamp ¶

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*Comment) SetParentId ¶

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

SetParentId sets the ParentId field's value.

func (*Comment) SetRecipientId ¶

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

SetRecipientId sets the RecipientId field's value.

func (*Comment) SetStatus ¶

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

SetStatus sets the Status field's value.

func (*Comment) SetText ¶

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

SetText sets the Text field's value.

func (*Comment) SetThreadId ¶

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

SetThreadId sets the ThreadId field's value.

func (*Comment) SetVisibility ¶

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

SetVisibility sets the Visibility field's value.

func (Comment) String ¶

func (s Comment) String() string

String returns the string representation

type CreateCommentInput ¶

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

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
}

func (CreateCommentInput) GoString ¶

func (s CreateCommentInput) GoString() string

GoString returns the string representation

func (*CreateCommentInput) SetAuthenticationToken ¶

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateCommentInput) SetDocumentId ¶

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

SetDocumentId sets the DocumentId field's value.

func (*CreateCommentInput) SetNotifyCollaborators ¶

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

SetNotifyCollaborators sets the NotifyCollaborators field's value.

func (*CreateCommentInput) SetParentId ¶

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

SetParentId sets the ParentId field's value.

func (*CreateCommentInput) SetText ¶

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

SetText sets the Text field's value.

func (*CreateCommentInput) SetThreadId ¶

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

SetThreadId sets the ThreadId field's value.

func (*CreateCommentInput) SetVersionId ¶

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

SetVersionId sets the VersionId field's value.

func (*CreateCommentInput) SetVisibility ¶

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

SetVisibility sets the Visibility field's value.

func (CreateCommentInput) String ¶

func (s CreateCommentInput) String() string

String returns the string representation

func (*CreateCommentInput) Validate ¶

func (s *CreateCommentInput) Validate() error

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

type CreateCommentOutput ¶

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

type CreateCommentOutput struct {

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

func (CreateCommentOutput) GoString ¶

func (s CreateCommentOutput) GoString() string

GoString returns the string representation

func (*CreateCommentOutput) SetComment ¶

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

SetComment sets the Comment field's value.

func (CreateCommentOutput) String ¶

func (s CreateCommentOutput) String() string

String returns the string representation

type CreateCustomMetadataInput ¶

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

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
}

func (CreateCustomMetadataInput) GoString ¶

func (s CreateCustomMetadataInput) GoString() string

GoString returns the string representation

func (*CreateCustomMetadataInput) SetAuthenticationToken ¶

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateCustomMetadataInput) SetCustomMetadata ¶

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

SetCustomMetadata sets the CustomMetadata field's value.

func (*CreateCustomMetadataInput) SetResourceId ¶

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

SetResourceId sets the ResourceId field's value.

func (*CreateCustomMetadataInput) SetVersionId ¶

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

SetVersionId sets the VersionId field's value.

func (CreateCustomMetadataInput) String ¶

func (s CreateCustomMetadataInput) String() string

String returns the string representation

func (*CreateCustomMetadataInput) Validate ¶

func (s *CreateCustomMetadataInput) Validate() error

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

type CreateCustomMetadataOutput ¶

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

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

func (CreateCustomMetadataOutput) GoString ¶

func (s CreateCustomMetadataOutput) GoString() string

GoString returns the string representation

func (CreateCustomMetadataOutput) String ¶

func (s CreateCustomMetadataOutput) String() string

String returns the string representation

type CreateFolderInput ¶

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

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
}

func (CreateFolderInput) GoString ¶

func (s CreateFolderInput) GoString() string

GoString returns the string representation

func (*CreateFolderInput) SetAuthenticationToken ¶

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 ¶

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

type CreateFolderOutput struct {

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

func (CreateFolderOutput) GoString ¶

func (s CreateFolderOutput) GoString() string

GoString returns the string representation

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 ¶

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

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
}

func (CreateLabelsInput) GoString ¶

func (s CreateLabelsInput) GoString() string

GoString returns the string representation

func (*CreateLabelsInput) SetAuthenticationToken ¶

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateLabelsInput) SetLabels ¶

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

SetLabels sets the Labels field's value.

func (*CreateLabelsInput) SetResourceId ¶

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

SetResourceId sets the ResourceId field's value.

func (CreateLabelsInput) String ¶

func (s CreateLabelsInput) String() string

String returns the string representation

func (*CreateLabelsInput) Validate ¶

func (s *CreateLabelsInput) Validate() error

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

type CreateLabelsOutput ¶

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

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

func (CreateLabelsOutput) GoString ¶

func (s CreateLabelsOutput) GoString() string

GoString returns the string representation

func (CreateLabelsOutput) String ¶

func (s CreateLabelsOutput) String() string

String returns the string representation

type CreateNotificationSubscriptionInput ¶

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

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
}

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 ¶

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

type CreateNotificationSubscriptionOutput struct {

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

func (CreateNotificationSubscriptionOutput) GoString ¶

func (s CreateNotificationSubscriptionOutput) GoString() string

GoString returns the string representation

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 ¶

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

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
}

func (CreateUserInput) GoString ¶

func (s CreateUserInput) GoString() string

GoString returns the string representation

func (*CreateUserInput) SetAuthenticationToken ¶

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateUserInput) SetEmailAddress ¶

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 ¶

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

type CreateUserOutput struct {

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

func (CreateUserOutput) GoString ¶

func (s CreateUserOutput) GoString() string

GoString returns the string representation

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 ¶

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

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
}

func (DeactivateUserInput) GoString ¶

func (s DeactivateUserInput) GoString() string

GoString returns the string representation

func (*DeactivateUserInput) SetAuthenticationToken ¶

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 ¶

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

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

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 ¶

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

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
}

func (DeleteCommentInput) GoString ¶

func (s DeleteCommentInput) GoString() string

GoString returns the string representation

func (*DeleteCommentInput) SetAuthenticationToken ¶

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteCommentInput) SetCommentId ¶

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

SetCommentId sets the CommentId field's value.

func (*DeleteCommentInput) SetDocumentId ¶

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

SetDocumentId sets the DocumentId field's value.

func (*DeleteCommentInput) SetVersionId ¶

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

SetVersionId sets the VersionId field's value.

func (DeleteCommentInput) String ¶

func (s DeleteCommentInput) String() string

String returns the string representation

func (*DeleteCommentInput) Validate ¶

func (s *DeleteCommentInput) Validate() error

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

type DeleteCommentOutput ¶

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

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

func (DeleteCommentOutput) GoString ¶

func (s DeleteCommentOutput) GoString() string

GoString returns the string representation

func (DeleteCommentOutput) String ¶

func (s DeleteCommentOutput) String() string

String returns the string representation

type DeleteCustomMetadataInput ¶

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

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
}

func (DeleteCustomMetadataInput) GoString ¶

func (s DeleteCustomMetadataInput) GoString() string

GoString returns the string representation

func (*DeleteCustomMetadataInput) SetAuthenticationToken ¶

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteCustomMetadataInput) SetDeleteAll ¶

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

SetDeleteAll sets the DeleteAll field's value.

func (*DeleteCustomMetadataInput) SetKeys ¶

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

SetKeys sets the Keys field's value.

func (*DeleteCustomMetadataInput) SetResourceId ¶

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

SetResourceId sets the ResourceId field's value.

func (*DeleteCustomMetadataInput) SetVersionId ¶

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

SetVersionId sets the VersionId field's value.

func (DeleteCustomMetadataInput) String ¶

func (s DeleteCustomMetadataInput) String() string

String returns the string representation

func (*DeleteCustomMetadataInput) Validate ¶

func (s *DeleteCustomMetadataInput) Validate() error

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

type DeleteCustomMetadataOutput ¶

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

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

func (DeleteCustomMetadataOutput) GoString ¶

func (s DeleteCustomMetadataOutput) GoString() string

GoString returns the string representation

func (DeleteCustomMetadataOutput) String ¶

func (s DeleteCustomMetadataOutput) String() string

String returns the string representation

type DeleteDocumentInput ¶

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

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
}

func (DeleteDocumentInput) GoString ¶

func (s DeleteDocumentInput) GoString() string

GoString returns the string representation

func (*DeleteDocumentInput) SetAuthenticationToken ¶

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 ¶

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

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

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 ¶

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

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
}

func (DeleteFolderContentsInput) GoString ¶

func (s DeleteFolderContentsInput) GoString() string

GoString returns the string representation

func (*DeleteFolderContentsInput) SetAuthenticationToken ¶

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 ¶

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

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

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 ¶

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

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
}

func (DeleteFolderInput) GoString ¶

func (s DeleteFolderInput) GoString() string

GoString returns the string representation

func (*DeleteFolderInput) SetAuthenticationToken ¶

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 ¶

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

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

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 ¶

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

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
}

func (DeleteLabelsInput) GoString ¶

func (s DeleteLabelsInput) GoString() string

GoString returns the string representation

func (*DeleteLabelsInput) SetAuthenticationToken ¶

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteLabelsInput) SetDeleteAll ¶

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

SetDeleteAll sets the DeleteAll field's value.

func (*DeleteLabelsInput) SetLabels ¶

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

SetLabels sets the Labels field's value.

func (*DeleteLabelsInput) SetResourceId ¶

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

SetResourceId sets the ResourceId field's value.

func (DeleteLabelsInput) String ¶

func (s DeleteLabelsInput) String() string

String returns the string representation

func (*DeleteLabelsInput) Validate ¶

func (s *DeleteLabelsInput) Validate() error

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

type DeleteLabelsOutput ¶

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

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

func (DeleteLabelsOutput) GoString ¶

func (s DeleteLabelsOutput) GoString() string

GoString returns the string representation

func (DeleteLabelsOutput) String ¶

func (s DeleteLabelsOutput) String() string

String returns the string representation

type DeleteNotificationSubscriptionInput ¶

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

type DeleteNotificationSubscriptionInput struct {

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

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

func (DeleteNotificationSubscriptionInput) GoString ¶

func (s DeleteNotificationSubscriptionInput) GoString() string

GoString returns the string representation

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 ¶

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

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

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 ¶

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

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
}

func (DeleteUserInput) GoString ¶

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (*DeleteUserInput) SetAuthenticationToken ¶

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 ¶

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

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

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 DescribeCommentsInput ¶

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

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
}

func (DescribeCommentsInput) GoString ¶

func (s DescribeCommentsInput) GoString() string

GoString returns the string representation

func (*DescribeCommentsInput) SetAuthenticationToken ¶

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeCommentsInput) SetDocumentId ¶

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

SetDocumentId sets the DocumentId field's value.

func (*DescribeCommentsInput) SetLimit ¶

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

SetLimit sets the Limit field's value.

func (*DescribeCommentsInput) SetMarker ¶

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

SetMarker sets the Marker field's value.

func (*DescribeCommentsInput) SetVersionId ¶

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

SetVersionId sets the VersionId field's value.

func (DescribeCommentsInput) String ¶

func (s DescribeCommentsInput) String() string

String returns the string representation

func (*DescribeCommentsInput) Validate ¶

func (s *DescribeCommentsInput) Validate() error

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

type DescribeCommentsOutput ¶

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

type DescribeCommentsOutput struct {

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

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

func (DescribeCommentsOutput) GoString ¶

func (s DescribeCommentsOutput) GoString() string

GoString returns the string representation

func (*DescribeCommentsOutput) SetComments ¶

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

SetComments sets the Comments field's value.

func (*DescribeCommentsOutput) SetMarker ¶

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

SetMarker sets the Marker field's value.

func (DescribeCommentsOutput) String ¶

func (s DescribeCommentsOutput) String() string

String returns the string representation

type DescribeDocumentVersionsInput ¶

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

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
}

func (DescribeDocumentVersionsInput) GoString ¶

func (s DescribeDocumentVersionsInput) GoString() string

GoString returns the string representation

func (*DescribeDocumentVersionsInput) SetAuthenticationToken ¶

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 ¶

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

type DescribeDocumentVersionsOutput struct {

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

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

func (DescribeDocumentVersionsOutput) GoString ¶

func (s DescribeDocumentVersionsOutput) GoString() string

GoString returns the string representation

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 ¶

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

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
}

func (DescribeFolderContentsInput) GoString ¶

func (s DescribeFolderContentsInput) GoString() string

GoString returns the string representation

func (*DescribeFolderContentsInput) SetAuthenticationToken ¶

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 ¶

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

type DescribeFolderContentsOutput struct {

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

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

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

func (DescribeFolderContentsOutput) GoString ¶

func (s DescribeFolderContentsOutput) GoString() string

GoString returns the string representation

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 ¶

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

type DescribeNotificationSubscriptionsInput struct {

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

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

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

func (DescribeNotificationSubscriptionsInput) GoString ¶

func (s DescribeNotificationSubscriptionsInput) GoString() string

GoString returns the string representation

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 ¶

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

type DescribeNotificationSubscriptionsOutput struct {

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

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

func (DescribeNotificationSubscriptionsOutput) GoString ¶

func (s DescribeNotificationSubscriptionsOutput) GoString() string

GoString returns the string representation

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 ¶

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

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
}

func (DescribeResourcePermissionsInput) GoString ¶

func (s DescribeResourcePermissionsInput) GoString() string

GoString returns the string representation

func (*DescribeResourcePermissionsInput) SetAuthenticationToken ¶

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 ¶

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

type DescribeResourcePermissionsOutput struct {

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

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

func (DescribeResourcePermissionsOutput) GoString ¶

func (s DescribeResourcePermissionsOutput) GoString() string

GoString returns the string representation

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 DescribeUsersInput ¶

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

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
}

func (DescribeUsersInput) GoString ¶

func (s DescribeUsersInput) GoString() string

GoString returns the string representation

func (*DescribeUsersInput) SetAuthenticationToken ¶

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 ¶

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

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
}

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 ¶

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

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 ¶

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 ¶

Describes a version of a document. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/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
}

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 ¶

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

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

    Size *int64 `type:"long"`
    // contains filtered or unexported fields
}

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 ¶

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

SetLabels sets the Labels field's value.

func (*FolderMetadata) SetLatestVersionSize ¶

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 ¶

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 GetDocumentInput ¶

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

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
}

func (GetDocumentInput) GoString ¶

func (s GetDocumentInput) GoString() string

GoString returns the string representation

func (*GetDocumentInput) SetAuthenticationToken ¶

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 ¶

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 ¶

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

type GetDocumentOutput struct {

    // The custom metadata on the document.
    CustomMetadata map[string]*string `min:"1" type:"map"`

    // The metadata details of the document.
    Metadata *DocumentMetadata `type:"structure"`
    // contains filtered or unexported fields
}

func (GetDocumentOutput) GoString ¶

func (s GetDocumentOutput) GoString() string

GoString returns the string representation

func (*GetDocumentOutput) SetCustomMetadata ¶

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 ¶

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

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
}

func (GetDocumentPathInput) GoString ¶

func (s GetDocumentPathInput) GoString() string

GoString returns the string representation

func (*GetDocumentPathInput) SetAuthenticationToken ¶

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 ¶

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

type GetDocumentPathOutput struct {

    // The path information.
    Path *ResourcePath `type:"structure"`
    // contains filtered or unexported fields
}

func (GetDocumentPathOutput) GoString ¶

func (s GetDocumentPathOutput) GoString() string

GoString returns the string representation

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 ¶

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

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
}

func (GetDocumentVersionInput) GoString ¶

func (s GetDocumentVersionInput) GoString() string

GoString returns the string representation

func (*GetDocumentVersionInput) SetAuthenticationToken ¶

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 ¶

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 ¶

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

type GetDocumentVersionOutput struct {

    // The custom metadata on the document version.
    CustomMetadata map[string]*string `min:"1" type:"map"`

    // The version metadata.
    Metadata *DocumentVersionMetadata `type:"structure"`
    // contains filtered or unexported fields
}

func (GetDocumentVersionOutput) GoString ¶

func (s GetDocumentVersionOutput) GoString() string

GoString returns the string representation

func (*GetDocumentVersionOutput) SetCustomMetadata ¶

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 ¶

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

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
}

func (GetFolderInput) GoString ¶

func (s GetFolderInput) GoString() string

GoString returns the string representation

func (*GetFolderInput) SetAuthenticationToken ¶

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 ¶

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 ¶

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

type GetFolderOutput struct {

    // The custom metadata on the folder.
    CustomMetadata map[string]*string `min:"1" type:"map"`

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

func (GetFolderOutput) GoString ¶

func (s GetFolderOutput) GoString() string

GoString returns the string representation

func (*GetFolderOutput) SetCustomMetadata ¶

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 ¶

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

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
}

func (GetFolderPathInput) GoString ¶

func (s GetFolderPathInput) GoString() string

GoString returns the string representation

func (*GetFolderPathInput) SetAuthenticationToken ¶

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 ¶

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

type GetFolderPathOutput struct {

    // The path information.
    Path *ResourcePath `type:"structure"`
    // contains filtered or unexported fields
}

func (GetFolderPathOutput) GoString ¶

func (s GetFolderPathOutput) GoString() string

GoString returns the string representation

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 InitiateDocumentVersionUploadInput ¶

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

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
}

func (InitiateDocumentVersionUploadInput) GoString ¶

func (s InitiateDocumentVersionUploadInput) GoString() string

GoString returns the string representation

func (*InitiateDocumentVersionUploadInput) SetAuthenticationToken ¶

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 ¶

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

type InitiateDocumentVersionUploadOutput struct {

    // The document metadata.
    Metadata *DocumentMetadata `type:"structure"`

    // The upload metadata.
    UploadMetadata *UploadMetadata `type:"structure"`
    // contains filtered or unexported fields
}

func (InitiateDocumentVersionUploadOutput) GoString ¶

func (s InitiateDocumentVersionUploadOutput) GoString() string

GoString returns the string representation

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 PermissionInfo ¶

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

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 ¶

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

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 ¶

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

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
}

func (RemoveAllResourcePermissionsInput) GoString ¶

func (s RemoveAllResourcePermissionsInput) GoString() string

GoString returns the string representation

func (*RemoveAllResourcePermissionsInput) SetAuthenticationToken ¶

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 ¶

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

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

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 ¶

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

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
}

func (RemoveResourcePermissionInput) GoString ¶

func (s RemoveResourcePermissionInput) GoString() string

GoString returns the string representation

func (*RemoveResourcePermissionInput) SetAuthenticationToken ¶

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 ¶

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

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

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 ResourcePath ¶

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

type ResourcePath struct {

    // The components of the resource path.
    Components []*ResourcePathComponent `type:"list"`
    // contains filtered or unexported fields
}

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 ¶

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

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 ¶

Describes the recipient type and ID, if available. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/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
}

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 ¶

Describes the share results of a resource. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/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
}

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 ¶

Describes the storage for a user. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/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
}

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 ¶

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

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 ¶

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

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
}

func (UpdateDocumentInput) GoString ¶

func (s UpdateDocumentInput) GoString() string

GoString returns the string representation

func (*UpdateDocumentInput) SetAuthenticationToken ¶

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 ¶

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

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

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 ¶

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

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
}

func (UpdateDocumentVersionInput) GoString ¶

func (s UpdateDocumentVersionInput) GoString() string

GoString returns the string representation

func (*UpdateDocumentVersionInput) SetAuthenticationToken ¶

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 ¶

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

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

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 ¶

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

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
}

func (UpdateFolderInput) GoString ¶

func (s UpdateFolderInput) GoString() string

GoString returns the string representation

func (*UpdateFolderInput) SetAuthenticationToken ¶

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 ¶

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

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

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 ¶

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

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
}

func (UpdateUserInput) GoString ¶

func (s UpdateUserInput) GoString() string

GoString returns the string representation

func (*UpdateUserInput) SetAuthenticationToken ¶

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 ¶

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

type UpdateUserOutput struct {

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

func (UpdateUserOutput) GoString ¶

func (s UpdateUserOutput) GoString() string

GoString returns the string representation

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 ¶

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

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 ¶

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

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 UserStorageMetadata ¶

Describes the storage for a user. Please also see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/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
}

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 ¶

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.

type WorkDocs struct {
    *client.Client
}

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 can be used to capture response data after the request's "Send" method is called.

See AbortDocumentVersionUpload for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AbortDocumentVersionUpload method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See ActivateUser for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ActivateUser method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See AddResourcePermissions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddResourcePermissions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 ¶

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See CreateComment for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateComment method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 ¶

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See CreateCustomMetadata for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateCustomMetadata method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See CreateFolder for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateFolder method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 ¶

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See CreateLabels for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateLabels method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See CreateNotificationSubscription for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateNotificationSubscription method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See CreateUser for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateUser method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See DeactivateUser for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeactivateUser method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 ¶

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See DeleteComment for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteComment method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 ¶

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See DeleteCustomMetadata for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteCustomMetadata method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See DeleteDocument for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDocument method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See DeleteFolderContents for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteFolderContents method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See DeleteFolder for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteFolder method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 ¶

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See DeleteLabels for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteLabels method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See DeleteNotificationSubscription for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteNotificationSubscription method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See DeleteUser for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteUser method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See DescribeComments for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeComments method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See DescribeDocumentVersions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeDocumentVersions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See DescribeFolderContents for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeFolderContents method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See DescribeNotificationSubscriptions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeNotificationSubscriptions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See DescribeResourcePermissions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeResourcePermissions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

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 can be used to capture response data after the request's "Send" method is called.

See DescribeUsers for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeUsers method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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) 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 can be used to capture response data after the request's "Send" method is called.

See GetDocumentPath for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocumentPath method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See GetDocument for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocument method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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 can be used to capture response data after the request's "Send" method is called.

See GetDocumentVersion for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocumentVersion method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See GetFolderPath for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetFolderPath method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See GetFolder for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetFolder method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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"

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 can be used to capture response data after the request's "Send" method is called.

See InitiateDocumentVersionUpload for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the InitiateDocumentVersionUpload method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See RemoveAllResourcePermissions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemoveAllResourcePermissions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See RemoveResourcePermission for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemoveResourcePermission method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See UpdateDocument for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDocument method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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 can be used to capture response data after the request's "Send" method is called.

See UpdateDocumentVersion for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDocumentVersion method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 ¶

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 can be used to capture response data after the request's "Send" method is called.

See UpdateFolder for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateFolder method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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 can be used to capture response data after the request's "Send" method is called.

See UpdateUser for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateUser method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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.

Subdirectories