aws-sdk-go: github.com/aws/aws-sdk-go/service/workdocs Index | Files | Directories

package workdocs

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

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

The WorkDocs API is designed for the following use cases:

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

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

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

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

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

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

Using the Client

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

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

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

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

Index

Package Files

api.go doc.go errors.go service.go

Constants

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // BooleanEnumTypeFalse is a BooleanEnumType enum value
    BooleanEnumTypeFalse = "FALSE"
)
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 (
    // ResourceTypeFolder is a ResourceType enum value
    ResourceTypeFolder = "FOLDER"

    // ResourceTypeDocument is a ResourceType enum value
    ResourceTypeDocument = "DOCUMENT"
)
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"

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

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

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

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

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

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

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

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

    // ErrCodeDraftUploadOutOfSyncException for service response error code
    // "DraftUploadOutOfSyncException".
    //
    // This exception is thrown when a valid checkout ID is not presented on document
    // version upload calls for a document that has been checked out from Web client.
    ErrCodeDraftUploadOutOfSyncException = "DraftUploadOutOfSyncException"

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

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

    // ErrCodeFailedDependencyException for service response error code
    // "FailedDependencyException".
    //
    // The 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 or limit fields are not valid.
    ErrCodeInvalidArgumentException = "InvalidArgumentException"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Service information constants

const (
    // DocumentVersionStatusActive is a DocumentVersionStatus enum value
    DocumentVersionStatusActive = "ACTIVE"
)
const (
    // ResourceCollectionTypeSharedWithMe is a ResourceCollectionType enum value
    ResourceCollectionTypeSharedWithMe = "SHARED_WITH_ME"
)
const (
    // SubscriptionProtocolTypeHttps is a SubscriptionProtocolType enum value
    SubscriptionProtocolTypeHttps = "HTTPS"
)
const (
    // SubscriptionTypeAll is a SubscriptionType enum value
    SubscriptionTypeAll = "ALL"
)

type AbortDocumentVersionUploadInput Uses

type AbortDocumentVersionUploadInput struct {

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

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

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

func (AbortDocumentVersionUploadInput) GoString Uses

func (s AbortDocumentVersionUploadInput) GoString() string

GoString returns the string representation

func (*AbortDocumentVersionUploadInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*AbortDocumentVersionUploadInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (*AbortDocumentVersionUploadInput) SetVersionId Uses

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

SetVersionId sets the VersionId field's value.

func (AbortDocumentVersionUploadInput) String Uses

func (s AbortDocumentVersionUploadInput) String() string

String returns the string representation

func (*AbortDocumentVersionUploadInput) Validate Uses

func (s *AbortDocumentVersionUploadInput) Validate() error

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

type AbortDocumentVersionUploadOutput Uses

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

func (AbortDocumentVersionUploadOutput) GoString Uses

func (s AbortDocumentVersionUploadOutput) GoString() string

GoString returns the string representation

func (AbortDocumentVersionUploadOutput) String Uses

func (s AbortDocumentVersionUploadOutput) String() string

String returns the string representation

type ActivateUserInput Uses

type ActivateUserInput struct {

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

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

func (ActivateUserInput) GoString Uses

func (s ActivateUserInput) GoString() string

GoString returns the string representation

func (*ActivateUserInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*ActivateUserInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (ActivateUserInput) String Uses

func (s ActivateUserInput) String() string

String returns the string representation

func (*ActivateUserInput) Validate Uses

func (s *ActivateUserInput) Validate() error

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

type ActivateUserOutput Uses

type ActivateUserOutput struct {

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

func (ActivateUserOutput) GoString Uses

func (s ActivateUserOutput) GoString() string

GoString returns the string representation

func (*ActivateUserOutput) SetUser Uses

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

SetUser sets the User field's value.

func (ActivateUserOutput) String Uses

func (s ActivateUserOutput) String() string

String returns the string representation

type Activity Uses

type Activity struct {

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

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

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

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

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

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

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

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

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

Describes the activity information.

func (Activity) GoString Uses

func (s Activity) GoString() string

GoString returns the string representation

func (*Activity) SetCommentMetadata Uses

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

SetCommentMetadata sets the CommentMetadata field's value.

func (*Activity) SetInitiator Uses

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

SetInitiator sets the Initiator field's value.

func (*Activity) SetIsIndirectActivity Uses

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

SetIsIndirectActivity sets the IsIndirectActivity field's value.

func (*Activity) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*Activity) SetOriginalParent Uses

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

SetOriginalParent sets the OriginalParent field's value.

func (*Activity) SetParticipants Uses

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

SetParticipants sets the Participants field's value.

func (*Activity) SetResourceMetadata Uses

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

SetResourceMetadata sets the ResourceMetadata field's value.

func (*Activity) SetTimeStamp Uses

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

SetTimeStamp sets the TimeStamp field's value.

func (*Activity) SetType Uses

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

SetType sets the Type field's value.

func (Activity) String Uses

func (s Activity) String() string

String returns the string representation

type AddResourcePermissionsInput Uses

type AddResourcePermissionsInput struct {

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

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

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

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

func (AddResourcePermissionsInput) GoString Uses

func (s AddResourcePermissionsInput) GoString() string

GoString returns the string representation

func (*AddResourcePermissionsInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*AddResourcePermissionsInput) SetNotificationOptions Uses

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

SetNotificationOptions sets the NotificationOptions field's value.

func (*AddResourcePermissionsInput) SetPrincipals Uses

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

SetPrincipals sets the Principals field's value.

func (*AddResourcePermissionsInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (AddResourcePermissionsInput) String Uses

func (s AddResourcePermissionsInput) String() string

String returns the string representation

func (*AddResourcePermissionsInput) Validate Uses

func (s *AddResourcePermissionsInput) Validate() error

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

type AddResourcePermissionsOutput Uses

type AddResourcePermissionsOutput struct {

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

func (AddResourcePermissionsOutput) GoString Uses

func (s AddResourcePermissionsOutput) GoString() string

GoString returns the string representation

func (*AddResourcePermissionsOutput) SetShareResults Uses

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

SetShareResults sets the ShareResults field's value.

func (AddResourcePermissionsOutput) String Uses

func (s AddResourcePermissionsOutput) String() string

String returns the string representation

type Comment Uses

type Comment struct {

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

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

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

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

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

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

    // The text of the comment.
    Text *string `min:"1" type:"string" sensitive:"true"`

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

    // The visibility of the comment. Options are either PRIVATE, where the comment
    // is visible only to the comment author and document owner and co-owners, or
    // PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
    Visibility *string `type:"string" enum:"CommentVisibilityType"`
    // contains filtered or unexported fields
}

Describes a comment.

func (Comment) GoString Uses

func (s Comment) GoString() string

GoString returns the string representation

func (*Comment) SetCommentId Uses

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

SetCommentId sets the CommentId field's value.

func (*Comment) SetContributor Uses

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

SetContributor sets the Contributor field's value.

func (*Comment) SetCreatedTimestamp Uses

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*Comment) SetParentId Uses

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

SetParentId sets the ParentId field's value.

func (*Comment) SetRecipientId Uses

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

SetRecipientId sets the RecipientId field's value.

func (*Comment) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*Comment) SetText Uses

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

SetText sets the Text field's value.

func (*Comment) SetThreadId Uses

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

SetThreadId sets the ThreadId field's value.

func (*Comment) SetVisibility Uses

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

SetVisibility sets the Visibility field's value.

func (Comment) String Uses

func (s Comment) String() string

String returns the string representation

type CommentMetadata Uses

type CommentMetadata struct {

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

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

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

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

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

Describes the metadata of a comment.

func (CommentMetadata) GoString Uses

func (s CommentMetadata) GoString() string

GoString returns the string representation

func (*CommentMetadata) SetCommentId Uses

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

SetCommentId sets the CommentId field's value.

func (*CommentMetadata) SetCommentStatus Uses

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

SetCommentStatus sets the CommentStatus field's value.

func (*CommentMetadata) SetContributor Uses

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

SetContributor sets the Contributor field's value.

func (*CommentMetadata) SetCreatedTimestamp Uses

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*CommentMetadata) SetRecipientId Uses

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

SetRecipientId sets the RecipientId field's value.

func (CommentMetadata) String Uses

func (s CommentMetadata) String() string

String returns the string representation

type CreateCommentInput Uses

type CreateCommentInput struct {

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

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

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

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

    // The text of the comment.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true" sensitive:"true"`

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

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

    // The visibility of the comment. Options are either PRIVATE, where the comment
    // is visible only to the comment author and document owner and co-owners, or
    // PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
    Visibility *string `type:"string" enum:"CommentVisibilityType"`
    // contains filtered or unexported fields
}

func (CreateCommentInput) GoString Uses

func (s CreateCommentInput) GoString() string

GoString returns the string representation

func (*CreateCommentInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateCommentInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (*CreateCommentInput) SetNotifyCollaborators Uses

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

SetNotifyCollaborators sets the NotifyCollaborators field's value.

func (*CreateCommentInput) SetParentId Uses

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

SetParentId sets the ParentId field's value.

func (*CreateCommentInput) SetText Uses

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

SetText sets the Text field's value.

func (*CreateCommentInput) SetThreadId Uses

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

SetThreadId sets the ThreadId field's value.

func (*CreateCommentInput) SetVersionId Uses

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

SetVersionId sets the VersionId field's value.

func (*CreateCommentInput) SetVisibility Uses

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

SetVisibility sets the Visibility field's value.

func (CreateCommentInput) String Uses

func (s CreateCommentInput) String() string

String returns the string representation

func (*CreateCommentInput) Validate Uses

func (s *CreateCommentInput) Validate() error

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

type CreateCommentOutput Uses

type CreateCommentOutput struct {

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

func (CreateCommentOutput) GoString Uses

func (s CreateCommentOutput) GoString() string

GoString returns the string representation

func (*CreateCommentOutput) SetComment Uses

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

SetComment sets the Comment field's value.

func (CreateCommentOutput) String Uses

func (s CreateCommentOutput) String() string

String returns the string representation

type CreateCustomMetadataInput Uses

type CreateCustomMetadataInput struct {

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

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

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

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

func (CreateCustomMetadataInput) GoString Uses

func (s CreateCustomMetadataInput) GoString() string

GoString returns the string representation

func (*CreateCustomMetadataInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateCustomMetadataInput) SetCustomMetadata Uses

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

SetCustomMetadata sets the CustomMetadata field's value.

func (*CreateCustomMetadataInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (*CreateCustomMetadataInput) SetVersionId Uses

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

SetVersionId sets the VersionId field's value.

func (CreateCustomMetadataInput) String Uses

func (s CreateCustomMetadataInput) String() string

String returns the string representation

func (*CreateCustomMetadataInput) Validate Uses

func (s *CreateCustomMetadataInput) Validate() error

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

type CreateCustomMetadataOutput Uses

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

func (CreateCustomMetadataOutput) GoString Uses

func (s CreateCustomMetadataOutput) GoString() string

GoString returns the string representation

func (CreateCustomMetadataOutput) String Uses

func (s CreateCustomMetadataOutput) String() string

String returns the string representation

type CreateFolderInput Uses

type CreateFolderInput struct {

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

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

func (s CreateFolderInput) GoString() string

GoString returns the string representation

func (*CreateFolderInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateFolderInput) SetName Uses

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

SetName sets the Name field's value.

func (*CreateFolderInput) SetParentFolderId Uses

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

SetParentFolderId sets the ParentFolderId field's value.

func (CreateFolderInput) String Uses

func (s CreateFolderInput) String() string

String returns the string representation

func (*CreateFolderInput) Validate Uses

func (s *CreateFolderInput) Validate() error

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

type CreateFolderOutput Uses

type CreateFolderOutput struct {

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

func (CreateFolderOutput) GoString Uses

func (s CreateFolderOutput) GoString() string

GoString returns the string representation

func (*CreateFolderOutput) SetMetadata Uses

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

SetMetadata sets the Metadata field's value.

func (CreateFolderOutput) String Uses

func (s CreateFolderOutput) String() string

String returns the string representation

type CreateLabelsInput Uses

type CreateLabelsInput struct {

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

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

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

func (CreateLabelsInput) GoString Uses

func (s CreateLabelsInput) GoString() string

GoString returns the string representation

func (*CreateLabelsInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateLabelsInput) SetLabels Uses

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

SetLabels sets the Labels field's value.

func (*CreateLabelsInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (CreateLabelsInput) String Uses

func (s CreateLabelsInput) String() string

String returns the string representation

func (*CreateLabelsInput) Validate Uses

func (s *CreateLabelsInput) Validate() error

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

type CreateLabelsOutput Uses

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

func (CreateLabelsOutput) GoString Uses

func (s CreateLabelsOutput) GoString() string

GoString returns the string representation

func (CreateLabelsOutput) String Uses

func (s CreateLabelsOutput) String() string

String returns the string representation

type CreateNotificationSubscriptionInput Uses

type CreateNotificationSubscriptionInput struct {

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

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

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

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

func (CreateNotificationSubscriptionInput) GoString Uses

func (s CreateNotificationSubscriptionInput) GoString() string

GoString returns the string representation

func (*CreateNotificationSubscriptionInput) SetEndpoint Uses

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

SetEndpoint sets the Endpoint field's value.

func (*CreateNotificationSubscriptionInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*CreateNotificationSubscriptionInput) SetProtocol Uses

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

SetProtocol sets the Protocol field's value.

func (*CreateNotificationSubscriptionInput) SetSubscriptionType Uses

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

SetSubscriptionType sets the SubscriptionType field's value.

func (CreateNotificationSubscriptionInput) String Uses

func (s CreateNotificationSubscriptionInput) String() string

String returns the string representation

func (*CreateNotificationSubscriptionInput) Validate Uses

func (s *CreateNotificationSubscriptionInput) Validate() error

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

type CreateNotificationSubscriptionOutput Uses

type CreateNotificationSubscriptionOutput struct {

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

func (CreateNotificationSubscriptionOutput) GoString Uses

func (s CreateNotificationSubscriptionOutput) GoString() string

GoString returns the string representation

func (*CreateNotificationSubscriptionOutput) SetSubscription Uses

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

SetSubscription sets the Subscription field's value.

func (CreateNotificationSubscriptionOutput) String Uses

func (s CreateNotificationSubscriptionOutput) String() string

String returns the string representation

type CreateUserInput Uses

type CreateUserInput struct {

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

    // 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" sensitive:"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 Uses

func (s CreateUserInput) GoString() string

GoString returns the string representation

func (*CreateUserInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*CreateUserInput) SetEmailAddress Uses

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

SetEmailAddress sets the EmailAddress field's value.

func (*CreateUserInput) SetGivenName Uses

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

SetGivenName sets the GivenName field's value.

func (*CreateUserInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*CreateUserInput) SetPassword Uses

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

SetPassword sets the Password field's value.

func (*CreateUserInput) SetStorageRule Uses

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

SetStorageRule sets the StorageRule field's value.

func (*CreateUserInput) SetSurname Uses

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

SetSurname sets the Surname field's value.

func (*CreateUserInput) SetTimeZoneId Uses

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

SetTimeZoneId sets the TimeZoneId field's value.

func (*CreateUserInput) SetUsername Uses

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

SetUsername sets the Username field's value.

func (CreateUserInput) String Uses

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate Uses

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput Uses

type CreateUserOutput struct {

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

func (CreateUserOutput) GoString Uses

func (s CreateUserOutput) GoString() string

GoString returns the string representation

func (*CreateUserOutput) SetUser Uses

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

SetUser sets the User field's value.

func (CreateUserOutput) String Uses

func (s CreateUserOutput) String() string

String returns the string representation

type DeactivateUserInput Uses

type DeactivateUserInput struct {

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

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

func (DeactivateUserInput) GoString Uses

func (s DeactivateUserInput) GoString() string

GoString returns the string representation

func (*DeactivateUserInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeactivateUserInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (DeactivateUserInput) String Uses

func (s DeactivateUserInput) String() string

String returns the string representation

func (*DeactivateUserInput) Validate Uses

func (s *DeactivateUserInput) Validate() error

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

type DeactivateUserOutput Uses

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

func (DeactivateUserOutput) GoString Uses

func (s DeactivateUserOutput) GoString() string

GoString returns the string representation

func (DeactivateUserOutput) String Uses

func (s DeactivateUserOutput) String() string

String returns the string representation

type DeleteCommentInput Uses

type DeleteCommentInput struct {

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

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

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

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

func (DeleteCommentInput) GoString Uses

func (s DeleteCommentInput) GoString() string

GoString returns the string representation

func (*DeleteCommentInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteCommentInput) SetCommentId Uses

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

SetCommentId sets the CommentId field's value.

func (*DeleteCommentInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (*DeleteCommentInput) SetVersionId Uses

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

SetVersionId sets the VersionId field's value.

func (DeleteCommentInput) String Uses

func (s DeleteCommentInput) String() string

String returns the string representation

func (*DeleteCommentInput) Validate Uses

func (s *DeleteCommentInput) Validate() error

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

type DeleteCommentOutput Uses

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

func (DeleteCommentOutput) GoString Uses

func (s DeleteCommentOutput) GoString() string

GoString returns the string representation

func (DeleteCommentOutput) String Uses

func (s DeleteCommentOutput) String() string

String returns the string representation

type DeleteCustomMetadataInput Uses

type DeleteCustomMetadataInput struct {

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

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

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

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

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

func (DeleteCustomMetadataInput) GoString Uses

func (s DeleteCustomMetadataInput) GoString() string

GoString returns the string representation

func (*DeleteCustomMetadataInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteCustomMetadataInput) SetDeleteAll Uses

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

SetDeleteAll sets the DeleteAll field's value.

func (*DeleteCustomMetadataInput) SetKeys Uses

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

SetKeys sets the Keys field's value.

func (*DeleteCustomMetadataInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (*DeleteCustomMetadataInput) SetVersionId Uses

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

SetVersionId sets the VersionId field's value.

func (DeleteCustomMetadataInput) String Uses

func (s DeleteCustomMetadataInput) String() string

String returns the string representation

func (*DeleteCustomMetadataInput) Validate Uses

func (s *DeleteCustomMetadataInput) Validate() error

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

type DeleteCustomMetadataOutput Uses

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

func (DeleteCustomMetadataOutput) GoString Uses

func (s DeleteCustomMetadataOutput) GoString() string

GoString returns the string representation

func (DeleteCustomMetadataOutput) String Uses

func (s DeleteCustomMetadataOutput) String() string

String returns the string representation

type DeleteDocumentInput Uses

type DeleteDocumentInput struct {

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

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

func (DeleteDocumentInput) GoString Uses

func (s DeleteDocumentInput) GoString() string

GoString returns the string representation

func (*DeleteDocumentInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteDocumentInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (DeleteDocumentInput) String Uses

func (s DeleteDocumentInput) String() string

String returns the string representation

func (*DeleteDocumentInput) Validate Uses

func (s *DeleteDocumentInput) Validate() error

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

type DeleteDocumentOutput Uses

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

func (DeleteDocumentOutput) GoString Uses

func (s DeleteDocumentOutput) GoString() string

GoString returns the string representation

func (DeleteDocumentOutput) String Uses

func (s DeleteDocumentOutput) String() string

String returns the string representation

type DeleteFolderContentsInput Uses

type DeleteFolderContentsInput struct {

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

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

func (DeleteFolderContentsInput) GoString Uses

func (s DeleteFolderContentsInput) GoString() string

GoString returns the string representation

func (*DeleteFolderContentsInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteFolderContentsInput) SetFolderId Uses

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

SetFolderId sets the FolderId field's value.

func (DeleteFolderContentsInput) String Uses

func (s DeleteFolderContentsInput) String() string

String returns the string representation

func (*DeleteFolderContentsInput) Validate Uses

func (s *DeleteFolderContentsInput) Validate() error

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

type DeleteFolderContentsOutput Uses

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

func (DeleteFolderContentsOutput) GoString Uses

func (s DeleteFolderContentsOutput) GoString() string

GoString returns the string representation

func (DeleteFolderContentsOutput) String Uses

func (s DeleteFolderContentsOutput) String() string

String returns the string representation

type DeleteFolderInput Uses

type DeleteFolderInput struct {

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

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

func (DeleteFolderInput) GoString Uses

func (s DeleteFolderInput) GoString() string

GoString returns the string representation

func (*DeleteFolderInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteFolderInput) SetFolderId Uses

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

SetFolderId sets the FolderId field's value.

func (DeleteFolderInput) String Uses

func (s DeleteFolderInput) String() string

String returns the string representation

func (*DeleteFolderInput) Validate Uses

func (s *DeleteFolderInput) Validate() error

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

type DeleteFolderOutput Uses

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

func (DeleteFolderOutput) GoString Uses

func (s DeleteFolderOutput) GoString() string

GoString returns the string representation

func (DeleteFolderOutput) String Uses

func (s DeleteFolderOutput) String() string

String returns the string representation

type DeleteLabelsInput Uses

type DeleteLabelsInput struct {

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

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

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

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

func (DeleteLabelsInput) GoString Uses

func (s DeleteLabelsInput) GoString() string

GoString returns the string representation

func (*DeleteLabelsInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteLabelsInput) SetDeleteAll Uses

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

SetDeleteAll sets the DeleteAll field's value.

func (*DeleteLabelsInput) SetLabels Uses

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

SetLabels sets the Labels field's value.

func (*DeleteLabelsInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (DeleteLabelsInput) String Uses

func (s DeleteLabelsInput) String() string

String returns the string representation

func (*DeleteLabelsInput) Validate Uses

func (s *DeleteLabelsInput) Validate() error

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

type DeleteLabelsOutput Uses

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

func (DeleteLabelsOutput) GoString Uses

func (s DeleteLabelsOutput) GoString() string

GoString returns the string representation

func (DeleteLabelsOutput) String Uses

func (s DeleteLabelsOutput) String() string

String returns the string representation

type DeleteNotificationSubscriptionInput Uses

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 Uses

func (s DeleteNotificationSubscriptionInput) GoString() string

GoString returns the string representation

func (*DeleteNotificationSubscriptionInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*DeleteNotificationSubscriptionInput) SetSubscriptionId Uses

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

SetSubscriptionId sets the SubscriptionId field's value.

func (DeleteNotificationSubscriptionInput) String Uses

func (s DeleteNotificationSubscriptionInput) String() string

String returns the string representation

func (*DeleteNotificationSubscriptionInput) Validate Uses

func (s *DeleteNotificationSubscriptionInput) Validate() error

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

type DeleteNotificationSubscriptionOutput Uses

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

func (DeleteNotificationSubscriptionOutput) GoString Uses

func (s DeleteNotificationSubscriptionOutput) GoString() string

GoString returns the string representation

func (DeleteNotificationSubscriptionOutput) String Uses

func (s DeleteNotificationSubscriptionOutput) String() string

String returns the string representation

type DeleteUserInput Uses

type DeleteUserInput struct {

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

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

func (DeleteUserInput) GoString Uses

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (*DeleteUserInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DeleteUserInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (DeleteUserInput) String Uses

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate Uses

func (s *DeleteUserInput) Validate() error

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

type DeleteUserOutput Uses

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

func (DeleteUserOutput) GoString Uses

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (DeleteUserOutput) String Uses

func (s DeleteUserOutput) String() string

String returns the string representation

type DescribeActivitiesInput Uses

type DescribeActivitiesInput struct {

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

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

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

    // Includes indirect activities. An indirect activity results from a direct
    // activity performed on a parent resource. For example, sharing a parent folder
    // (the direct activity) shares all of the subfolders and documents within the
    // parent folder (the indirect activity).
    IncludeIndirectActivities *bool `location:"querystring" locationName:"includeIndirectActivities" type:"boolean"`

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

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

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

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

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

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

func (DescribeActivitiesInput) GoString Uses

func (s DescribeActivitiesInput) GoString() string

GoString returns the string representation

func (*DescribeActivitiesInput) SetActivityTypes Uses

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

SetActivityTypes sets the ActivityTypes field's value.

func (*DescribeActivitiesInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeActivitiesInput) SetEndTime Uses

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

SetEndTime sets the EndTime field's value.

func (*DescribeActivitiesInput) SetIncludeIndirectActivities Uses

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

SetIncludeIndirectActivities sets the IncludeIndirectActivities field's value.

func (*DescribeActivitiesInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*DescribeActivitiesInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeActivitiesInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeActivitiesInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (*DescribeActivitiesInput) SetStartTime Uses

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

SetStartTime sets the StartTime field's value.

func (*DescribeActivitiesInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (DescribeActivitiesInput) String Uses

func (s DescribeActivitiesInput) String() string

String returns the string representation

func (*DescribeActivitiesInput) Validate Uses

func (s *DescribeActivitiesInput) Validate() error

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

type DescribeActivitiesOutput Uses

type DescribeActivitiesOutput struct {

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

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

func (DescribeActivitiesOutput) GoString Uses

func (s DescribeActivitiesOutput) GoString() string

GoString returns the string representation

func (*DescribeActivitiesOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeActivitiesOutput) SetUserActivities Uses

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

SetUserActivities sets the UserActivities field's value.

func (DescribeActivitiesOutput) String Uses

func (s DescribeActivitiesOutput) String() string

String returns the string representation

type DescribeCommentsInput Uses

type DescribeCommentsInput struct {

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

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

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

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

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

func (DescribeCommentsInput) GoString Uses

func (s DescribeCommentsInput) GoString() string

GoString returns the string representation

func (*DescribeCommentsInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeCommentsInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (*DescribeCommentsInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*DescribeCommentsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeCommentsInput) SetVersionId Uses

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

SetVersionId sets the VersionId field's value.

func (DescribeCommentsInput) String Uses

func (s DescribeCommentsInput) String() string

String returns the string representation

func (*DescribeCommentsInput) Validate Uses

func (s *DescribeCommentsInput) Validate() error

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

type DescribeCommentsOutput Uses

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 Uses

func (s DescribeCommentsOutput) GoString() string

GoString returns the string representation

func (*DescribeCommentsOutput) SetComments Uses

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

SetComments sets the Comments field's value.

func (*DescribeCommentsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeCommentsOutput) String Uses

func (s DescribeCommentsOutput) String() string

String returns the string representation

type DescribeDocumentVersionsInput Uses

type DescribeDocumentVersionsInput struct {

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

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

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

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

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

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

func (DescribeDocumentVersionsInput) GoString Uses

func (s DescribeDocumentVersionsInput) GoString() string

GoString returns the string representation

func (*DescribeDocumentVersionsInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeDocumentVersionsInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (*DescribeDocumentVersionsInput) SetFields Uses

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

SetFields sets the Fields field's value.

func (*DescribeDocumentVersionsInput) SetInclude Uses

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

SetInclude sets the Include field's value.

func (*DescribeDocumentVersionsInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*DescribeDocumentVersionsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeDocumentVersionsInput) String Uses

func (s DescribeDocumentVersionsInput) String() string

String returns the string representation

func (*DescribeDocumentVersionsInput) Validate Uses

func (s *DescribeDocumentVersionsInput) Validate() error

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

type DescribeDocumentVersionsOutput Uses

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 Uses

func (s DescribeDocumentVersionsOutput) GoString() string

GoString returns the string representation

func (*DescribeDocumentVersionsOutput) SetDocumentVersions Uses

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

SetDocumentVersions sets the DocumentVersions field's value.

func (*DescribeDocumentVersionsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeDocumentVersionsOutput) String Uses

func (s DescribeDocumentVersionsOutput) String() string

String returns the string representation

type DescribeFolderContentsInput Uses

type DescribeFolderContentsInput struct {

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

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

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

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

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

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

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

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

func (DescribeFolderContentsInput) GoString Uses

func (s DescribeFolderContentsInput) GoString() string

GoString returns the string representation

func (*DescribeFolderContentsInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeFolderContentsInput) SetFolderId Uses

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

SetFolderId sets the FolderId field's value.

func (*DescribeFolderContentsInput) SetInclude Uses

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

SetInclude sets the Include field's value.

func (*DescribeFolderContentsInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*DescribeFolderContentsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeFolderContentsInput) SetOrder Uses

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

SetOrder sets the Order field's value.

func (*DescribeFolderContentsInput) SetSort Uses

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

SetSort sets the Sort field's value.

func (*DescribeFolderContentsInput) SetType Uses

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

SetType sets the Type field's value.

func (DescribeFolderContentsInput) String Uses

func (s DescribeFolderContentsInput) String() string

String returns the string representation

func (*DescribeFolderContentsInput) Validate Uses

func (s *DescribeFolderContentsInput) Validate() error

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

type DescribeFolderContentsOutput Uses

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 Uses

func (s DescribeFolderContentsOutput) GoString() string

GoString returns the string representation

func (*DescribeFolderContentsOutput) SetDocuments Uses

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

SetDocuments sets the Documents field's value.

func (*DescribeFolderContentsOutput) SetFolders Uses

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

SetFolders sets the Folders field's value.

func (*DescribeFolderContentsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeFolderContentsOutput) String Uses

func (s DescribeFolderContentsOutput) String() string

String returns the string representation

type DescribeGroupsInput Uses

type DescribeGroupsInput struct {

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

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

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

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

    // A query to describe groups by group name.
    //
    // SearchQuery is a required field
    SearchQuery *string `location:"querystring" locationName:"searchQuery" min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (DescribeGroupsInput) GoString Uses

func (s DescribeGroupsInput) GoString() string

GoString returns the string representation

func (*DescribeGroupsInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeGroupsInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*DescribeGroupsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeGroupsInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeGroupsInput) SetSearchQuery Uses

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

SetSearchQuery sets the SearchQuery field's value.

func (DescribeGroupsInput) String Uses

func (s DescribeGroupsInput) String() string

String returns the string representation

func (*DescribeGroupsInput) Validate Uses

func (s *DescribeGroupsInput) Validate() error

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

type DescribeGroupsOutput Uses

type DescribeGroupsOutput struct {

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

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

func (DescribeGroupsOutput) GoString Uses

func (s DescribeGroupsOutput) GoString() string

GoString returns the string representation

func (*DescribeGroupsOutput) SetGroups Uses

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

SetGroups sets the Groups field's value.

func (*DescribeGroupsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeGroupsOutput) String Uses

func (s DescribeGroupsOutput) String() string

String returns the string representation

type DescribeNotificationSubscriptionsInput Uses

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 Uses

func (s DescribeNotificationSubscriptionsInput) GoString() string

GoString returns the string representation

func (*DescribeNotificationSubscriptionsInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*DescribeNotificationSubscriptionsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeNotificationSubscriptionsInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (DescribeNotificationSubscriptionsInput) String Uses

func (s DescribeNotificationSubscriptionsInput) String() string

String returns the string representation

func (*DescribeNotificationSubscriptionsInput) Validate Uses

func (s *DescribeNotificationSubscriptionsInput) Validate() error

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

type DescribeNotificationSubscriptionsOutput Uses

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 Uses

func (s DescribeNotificationSubscriptionsOutput) GoString() string

GoString returns the string representation

func (*DescribeNotificationSubscriptionsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeNotificationSubscriptionsOutput) SetSubscriptions Uses

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

SetSubscriptions sets the Subscriptions field's value.

func (DescribeNotificationSubscriptionsOutput) String Uses

func (s DescribeNotificationSubscriptionsOutput) String() string

String returns the string representation

type DescribeResourcePermissionsInput Uses

type DescribeResourcePermissionsInput struct {

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

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

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

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

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

func (DescribeResourcePermissionsInput) GoString Uses

func (s DescribeResourcePermissionsInput) GoString() string

GoString returns the string representation

func (*DescribeResourcePermissionsInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeResourcePermissionsInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*DescribeResourcePermissionsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeResourcePermissionsInput) SetPrincipalId Uses

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

SetPrincipalId sets the PrincipalId field's value.

func (*DescribeResourcePermissionsInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (DescribeResourcePermissionsInput) String Uses

func (s DescribeResourcePermissionsInput) String() string

String returns the string representation

func (*DescribeResourcePermissionsInput) Validate Uses

func (s *DescribeResourcePermissionsInput) Validate() error

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

type DescribeResourcePermissionsOutput Uses

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 Uses

func (s DescribeResourcePermissionsOutput) GoString() string

GoString returns the string representation

func (*DescribeResourcePermissionsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeResourcePermissionsOutput) SetPrincipals Uses

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

SetPrincipals sets the Principals field's value.

func (DescribeResourcePermissionsOutput) String Uses

func (s DescribeResourcePermissionsOutput) String() string

String returns the string representation

type DescribeRootFoldersInput Uses

type DescribeRootFoldersInput struct {

    // Amazon WorkDocs authentication token. Do not set this field when using administrative
    // API actions, as in accessing the API using AWS credentials.
    //
    // AuthenticationToken is a required field
    AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" required:"true" sensitive:"true"`

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

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

func (DescribeRootFoldersInput) GoString Uses

func (s DescribeRootFoldersInput) GoString() string

GoString returns the string representation

func (*DescribeRootFoldersInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeRootFoldersInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*DescribeRootFoldersInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeRootFoldersInput) String Uses

func (s DescribeRootFoldersInput) String() string

String returns the string representation

func (*DescribeRootFoldersInput) Validate Uses

func (s *DescribeRootFoldersInput) Validate() error

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

type DescribeRootFoldersOutput Uses

type DescribeRootFoldersOutput struct {

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

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

func (DescribeRootFoldersOutput) GoString Uses

func (s DescribeRootFoldersOutput) GoString() string

GoString returns the string representation

func (*DescribeRootFoldersOutput) SetFolders Uses

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

SetFolders sets the Folders field's value.

func (*DescribeRootFoldersOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeRootFoldersOutput) String Uses

func (s DescribeRootFoldersOutput) String() string

String returns the string representation

type DescribeUsersInput Uses

type DescribeUsersInput struct {

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

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

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

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

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

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

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

    // A query to filter users by user name.
    Query *string `location:"querystring" locationName:"query" min:"1" type:"string" sensitive:"true"`

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

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

func (DescribeUsersInput) GoString Uses

func (s DescribeUsersInput) GoString() string

GoString returns the string representation

func (*DescribeUsersInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*DescribeUsersInput) SetFields Uses

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

SetFields sets the Fields field's value.

func (*DescribeUsersInput) SetInclude Uses

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

SetInclude sets the Include field's value.

func (*DescribeUsersInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*DescribeUsersInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeUsersInput) SetOrder Uses

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

SetOrder sets the Order field's value.

func (*DescribeUsersInput) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*DescribeUsersInput) SetQuery Uses

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

SetQuery sets the Query field's value.

func (*DescribeUsersInput) SetSort Uses

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

SetSort sets the Sort field's value.

func (*DescribeUsersInput) SetUserIds Uses

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

SetUserIds sets the UserIds field's value.

func (DescribeUsersInput) String Uses

func (s DescribeUsersInput) String() string

String returns the string representation

func (*DescribeUsersInput) Validate Uses

func (s *DescribeUsersInput) Validate() error

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

type DescribeUsersOutput Uses

type DescribeUsersOutput struct {

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

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

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

func (DescribeUsersOutput) GoString Uses

func (s DescribeUsersOutput) GoString() string

GoString returns the string representation

func (*DescribeUsersOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeUsersOutput) SetTotalNumberOfUsers Uses

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

SetTotalNumberOfUsers sets the TotalNumberOfUsers field's value.

func (*DescribeUsersOutput) SetUsers Uses

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

SetUsers sets the Users field's value.

func (DescribeUsersOutput) String Uses

func (s DescribeUsersOutput) String() string

String returns the string representation

type DocumentMetadata Uses

type DocumentMetadata struct {

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

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

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

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

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

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

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

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

Describes the document.

func (DocumentMetadata) GoString Uses

func (s DocumentMetadata) GoString() string

GoString returns the string representation

func (*DocumentMetadata) SetCreatedTimestamp Uses

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*DocumentMetadata) SetCreatorId Uses

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

SetCreatorId sets the CreatorId field's value.

func (*DocumentMetadata) SetId Uses

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

SetId sets the Id field's value.

func (*DocumentMetadata) SetLabels Uses

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

SetLabels sets the Labels field's value.

func (*DocumentMetadata) SetLatestVersionMetadata Uses

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

SetLatestVersionMetadata sets the LatestVersionMetadata field's value.

func (*DocumentMetadata) SetModifiedTimestamp Uses

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

SetModifiedTimestamp sets the ModifiedTimestamp field's value.

func (*DocumentMetadata) SetParentFolderId Uses

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

SetParentFolderId sets the ParentFolderId field's value.

func (*DocumentMetadata) SetResourceState Uses

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

SetResourceState sets the ResourceState field's value.

func (DocumentMetadata) String Uses

func (s DocumentMetadata) String() string

String returns the string representation

type DocumentVersionMetadata Uses

type DocumentVersionMetadata struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

Describes a version of a document.

func (DocumentVersionMetadata) GoString Uses

func (s DocumentVersionMetadata) GoString() string

GoString returns the string representation

func (*DocumentVersionMetadata) SetContentCreatedTimestamp Uses

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

SetContentCreatedTimestamp sets the ContentCreatedTimestamp field's value.

func (*DocumentVersionMetadata) SetContentModifiedTimestamp Uses

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

SetContentModifiedTimestamp sets the ContentModifiedTimestamp field's value.

func (*DocumentVersionMetadata) SetContentType Uses

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

SetContentType sets the ContentType field's value.

func (*DocumentVersionMetadata) SetCreatedTimestamp Uses

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*DocumentVersionMetadata) SetCreatorId Uses

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

SetCreatorId sets the CreatorId field's value.

func (*DocumentVersionMetadata) SetId Uses

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

SetId sets the Id field's value.

func (*DocumentVersionMetadata) SetModifiedTimestamp Uses

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

SetModifiedTimestamp sets the ModifiedTimestamp field's value.

func (*DocumentVersionMetadata) SetName Uses

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

SetName sets the Name field's value.

func (*DocumentVersionMetadata) SetSignature Uses

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

SetSignature sets the Signature field's value.

func (*DocumentVersionMetadata) SetSize Uses

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

SetSize sets the Size field's value.

func (*DocumentVersionMetadata) SetSource Uses

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

SetSource sets the Source field's value.

func (*DocumentVersionMetadata) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*DocumentVersionMetadata) SetThumbnail Uses

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

SetThumbnail sets the Thumbnail field's value.

func (DocumentVersionMetadata) String Uses

func (s DocumentVersionMetadata) String() string

String returns the string representation

type FolderMetadata Uses

type FolderMetadata struct {

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

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

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

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

    // The size of the latest version of the folder metadata.
    LatestVersionSize *int64 `type:"long"`

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

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

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

    // The resource state of the folder.
    ResourceState *string `type:"string" enum:"ResourceStateType"`

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

    // The size of the folder metadata.
    Size *int64 `type:"long"`
    // contains filtered or unexported fields
}

Describes a folder.

func (FolderMetadata) GoString Uses

func (s FolderMetadata) GoString() string

GoString returns the string representation

func (*FolderMetadata) SetCreatedTimestamp Uses

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*FolderMetadata) SetCreatorId Uses

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

SetCreatorId sets the CreatorId field's value.

func (*FolderMetadata) SetId Uses

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

SetId sets the Id field's value.

func (*FolderMetadata) SetLabels Uses

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

SetLabels sets the Labels field's value.

func (*FolderMetadata) SetLatestVersionSize Uses

func (s *FolderMetadata) SetLatestVersionSize(v int64) *FolderMetadata

SetLatestVersionSize sets the LatestVersionSize field's value.

func (*FolderMetadata) SetModifiedTimestamp Uses

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

SetModifiedTimestamp sets the ModifiedTimestamp field's value.

func (*FolderMetadata) SetName Uses

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

SetName sets the Name field's value.

func (*FolderMetadata) SetParentFolderId Uses

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

SetParentFolderId sets the ParentFolderId field's value.

func (*FolderMetadata) SetResourceState Uses

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

SetResourceState sets the ResourceState field's value.

func (*FolderMetadata) SetSignature Uses

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

SetSignature sets the Signature field's value.

func (*FolderMetadata) SetSize Uses

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

SetSize sets the Size field's value.

func (FolderMetadata) String Uses

func (s FolderMetadata) String() string

String returns the string representation

type GetCurrentUserInput Uses

type GetCurrentUserInput struct {

    // Amazon WorkDocs authentication token. Do not set this field when using administrative
    // API actions, as in accessing the API using AWS credentials.
    //
    // AuthenticationToken is a required field
    AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (GetCurrentUserInput) GoString Uses

func (s GetCurrentUserInput) GoString() string

GoString returns the string representation

func (*GetCurrentUserInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (GetCurrentUserInput) String Uses

func (s GetCurrentUserInput) String() string

String returns the string representation

func (*GetCurrentUserInput) Validate Uses

func (s *GetCurrentUserInput) Validate() error

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

type GetCurrentUserOutput Uses

type GetCurrentUserOutput struct {

    // Metadata of the user.
    User *User `type:"structure"`
    // contains filtered or unexported fields
}

func (GetCurrentUserOutput) GoString Uses

func (s GetCurrentUserOutput) GoString() string

GoString returns the string representation

func (*GetCurrentUserOutput) SetUser Uses

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

SetUser sets the User field's value.

func (GetCurrentUserOutput) String Uses

func (s GetCurrentUserOutput) String() string

String returns the string representation

type GetDocumentInput Uses

type GetDocumentInput struct {

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

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

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

func (GetDocumentInput) GoString Uses

func (s GetDocumentInput) GoString() string

GoString returns the string representation

func (*GetDocumentInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetDocumentInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (*GetDocumentInput) SetIncludeCustomMetadata Uses

func (s *GetDocumentInput) SetIncludeCustomMetadata(v bool) *GetDocumentInput

SetIncludeCustomMetadata sets the IncludeCustomMetadata field's value.

func (GetDocumentInput) String Uses

func (s GetDocumentInput) String() string

String returns the string representation

func (*GetDocumentInput) Validate Uses

func (s *GetDocumentInput) Validate() error

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

type GetDocumentOutput Uses

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 Uses

func (s GetDocumentOutput) GoString() string

GoString returns the string representation

func (*GetDocumentOutput) SetCustomMetadata Uses

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

SetCustomMetadata sets the CustomMetadata field's value.

func (*GetDocumentOutput) SetMetadata Uses

func (s *GetDocumentOutput) SetMetadata(v *DocumentMetadata) *GetDocumentOutput

SetMetadata sets the Metadata field's value.

func (GetDocumentOutput) String Uses

func (s GetDocumentOutput) String() string

String returns the string representation

type GetDocumentPathInput Uses

type GetDocumentPathInput struct {

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

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

    // A comma-separated list of values. Specify NAME to include the names of the
    // parent folders.
    Fields *string `location:"querystring" locationName:"fields" min:"1" type:"string"`

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

    // This value is not supported.
    Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GetDocumentPathInput) GoString Uses

func (s GetDocumentPathInput) GoString() string

GoString returns the string representation

func (*GetDocumentPathInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetDocumentPathInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (*GetDocumentPathInput) SetFields Uses

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

SetFields sets the Fields field's value.

func (*GetDocumentPathInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*GetDocumentPathInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (GetDocumentPathInput) String Uses

func (s GetDocumentPathInput) String() string

String returns the string representation

func (*GetDocumentPathInput) Validate Uses

func (s *GetDocumentPathInput) Validate() error

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

type GetDocumentPathOutput Uses

type GetDocumentPathOutput struct {

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

func (GetDocumentPathOutput) GoString Uses

func (s GetDocumentPathOutput) GoString() string

GoString returns the string representation

func (*GetDocumentPathOutput) SetPath Uses

func (s *GetDocumentPathOutput) SetPath(v *ResourcePath) *GetDocumentPathOutput

SetPath sets the Path field's value.

func (GetDocumentPathOutput) String Uses

func (s GetDocumentPathOutput) String() string

String returns the string representation

type GetDocumentVersionInput Uses

type GetDocumentVersionInput struct {

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

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

    // A comma-separated list of values. Specify "SOURCE" to include a URL for the
    // source document.
    Fields *string `location:"querystring" locationName:"fields" min:"1" type:"string"`

    // Set this to TRUE to include custom metadata in the response.
    IncludeCustomMetadata *bool `location:"querystring" locationName:"includeCustomMetadata" type:"boolean"`

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

func (GetDocumentVersionInput) GoString Uses

func (s GetDocumentVersionInput) GoString() string

GoString returns the string representation

func (*GetDocumentVersionInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetDocumentVersionInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (*GetDocumentVersionInput) SetFields Uses

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

SetFields sets the Fields field's value.

func (*GetDocumentVersionInput) SetIncludeCustomMetadata Uses

func (s *GetDocumentVersionInput) SetIncludeCustomMetadata(v bool) *GetDocumentVersionInput

SetIncludeCustomMetadata sets the IncludeCustomMetadata field's value.

func (*GetDocumentVersionInput) SetVersionId Uses

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

SetVersionId sets the VersionId field's value.

func (GetDocumentVersionInput) String Uses

func (s GetDocumentVersionInput) String() string

String returns the string representation

func (*GetDocumentVersionInput) Validate Uses

func (s *GetDocumentVersionInput) Validate() error

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

type GetDocumentVersionOutput Uses

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 Uses

func (s GetDocumentVersionOutput) GoString() string

GoString returns the string representation

func (*GetDocumentVersionOutput) SetCustomMetadata Uses

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

SetCustomMetadata sets the CustomMetadata field's value.

func (*GetDocumentVersionOutput) SetMetadata Uses

func (s *GetDocumentVersionOutput) SetMetadata(v *DocumentVersionMetadata) *GetDocumentVersionOutput

SetMetadata sets the Metadata field's value.

func (GetDocumentVersionOutput) String Uses

func (s GetDocumentVersionOutput) String() string

String returns the string representation

type GetFolderInput Uses

type GetFolderInput struct {

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

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

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

func (GetFolderInput) GoString Uses

func (s GetFolderInput) GoString() string

GoString returns the string representation

func (*GetFolderInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetFolderInput) SetFolderId Uses

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

SetFolderId sets the FolderId field's value.

func (*GetFolderInput) SetIncludeCustomMetadata Uses

func (s *GetFolderInput) SetIncludeCustomMetadata(v bool) *GetFolderInput

SetIncludeCustomMetadata sets the IncludeCustomMetadata field's value.

func (GetFolderInput) String Uses

func (s GetFolderInput) String() string

String returns the string representation

func (*GetFolderInput) Validate Uses

func (s *GetFolderInput) Validate() error

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

type GetFolderOutput Uses

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 Uses

func (s GetFolderOutput) GoString() string

GoString returns the string representation

func (*GetFolderOutput) SetCustomMetadata Uses

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

SetCustomMetadata sets the CustomMetadata field's value.

func (*GetFolderOutput) SetMetadata Uses

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

SetMetadata sets the Metadata field's value.

func (GetFolderOutput) String Uses

func (s GetFolderOutput) String() string

String returns the string representation

type GetFolderPathInput Uses

type GetFolderPathInput struct {

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

    // A comma-separated list of values. Specify "NAME" to include the names of
    // the parent folders.
    Fields *string `location:"querystring" locationName:"fields" min:"1" type:"string"`

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

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

    // This value is not supported.
    Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GetFolderPathInput) GoString Uses

func (s GetFolderPathInput) GoString() string

GoString returns the string representation

func (*GetFolderPathInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetFolderPathInput) SetFields Uses

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

SetFields sets the Fields field's value.

func (*GetFolderPathInput) SetFolderId Uses

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

SetFolderId sets the FolderId field's value.

func (*GetFolderPathInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*GetFolderPathInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (GetFolderPathInput) String Uses

func (s GetFolderPathInput) String() string

String returns the string representation

func (*GetFolderPathInput) Validate Uses

func (s *GetFolderPathInput) Validate() error

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

type GetFolderPathOutput Uses

type GetFolderPathOutput struct {

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

func (GetFolderPathOutput) GoString Uses

func (s GetFolderPathOutput) GoString() string

GoString returns the string representation

func (*GetFolderPathOutput) SetPath Uses

func (s *GetFolderPathOutput) SetPath(v *ResourcePath) *GetFolderPathOutput

SetPath sets the Path field's value.

func (GetFolderPathOutput) String Uses

func (s GetFolderPathOutput) String() string

String returns the string representation

type GetResourcesInput Uses

type GetResourcesInput struct {

    // The Amazon WorkDocs authentication token. Do not set this field when using
    // administrative API actions, as in accessing the API operation using AWS credentials.
    AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

    // The collection type.
    CollectionType *string `location:"querystring" locationName:"collectionType" type:"string" enum:"ResourceCollectionType"`

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

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

    // The user ID for the resource collection. This is a required field for accessing
    // the API operation using IAM credentials.
    UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GetResourcesInput) GoString Uses

func (s GetResourcesInput) GoString() string

GoString returns the string representation

func (*GetResourcesInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*GetResourcesInput) SetCollectionType Uses

func (s *GetResourcesInput) SetCollectionType(v string) *GetResourcesInput

SetCollectionType sets the CollectionType field's value.

func (*GetResourcesInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*GetResourcesInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*GetResourcesInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (GetResourcesInput) String Uses

func (s GetResourcesInput) String() string

String returns the string representation

func (*GetResourcesInput) Validate Uses

func (s *GetResourcesInput) Validate() error

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

type GetResourcesOutput Uses

type GetResourcesOutput struct {

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

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

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

func (GetResourcesOutput) GoString Uses

func (s GetResourcesOutput) GoString() string

GoString returns the string representation

func (*GetResourcesOutput) SetDocuments Uses

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

SetDocuments sets the Documents field's value.

func (*GetResourcesOutput) SetFolders Uses

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

SetFolders sets the Folders field's value.

func (*GetResourcesOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (GetResourcesOutput) String Uses

func (s GetResourcesOutput) String() string

String returns the string representation

type GroupMetadata Uses

type GroupMetadata struct {

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

    // The name of the group.
    Name *string `type:"string"`
    // contains filtered or unexported fields
}

Describes the metadata of a user group.

func (GroupMetadata) GoString Uses

func (s GroupMetadata) GoString() string

GoString returns the string representation

func (*GroupMetadata) SetId Uses

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

SetId sets the Id field's value.

func (*GroupMetadata) SetName Uses

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

SetName sets the Name field's value.

func (GroupMetadata) String Uses

func (s GroupMetadata) String() string

String returns the string representation

type InitiateDocumentVersionUploadInput Uses

type InitiateDocumentVersionUploadInput struct {

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

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

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

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

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

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

    // The name of the document.
    Name *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 Uses

func (s InitiateDocumentVersionUploadInput) GoString() string

GoString returns the string representation

func (*InitiateDocumentVersionUploadInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*InitiateDocumentVersionUploadInput) SetContentCreatedTimestamp Uses

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

SetContentCreatedTimestamp sets the ContentCreatedTimestamp field's value.

func (*InitiateDocumentVersionUploadInput) SetContentModifiedTimestamp Uses

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

SetContentModifiedTimestamp sets the ContentModifiedTimestamp field's value.

func (*InitiateDocumentVersionUploadInput) SetContentType Uses

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

SetContentType sets the ContentType field's value.

func (*InitiateDocumentVersionUploadInput) SetDocumentSizeInBytes Uses

func (s *InitiateDocumentVersionUploadInput) SetDocumentSizeInBytes(v int64) *InitiateDocumentVersionUploadInput

SetDocumentSizeInBytes sets the DocumentSizeInBytes field's value.

func (*InitiateDocumentVersionUploadInput) SetId Uses

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

SetId sets the Id field's value.

func (*InitiateDocumentVersionUploadInput) SetName Uses

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

SetName sets the Name field's value.

func (*InitiateDocumentVersionUploadInput) SetParentFolderId Uses

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

SetParentFolderId sets the ParentFolderId field's value.

func (InitiateDocumentVersionUploadInput) String Uses

func (s InitiateDocumentVersionUploadInput) String() string

String returns the string representation

func (*InitiateDocumentVersionUploadInput) Validate Uses

func (s *InitiateDocumentVersionUploadInput) Validate() error

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

type InitiateDocumentVersionUploadOutput Uses

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 Uses

func (s InitiateDocumentVersionUploadOutput) GoString() string

GoString returns the string representation

func (*InitiateDocumentVersionUploadOutput) SetMetadata Uses

func (s *InitiateDocumentVersionUploadOutput) SetMetadata(v *DocumentMetadata) *InitiateDocumentVersionUploadOutput

SetMetadata sets the Metadata field's value.

func (*InitiateDocumentVersionUploadOutput) SetUploadMetadata Uses

func (s *InitiateDocumentVersionUploadOutput) SetUploadMetadata(v *UploadMetadata) *InitiateDocumentVersionUploadOutput

SetUploadMetadata sets the UploadMetadata field's value.

func (InitiateDocumentVersionUploadOutput) String Uses

func (s InitiateDocumentVersionUploadOutput) String() string

String returns the string representation

type NotificationOptions Uses

type NotificationOptions struct {

    // Text value to be included in the email body.
    EmailMessage *string `type:"string" sensitive:"true"`

    // Boolean value to indicate an email notification should be sent to the receipients.
    SendEmail *bool `type:"boolean"`
    // contains filtered or unexported fields
}

Set of options which defines notification preferences of given action.

func (NotificationOptions) GoString Uses

func (s NotificationOptions) GoString() string

GoString returns the string representation

func (*NotificationOptions) SetEmailMessage Uses

func (s *NotificationOptions) SetEmailMessage(v string) *NotificationOptions

SetEmailMessage sets the EmailMessage field's value.

func (*NotificationOptions) SetSendEmail Uses

func (s *NotificationOptions) SetSendEmail(v bool) *NotificationOptions

SetSendEmail sets the SendEmail field's value.

func (NotificationOptions) String Uses

func (s NotificationOptions) String() string

String returns the string representation

type Participants Uses

type Participants struct {

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

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

Describes the users or user groups.

func (Participants) GoString Uses

func (s Participants) GoString() string

GoString returns the string representation

func (*Participants) SetGroups Uses

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

SetGroups sets the Groups field's value.

func (*Participants) SetUsers Uses

func (s *Participants) SetUsers(v []*UserMetadata) *Participants

SetUsers sets the Users field's value.

func (Participants) String Uses

func (s Participants) String() string

String returns the string representation

type PermissionInfo Uses

type PermissionInfo struct {

    // The role of the user.
    Role *string `type:"string" enum:"RoleType"`

    // The type of permissions.
    Type *string `type:"string" enum:"RolePermissionType"`
    // contains filtered or unexported fields
}

Describes the permissions.

func (PermissionInfo) GoString Uses

func (s PermissionInfo) GoString() string

GoString returns the string representation

func (*PermissionInfo) SetRole Uses

func (s *PermissionInfo) SetRole(v string) *PermissionInfo

SetRole sets the Role field's value.

func (*PermissionInfo) SetType Uses

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

SetType sets the Type field's value.

func (PermissionInfo) String Uses

func (s PermissionInfo) String() string

String returns the string representation

type Principal Uses

type Principal struct {

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

    // The permission information for the resource.
    Roles []*PermissionInfo `type:"list"`

    // The type of resource.
    Type *string `type:"string" enum:"PrincipalType"`
    // contains filtered or unexported fields
}

Describes a resource.

func (Principal) GoString Uses

func (s Principal) GoString() string

GoString returns the string representation

func (*Principal) SetId Uses

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

SetId sets the Id field's value.

func (*Principal) SetRoles Uses

func (s *Principal) SetRoles(v []*PermissionInfo) *Principal

SetRoles sets the Roles field's value.

func (*Principal) SetType Uses

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

SetType sets the Type field's value.

func (Principal) String Uses

func (s Principal) String() string

String returns the string representation

type RemoveAllResourcePermissionsInput Uses

type RemoveAllResourcePermissionsInput struct {

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

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

func (RemoveAllResourcePermissionsInput) GoString Uses

func (s RemoveAllResourcePermissionsInput) GoString() string

GoString returns the string representation

func (*RemoveAllResourcePermissionsInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*RemoveAllResourcePermissionsInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (RemoveAllResourcePermissionsInput) String Uses

func (s RemoveAllResourcePermissionsInput) String() string

String returns the string representation

func (*RemoveAllResourcePermissionsInput) Validate Uses

func (s *RemoveAllResourcePermissionsInput) Validate() error

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

type RemoveAllResourcePermissionsOutput Uses

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

func (RemoveAllResourcePermissionsOutput) GoString Uses

func (s RemoveAllResourcePermissionsOutput) GoString() string

GoString returns the string representation

func (RemoveAllResourcePermissionsOutput) String Uses

func (s RemoveAllResourcePermissionsOutput) String() string

String returns the string representation

type RemoveResourcePermissionInput Uses

type RemoveResourcePermissionInput struct {

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

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

    // The principal type of the resource.
    PrincipalType *string `location:"querystring" locationName:"type" type:"string" enum:"PrincipalType"`

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

func (RemoveResourcePermissionInput) GoString Uses

func (s RemoveResourcePermissionInput) GoString() string

GoString returns the string representation

func (*RemoveResourcePermissionInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*RemoveResourcePermissionInput) SetPrincipalId Uses

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

SetPrincipalId sets the PrincipalId field's value.

func (*RemoveResourcePermissionInput) SetPrincipalType Uses

func (s *RemoveResourcePermissionInput) SetPrincipalType(v string) *RemoveResourcePermissionInput

SetPrincipalType sets the PrincipalType field's value.

func (*RemoveResourcePermissionInput) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (RemoveResourcePermissionInput) String Uses

func (s RemoveResourcePermissionInput) String() string

String returns the string representation

func (*RemoveResourcePermissionInput) Validate Uses

func (s *RemoveResourcePermissionInput) Validate() error

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

type RemoveResourcePermissionOutput Uses

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

func (RemoveResourcePermissionOutput) GoString Uses

func (s RemoveResourcePermissionOutput) GoString() string

GoString returns the string representation

func (RemoveResourcePermissionOutput) String Uses

func (s RemoveResourcePermissionOutput) String() string

String returns the string representation

type ResourceMetadata Uses

type ResourceMetadata struct {

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

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

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

    // The owner of the resource.
    Owner *UserMetadata `type:"structure"`

    // The parent ID of the resource before a rename operation.
    ParentId *string `min:"1" type:"string"`

    // The type of resource.
    Type *string `type:"string" enum:"ResourceType"`

    // The version ID of the resource. This is an optional field and is filled for
    // action on document version.
    VersionId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Describes the metadata of a resource.

func (ResourceMetadata) GoString Uses

func (s ResourceMetadata) GoString() string

GoString returns the string representation

func (*ResourceMetadata) SetId Uses

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

SetId sets the Id field's value.

func (*ResourceMetadata) SetName Uses

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

SetName sets the Name field's value.

func (*ResourceMetadata) SetOriginalName Uses

func (s *ResourceMetadata) SetOriginalName(v string) *ResourceMetadata

SetOriginalName sets the OriginalName field's value.

func (*ResourceMetadata) SetOwner Uses

func (s *ResourceMetadata) SetOwner(v *UserMetadata) *ResourceMetadata

SetOwner sets the Owner field's value.

func (*ResourceMetadata) SetParentId Uses

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

SetParentId sets the ParentId field's value.

func (*ResourceMetadata) SetType Uses

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

SetType sets the Type field's value.

func (*ResourceMetadata) SetVersionId Uses

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

SetVersionId sets the VersionId field's value.

func (ResourceMetadata) String Uses

func (s ResourceMetadata) String() string

String returns the string representation

type ResourcePath Uses

type ResourcePath struct {

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

Describes the path information of a resource.

func (ResourcePath) GoString Uses

func (s ResourcePath) GoString() string

GoString returns the string representation

func (*ResourcePath) SetComponents Uses

func (s *ResourcePath) SetComponents(v []*ResourcePathComponent) *ResourcePath

SetComponents sets the Components field's value.

func (ResourcePath) String Uses

func (s ResourcePath) String() string

String returns the string representation

type ResourcePathComponent Uses

type ResourcePathComponent struct {

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

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

Describes the resource path.

func (ResourcePathComponent) GoString Uses

func (s ResourcePathComponent) GoString() string

GoString returns the string representation

func (*ResourcePathComponent) SetId Uses

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

SetId sets the Id field's value.

func (*ResourcePathComponent) SetName Uses

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

SetName sets the Name field's value.

func (ResourcePathComponent) String Uses

func (s ResourcePathComponent) String() string

String returns the string representation

type SharePrincipal Uses

type SharePrincipal struct {

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

    // The role of the recipient.
    //
    // Role is a required field
    Role *string `type:"string" required:"true" enum:"RoleType"`

    // The type of the recipient.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"PrincipalType"`
    // contains filtered or unexported fields
}

Describes the recipient type and ID, if available.

func (SharePrincipal) GoString Uses

func (s SharePrincipal) GoString() string

GoString returns the string representation

func (*SharePrincipal) SetId Uses

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

SetId sets the Id field's value.

func (*SharePrincipal) SetRole Uses

func (s *SharePrincipal) SetRole(v string) *SharePrincipal

SetRole sets the Role field's value.

func (*SharePrincipal) SetType Uses

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

SetType sets the Type field's value.

func (SharePrincipal) String Uses

func (s SharePrincipal) String() string

String returns the string representation

func (*SharePrincipal) Validate Uses

func (s *SharePrincipal) Validate() error

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

type ShareResult Uses

type ShareResult struct {

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

    // The ID of the principal.
    PrincipalId *string `min:"1" type:"string"`

    // The role.
    Role *string `type:"string" enum:"RoleType"`

    // The ID of the resource that was shared.
    ShareId *string `min:"1" type:"string"`

    // The status.
    Status *string `type:"string" enum:"ShareStatusType"`

    // The status message.
    StatusMessage *string `type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

Describes the share results of a resource.

func (ShareResult) GoString Uses

func (s ShareResult) GoString() string

GoString returns the string representation

func (*ShareResult) SetInviteePrincipalId Uses

func (s *ShareResult) SetInviteePrincipalId(v string) *ShareResult

SetInviteePrincipalId sets the InviteePrincipalId field's value.

func (*ShareResult) SetPrincipalId Uses

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

SetPrincipalId sets the PrincipalId field's value.

func (*ShareResult) SetRole Uses

func (s *ShareResult) SetRole(v string) *ShareResult

SetRole sets the Role field's value.

func (*ShareResult) SetShareId Uses

func (s *ShareResult) SetShareId(v string) *ShareResult

SetShareId sets the ShareId field's value.

func (*ShareResult) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*ShareResult) SetStatusMessage Uses

func (s *ShareResult) SetStatusMessage(v string) *ShareResult

SetStatusMessage sets the StatusMessage field's value.

func (ShareResult) String Uses

func (s ShareResult) String() string

String returns the string representation

type StorageRuleType Uses

type StorageRuleType struct {

    // The amount of storage allocated, in bytes.
    StorageAllocatedInBytes *int64 `type:"long"`

    // The type of storage.
    StorageType *string `type:"string" enum:"StorageType"`
    // contains filtered or unexported fields
}

Describes the storage for a user.

func (StorageRuleType) GoString Uses

func (s StorageRuleType) GoString() string

GoString returns the string representation

func (*StorageRuleType) SetStorageAllocatedInBytes Uses

func (s *StorageRuleType) SetStorageAllocatedInBytes(v int64) *StorageRuleType

SetStorageAllocatedInBytes sets the StorageAllocatedInBytes field's value.

func (*StorageRuleType) SetStorageType Uses

func (s *StorageRuleType) SetStorageType(v string) *StorageRuleType

SetStorageType sets the StorageType field's value.

func (StorageRuleType) String Uses

func (s StorageRuleType) String() string

String returns the string representation

type Subscription Uses

type Subscription struct {

    // The endpoint of the subscription.
    EndPoint *string `min:"1" type:"string"`

    // The protocol of the subscription.
    Protocol *string `type:"string" enum:"SubscriptionProtocolType"`

    // The ID of the subscription.
    SubscriptionId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Describes a subscription.

func (Subscription) GoString Uses

func (s Subscription) GoString() string

GoString returns the string representation

func (*Subscription) SetEndPoint Uses

func (s *Subscription) SetEndPoint(v string) *Subscription

SetEndPoint sets the EndPoint field's value.

func (*Subscription) SetProtocol Uses

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

SetProtocol sets the Protocol field's value.

func (*Subscription) SetSubscriptionId Uses

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

SetSubscriptionId sets the SubscriptionId field's value.

func (Subscription) String Uses

func (s Subscription) String() string

String returns the string representation

type UpdateDocumentInput Uses

type UpdateDocumentInput struct {

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

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

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

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

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

func (UpdateDocumentInput) GoString Uses

func (s UpdateDocumentInput) GoString() string

GoString returns the string representation

func (*UpdateDocumentInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*UpdateDocumentInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (*UpdateDocumentInput) SetName Uses

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

SetName sets the Name field's value.

func (*UpdateDocumentInput) SetParentFolderId Uses

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

SetParentFolderId sets the ParentFolderId field's value.

func (*UpdateDocumentInput) SetResourceState Uses

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

SetResourceState sets the ResourceState field's value.

func (UpdateDocumentInput) String Uses

func (s UpdateDocumentInput) String() string

String returns the string representation

func (*UpdateDocumentInput) Validate Uses

func (s *UpdateDocumentInput) Validate() error

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

type UpdateDocumentOutput Uses

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

func (UpdateDocumentOutput) GoString Uses

func (s UpdateDocumentOutput) GoString() string

GoString returns the string representation

func (UpdateDocumentOutput) String Uses

func (s UpdateDocumentOutput) String() string

String returns the string representation

type UpdateDocumentVersionInput Uses

type UpdateDocumentVersionInput struct {

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

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

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

    // The status of the version.
    VersionStatus *string `type:"string" enum:"DocumentVersionStatus"`
    // contains filtered or unexported fields
}

func (UpdateDocumentVersionInput) GoString Uses

func (s UpdateDocumentVersionInput) GoString() string

GoString returns the string representation

func (*UpdateDocumentVersionInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*UpdateDocumentVersionInput) SetDocumentId Uses

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

SetDocumentId sets the DocumentId field's value.

func (*UpdateDocumentVersionInput) SetVersionId Uses

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

SetVersionId sets the VersionId field's value.

func (*UpdateDocumentVersionInput) SetVersionStatus Uses

func (s *UpdateDocumentVersionInput) SetVersionStatus(v string) *UpdateDocumentVersionInput

SetVersionStatus sets the VersionStatus field's value.

func (UpdateDocumentVersionInput) String Uses

func (s UpdateDocumentVersionInput) String() string

String returns the string representation

func (*UpdateDocumentVersionInput) Validate Uses

func (s *UpdateDocumentVersionInput) Validate() error

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

type UpdateDocumentVersionOutput Uses

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

func (UpdateDocumentVersionOutput) GoString Uses

func (s UpdateDocumentVersionOutput) GoString() string

GoString returns the string representation

func (UpdateDocumentVersionOutput) String Uses

func (s UpdateDocumentVersionOutput) String() string

String returns the string representation

type UpdateFolderInput Uses

type UpdateFolderInput struct {

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

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

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

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

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

func (UpdateFolderInput) GoString Uses

func (s UpdateFolderInput) GoString() string

GoString returns the string representation

func (*UpdateFolderInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*UpdateFolderInput) SetFolderId Uses

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

SetFolderId sets the FolderId field's value.

func (*UpdateFolderInput) SetName Uses

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

SetName sets the Name field's value.

func (*UpdateFolderInput) SetParentFolderId Uses

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

SetParentFolderId sets the ParentFolderId field's value.

func (*UpdateFolderInput) SetResourceState Uses

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

SetResourceState sets the ResourceState field's value.

func (UpdateFolderInput) String Uses

func (s UpdateFolderInput) String() string

String returns the string representation

func (*UpdateFolderInput) Validate Uses

func (s *UpdateFolderInput) Validate() error

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

type UpdateFolderOutput Uses

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

func (UpdateFolderOutput) GoString Uses

func (s UpdateFolderOutput) GoString() string

GoString returns the string representation

func (UpdateFolderOutput) String Uses

func (s UpdateFolderOutput) String() string

String returns the string representation

type UpdateUserInput Uses

type UpdateUserInput struct {

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

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

    // Boolean value to determine whether the user is granted Poweruser privileges.
    GrantPoweruserPrivileges *string `type:"string" enum:"BooleanEnumType"`

    // The locale of the user.
    Locale *string `type:"string" enum:"LocaleType"`

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

    // The surname of the user.
    Surname *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 Uses

func (s UpdateUserInput) GoString() string

GoString returns the string representation

func (*UpdateUserInput) SetAuthenticationToken Uses

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

SetAuthenticationToken sets the AuthenticationToken field's value.

func (*UpdateUserInput) SetGivenName Uses

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

SetGivenName sets the GivenName field's value.

func (*UpdateUserInput) SetGrantPoweruserPrivileges Uses

func (s *UpdateUserInput) SetGrantPoweruserPrivileges(v string) *UpdateUserInput

SetGrantPoweruserPrivileges sets the GrantPoweruserPrivileges field's value.

func (*UpdateUserInput) SetLocale Uses

func (s *UpdateUserInput) SetLocale(v string) *UpdateUserInput

SetLocale sets the Locale field's value.

func (*UpdateUserInput) SetStorageRule Uses

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

SetStorageRule sets the StorageRule field's value.

func (*UpdateUserInput) SetSurname Uses

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

SetSurname sets the Surname field's value.

func (*UpdateUserInput) SetTimeZoneId Uses

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

SetTimeZoneId sets the TimeZoneId field's value.

func (*UpdateUserInput) SetType Uses

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

SetType sets the Type field's value.

func (*UpdateUserInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (UpdateUserInput) String Uses

func (s UpdateUserInput) String() string

String returns the string representation

func (*UpdateUserInput) Validate Uses

func (s *UpdateUserInput) Validate() error

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

type UpdateUserOutput Uses

type UpdateUserOutput struct {

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

func (UpdateUserOutput) GoString Uses

func (s UpdateUserOutput) GoString() string

GoString returns the string representation

func (*UpdateUserOutput) SetUser Uses

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

SetUser sets the User field's value.

func (UpdateUserOutput) String Uses

func (s UpdateUserOutput) String() string

String returns the string representation

type UploadMetadata Uses

type UploadMetadata struct {

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

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

Describes the upload.

func (UploadMetadata) GoString Uses

func (s UploadMetadata) GoString() string

GoString returns the string representation

func (*UploadMetadata) SetSignedHeaders Uses

func (s *UploadMetadata) SetSignedHeaders(v map[string]*string) *UploadMetadata

SetSignedHeaders sets the SignedHeaders field's value.

func (*UploadMetadata) SetUploadUrl Uses

func (s *UploadMetadata) SetUploadUrl(v string) *UploadMetadata

SetUploadUrl sets the UploadUrl field's value.

func (UploadMetadata) String Uses

func (s UploadMetadata) String() string

String returns the string representation

type User Uses

type User struct {

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

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

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

    // The ID of the recycle bin folder.
    RecycleBinFolderId *string `min:"1" type:"string"`

    // The ID of the root folder.
    RootFolderId *string `min:"1" type:"string"`

    // The status of the user.
    Status *string `type:"string" enum:"UserStatusType"`

    // The storage for the user.
    Storage *UserStorageMetadata `type:"structure"`

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

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

    // The type of user.
    Type *string `type:"string" enum:"UserType"`

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

Describes a user.

func (User) GoString Uses

func (s User) GoString() string

GoString returns the string representation

func (*User) SetCreatedTimestamp Uses

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*User) SetEmailAddress Uses

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

SetEmailAddress sets the EmailAddress field's value.

func (*User) SetGivenName Uses

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

SetGivenName sets the GivenName field's value.

func (*User) SetId Uses

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

SetId sets the Id field's value.

func (*User) SetLocale Uses

func (s *User) SetLocale(v string) *User

SetLocale sets the Locale field's value.

func (*User) SetModifiedTimestamp Uses

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

SetModifiedTimestamp sets the ModifiedTimestamp field's value.

func (*User) SetOrganizationId Uses

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

SetOrganizationId sets the OrganizationId field's value.

func (*User) SetRecycleBinFolderId Uses

func (s *User) SetRecycleBinFolderId(v string) *User

SetRecycleBinFolderId sets the RecycleBinFolderId field's value.

func (*User) SetRootFolderId Uses

func (s *User) SetRootFolderId(v string) *User

SetRootFolderId sets the RootFolderId field's value.

func (*User) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*User) SetStorage Uses

func (s *User) SetStorage(v *UserStorageMetadata) *User

SetStorage sets the Storage field's value.

func (*User) SetSurname Uses

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

SetSurname sets the Surname field's value.

func (*User) SetTimeZoneId Uses

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

SetTimeZoneId sets the TimeZoneId field's value.

func (*User) SetType Uses

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

SetType sets the Type field's value.

func (*User) SetUsername Uses

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

SetUsername sets the Username field's value.

func (User) String Uses

func (s User) String() string

String returns the string representation

type UserMetadata Uses

type UserMetadata struct {

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

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

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

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

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

Describes the metadata of the user.

func (UserMetadata) GoString Uses

func (s UserMetadata) GoString() string

GoString returns the string representation

func (*UserMetadata) SetEmailAddress Uses

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

SetEmailAddress sets the EmailAddress field's value.

func (*UserMetadata) SetGivenName Uses

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

SetGivenName sets the GivenName field's value.

func (*UserMetadata) SetId Uses

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

SetId sets the Id field's value.

func (*UserMetadata) SetSurname Uses

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

SetSurname sets the Surname field's value.

func (*UserMetadata) SetUsername Uses

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

SetUsername sets the Username field's value.

func (UserMetadata) String Uses

func (s UserMetadata) String() string

String returns the string representation

type UserStorageMetadata Uses

type UserStorageMetadata struct {

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

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

Describes the storage for a user.

func (UserStorageMetadata) GoString Uses

func (s UserStorageMetadata) GoString() string

GoString returns the string representation

func (*UserStorageMetadata) SetStorageRule Uses

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

SetStorageRule sets the StorageRule field's value.

func (*UserStorageMetadata) SetStorageUtilizedInBytes Uses

func (s *UserStorageMetadata) SetStorageUtilizedInBytes(v int64) *UserStorageMetadata

SetStorageUtilizedInBytes sets the StorageUtilizedInBytes field's value.

func (UserStorageMetadata) String Uses

func (s UserStorageMetadata) String() string

String returns the string representation

type WorkDocs Uses

type WorkDocs struct {
    *client.Client
}

WorkDocs provides the API operation methods for making requests to Amazon WorkDocs. See this package's package overview docs for details on the service.

WorkDocs methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AbortDocumentVersionUpload

func (*WorkDocs) AbortDocumentVersionUploadRequest Uses

func (c *WorkDocs) AbortDocumentVersionUploadRequest(input *AbortDocumentVersionUploadInput) (req *request.Request, output *AbortDocumentVersionUploadOutput)

AbortDocumentVersionUploadRequest generates a "aws/request.Request" representing the client's request for the AbortDocumentVersionUpload operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AbortDocumentVersionUpload for more information on using the AbortDocumentVersionUpload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AbortDocumentVersionUploadRequest method.
req, resp := client.AbortDocumentVersionUploadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AbortDocumentVersionUpload

func (*WorkDocs) AbortDocumentVersionUploadWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUser

func (*WorkDocs) ActivateUserRequest Uses

func (c *WorkDocs) ActivateUserRequest(input *ActivateUserInput) (req *request.Request, output *ActivateUserOutput)

ActivateUserRequest generates a "aws/request.Request" representing the client's request for the ActivateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ActivateUser for more information on using the ActivateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ActivateUserRequest method.
req, resp := client.ActivateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUser

func (*WorkDocs) ActivateUserWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AddResourcePermissions

func (*WorkDocs) AddResourcePermissionsRequest Uses

func (c *WorkDocs) AddResourcePermissionsRequest(input *AddResourcePermissionsInput) (req *request.Request, output *AddResourcePermissionsOutput)

AddResourcePermissionsRequest generates a "aws/request.Request" representing the client's request for the AddResourcePermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddResourcePermissions for more information on using the AddResourcePermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddResourcePermissionsRequest method.
req, resp := client.AddResourcePermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AddResourcePermissions

func (*WorkDocs) AddResourcePermissionsWithContext Uses

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 Uses

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.

* ErrCodeInvalidCommentOperationException "InvalidCommentOperationException"
The requested operation is not allowed on the specified comment object.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateComment

func (*WorkDocs) CreateCommentRequest Uses

func (c *WorkDocs) CreateCommentRequest(input *CreateCommentInput) (req *request.Request, output *CreateCommentOutput)

CreateCommentRequest generates a "aws/request.Request" representing the client's request for the CreateComment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateComment for more information on using the CreateComment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCommentRequest method.
req, resp := client.CreateCommentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateComment

func (*WorkDocs) CreateCommentWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCustomMetadata

func (*WorkDocs) CreateCustomMetadataRequest Uses

func (c *WorkDocs) CreateCustomMetadataRequest(input *CreateCustomMetadataInput) (req *request.Request, output *CreateCustomMetadataOutput)

CreateCustomMetadataRequest generates a "aws/request.Request" representing the client's request for the CreateCustomMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCustomMetadata for more information on using the CreateCustomMetadata API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCustomMetadataRequest method.
req, resp := client.CreateCustomMetadataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCustomMetadata

func (*WorkDocs) CreateCustomMetadataWithContext Uses

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 Uses

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.

* ErrCodeConflictingOperationException "ConflictingOperationException"
Another operation is in progress on the resource that conflicts with the
current operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateFolder

func (*WorkDocs) CreateFolderRequest Uses

func (c *WorkDocs) CreateFolderRequest(input *CreateFolderInput) (req *request.Request, output *CreateFolderOutput)

CreateFolderRequest generates a "aws/request.Request" representing the client's request for the CreateFolder operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFolder for more information on using the CreateFolder API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFolderRequest method.
req, resp := client.CreateFolderRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateFolder

func (*WorkDocs) CreateFolderWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabels

func (*WorkDocs) CreateLabelsRequest Uses

func (c *WorkDocs) CreateLabelsRequest(input *CreateLabelsInput) (req *request.Request, output *CreateLabelsOutput)

CreateLabelsRequest generates a "aws/request.Request" representing the client's request for the CreateLabels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLabels for more information on using the CreateLabels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLabelsRequest method.
req, resp := client.CreateLabelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabels

func (*WorkDocs) CreateLabelsWithContext Uses

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 Uses

func (c *WorkDocs) CreateNotificationSubscription(input *CreateNotificationSubscriptionInput) (*CreateNotificationSubscriptionOutput, error)

CreateNotificationSubscription API operation for Amazon WorkDocs.

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

For more information, see Subscribe to Notifications (https://docs.aws.amazon.com/workdocs/latest/developerguide/subscribe-notifications.html) in the Amazon WorkDocs Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation CreateNotificationSubscription for usage and error information.

Returned Error 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateNotificationSubscription

func (*WorkDocs) CreateNotificationSubscriptionRequest Uses

func (c *WorkDocs) CreateNotificationSubscriptionRequest(input *CreateNotificationSubscriptionInput) (req *request.Request, output *CreateNotificationSubscriptionOutput)

CreateNotificationSubscriptionRequest generates a "aws/request.Request" representing the client's request for the CreateNotificationSubscription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateNotificationSubscription for more information on using the CreateNotificationSubscription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateNotificationSubscriptionRequest method.
req, resp := client.CreateNotificationSubscriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateNotificationSubscription

func (*WorkDocs) CreateNotificationSubscriptionWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUser

func (*WorkDocs) CreateUserRequest Uses

func (c *WorkDocs) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)

CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateUser for more information on using the CreateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateUserRequest method.
req, resp := client.CreateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUser

func (*WorkDocs) CreateUserWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUser

func (*WorkDocs) DeactivateUserRequest Uses

func (c *WorkDocs) DeactivateUserRequest(input *DeactivateUserInput) (req *request.Request, output *DeactivateUserOutput)

DeactivateUserRequest generates a "aws/request.Request" representing the client's request for the DeactivateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeactivateUser for more information on using the DeactivateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeactivateUserRequest method.
req, resp := client.DeactivateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUser

func (*WorkDocs) DeactivateUserWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteComment

func (*WorkDocs) DeleteCommentRequest Uses

func (c *WorkDocs) DeleteCommentRequest(input *DeleteCommentInput) (req *request.Request, output *DeleteCommentOutput)

DeleteCommentRequest generates a "aws/request.Request" representing the client's request for the DeleteComment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteComment for more information on using the DeleteComment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteCommentRequest method.
req, resp := client.DeleteCommentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteComment

func (*WorkDocs) DeleteCommentWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCustomMetadata

func (*WorkDocs) DeleteCustomMetadataRequest Uses

func (c *WorkDocs) DeleteCustomMetadataRequest(input *DeleteCustomMetadataInput) (req *request.Request, output *DeleteCustomMetadataOutput)

DeleteCustomMetadataRequest generates a "aws/request.Request" representing the client's request for the DeleteCustomMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCustomMetadata for more information on using the DeleteCustomMetadata API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteCustomMetadataRequest method.
req, resp := client.DeleteCustomMetadataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCustomMetadata

func (*WorkDocs) DeleteCustomMetadataWithContext Uses

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 Uses

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.

* ErrCodeConflictingOperationException "ConflictingOperationException"
Another operation is in progress on the resource that conflicts with the
current operation.

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

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

func (*WorkDocs) DeleteDocumentRequest Uses

func (c *WorkDocs) DeleteDocumentRequest(input *DeleteDocumentInput) (req *request.Request, output *DeleteDocumentOutput)

DeleteDocumentRequest generates a "aws/request.Request" representing the client's request for the DeleteDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDocument for more information on using the DeleteDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDocumentRequest method.
req, resp := client.DeleteDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkDocs) DeleteDocumentWithContext Uses

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 Uses

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.

* ErrCodeConflictingOperationException "ConflictingOperationException"
Another operation is in progress on the resource that conflicts with the
current operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolder

func (*WorkDocs) DeleteFolderContents Uses

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.

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

* ErrCodeConflictingOperationException "ConflictingOperationException"
Another operation is in progress on the resource that conflicts with the
current operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderContents

func (*WorkDocs) DeleteFolderContentsRequest Uses

func (c *WorkDocs) DeleteFolderContentsRequest(input *DeleteFolderContentsInput) (req *request.Request, output *DeleteFolderContentsOutput)

DeleteFolderContentsRequest generates a "aws/request.Request" representing the client's request for the DeleteFolderContents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFolderContents for more information on using the DeleteFolderContents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFolderContentsRequest method.
req, resp := client.DeleteFolderContentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderContents

func (*WorkDocs) DeleteFolderContentsWithContext Uses

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 Uses

func (c *WorkDocs) DeleteFolderRequest(input *DeleteFolderInput) (req *request.Request, output *DeleteFolderOutput)

DeleteFolderRequest generates a "aws/request.Request" representing the client's request for the DeleteFolder operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFolder for more information on using the DeleteFolder API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFolderRequest method.
req, resp := client.DeleteFolderRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolder

func (*WorkDocs) DeleteFolderWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteLabels

func (*WorkDocs) DeleteLabelsRequest Uses

func (c *WorkDocs) DeleteLabelsRequest(input *DeleteLabelsInput) (req *request.Request, output *DeleteLabelsOutput)

DeleteLabelsRequest generates a "aws/request.Request" representing the client's request for the DeleteLabels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLabels for more information on using the DeleteLabels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLabelsRequest method.
req, resp := client.DeleteLabelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteLabels

func (*WorkDocs) DeleteLabelsWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteNotificationSubscription

func (*WorkDocs) DeleteNotificationSubscriptionRequest Uses

func (c *WorkDocs) DeleteNotificationSubscriptionRequest(input *DeleteNotificationSubscriptionInput) (req *request.Request, output *DeleteNotificationSubscriptionOutput)

DeleteNotificationSubscriptionRequest generates a "aws/request.Request" representing the client's request for the DeleteNotificationSubscription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteNotificationSubscription for more information on using the DeleteNotificationSubscription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteNotificationSubscriptionRequest method.
req, resp := client.DeleteNotificationSubscriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteNotificationSubscription

func (*WorkDocs) DeleteNotificationSubscriptionWithContext Uses

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 Uses

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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteUser

func (*WorkDocs) DeleteUserRequest Uses

func (c *WorkDocs) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUser for more information on using the DeleteUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteUserRequest method.
req, resp := client.DeleteUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteUser

func (*WorkDocs) DeleteUserWithContext Uses

func (c *WorkDocs) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.

See DeleteUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeActivities Uses

func (c *WorkDocs) DescribeActivities(input *DescribeActivitiesInput) (*DescribeActivitiesOutput, error)

DescribeActivities API operation for Amazon WorkDocs.

Describes the user activities in a specified time period.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeActivities for usage and error information.

Returned Error Codes:

* ErrCodeUnauthorizedOperationException "UnauthorizedOperationException"
The operation is not permitted.

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

* ErrCodeInvalidArgumentException "InvalidArgumentException"
The pagination marker 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.

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

func (*WorkDocs) DescribeActivitiesRequest Uses

func (c *WorkDocs) DescribeActivitiesRequest(input *DescribeActivitiesInput) (req *request.Request, output *DescribeActivitiesOutput)

DescribeActivitiesRequest generates a "aws/request.Request" representing the client's request for the DescribeActivities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeActivities for more information on using the DescribeActivities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeActivitiesRequest method.
req, resp := client.DescribeActivitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkDocs) DescribeActivitiesWithContext Uses

func (c *WorkDocs) DescribeActivitiesWithContext(ctx aws.Context, input *DescribeActivitiesInput, opts ...request.Option) (*DescribeActivitiesOutput, error)

DescribeActivitiesWithContext is the same as DescribeActivities with the addition of the ability to pass a context and additional request options.

See DescribeActivities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeComments Uses

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.

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

func (*WorkDocs) DescribeCommentsRequest Uses

func (c *WorkDocs) DescribeCommentsRequest(input *DescribeCommentsInput) (req *request.Request, output *DescribeCommentsOutput)

DescribeCommentsRequest generates a "aws/request.Request" representing the client's request for the DescribeComments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeComments for more information on using the DescribeComments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCommentsRequest method.
req, resp := client.DescribeCommentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkDocs) DescribeCommentsWithContext Uses

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 Uses

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeDocumentVersions

func (*WorkDocs) DescribeDocumentVersionsPages Uses

func (c *WorkDocs) DescribeDocumentVersionsPages(input *DescribeDocumentVersionsInput, fn func(*DescribeDocumentVersionsOutput, bool) bool) error

DescribeDocumentVersionsPages iterates over the pages of a DescribeDocumentVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDocumentVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDocumentVersions operation.
pageNum := 0
err := client.DescribeDocumentVersionsPages(params,
    func(page *workdocs.DescribeDocumentVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeDocumentVersionsPagesWithContext Uses

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 Uses

func (c *WorkDocs) DescribeDocumentVersionsRequest(input *DescribeDocumentVersionsInput) (req *request.Request, output *DescribeDocumentVersionsOutput)

DescribeDocumentVersionsRequest generates a "aws/request.Request" representing the client's request for the DescribeDocumentVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDocumentVersions for more information on using the DescribeDocumentVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDocumentVersionsRequest method.
req, resp := client.DescribeDocumentVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeDocumentVersions

func (*WorkDocs) DescribeDocumentVersionsWithContext Uses

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 Uses

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeFolderContents

func (*WorkDocs) DescribeFolderContentsPages Uses

func (c *WorkDocs) DescribeFolderContentsPages(input *DescribeFolderContentsInput, fn func(*DescribeFolderContentsOutput, bool) bool) error

DescribeFolderContentsPages iterates over the pages of a DescribeFolderContents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeFolderContents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeFolderContents operation.
pageNum := 0
err := client.DescribeFolderContentsPages(params,
    func(page *workdocs.DescribeFolderContentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WorkDocs) DescribeFolderContentsPagesWithContext Uses

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 Uses

func (c *WorkDocs) DescribeFolderContentsRequest(input *DescribeFolderContentsInput) (req *request.Request, output *DescribeFolderContentsOutput)

DescribeFolderContentsRequest generates a "aws/request.Request" representing the client's request for the DescribeFolderContents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFolderContents for more information on using the DescribeFolderContents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFolderContentsRequest method.
req, resp := client.DescribeFolderContentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeFolderContents

func (*WorkDocs) DescribeFolderContentsWithContext Uses

func (c *WorkDocs) DescribeFolderContentsWithContext(ctx aws.Context, input *DescribeFolderContentsInput, opts ...request.Option) (*DescribeFolderContentsOutput, error)

DescribeFolderContentsWithContext is the same as DescribeFolderContents with the addition of the ability to pass a context and additional request options.

See DescribeFolderContents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs) DescribeGroups Uses

func (c *WorkDocs) DescribeGroups(input *DescribeGroupsInput) (*DescribeGroupsOutput, error)

DescribeGroups API operation for Amazon WorkDocs.

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkDocs's API operation DescribeGroups for usage and error information.

Returned Error 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeGroups

func (*WorkDocs) DescribeGroupsRequest Uses

func (c *WorkDocs) DescribeGroupsRequest(input *DescribeGroupsInput) (req *request.Request, output *DescribeGroupsOutput)

DescribeGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGroups for more information on using the DescribeGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeGroupsRequest method.
req, resp := client.DescribeGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeGroups

func (*WorkDocs) DescribeGroupsWithContext Uses

func (c *WorkDocs) DescribeGroupsWithContext(ctx aws.Context, input *DescribeGroupsInput, opts ...request.Option) (*DescribeGroupsOutput, error)

DescribeGroupsWithContext is the same as DescribeGroups with the addition of the ability to pass a context and additional request options.

See DescribeGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkDocs)