workdocs

package
v0.20.0 Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2020 License: Apache-2.0 Imports: 9 Imported by: 22

Documentation

Overview

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

The WorkDocs API is designed for the following use cases:

  • File Migration: File migration applications are supported for users who want to migrate their files from an on-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 use 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 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/workdocs/#New

Index

Constants

View Source 
const (
	ServiceName = "Amazon WorkDocs" // Service's name
	ServiceID   = "WorkDocs"        // Service's identifier
	EndpointsID = "workdocs"        // Service's Endpoint identifier
)
View Source 
const (

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

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

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

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

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

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

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

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

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

Variables

This section is empty.

Functions

This section is empty.

Types

type AbortDocumentVersionUploadInput 

type AbortDocumentVersionUploadInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s AbortDocumentVersionUploadInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AbortDocumentVersionUploadInput) String 

func (s AbortDocumentVersionUploadInput) String() string

String returns the string representation

func (*AbortDocumentVersionUploadInput) Validate 

func (s *AbortDocumentVersionUploadInput) Validate() error

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

type AbortDocumentVersionUploadOutput 

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

func (AbortDocumentVersionUploadOutput) MarshalFields added in v0.3.0 

func (s AbortDocumentVersionUploadOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AbortDocumentVersionUploadOutput) String 

func (s AbortDocumentVersionUploadOutput) String() string

String returns the string representation

type AbortDocumentVersionUploadRequest 

type AbortDocumentVersionUploadRequest struct {
	*aws.Request
	Input *AbortDocumentVersionUploadInput
	Copy  func(*AbortDocumentVersionUploadInput) AbortDocumentVersionUploadRequest
}

AbortDocumentVersionUploadRequest is the request type for the AbortDocumentVersionUpload API operation.

func (AbortDocumentVersionUploadRequest) Send 

func (r AbortDocumentVersionUploadRequest) Send(ctx context.Context) (*AbortDocumentVersionUploadResponse, error)

Send marshals and sends the AbortDocumentVersionUpload API request.

type AbortDocumentVersionUploadResponse added in v0.9.0 

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

AbortDocumentVersionUploadResponse is the response type for the AbortDocumentVersionUpload API operation.

func (*AbortDocumentVersionUploadResponse) SDKResponseMetdata added in v0.9.0 

func (r *AbortDocumentVersionUploadResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AbortDocumentVersionUpload request.

type ActivateUserInput 

type ActivateUserInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s ActivateUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ActivateUserInput) String 

func (s ActivateUserInput) String() string

String returns the string representation

func (*ActivateUserInput) Validate 

func (s *ActivateUserInput) Validate() error

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

type ActivateUserOutput 

type ActivateUserOutput struct {

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

func (ActivateUserOutput) MarshalFields added in v0.3.0 

func (s ActivateUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ActivateUserOutput) String 

func (s ActivateUserOutput) String() string

String returns the string representation

type ActivateUserRequest 

type ActivateUserRequest struct {
	*aws.Request
	Input *ActivateUserInput
	Copy  func(*ActivateUserInput) ActivateUserRequest
}

ActivateUserRequest is the request type for the ActivateUser API operation.

func (ActivateUserRequest) Send 

func (r ActivateUserRequest) Send(ctx context.Context) (*ActivateUserResponse, error)

Send marshals and sends the ActivateUser API request.

type ActivateUserResponse added in v0.9.0 

type ActivateUserResponse struct {
	*ActivateUserOutput
	// contains filtered or unexported fields
}

ActivateUserResponse is the response type for the ActivateUser API operation.

func (*ActivateUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *ActivateUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ActivateUser request.

type Activity 

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

Describes the activity information.

func (Activity) MarshalFields added in v0.3.0 

func (s Activity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Activity) String 

func (s Activity) String() string

String returns the string representation

type ActivityType 

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

Enum values for ActivityType

func (ActivityType) MarshalValue added in v0.3.0 

func (enum ActivityType) MarshalValue() (string, error)

func (ActivityType) MarshalValueBuf added in v0.3.0 

func (enum ActivityType) MarshalValueBuf(b []byte) ([]byte, error)

type AddResourcePermissionsInput 

type AddResourcePermissionsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s AddResourcePermissionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AddResourcePermissionsInput) String 

func (s AddResourcePermissionsInput) String() string

String returns the string representation

func (*AddResourcePermissionsInput) Validate 

func (s *AddResourcePermissionsInput) Validate() error

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

type AddResourcePermissionsOutput 

type AddResourcePermissionsOutput struct {

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

func (AddResourcePermissionsOutput) MarshalFields added in v0.3.0 

func (s AddResourcePermissionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AddResourcePermissionsOutput) String 

func (s AddResourcePermissionsOutput) String() string

String returns the string representation

type AddResourcePermissionsRequest 

type AddResourcePermissionsRequest struct {
	*aws.Request
	Input *AddResourcePermissionsInput
	Copy  func(*AddResourcePermissionsInput) AddResourcePermissionsRequest
}

AddResourcePermissionsRequest is the request type for the AddResourcePermissions API operation.

func (AddResourcePermissionsRequest) Send 

func (r AddResourcePermissionsRequest) Send(ctx context.Context) (*AddResourcePermissionsResponse, error)

Send marshals and sends the AddResourcePermissions API request.

type AddResourcePermissionsResponse added in v0.9.0 

type AddResourcePermissionsResponse struct {
	*AddResourcePermissionsOutput
	// contains filtered or unexported fields
}

AddResourcePermissionsResponse is the response type for the AddResourcePermissions API operation.

func (*AddResourcePermissionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *AddResourcePermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AddResourcePermissions request.

type BooleanEnumType added in v0.2.0 

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

Enum values for BooleanEnumType

func (BooleanEnumType) MarshalValue added in v0.3.0 

func (enum BooleanEnumType) MarshalValue() (string, error)

func (BooleanEnumType) MarshalValueBuf added in v0.3.0 

func (enum BooleanEnumType) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := workdocs.New(myConfig)

func (*Client) AbortDocumentVersionUploadRequest added in v0.9.0 

func (c *Client) AbortDocumentVersionUploadRequest(input *AbortDocumentVersionUploadInput) AbortDocumentVersionUploadRequest

AbortDocumentVersionUploadRequest returns a request value for making 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. 

// Example sending a request using AbortDocumentVersionUploadRequest.
req := client.AbortDocumentVersionUploadRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ActivateUserRequest added in v0.9.0 

func (c *Client) ActivateUserRequest(input *ActivateUserInput) ActivateUserRequest

ActivateUserRequest returns a request value for making API operation for Amazon WorkDocs.

Activates the specified user. Only active users can access Amazon WorkDocs. 

// Example sending a request using ActivateUserRequest.
req := client.ActivateUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) AddResourcePermissionsRequest added in v0.9.0 

func (c *Client) AddResourcePermissionsRequest(input *AddResourcePermissionsInput) AddResourcePermissionsRequest

AddResourcePermissionsRequest returns a request value for making 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. 

// Example sending a request using AddResourcePermissionsRequest.
req := client.AddResourcePermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateCommentRequest added in v0.9.0 

func (c *Client) CreateCommentRequest(input *CreateCommentInput) CreateCommentRequest

CreateCommentRequest returns a request value for making API operation for Amazon WorkDocs.

Adds a new comment to the specified document version. 

// Example sending a request using CreateCommentRequest.
req := client.CreateCommentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateCustomMetadataRequest added in v0.9.0 

func (c *Client) CreateCustomMetadataRequest(input *CreateCustomMetadataInput) CreateCustomMetadataRequest

CreateCustomMetadataRequest returns a request value for making API operation for Amazon WorkDocs.

Adds one or more custom properties to the specified resource (a folder, document, or version). 

// Example sending a request using CreateCustomMetadataRequest.
req := client.CreateCustomMetadataRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateFolderRequest added in v0.9.0 

func (c *Client) CreateFolderRequest(input *CreateFolderInput) CreateFolderRequest

CreateFolderRequest returns a request value for making API operation for Amazon WorkDocs.

Creates a folder with the specified name and parent folder. 

// Example sending a request using CreateFolderRequest.
req := client.CreateFolderRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateLabelsRequest added in v0.9.0 

func (c *Client) CreateLabelsRequest(input *CreateLabelsInput) CreateLabelsRequest

CreateLabelsRequest returns a request value for making API operation for Amazon WorkDocs.

Adds the specified list of labels to the given resource (a document or folder) 

// Example sending a request using CreateLabelsRequest.
req := client.CreateLabelsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateNotificationSubscriptionRequest added in v0.9.0 

func (c *Client) CreateNotificationSubscriptionRequest(input *CreateNotificationSubscriptionInput) CreateNotificationSubscriptionRequest

CreateNotificationSubscriptionRequest returns a request value for making 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. 

// Example sending a request using CreateNotificationSubscriptionRequest.
req := client.CreateNotificationSubscriptionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateUserRequest added in v0.9.0 

func (c *Client) CreateUserRequest(input *CreateUserInput) CreateUserRequest

CreateUserRequest returns a request value for making 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. 

// Example sending a request using CreateUserRequest.
req := client.CreateUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeactivateUserRequest added in v0.9.0 

func (c *Client) DeactivateUserRequest(input *DeactivateUserInput) DeactivateUserRequest

DeactivateUserRequest returns a request value for making API operation for Amazon WorkDocs.

Deactivates the specified user, which revokes the user's access to Amazon WorkDocs. 

// Example sending a request using DeactivateUserRequest.
req := client.DeactivateUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteCommentRequest added in v0.9.0 

func (c *Client) DeleteCommentRequest(input *DeleteCommentInput) DeleteCommentRequest

DeleteCommentRequest returns a request value for making API operation for Amazon WorkDocs.

Deletes the specified comment from the document version. 

// Example sending a request using DeleteCommentRequest.
req := client.DeleteCommentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteCustomMetadataRequest added in v0.9.0 

func (c *Client) DeleteCustomMetadataRequest(input *DeleteCustomMetadataInput) DeleteCustomMetadataRequest

DeleteCustomMetadataRequest returns a request value for making API operation for Amazon WorkDocs.

Deletes custom metadata from the specified resource. 

// Example sending a request using DeleteCustomMetadataRequest.
req := client.DeleteCustomMetadataRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteDocumentRequest added in v0.9.0 

func (c *Client) DeleteDocumentRequest(input *DeleteDocumentInput) DeleteDocumentRequest

DeleteDocumentRequest returns a request value for making API operation for Amazon WorkDocs.

Permanently deletes the specified document and its associated metadata. 

// Example sending a request using DeleteDocumentRequest.
req := client.DeleteDocumentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteFolderContentsRequest added in v0.9.0 

func (c *Client) DeleteFolderContentsRequest(input *DeleteFolderContentsInput) DeleteFolderContentsRequest

DeleteFolderContentsRequest returns a request value for making API operation for Amazon WorkDocs.

Deletes the contents of the specified folder. 

// Example sending a request using DeleteFolderContentsRequest.
req := client.DeleteFolderContentsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteFolderRequest added in v0.9.0 

func (c *Client) DeleteFolderRequest(input *DeleteFolderInput) DeleteFolderRequest

DeleteFolderRequest returns a request value for making API operation for Amazon WorkDocs.

Permanently deletes the specified folder and its contents. 

// Example sending a request using DeleteFolderRequest.
req := client.DeleteFolderRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteLabelsRequest added in v0.9.0 

func (c *Client) DeleteLabelsRequest(input *DeleteLabelsInput) DeleteLabelsRequest

DeleteLabelsRequest returns a request value for making API operation for Amazon WorkDocs.

Deletes the specified list of labels from a resource. 

// Example sending a request using DeleteLabelsRequest.
req := client.DeleteLabelsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteNotificationSubscriptionRequest added in v0.9.0 

func (c *Client) DeleteNotificationSubscriptionRequest(input *DeleteNotificationSubscriptionInput) DeleteNotificationSubscriptionRequest

DeleteNotificationSubscriptionRequest returns a request value for making API operation for Amazon WorkDocs.

Deletes the specified subscription from the specified organization. 

// Example sending a request using DeleteNotificationSubscriptionRequest.
req := client.DeleteNotificationSubscriptionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteUserRequest added in v0.9.0 

func (c *Client) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest

DeleteUserRequest returns a request value for making API operation for Amazon WorkDocs.

Deletes the specified user from a Simple AD or Microsoft AD directory. 

// Example sending a request using DeleteUserRequest.
req := client.DeleteUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeActivitiesRequest added in v0.9.0 

func (c *Client) DescribeActivitiesRequest(input *DescribeActivitiesInput) DescribeActivitiesRequest

DescribeActivitiesRequest returns a request value for making API operation for Amazon WorkDocs.

Describes the user activities in a specified time period. 

// Example sending a request using DescribeActivitiesRequest.
req := client.DescribeActivitiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeCommentsRequest added in v0.9.0 

func (c *Client) DescribeCommentsRequest(input *DescribeCommentsInput) DescribeCommentsRequest

DescribeCommentsRequest returns a request value for making API operation for Amazon WorkDocs.

List all the comments for the specified document version. 

// Example sending a request using DescribeCommentsRequest.
req := client.DescribeCommentsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeDocumentVersionsRequest added in v0.9.0 

func (c *Client) DescribeDocumentVersionsRequest(input *DescribeDocumentVersionsInput) DescribeDocumentVersionsRequest

DescribeDocumentVersionsRequest returns a request value for making API operation for Amazon WorkDocs.

Retrieves the document versions for the specified document.

By default, only active versions are returned. 

// Example sending a request using DescribeDocumentVersionsRequest.
req := client.DescribeDocumentVersionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeFolderContentsRequest added in v0.9.0 

func (c *Client) DescribeFolderContentsRequest(input *DescribeFolderContentsInput) DescribeFolderContentsRequest

DescribeFolderContentsRequest returns a request value for making 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. 

// Example sending a request using DescribeFolderContentsRequest.
req := client.DescribeFolderContentsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeGroupsRequest added in v0.9.0 

func (c *Client) DescribeGroupsRequest(input *DescribeGroupsInput) DescribeGroupsRequest

DescribeGroupsRequest returns a request value for making API operation for Amazon WorkDocs.

Describes the groups specified by the query. Groups are defined by the underlying Active Directory. 

// Example sending a request using DescribeGroupsRequest.
req := client.DescribeGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeNotificationSubscriptionsRequest added in v0.9.0 

func (c *Client) DescribeNotificationSubscriptionsRequest(input *DescribeNotificationSubscriptionsInput) DescribeNotificationSubscriptionsRequest

DescribeNotificationSubscriptionsRequest returns a request value for making API operation for Amazon WorkDocs.

Lists the specified notification subscriptions. 

// Example sending a request using DescribeNotificationSubscriptionsRequest.
req := client.DescribeNotificationSubscriptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeResourcePermissionsRequest added in v0.9.0 

func (c *Client) DescribeResourcePermissionsRequest(input *DescribeResourcePermissionsInput) DescribeResourcePermissionsRequest

DescribeResourcePermissionsRequest returns a request value for making API operation for Amazon WorkDocs.

Describes the permissions of a specified resource. 

// Example sending a request using DescribeResourcePermissionsRequest.
req := client.DescribeResourcePermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeRootFoldersRequest added in v0.9.0 

func (c *Client) DescribeRootFoldersRequest(input *DescribeRootFoldersInput) DescribeRootFoldersRequest

DescribeRootFoldersRequest returns a request value for making API operation for Amazon WorkDocs.

Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html) in the Amazon WorkDocs Developer Guide. 

// Example sending a request using DescribeRootFoldersRequest.
req := client.DescribeRootFoldersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeUsersRequest added in v0.9.0 

func (c *Client) DescribeUsersRequest(input *DescribeUsersInput) DescribeUsersRequest

DescribeUsersRequest returns a request value for making API operation for Amazon WorkDocs.

Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results. 

// Example sending a request using DescribeUsersRequest.
req := client.DescribeUsersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetCurrentUserRequest added in v0.9.0 

func (c *Client) GetCurrentUserRequest(input *GetCurrentUserInput) GetCurrentUserRequest

GetCurrentUserRequest returns a request value for making API operation for Amazon WorkDocs.

Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html) in the Amazon WorkDocs Developer Guide. 

// Example sending a request using GetCurrentUserRequest.
req := client.GetCurrentUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetDocumentPathRequest added in v0.9.0 

func (c *Client) GetDocumentPathRequest(input *GetDocumentPathInput) GetDocumentPathRequest

GetDocumentPathRequest returns a request value for making API operation for Amazon WorkDocs.

Retrieves the path information (the hierarchy from the root folder) for the requested document.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders. 

// Example sending a request using GetDocumentPathRequest.
req := client.GetDocumentPathRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetDocumentRequest added in v0.9.0 

func (c *Client) GetDocumentRequest(input *GetDocumentInput) GetDocumentRequest

GetDocumentRequest returns a request value for making API operation for Amazon WorkDocs.

Retrieves details of a document. 

// Example sending a request using GetDocumentRequest.
req := client.GetDocumentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetDocumentVersionRequest added in v0.9.0 

func (c *Client) GetDocumentVersionRequest(input *GetDocumentVersionInput) GetDocumentVersionRequest

GetDocumentVersionRequest returns a request value for making API operation for Amazon WorkDocs.

Retrieves version metadata for the specified document. 

// Example sending a request using GetDocumentVersionRequest.
req := client.GetDocumentVersionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetFolderPathRequest added in v0.9.0 

func (c *Client) GetFolderPathRequest(input *GetFolderPathInput) GetFolderPathRequest

GetFolderPathRequest returns a request value for making API operation for Amazon WorkDocs.

Retrieves the path information (the hierarchy from the root folder) for the specified folder.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names. 

// Example sending a request using GetFolderPathRequest.
req := client.GetFolderPathRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetFolderRequest added in v0.9.0 

func (c *Client) GetFolderRequest(input *GetFolderInput) GetFolderRequest

GetFolderRequest returns a request value for making API operation for Amazon WorkDocs.

Retrieves the metadata of the specified folder. 

// Example sending a request using GetFolderRequest.
req := client.GetFolderRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetResourcesRequest added in v0.9.0 

func (c *Client) GetResourcesRequest(input *GetResourcesInput) GetResourcesRequest

GetResourcesRequest returns a request value for making API operation for Amazon WorkDocs.

Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME. 

// Example sending a request using GetResourcesRequest.
req := client.GetResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) InitiateDocumentVersionUploadRequest added in v0.9.0 

func (c *Client) InitiateDocumentVersionUploadRequest(input *InitiateDocumentVersionUploadInput) InitiateDocumentVersionUploadRequest

InitiateDocumentVersionUploadRequest returns a request value for making API operation for Amazon WorkDocs.

Creates a new document object and version object.

The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.

To cancel the document upload, call AbortDocumentVersionUpload. 

// Example sending a request using InitiateDocumentVersionUploadRequest.
req := client.InitiateDocumentVersionUploadRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) RemoveAllResourcePermissionsRequest added in v0.9.0 

func (c *Client) RemoveAllResourcePermissionsRequest(input *RemoveAllResourcePermissionsInput) RemoveAllResourcePermissionsRequest

RemoveAllResourcePermissionsRequest returns a request value for making API operation for Amazon WorkDocs.

Removes all the permissions from the specified resource. 

// Example sending a request using RemoveAllResourcePermissionsRequest.
req := client.RemoveAllResourcePermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) RemoveResourcePermissionRequest added in v0.9.0 

func (c *Client) RemoveResourcePermissionRequest(input *RemoveResourcePermissionInput) RemoveResourcePermissionRequest

RemoveResourcePermissionRequest returns a request value for making API operation for Amazon WorkDocs.

Removes the permission for the specified principal from the specified resource. 

// Example sending a request using RemoveResourcePermissionRequest.
req := client.RemoveResourcePermissionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateDocumentRequest added in v0.9.0 

func (c *Client) UpdateDocumentRequest(input *UpdateDocumentInput) UpdateDocumentRequest

UpdateDocumentRequest returns a request value for making API operation for Amazon WorkDocs.

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable. 

// Example sending a request using UpdateDocumentRequest.
req := client.UpdateDocumentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateDocumentVersionRequest added in v0.9.0 

func (c *Client) UpdateDocumentVersionRequest(input *UpdateDocumentVersionInput) UpdateDocumentVersionRequest

UpdateDocumentVersionRequest returns a request value for making API operation for Amazon WorkDocs.

Changes the status of the document version to ACTIVE.

Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload. 

// Example sending a request using UpdateDocumentVersionRequest.
req := client.UpdateDocumentVersionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateFolderRequest added in v0.9.0 

func (c *Client) UpdateFolderRequest(input *UpdateFolderInput) UpdateFolderRequest

UpdateFolderRequest returns a request value for making API operation for Amazon WorkDocs.

Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable. 

// Example sending a request using UpdateFolderRequest.
req := client.UpdateFolderRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateUserRequest added in v0.9.0 

func (c *Client) UpdateUserRequest(input *UpdateUserInput) UpdateUserRequest

UpdateUserRequest returns a request value for making API operation for Amazon WorkDocs.

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site. 

// Example sending a request using UpdateUserRequest.
req := client.UpdateUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type Comment 

type Comment struct {

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

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

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

	// 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 CommentStatusType `type:"string" enum:"true"`

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

Describes a comment.

func (Comment) MarshalFields added in v0.3.0 

func (s Comment) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Comment) String 

func (s Comment) String() string

String returns the string representation

type CommentMetadata 

type CommentMetadata struct {

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

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

	// 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) MarshalFields added in v0.3.0 

func (s CommentMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CommentMetadata) String 

func (s CommentMetadata) String() string

String returns the string representation

type CommentStatusType 

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

Enum values for CommentStatusType

func (CommentStatusType) MarshalValue added in v0.3.0 

func (enum CommentStatusType) MarshalValue() (string, error)

func (CommentStatusType) MarshalValueBuf added in v0.3.0 

func (enum CommentStatusType) MarshalValueBuf(b []byte) ([]byte, error)

type CommentVisibilityType 

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

Enum values for CommentVisibilityType

func (CommentVisibilityType) MarshalValue added in v0.3.0 

func (enum CommentVisibilityType) MarshalValue() (string, error)

func (CommentVisibilityType) MarshalValueBuf added in v0.3.0 

func (enum CommentVisibilityType) MarshalValueBuf(b []byte) ([]byte, error)

type CreateCommentInput 

type CreateCommentInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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 CommentVisibilityType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (CreateCommentInput) MarshalFields added in v0.3.0 

func (s CreateCommentInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateCommentInput) String 

func (s CreateCommentInput) String() string

String returns the string representation

func (*CreateCommentInput) Validate 

func (s *CreateCommentInput) Validate() error

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

type CreateCommentOutput 

type CreateCommentOutput struct {

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

func (CreateCommentOutput) MarshalFields added in v0.3.0 

func (s CreateCommentOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateCommentOutput) String 

func (s CreateCommentOutput) String() string

String returns the string representation

type CreateCommentRequest 

type CreateCommentRequest struct {
	*aws.Request
	Input *CreateCommentInput
	Copy  func(*CreateCommentInput) CreateCommentRequest
}

CreateCommentRequest is the request type for the CreateComment API operation.

func (CreateCommentRequest) Send 

func (r CreateCommentRequest) Send(ctx context.Context) (*CreateCommentResponse, error)

Send marshals and sends the CreateComment API request.

type CreateCommentResponse added in v0.9.0 

type CreateCommentResponse struct {
	*CreateCommentOutput
	// contains filtered or unexported fields
}

CreateCommentResponse is the response type for the CreateComment API operation.

func (*CreateCommentResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateCommentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateComment request.

type CreateCustomMetadataInput 

type CreateCustomMetadataInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s CreateCustomMetadataInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateCustomMetadataInput) String 

func (s CreateCustomMetadataInput) String() string

String returns the string representation

func (*CreateCustomMetadataInput) Validate 

func (s *CreateCustomMetadataInput) Validate() error

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

type CreateCustomMetadataOutput 

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

func (CreateCustomMetadataOutput) MarshalFields added in v0.3.0 

func (s CreateCustomMetadataOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateCustomMetadataOutput) String 

func (s CreateCustomMetadataOutput) String() string

String returns the string representation

type CreateCustomMetadataRequest 

type CreateCustomMetadataRequest struct {
	*aws.Request
	Input *CreateCustomMetadataInput
	Copy  func(*CreateCustomMetadataInput) CreateCustomMetadataRequest
}

CreateCustomMetadataRequest is the request type for the CreateCustomMetadata API operation.

func (CreateCustomMetadataRequest) Send 

func (r CreateCustomMetadataRequest) Send(ctx context.Context) (*CreateCustomMetadataResponse, error)

Send marshals and sends the CreateCustomMetadata API request.

type CreateCustomMetadataResponse added in v0.9.0 

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

CreateCustomMetadataResponse is the response type for the CreateCustomMetadata API operation.

func (*CreateCustomMetadataResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateCustomMetadataResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCustomMetadata request.

type CreateFolderInput 

type CreateFolderInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s CreateFolderInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateFolderInput) String 

func (s CreateFolderInput) String() string

String returns the string representation

func (*CreateFolderInput) Validate 

func (s *CreateFolderInput) Validate() error

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

type CreateFolderOutput 

type CreateFolderOutput struct {

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

func (CreateFolderOutput) MarshalFields added in v0.3.0 

func (s CreateFolderOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateFolderOutput) String 

func (s CreateFolderOutput) String() string

String returns the string representation

type CreateFolderRequest 

type CreateFolderRequest struct {
	*aws.Request
	Input *CreateFolderInput
	Copy  func(*CreateFolderInput) CreateFolderRequest
}

CreateFolderRequest is the request type for the CreateFolder API operation.

func (CreateFolderRequest) Send 

func (r CreateFolderRequest) Send(ctx context.Context) (*CreateFolderResponse, error)

Send marshals and sends the CreateFolder API request.

type CreateFolderResponse added in v0.9.0 

type CreateFolderResponse struct {
	*CreateFolderOutput
	// contains filtered or unexported fields
}

CreateFolderResponse is the response type for the CreateFolder API operation.

func (*CreateFolderResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateFolderResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateFolder request.

type CreateLabelsInput 

type CreateLabelsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s CreateLabelsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateLabelsInput) String 

func (s CreateLabelsInput) String() string

String returns the string representation

func (*CreateLabelsInput) Validate 

func (s *CreateLabelsInput) Validate() error

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

type CreateLabelsOutput 

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

func (CreateLabelsOutput) MarshalFields added in v0.3.0 

func (s CreateLabelsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateLabelsOutput) String 

func (s CreateLabelsOutput) String() string

String returns the string representation

type CreateLabelsRequest 

type CreateLabelsRequest struct {
	*aws.Request
	Input *CreateLabelsInput
	Copy  func(*CreateLabelsInput) CreateLabelsRequest
}

CreateLabelsRequest is the request type for the CreateLabels API operation.

func (CreateLabelsRequest) Send 

func (r CreateLabelsRequest) Send(ctx context.Context) (*CreateLabelsResponse, error)

Send marshals and sends the CreateLabels API request.

type CreateLabelsResponse added in v0.9.0 

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

CreateLabelsResponse is the response type for the CreateLabels API operation.

func (*CreateLabelsResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateLabelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateLabels request.

type CreateNotificationSubscriptionInput 

type CreateNotificationSubscriptionInput struct {

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

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

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

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

func (CreateNotificationSubscriptionInput) MarshalFields added in v0.3.0 

func (s CreateNotificationSubscriptionInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateNotificationSubscriptionInput) String 

func (s CreateNotificationSubscriptionInput) String() string

String returns the string representation

func (*CreateNotificationSubscriptionInput) Validate 

func (s *CreateNotificationSubscriptionInput) Validate() error

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

type CreateNotificationSubscriptionOutput 

type CreateNotificationSubscriptionOutput struct {

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

func (CreateNotificationSubscriptionOutput) MarshalFields added in v0.3.0 

func (s CreateNotificationSubscriptionOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateNotificationSubscriptionOutput) String 

func (s CreateNotificationSubscriptionOutput) String() string

String returns the string representation

type CreateNotificationSubscriptionRequest 

type CreateNotificationSubscriptionRequest struct {
	*aws.Request
	Input *CreateNotificationSubscriptionInput
	Copy  func(*CreateNotificationSubscriptionInput) CreateNotificationSubscriptionRequest
}

CreateNotificationSubscriptionRequest is the request type for the CreateNotificationSubscription API operation.

func (CreateNotificationSubscriptionRequest) Send 

func (r CreateNotificationSubscriptionRequest) Send(ctx context.Context) (*CreateNotificationSubscriptionResponse, error)

Send marshals and sends the CreateNotificationSubscription API request.

type CreateNotificationSubscriptionResponse added in v0.9.0 

type CreateNotificationSubscriptionResponse struct {
	*CreateNotificationSubscriptionOutput
	// contains filtered or unexported fields
}

CreateNotificationSubscriptionResponse is the response type for the CreateNotificationSubscription API operation.

func (*CreateNotificationSubscriptionResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateNotificationSubscriptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateNotificationSubscription request.

type CreateUserInput 

type CreateUserInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s CreateUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateUserInput) String 

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate 

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput 

type CreateUserOutput struct {

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

func (CreateUserOutput) MarshalFields added in v0.3.0 

func (s CreateUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateUserOutput) String 

func (s CreateUserOutput) String() string

String returns the string representation

type CreateUserRequest 

type CreateUserRequest struct {
	*aws.Request
	Input *CreateUserInput
	Copy  func(*CreateUserInput) CreateUserRequest
}

CreateUserRequest is the request type for the CreateUser API operation.

func (CreateUserRequest) Send 

func (r CreateUserRequest) Send(ctx context.Context) (*CreateUserResponse, error)

Send marshals and sends the CreateUser API request.

type CreateUserResponse added in v0.9.0 

type CreateUserResponse struct {
	*CreateUserOutput
	// contains filtered or unexported fields
}

CreateUserResponse is the response type for the CreateUser API operation.

func (*CreateUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateUser request.

type DeactivateUserInput 

type DeactivateUserInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DeactivateUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeactivateUserInput) String 

func (s DeactivateUserInput) String() string

String returns the string representation

func (*DeactivateUserInput) Validate 

func (s *DeactivateUserInput) Validate() error

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

type DeactivateUserOutput 

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

func (DeactivateUserOutput) MarshalFields added in v0.3.0 

func (s DeactivateUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeactivateUserOutput) String 

func (s DeactivateUserOutput) String() string

String returns the string representation

type DeactivateUserRequest 

type DeactivateUserRequest struct {
	*aws.Request
	Input *DeactivateUserInput
	Copy  func(*DeactivateUserInput) DeactivateUserRequest
}

DeactivateUserRequest is the request type for the DeactivateUser API operation.

func (DeactivateUserRequest) Send 

func (r DeactivateUserRequest) Send(ctx context.Context) (*DeactivateUserResponse, error)

Send marshals and sends the DeactivateUser API request.

type DeactivateUserResponse added in v0.9.0 

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

DeactivateUserResponse is the response type for the DeactivateUser API operation.

func (*DeactivateUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeactivateUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeactivateUser request.

type DeleteCommentInput 

type DeleteCommentInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DeleteCommentInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteCommentInput) String 

func (s DeleteCommentInput) String() string

String returns the string representation

func (*DeleteCommentInput) Validate 

func (s *DeleteCommentInput) Validate() error

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

type DeleteCommentOutput 

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

func (DeleteCommentOutput) MarshalFields added in v0.3.0 

func (s DeleteCommentOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteCommentOutput) String 

func (s DeleteCommentOutput) String() string

String returns the string representation

type DeleteCommentRequest 

type DeleteCommentRequest struct {
	*aws.Request
	Input *DeleteCommentInput
	Copy  func(*DeleteCommentInput) DeleteCommentRequest
}

DeleteCommentRequest is the request type for the DeleteComment API operation.

func (DeleteCommentRequest) Send 

func (r DeleteCommentRequest) Send(ctx context.Context) (*DeleteCommentResponse, error)

Send marshals and sends the DeleteComment API request.

type DeleteCommentResponse added in v0.9.0 

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

DeleteCommentResponse is the response type for the DeleteComment API operation.

func (*DeleteCommentResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteCommentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteComment request.

type DeleteCustomMetadataInput 

type DeleteCustomMetadataInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DeleteCustomMetadataInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteCustomMetadataInput) String 

func (s DeleteCustomMetadataInput) String() string

String returns the string representation

func (*DeleteCustomMetadataInput) Validate 

func (s *DeleteCustomMetadataInput) Validate() error

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

type DeleteCustomMetadataOutput 

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

func (DeleteCustomMetadataOutput) MarshalFields added in v0.3.0 

func (s DeleteCustomMetadataOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteCustomMetadataOutput) String 

func (s DeleteCustomMetadataOutput) String() string

String returns the string representation

type DeleteCustomMetadataRequest 

type DeleteCustomMetadataRequest struct {
	*aws.Request
	Input *DeleteCustomMetadataInput
	Copy  func(*DeleteCustomMetadataInput) DeleteCustomMetadataRequest
}

DeleteCustomMetadataRequest is the request type for the DeleteCustomMetadata API operation.

func (DeleteCustomMetadataRequest) Send 

func (r DeleteCustomMetadataRequest) Send(ctx context.Context) (*DeleteCustomMetadataResponse, error)

Send marshals and sends the DeleteCustomMetadata API request.

type DeleteCustomMetadataResponse added in v0.9.0 

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

DeleteCustomMetadataResponse is the response type for the DeleteCustomMetadata API operation.

func (*DeleteCustomMetadataResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteCustomMetadataResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCustomMetadata request.

type DeleteDocumentInput 

type DeleteDocumentInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DeleteDocumentInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDocumentInput) String 

func (s DeleteDocumentInput) String() string

String returns the string representation

func (*DeleteDocumentInput) Validate 

func (s *DeleteDocumentInput) Validate() error

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

type DeleteDocumentOutput 

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

func (DeleteDocumentOutput) MarshalFields added in v0.3.0 

func (s DeleteDocumentOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDocumentOutput) String 

func (s DeleteDocumentOutput) String() string

String returns the string representation

type DeleteDocumentRequest 

type DeleteDocumentRequest struct {
	*aws.Request
	Input *DeleteDocumentInput
	Copy  func(*DeleteDocumentInput) DeleteDocumentRequest
}

DeleteDocumentRequest is the request type for the DeleteDocument API operation.

func (DeleteDocumentRequest) Send 

func (r DeleteDocumentRequest) Send(ctx context.Context) (*DeleteDocumentResponse, error)

Send marshals and sends the DeleteDocument API request.

type DeleteDocumentResponse added in v0.9.0 

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

DeleteDocumentResponse is the response type for the DeleteDocument API operation.

func (*DeleteDocumentResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteDocumentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDocument request.

type DeleteFolderContentsInput 

type DeleteFolderContentsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DeleteFolderContentsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteFolderContentsInput) String 

func (s DeleteFolderContentsInput) String() string

String returns the string representation

func (*DeleteFolderContentsInput) Validate 

func (s *DeleteFolderContentsInput) Validate() error

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

type DeleteFolderContentsOutput 

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

func (DeleteFolderContentsOutput) MarshalFields added in v0.3.0 

func (s DeleteFolderContentsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteFolderContentsOutput) String 

func (s DeleteFolderContentsOutput) String() string

String returns the string representation

type DeleteFolderContentsRequest 

type DeleteFolderContentsRequest struct {
	*aws.Request
	Input *DeleteFolderContentsInput
	Copy  func(*DeleteFolderContentsInput) DeleteFolderContentsRequest
}

DeleteFolderContentsRequest is the request type for the DeleteFolderContents API operation.

func (DeleteFolderContentsRequest) Send 

func (r DeleteFolderContentsRequest) Send(ctx context.Context) (*DeleteFolderContentsResponse, error)

Send marshals and sends the DeleteFolderContents API request.

type DeleteFolderContentsResponse added in v0.9.0 

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

DeleteFolderContentsResponse is the response type for the DeleteFolderContents API operation.

func (*DeleteFolderContentsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteFolderContentsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteFolderContents request.

type DeleteFolderInput 

type DeleteFolderInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DeleteFolderInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteFolderInput) String 

func (s DeleteFolderInput) String() string

String returns the string representation

func (*DeleteFolderInput) Validate 

func (s *DeleteFolderInput) Validate() error

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

type DeleteFolderOutput 

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

func (DeleteFolderOutput) MarshalFields added in v0.3.0 

func (s DeleteFolderOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteFolderOutput) String 

func (s DeleteFolderOutput) String() string

String returns the string representation

type DeleteFolderRequest 

type DeleteFolderRequest struct {
	*aws.Request
	Input *DeleteFolderInput
	Copy  func(*DeleteFolderInput) DeleteFolderRequest
}

DeleteFolderRequest is the request type for the DeleteFolder API operation.

func (DeleteFolderRequest) Send 

func (r DeleteFolderRequest) Send(ctx context.Context) (*DeleteFolderResponse, error)

Send marshals and sends the DeleteFolder API request.

type DeleteFolderResponse added in v0.9.0 

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

DeleteFolderResponse is the response type for the DeleteFolder API operation.

func (*DeleteFolderResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteFolderResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteFolder request.

type DeleteLabelsInput 

type DeleteLabelsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DeleteLabelsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteLabelsInput) String 

func (s DeleteLabelsInput) String() string

String returns the string representation

func (*DeleteLabelsInput) Validate 

func (s *DeleteLabelsInput) Validate() error

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

type DeleteLabelsOutput 

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

func (DeleteLabelsOutput) MarshalFields added in v0.3.0 

func (s DeleteLabelsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteLabelsOutput) String 

func (s DeleteLabelsOutput) String() string

String returns the string representation

type DeleteLabelsRequest 

type DeleteLabelsRequest struct {
	*aws.Request
	Input *DeleteLabelsInput
	Copy  func(*DeleteLabelsInput) DeleteLabelsRequest
}

DeleteLabelsRequest is the request type for the DeleteLabels API operation.

func (DeleteLabelsRequest) Send 

func (r DeleteLabelsRequest) Send(ctx context.Context) (*DeleteLabelsResponse, error)

Send marshals and sends the DeleteLabels API request.

type DeleteLabelsResponse added in v0.9.0 

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

DeleteLabelsResponse is the response type for the DeleteLabels API operation.

func (*DeleteLabelsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteLabelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteLabels request.

type DeleteNotificationSubscriptionInput 

type DeleteNotificationSubscriptionInput struct {

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

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

func (DeleteNotificationSubscriptionInput) MarshalFields added in v0.3.0 

func (s DeleteNotificationSubscriptionInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteNotificationSubscriptionInput) String 

func (s DeleteNotificationSubscriptionInput) String() string

String returns the string representation

func (*DeleteNotificationSubscriptionInput) Validate 

func (s *DeleteNotificationSubscriptionInput) Validate() error

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

type DeleteNotificationSubscriptionOutput 

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

func (DeleteNotificationSubscriptionOutput) MarshalFields added in v0.3.0 

func (s DeleteNotificationSubscriptionOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteNotificationSubscriptionOutput) String 

func (s DeleteNotificationSubscriptionOutput) String() string

String returns the string representation

type DeleteNotificationSubscriptionRequest 

type DeleteNotificationSubscriptionRequest struct {
	*aws.Request
	Input *DeleteNotificationSubscriptionInput
	Copy  func(*DeleteNotificationSubscriptionInput) DeleteNotificationSubscriptionRequest
}

DeleteNotificationSubscriptionRequest is the request type for the DeleteNotificationSubscription API operation.

func (DeleteNotificationSubscriptionRequest) Send 

func (r DeleteNotificationSubscriptionRequest) Send(ctx context.Context) (*DeleteNotificationSubscriptionResponse, error)

Send marshals and sends the DeleteNotificationSubscription API request.

type DeleteNotificationSubscriptionResponse added in v0.9.0 

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

DeleteNotificationSubscriptionResponse is the response type for the DeleteNotificationSubscription API operation.

func (*DeleteNotificationSubscriptionResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteNotificationSubscriptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteNotificationSubscription request.

type DeleteUserInput 

type DeleteUserInput struct {

	// Amazon WorkDocs authentication token. Do not set this field when using administrative
	// API actions, as in accessing the API using 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) MarshalFields added in v0.3.0 

func (s DeleteUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteUserInput) String 

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate 

func (s *DeleteUserInput) Validate() error

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

type DeleteUserOutput 

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

func (DeleteUserOutput) MarshalFields added in v0.3.0 

func (s DeleteUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteUserOutput) String 

func (s DeleteUserOutput) String() string

String returns the string representation

type DeleteUserRequest 

type DeleteUserRequest struct {
	*aws.Request
	Input *DeleteUserInput
	Copy  func(*DeleteUserInput) DeleteUserRequest
}

DeleteUserRequest is the request type for the DeleteUser API operation.

func (DeleteUserRequest) Send 

func (r DeleteUserRequest) Send(ctx context.Context) (*DeleteUserResponse, error)

Send marshals and sends the DeleteUser API request.

type DeleteUserResponse added in v0.9.0 

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

DeleteUserResponse is the response type for the DeleteUser API operation.

func (*DeleteUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteUser request.

type DescribeActivitiesInput 

type DescribeActivitiesInput struct {

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

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DescribeActivitiesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeActivitiesInput) String 

func (s DescribeActivitiesInput) String() string

String returns the string representation

func (*DescribeActivitiesInput) Validate 

func (s *DescribeActivitiesInput) Validate() error

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

type DescribeActivitiesOutput 

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) MarshalFields added in v0.3.0 

func (s DescribeActivitiesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeActivitiesOutput) String 

func (s DescribeActivitiesOutput) String() string

String returns the string representation

type DescribeActivitiesRequest 

type DescribeActivitiesRequest struct {
	*aws.Request
	Input *DescribeActivitiesInput
	Copy  func(*DescribeActivitiesInput) DescribeActivitiesRequest
}

DescribeActivitiesRequest is the request type for the DescribeActivities API operation.

func (DescribeActivitiesRequest) Send 

func (r DescribeActivitiesRequest) Send(ctx context.Context) (*DescribeActivitiesResponse, error)

Send marshals and sends the DescribeActivities API request.

type DescribeActivitiesResponse added in v0.9.0 

type DescribeActivitiesResponse struct {
	*DescribeActivitiesOutput
	// contains filtered or unexported fields
}

DescribeActivitiesResponse is the response type for the DescribeActivities API operation.

func (*DescribeActivitiesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeActivitiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeActivities request.

type DescribeCommentsInput 

type DescribeCommentsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DescribeCommentsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeCommentsInput) String 

func (s DescribeCommentsInput) String() string

String returns the string representation

func (*DescribeCommentsInput) Validate 

func (s *DescribeCommentsInput) Validate() error

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

type DescribeCommentsOutput 

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) MarshalFields added in v0.3.0 

func (s DescribeCommentsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeCommentsOutput) String 

func (s DescribeCommentsOutput) String() string

String returns the string representation

type DescribeCommentsRequest 

type DescribeCommentsRequest struct {
	*aws.Request
	Input *DescribeCommentsInput
	Copy  func(*DescribeCommentsInput) DescribeCommentsRequest
}

DescribeCommentsRequest is the request type for the DescribeComments API operation.

func (DescribeCommentsRequest) Send 

func (r DescribeCommentsRequest) Send(ctx context.Context) (*DescribeCommentsResponse, error)

Send marshals and sends the DescribeComments API request.

type DescribeCommentsResponse added in v0.9.0 

type DescribeCommentsResponse struct {
	*DescribeCommentsOutput
	// contains filtered or unexported fields
}

DescribeCommentsResponse is the response type for the DescribeComments API operation.

func (*DescribeCommentsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeCommentsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeComments request.

type DescribeDocumentVersionsInput 

type DescribeDocumentVersionsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DescribeDocumentVersionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDocumentVersionsInput) String 

func (s DescribeDocumentVersionsInput) String() string

String returns the string representation

func (*DescribeDocumentVersionsInput) Validate 

func (s *DescribeDocumentVersionsInput) Validate() error

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

type DescribeDocumentVersionsOutput 

type DescribeDocumentVersionsOutput struct {

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

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

func (DescribeDocumentVersionsOutput) MarshalFields added in v0.3.0 

func (s DescribeDocumentVersionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDocumentVersionsOutput) String 

func (s DescribeDocumentVersionsOutput) String() string

String returns the string representation

type DescribeDocumentVersionsPaginator added in v0.9.0 

type DescribeDocumentVersionsPaginator struct {
	aws.Pager
}

DescribeDocumentVersionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeDocumentVersionsPaginator added in v0.9.0 

func NewDescribeDocumentVersionsPaginator(req DescribeDocumentVersionsRequest) DescribeDocumentVersionsPaginator

NewDescribeDocumentVersionsRequestPaginator returns a paginator for DescribeDocumentVersions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeDocumentVersionsRequest(input)
p := workdocs.NewDescribeDocumentVersionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeDocumentVersionsPaginator) CurrentPage added in v0.9.0 

func (p *DescribeDocumentVersionsPaginator) CurrentPage() *DescribeDocumentVersionsOutput

type DescribeDocumentVersionsRequest 

type DescribeDocumentVersionsRequest struct {
	*aws.Request
	Input *DescribeDocumentVersionsInput
	Copy  func(*DescribeDocumentVersionsInput) DescribeDocumentVersionsRequest
}

DescribeDocumentVersionsRequest is the request type for the DescribeDocumentVersions API operation.

func (DescribeDocumentVersionsRequest) Send 

func (r DescribeDocumentVersionsRequest) Send(ctx context.Context) (*DescribeDocumentVersionsResponse, error)

Send marshals and sends the DescribeDocumentVersions API request.

type DescribeDocumentVersionsResponse added in v0.9.0 

type DescribeDocumentVersionsResponse struct {
	*DescribeDocumentVersionsOutput
	// contains filtered or unexported fields
}

DescribeDocumentVersionsResponse is the response type for the DescribeDocumentVersions API operation.

func (*DescribeDocumentVersionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDocumentVersionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDocumentVersions request.

type DescribeFolderContentsInput 

type DescribeFolderContentsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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 OrderType `location:"querystring" locationName:"order" type:"string" enum:"true"`

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

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

func (DescribeFolderContentsInput) MarshalFields added in v0.3.0 

func (s DescribeFolderContentsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeFolderContentsInput) String 

func (s DescribeFolderContentsInput) String() string

String returns the string representation

func (*DescribeFolderContentsInput) Validate 

func (s *DescribeFolderContentsInput) Validate() error

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

type DescribeFolderContentsOutput 

type DescribeFolderContentsOutput struct {

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

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

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

func (DescribeFolderContentsOutput) MarshalFields added in v0.3.0 

func (s DescribeFolderContentsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeFolderContentsOutput) String 

func (s DescribeFolderContentsOutput) String() string

String returns the string representation

type DescribeFolderContentsPaginator added in v0.9.0 

type DescribeFolderContentsPaginator struct {
	aws.Pager
}

DescribeFolderContentsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeFolderContentsPaginator added in v0.9.0 

func NewDescribeFolderContentsPaginator(req DescribeFolderContentsRequest) DescribeFolderContentsPaginator

NewDescribeFolderContentsRequestPaginator returns a paginator for DescribeFolderContents. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeFolderContentsRequest(input)
p := workdocs.NewDescribeFolderContentsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeFolderContentsPaginator) CurrentPage added in v0.9.0 

func (p *DescribeFolderContentsPaginator) CurrentPage() *DescribeFolderContentsOutput

type DescribeFolderContentsRequest 

type DescribeFolderContentsRequest struct {
	*aws.Request
	Input *DescribeFolderContentsInput
	Copy  func(*DescribeFolderContentsInput) DescribeFolderContentsRequest
}

DescribeFolderContentsRequest is the request type for the DescribeFolderContents API operation.

func (DescribeFolderContentsRequest) Send 

func (r DescribeFolderContentsRequest) Send(ctx context.Context) (*DescribeFolderContentsResponse, error)

Send marshals and sends the DescribeFolderContents API request.

type DescribeFolderContentsResponse added in v0.9.0 

type DescribeFolderContentsResponse struct {
	*DescribeFolderContentsOutput
	// contains filtered or unexported fields
}

DescribeFolderContentsResponse is the response type for the DescribeFolderContents API operation.

func (*DescribeFolderContentsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeFolderContentsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeFolderContents request.

type DescribeGroupsInput added in v0.2.0 

type DescribeGroupsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DescribeGroupsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeGroupsInput) String added in v0.2.0 

func (s DescribeGroupsInput) String() string

String returns the string representation

func (*DescribeGroupsInput) Validate added in v0.2.0 

func (s *DescribeGroupsInput) Validate() error

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

type DescribeGroupsOutput added in v0.2.0 

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) MarshalFields added in v0.3.0 

func (s DescribeGroupsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeGroupsOutput) String added in v0.2.0 

func (s DescribeGroupsOutput) String() string

String returns the string representation

type DescribeGroupsRequest added in v0.2.0 

type DescribeGroupsRequest struct {
	*aws.Request
	Input *DescribeGroupsInput
	Copy  func(*DescribeGroupsInput) DescribeGroupsRequest
}

DescribeGroupsRequest is the request type for the DescribeGroups API operation.

func (DescribeGroupsRequest) Send added in v0.2.0 

func (r DescribeGroupsRequest) Send(ctx context.Context) (*DescribeGroupsResponse, error)

Send marshals and sends the DescribeGroups API request.

type DescribeGroupsResponse added in v0.9.0 

type DescribeGroupsResponse struct {
	*DescribeGroupsOutput
	// contains filtered or unexported fields
}

DescribeGroupsResponse is the response type for the DescribeGroups API operation.

func (*DescribeGroupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeGroups request.

type DescribeNotificationSubscriptionsInput 

type DescribeNotificationSubscriptionsInput struct {

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

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

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

func (DescribeNotificationSubscriptionsInput) MarshalFields added in v0.3.0 

func (s DescribeNotificationSubscriptionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeNotificationSubscriptionsInput) String 

func (s DescribeNotificationSubscriptionsInput) String() string

String returns the string representation

func (*DescribeNotificationSubscriptionsInput) Validate 

func (s *DescribeNotificationSubscriptionsInput) Validate() error

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

type DescribeNotificationSubscriptionsOutput 

type DescribeNotificationSubscriptionsOutput struct {

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

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

func (DescribeNotificationSubscriptionsOutput) MarshalFields added in v0.3.0 

func (s DescribeNotificationSubscriptionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeNotificationSubscriptionsOutput) String 

func (s DescribeNotificationSubscriptionsOutput) String() string

String returns the string representation

type DescribeNotificationSubscriptionsRequest 

type DescribeNotificationSubscriptionsRequest struct {
	*aws.Request
	Input *DescribeNotificationSubscriptionsInput
	Copy  func(*DescribeNotificationSubscriptionsInput) DescribeNotificationSubscriptionsRequest
}

DescribeNotificationSubscriptionsRequest is the request type for the DescribeNotificationSubscriptions API operation.

func (DescribeNotificationSubscriptionsRequest) Send 

func (r DescribeNotificationSubscriptionsRequest) Send(ctx context.Context) (*DescribeNotificationSubscriptionsResponse, error)

Send marshals and sends the DescribeNotificationSubscriptions API request.

type DescribeNotificationSubscriptionsResponse added in v0.9.0 

type DescribeNotificationSubscriptionsResponse struct {
	*DescribeNotificationSubscriptionsOutput
	// contains filtered or unexported fields
}

DescribeNotificationSubscriptionsResponse is the response type for the DescribeNotificationSubscriptions API operation.

func (*DescribeNotificationSubscriptionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeNotificationSubscriptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeNotificationSubscriptions request.

type DescribeResourcePermissionsInput 

type DescribeResourcePermissionsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s DescribeResourcePermissionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeResourcePermissionsInput) String 

func (s DescribeResourcePermissionsInput) String() string

String returns the string representation

func (*DescribeResourcePermissionsInput) Validate 

func (s *DescribeResourcePermissionsInput) Validate() error

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

type DescribeResourcePermissionsOutput 

type DescribeResourcePermissionsOutput struct {

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

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

func (DescribeResourcePermissionsOutput) MarshalFields added in v0.3.0 

func (s DescribeResourcePermissionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeResourcePermissionsOutput) String 

func (s DescribeResourcePermissionsOutput) String() string

String returns the string representation

type DescribeResourcePermissionsRequest 

type DescribeResourcePermissionsRequest struct {
	*aws.Request
	Input *DescribeResourcePermissionsInput
	Copy  func(*DescribeResourcePermissionsInput) DescribeResourcePermissionsRequest
}

DescribeResourcePermissionsRequest is the request type for the DescribeResourcePermissions API operation.

func (DescribeResourcePermissionsRequest) Send 

func (r DescribeResourcePermissionsRequest) Send(ctx context.Context) (*DescribeResourcePermissionsResponse, error)

Send marshals and sends the DescribeResourcePermissions API request.

type DescribeResourcePermissionsResponse added in v0.9.0 

type DescribeResourcePermissionsResponse struct {
	*DescribeResourcePermissionsOutput
	// contains filtered or unexported fields
}

DescribeResourcePermissionsResponse is the response type for the DescribeResourcePermissions API operation.

func (*DescribeResourcePermissionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeResourcePermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeResourcePermissions request.

type DescribeRootFoldersInput 

type DescribeRootFoldersInput struct {

	// Amazon WorkDocs authentication token.
	//
	// 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) MarshalFields added in v0.3.0 

func (s DescribeRootFoldersInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeRootFoldersInput) String 

func (s DescribeRootFoldersInput) String() string

String returns the string representation

func (*DescribeRootFoldersInput) Validate 

func (s *DescribeRootFoldersInput) Validate() error

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

type DescribeRootFoldersOutput 

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) MarshalFields added in v0.3.0 

func (s DescribeRootFoldersOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeRootFoldersOutput) String 

func (s DescribeRootFoldersOutput) String() string

String returns the string representation

type DescribeRootFoldersRequest 

type DescribeRootFoldersRequest struct {
	*aws.Request
	Input *DescribeRootFoldersInput
	Copy  func(*DescribeRootFoldersInput) DescribeRootFoldersRequest
}

DescribeRootFoldersRequest is the request type for the DescribeRootFolders API operation.

func (DescribeRootFoldersRequest) Send 

func (r DescribeRootFoldersRequest) Send(ctx context.Context) (*DescribeRootFoldersResponse, error)

Send marshals and sends the DescribeRootFolders API request.

type DescribeRootFoldersResponse added in v0.9.0 

type DescribeRootFoldersResponse struct {
	*DescribeRootFoldersOutput
	// contains filtered or unexported fields
}

DescribeRootFoldersResponse is the response type for the DescribeRootFolders API operation.

func (*DescribeRootFoldersResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeRootFoldersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeRootFolders request.

type DescribeUsersInput 

type DescribeUsersInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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 UserFilterType `location:"querystring" locationName:"include" type:"string" enum:"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"`

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

	// 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 UserSortType `location:"querystring" locationName:"sort" type:"string" enum:"true"`

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

func (DescribeUsersInput) MarshalFields added in v0.3.0 

func (s DescribeUsersInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUsersInput) String 

func (s DescribeUsersInput) String() string

String returns the string representation

func (*DescribeUsersInput) Validate 

func (s *DescribeUsersInput) Validate() error

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

type DescribeUsersOutput 

type DescribeUsersOutput struct {

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

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

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

func (DescribeUsersOutput) MarshalFields added in v0.3.0 

func (s DescribeUsersOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUsersOutput) String 

func (s DescribeUsersOutput) String() string

String returns the string representation

type DescribeUsersPaginator added in v0.9.0 

type DescribeUsersPaginator struct {
	aws.Pager
}

DescribeUsersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeUsersPaginator added in v0.9.0 

func NewDescribeUsersPaginator(req DescribeUsersRequest) DescribeUsersPaginator

NewDescribeUsersRequestPaginator returns a paginator for DescribeUsers. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeUsersRequest(input)
p := workdocs.NewDescribeUsersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeUsersPaginator) CurrentPage added in v0.9.0 

func (p *DescribeUsersPaginator) CurrentPage() *DescribeUsersOutput

type DescribeUsersRequest 

type DescribeUsersRequest struct {
	*aws.Request
	Input *DescribeUsersInput
	Copy  func(*DescribeUsersInput) DescribeUsersRequest
}

DescribeUsersRequest is the request type for the DescribeUsers API operation.

func (DescribeUsersRequest) Send 

func (r DescribeUsersRequest) Send(ctx context.Context) (*DescribeUsersResponse, error)

Send marshals and sends the DescribeUsers API request.

type DescribeUsersResponse added in v0.9.0 

type DescribeUsersResponse struct {
	*DescribeUsersOutput
	// contains filtered or unexported fields
}

DescribeUsersResponse is the response type for the DescribeUsers API operation.

func (*DescribeUsersResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeUsersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeUsers request.

type DocumentMetadata 

type DocumentMetadata struct {

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

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

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

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

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

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

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

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

Describes the document.

func (DocumentMetadata) MarshalFields added in v0.3.0 

func (s DocumentMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DocumentMetadata) String 

func (s DocumentMetadata) String() string

String returns the string representation

type DocumentSourceType 

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

Enum values for DocumentSourceType

func (DocumentSourceType) MarshalValue added in v0.3.0 

func (enum DocumentSourceType) MarshalValue() (string, error)

func (DocumentSourceType) MarshalValueBuf added in v0.3.0 

func (enum DocumentSourceType) MarshalValueBuf(b []byte) ([]byte, error)

type DocumentStatusType 

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

Enum values for DocumentStatusType

func (DocumentStatusType) MarshalValue added in v0.3.0 

func (enum DocumentStatusType) MarshalValue() (string, error)

func (DocumentStatusType) MarshalValueBuf added in v0.3.0 

func (enum DocumentStatusType) MarshalValueBuf(b []byte) ([]byte, error)

type DocumentThumbnailType 

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

Enum values for DocumentThumbnailType

func (DocumentThumbnailType) MarshalValue added in v0.3.0 

func (enum DocumentThumbnailType) MarshalValue() (string, error)

func (DocumentThumbnailType) MarshalValueBuf added in v0.3.0 

func (enum DocumentThumbnailType) MarshalValueBuf(b []byte) ([]byte, error)

type DocumentVersionMetadata 

type DocumentVersionMetadata struct {

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

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

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

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

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

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

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

	// The name of the version.
	Name *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 DocumentStatusType `type:"string" enum:"true"`

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

Describes a version of a document.

func (DocumentVersionMetadata) MarshalFields added in v0.3.0 

func (s DocumentVersionMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DocumentVersionMetadata) String 

func (s DocumentVersionMetadata) String() string

String returns the string representation

type DocumentVersionStatus 

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

Enum values for DocumentVersionStatus

func (DocumentVersionStatus) MarshalValue added in v0.3.0 

func (enum DocumentVersionStatus) MarshalValue() (string, error)

func (DocumentVersionStatus) MarshalValueBuf added in v0.3.0 

func (enum DocumentVersionStatus) MarshalValueBuf(b []byte) ([]byte, error)

type FolderContentType 

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

Enum values for FolderContentType

func (FolderContentType) MarshalValue added in v0.3.0 

func (enum FolderContentType) MarshalValue() (string, error)

func (FolderContentType) MarshalValueBuf added in v0.3.0 

func (enum FolderContentType) MarshalValueBuf(b []byte) ([]byte, error)

type FolderMetadata 

type FolderMetadata struct {

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

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

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

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

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

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

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

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

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

	// 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) MarshalFields added in v0.3.0 

func (s FolderMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FolderMetadata) String 

func (s FolderMetadata) String() string

String returns the string representation

type GetCurrentUserInput 

type GetCurrentUserInput struct {

	// Amazon WorkDocs authentication token.
	//
	// 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) MarshalFields added in v0.3.0 

func (s GetCurrentUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetCurrentUserInput) String 

func (s GetCurrentUserInput) String() string

String returns the string representation

func (*GetCurrentUserInput) Validate 

func (s *GetCurrentUserInput) Validate() error

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

type GetCurrentUserOutput 

type GetCurrentUserOutput struct {

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

func (GetCurrentUserOutput) MarshalFields added in v0.3.0 

func (s GetCurrentUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetCurrentUserOutput) String 

func (s GetCurrentUserOutput) String() string

String returns the string representation

type GetCurrentUserRequest 

type GetCurrentUserRequest struct {
	*aws.Request
	Input *GetCurrentUserInput
	Copy  func(*GetCurrentUserInput) GetCurrentUserRequest
}

GetCurrentUserRequest is the request type for the GetCurrentUser API operation.

func (GetCurrentUserRequest) Send 

func (r GetCurrentUserRequest) Send(ctx context.Context) (*GetCurrentUserResponse, error)

Send marshals and sends the GetCurrentUser API request.

type GetCurrentUserResponse added in v0.9.0 

type GetCurrentUserResponse struct {
	*GetCurrentUserOutput
	// contains filtered or unexported fields
}

GetCurrentUserResponse is the response type for the GetCurrentUser API operation.

func (*GetCurrentUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetCurrentUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetCurrentUser request.

type GetDocumentInput 

type GetDocumentInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s GetDocumentInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDocumentInput) String 

func (s GetDocumentInput) String() string

String returns the string representation

func (*GetDocumentInput) Validate 

func (s *GetDocumentInput) Validate() error

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

type GetDocumentOutput 

type GetDocumentOutput struct {

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

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

func (GetDocumentOutput) MarshalFields added in v0.3.0 

func (s GetDocumentOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDocumentOutput) String 

func (s GetDocumentOutput) String() string

String returns the string representation

type GetDocumentPathInput 

type GetDocumentPathInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s GetDocumentPathInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDocumentPathInput) String 

func (s GetDocumentPathInput) String() string

String returns the string representation

func (*GetDocumentPathInput) Validate 

func (s *GetDocumentPathInput) Validate() error

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

type GetDocumentPathOutput 

type GetDocumentPathOutput struct {

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

func (GetDocumentPathOutput) MarshalFields added in v0.3.0 

func (s GetDocumentPathOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDocumentPathOutput) String 

func (s GetDocumentPathOutput) String() string

String returns the string representation

type GetDocumentPathRequest 

type GetDocumentPathRequest struct {
	*aws.Request
	Input *GetDocumentPathInput
	Copy  func(*GetDocumentPathInput) GetDocumentPathRequest
}

GetDocumentPathRequest is the request type for the GetDocumentPath API operation.

func (GetDocumentPathRequest) Send 

func (r GetDocumentPathRequest) Send(ctx context.Context) (*GetDocumentPathResponse, error)

Send marshals and sends the GetDocumentPath API request.

type GetDocumentPathResponse added in v0.9.0 

type GetDocumentPathResponse struct {
	*GetDocumentPathOutput
	// contains filtered or unexported fields
}

GetDocumentPathResponse is the response type for the GetDocumentPath API operation.

func (*GetDocumentPathResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetDocumentPathResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDocumentPath request.

type GetDocumentRequest 

type GetDocumentRequest struct {
	*aws.Request
	Input *GetDocumentInput
	Copy  func(*GetDocumentInput) GetDocumentRequest
}

GetDocumentRequest is the request type for the GetDocument API operation.

func (GetDocumentRequest) Send 

func (r GetDocumentRequest) Send(ctx context.Context) (*GetDocumentResponse, error)

Send marshals and sends the GetDocument API request.

type GetDocumentResponse added in v0.9.0 

type GetDocumentResponse struct {
	*GetDocumentOutput
	// contains filtered or unexported fields
}

GetDocumentResponse is the response type for the GetDocument API operation.

func (*GetDocumentResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetDocumentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDocument request.

type GetDocumentVersionInput 

type GetDocumentVersionInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s GetDocumentVersionInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDocumentVersionInput) String 

func (s GetDocumentVersionInput) String() string

String returns the string representation

func (*GetDocumentVersionInput) Validate 

func (s *GetDocumentVersionInput) Validate() error

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

type GetDocumentVersionOutput 

type GetDocumentVersionOutput struct {

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

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

func (GetDocumentVersionOutput) MarshalFields added in v0.3.0 

func (s GetDocumentVersionOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDocumentVersionOutput) String 

func (s GetDocumentVersionOutput) String() string

String returns the string representation

type GetDocumentVersionRequest 

type GetDocumentVersionRequest struct {
	*aws.Request
	Input *GetDocumentVersionInput
	Copy  func(*GetDocumentVersionInput) GetDocumentVersionRequest
}

GetDocumentVersionRequest is the request type for the GetDocumentVersion API operation.

func (GetDocumentVersionRequest) Send 

func (r GetDocumentVersionRequest) Send(ctx context.Context) (*GetDocumentVersionResponse, error)

Send marshals and sends the GetDocumentVersion API request.

type GetDocumentVersionResponse added in v0.9.0 

type GetDocumentVersionResponse struct {
	*GetDocumentVersionOutput
	// contains filtered or unexported fields
}

GetDocumentVersionResponse is the response type for the GetDocumentVersion API operation.

func (*GetDocumentVersionResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetDocumentVersionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDocumentVersion request.

type GetFolderInput 

type GetFolderInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s GetFolderInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetFolderInput) String 

func (s GetFolderInput) String() string

String returns the string representation

func (*GetFolderInput) Validate 

func (s *GetFolderInput) Validate() error

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

type GetFolderOutput 

type GetFolderOutput struct {

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

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

func (GetFolderOutput) MarshalFields added in v0.3.0 

func (s GetFolderOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetFolderOutput) String 

func (s GetFolderOutput) String() string

String returns the string representation

type GetFolderPathInput 

type GetFolderPathInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s GetFolderPathInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetFolderPathInput) String 

func (s GetFolderPathInput) String() string

String returns the string representation

func (*GetFolderPathInput) Validate 

func (s *GetFolderPathInput) Validate() error

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

type GetFolderPathOutput 

type GetFolderPathOutput struct {

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

func (GetFolderPathOutput) MarshalFields added in v0.3.0 

func (s GetFolderPathOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetFolderPathOutput) String 

func (s GetFolderPathOutput) String() string

String returns the string representation

type GetFolderPathRequest 

type GetFolderPathRequest struct {
	*aws.Request
	Input *GetFolderPathInput
	Copy  func(*GetFolderPathInput) GetFolderPathRequest
}

GetFolderPathRequest is the request type for the GetFolderPath API operation.

func (GetFolderPathRequest) Send 

func (r GetFolderPathRequest) Send(ctx context.Context) (*GetFolderPathResponse, error)

Send marshals and sends the GetFolderPath API request.

type GetFolderPathResponse added in v0.9.0 

type GetFolderPathResponse struct {
	*GetFolderPathOutput
	// contains filtered or unexported fields
}

GetFolderPathResponse is the response type for the GetFolderPath API operation.

func (*GetFolderPathResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetFolderPathResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetFolderPath request.

type GetFolderRequest 

type GetFolderRequest struct {
	*aws.Request
	Input *GetFolderInput
	Copy  func(*GetFolderInput) GetFolderRequest
}

GetFolderRequest is the request type for the GetFolder API operation.

func (GetFolderRequest) Send 

func (r GetFolderRequest) Send(ctx context.Context) (*GetFolderResponse, error)

Send marshals and sends the GetFolder API request.

type GetFolderResponse added in v0.9.0 

type GetFolderResponse struct {
	*GetFolderOutput
	// contains filtered or unexported fields
}

GetFolderResponse is the response type for the GetFolder API operation.

func (*GetFolderResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetFolderResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetFolder request.

type GetResourcesInput added in v0.6.0 

type GetResourcesInput struct {

	// The Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"`

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

	// 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) MarshalFields added in v0.6.0 

func (s GetResourcesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetResourcesInput) String added in v0.6.0 

func (s GetResourcesInput) String() string

String returns the string representation

func (*GetResourcesInput) Validate added in v0.6.0 

func (s *GetResourcesInput) Validate() error

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

type GetResourcesOutput added in v0.6.0 

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) MarshalFields added in v0.6.0 

func (s GetResourcesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetResourcesOutput) String added in v0.6.0 

func (s GetResourcesOutput) String() string

String returns the string representation

type GetResourcesRequest added in v0.6.0 

type GetResourcesRequest struct {
	*aws.Request
	Input *GetResourcesInput
	Copy  func(*GetResourcesInput) GetResourcesRequest
}

GetResourcesRequest is the request type for the GetResources API operation.

func (GetResourcesRequest) Send added in v0.6.0 

func (r GetResourcesRequest) Send(ctx context.Context) (*GetResourcesResponse, error)

Send marshals and sends the GetResources API request.

type GetResourcesResponse added in v0.9.0 

type GetResourcesResponse struct {
	*GetResourcesOutput
	// contains filtered or unexported fields
}

GetResourcesResponse is the response type for the GetResources API operation.

func (*GetResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetResources request.

type GroupMetadata 

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) MarshalFields added in v0.3.0 

func (s GroupMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GroupMetadata) String 

func (s GroupMetadata) String() string

String returns the string representation

type InitiateDocumentVersionUploadInput 

type InitiateDocumentVersionUploadInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s InitiateDocumentVersionUploadInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InitiateDocumentVersionUploadInput) String 

func (s InitiateDocumentVersionUploadInput) String() string

String returns the string representation

func (*InitiateDocumentVersionUploadInput) Validate 

func (s *InitiateDocumentVersionUploadInput) Validate() error

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

type InitiateDocumentVersionUploadOutput 

type InitiateDocumentVersionUploadOutput struct {

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

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

func (InitiateDocumentVersionUploadOutput) MarshalFields added in v0.3.0 

func (s InitiateDocumentVersionUploadOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InitiateDocumentVersionUploadOutput) String 

func (s InitiateDocumentVersionUploadOutput) String() string

String returns the string representation

type InitiateDocumentVersionUploadRequest 

type InitiateDocumentVersionUploadRequest struct {
	*aws.Request
	Input *InitiateDocumentVersionUploadInput
	Copy  func(*InitiateDocumentVersionUploadInput) InitiateDocumentVersionUploadRequest
}

InitiateDocumentVersionUploadRequest is the request type for the InitiateDocumentVersionUpload API operation.

func (InitiateDocumentVersionUploadRequest) Send 

func (r InitiateDocumentVersionUploadRequest) Send(ctx context.Context) (*InitiateDocumentVersionUploadResponse, error)

Send marshals and sends the InitiateDocumentVersionUpload API request.

type InitiateDocumentVersionUploadResponse added in v0.9.0 

type InitiateDocumentVersionUploadResponse struct {
	*InitiateDocumentVersionUploadOutput
	// contains filtered or unexported fields
}

InitiateDocumentVersionUploadResponse is the response type for the InitiateDocumentVersionUpload API operation.

func (*InitiateDocumentVersionUploadResponse) SDKResponseMetdata added in v0.9.0 

func (r *InitiateDocumentVersionUploadResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the InitiateDocumentVersionUpload request.

type LocaleType 

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

Enum values for LocaleType

func (LocaleType) MarshalValue added in v0.3.0 

func (enum LocaleType) MarshalValue() (string, error)

func (LocaleType) MarshalValueBuf added in v0.3.0 

func (enum LocaleType) MarshalValueBuf(b []byte) ([]byte, error)

type NotificationOptions added in v0.2.0 

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) MarshalFields added in v0.3.0 

func (s NotificationOptions) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NotificationOptions) String added in v0.2.0 

func (s NotificationOptions) String() string

String returns the string representation

type OrderType 

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

Enum values for OrderType

func (OrderType) MarshalValue added in v0.3.0 

func (enum OrderType) MarshalValue() (string, error)

func (OrderType) MarshalValueBuf added in v0.3.0 

func (enum OrderType) MarshalValueBuf(b []byte) ([]byte, error)

type Participants 

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) MarshalFields added in v0.3.0 

func (s Participants) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Participants) String 

func (s Participants) String() string

String returns the string representation

type PermissionInfo 

type PermissionInfo struct {

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

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

Describes the permissions.

func (PermissionInfo) MarshalFields added in v0.3.0 

func (s PermissionInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PermissionInfo) String 

func (s PermissionInfo) String() string

String returns the string representation

type Principal 

type Principal struct {

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

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

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

Describes a resource.

func (Principal) MarshalFields added in v0.3.0 

func (s Principal) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Principal) String 

func (s Principal) String() string

String returns the string representation

type PrincipalType 

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

Enum values for PrincipalType

func (PrincipalType) MarshalValue added in v0.3.0 

func (enum PrincipalType) MarshalValue() (string, error)

func (PrincipalType) MarshalValueBuf added in v0.3.0 

func (enum PrincipalType) MarshalValueBuf(b []byte) ([]byte, error)

type RemoveAllResourcePermissionsInput 

type RemoveAllResourcePermissionsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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) MarshalFields added in v0.3.0 

func (s RemoveAllResourcePermissionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RemoveAllResourcePermissionsInput) String 

func (s RemoveAllResourcePermissionsInput) String() string

String returns the string representation

func (*RemoveAllResourcePermissionsInput) Validate 

func (s *RemoveAllResourcePermissionsInput) Validate() error

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

type RemoveAllResourcePermissionsOutput 

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

func (RemoveAllResourcePermissionsOutput) MarshalFields added in v0.3.0 

func (s RemoveAllResourcePermissionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RemoveAllResourcePermissionsOutput) String 

func (s RemoveAllResourcePermissionsOutput) String() string

String returns the string representation

type RemoveAllResourcePermissionsRequest 

type RemoveAllResourcePermissionsRequest struct {
	*aws.Request
	Input *RemoveAllResourcePermissionsInput
	Copy  func(*RemoveAllResourcePermissionsInput) RemoveAllResourcePermissionsRequest
}

RemoveAllResourcePermissionsRequest is the request type for the RemoveAllResourcePermissions API operation.

func (RemoveAllResourcePermissionsRequest) Send 

func (r RemoveAllResourcePermissionsRequest) Send(ctx context.Context) (*RemoveAllResourcePermissionsResponse, error)

Send marshals and sends the RemoveAllResourcePermissions API request.

type RemoveAllResourcePermissionsResponse added in v0.9.0 

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

RemoveAllResourcePermissionsResponse is the response type for the RemoveAllResourcePermissions API operation.

func (*RemoveAllResourcePermissionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *RemoveAllResourcePermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RemoveAllResourcePermissions request.

type RemoveResourcePermissionInput 

type RemoveResourcePermissionInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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 PrincipalType `location:"querystring" locationName:"type" type:"string" enum:"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 (RemoveResourcePermissionInput) MarshalFields added in v0.3.0 

func (s RemoveResourcePermissionInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RemoveResourcePermissionInput) String 

func (s RemoveResourcePermissionInput) String() string

String returns the string representation

func (*RemoveResourcePermissionInput) Validate 

func (s *RemoveResourcePermissionInput) Validate() error

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

type RemoveResourcePermissionOutput 

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

func (RemoveResourcePermissionOutput) MarshalFields added in v0.3.0 

func (s RemoveResourcePermissionOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RemoveResourcePermissionOutput) String 

func (s RemoveResourcePermissionOutput) String() string

String returns the string representation

type RemoveResourcePermissionRequest 

type RemoveResourcePermissionRequest struct {
	*aws.Request
	Input *RemoveResourcePermissionInput
	Copy  func(*RemoveResourcePermissionInput) RemoveResourcePermissionRequest
}

RemoveResourcePermissionRequest is the request type for the RemoveResourcePermission API operation.

func (RemoveResourcePermissionRequest) Send 

func (r RemoveResourcePermissionRequest) Send(ctx context.Context) (*RemoveResourcePermissionResponse, error)

Send marshals and sends the RemoveResourcePermission API request.

type RemoveResourcePermissionResponse added in v0.9.0 

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

RemoveResourcePermissionResponse is the response type for the RemoveResourcePermission API operation.

func (*RemoveResourcePermissionResponse) SDKResponseMetdata added in v0.9.0 

func (r *RemoveResourcePermissionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RemoveResourcePermission request.

type ResourceCollectionType added in v0.6.0 

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

Enum values for ResourceCollectionType

func (ResourceCollectionType) MarshalValue added in v0.6.0 

func (enum ResourceCollectionType) MarshalValue() (string, error)

func (ResourceCollectionType) MarshalValueBuf added in v0.6.0 

func (enum ResourceCollectionType) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceMetadata 

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 ResourceType `type:"string" enum:"true"`

	// 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) MarshalFields added in v0.3.0 

func (s ResourceMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourceMetadata) String 

func (s ResourceMetadata) String() string

String returns the string representation

type ResourcePath 

type ResourcePath struct {

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

Describes the path information of a resource.

func (ResourcePath) MarshalFields added in v0.3.0 

func (s ResourcePath) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourcePath) String 

func (s ResourcePath) String() string

String returns the string representation

type ResourcePathComponent 

type ResourcePathComponent struct {

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

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

Describes the resource path.

func (ResourcePathComponent) MarshalFields added in v0.3.0 

func (s ResourcePathComponent) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourcePathComponent) String 

func (s ResourcePathComponent) String() string

String returns the string representation

type ResourceSortType 

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

Enum values for ResourceSortType

func (ResourceSortType) MarshalValue added in v0.3.0 

func (enum ResourceSortType) MarshalValue() (string, error)

func (ResourceSortType) MarshalValueBuf added in v0.3.0 

func (enum ResourceSortType) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceStateType 

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

Enum values for ResourceStateType

func (ResourceStateType) MarshalValue added in v0.3.0 

func (enum ResourceStateType) MarshalValue() (string, error)

func (ResourceStateType) MarshalValueBuf added in v0.3.0 

func (enum ResourceStateType) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceType 

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

Enum values for ResourceType

func (ResourceType) MarshalValue added in v0.3.0 

func (enum ResourceType) MarshalValue() (string, error)

func (ResourceType) MarshalValueBuf added in v0.3.0 

func (enum ResourceType) MarshalValueBuf(b []byte) ([]byte, error)

type RolePermissionType 

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

Enum values for RolePermissionType

func (RolePermissionType) MarshalValue added in v0.3.0 

func (enum RolePermissionType) MarshalValue() (string, error)

func (RolePermissionType) MarshalValueBuf added in v0.3.0 

func (enum RolePermissionType) MarshalValueBuf(b []byte) ([]byte, error)

type RoleType 

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

Enum values for RoleType

func (RoleType) MarshalValue added in v0.3.0 

func (enum RoleType) MarshalValue() (string, error)

func (RoleType) MarshalValueBuf added in v0.3.0 

func (enum RoleType) MarshalValueBuf(b []byte) ([]byte, error)

type SharePrincipal 

type SharePrincipal struct {

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

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

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

Describes the recipient type and ID, if available.

func (SharePrincipal) MarshalFields added in v0.3.0 

func (s SharePrincipal) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SharePrincipal) String 

func (s SharePrincipal) String() string

String returns the string representation

func (*SharePrincipal) Validate 

func (s *SharePrincipal) Validate() error

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

type ShareResult 

type ShareResult struct {

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

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

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

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

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

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

Describes the share results of a resource.

func (ShareResult) MarshalFields added in v0.3.0 

func (s ShareResult) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ShareResult) String 

func (s ShareResult) String() string

String returns the string representation

type ShareStatusType 

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

Enum values for ShareStatusType

func (ShareStatusType) MarshalValue added in v0.3.0 

func (enum ShareStatusType) MarshalValue() (string, error)

func (ShareStatusType) MarshalValueBuf added in v0.3.0 

func (enum ShareStatusType) MarshalValueBuf(b []byte) ([]byte, error)

type StorageRuleType 

type StorageRuleType struct {

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

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

Describes the storage for a user.

func (StorageRuleType) MarshalFields added in v0.3.0 

func (s StorageRuleType) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StorageRuleType) String 

func (s StorageRuleType) String() string

String returns the string representation

type StorageType 

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

Enum values for StorageType

func (StorageType) MarshalValue added in v0.3.0 

func (enum StorageType) MarshalValue() (string, error)

func (StorageType) MarshalValueBuf added in v0.3.0 

func (enum StorageType) MarshalValueBuf(b []byte) ([]byte, error)

type Subscription 

type Subscription struct {

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

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

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

Describes a subscription.

func (Subscription) MarshalFields added in v0.3.0 

func (s Subscription) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Subscription) String 

func (s Subscription) String() string

String returns the string representation

type SubscriptionProtocolType 

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

Enum values for SubscriptionProtocolType

func (SubscriptionProtocolType) MarshalValue added in v0.3.0 

func (enum SubscriptionProtocolType) MarshalValue() (string, error)

func (SubscriptionProtocolType) MarshalValueBuf added in v0.3.0 

func (enum SubscriptionProtocolType) MarshalValueBuf(b []byte) ([]byte, error)

type SubscriptionType 

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

Enum values for SubscriptionType

func (SubscriptionType) MarshalValue added in v0.3.0 

func (enum SubscriptionType) MarshalValue() (string, error)

func (SubscriptionType) MarshalValueBuf added in v0.3.0 

func (enum SubscriptionType) MarshalValueBuf(b []byte) ([]byte, error)

type UpdateDocumentInput 

type UpdateDocumentInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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 ResourceStateType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateDocumentInput) MarshalFields added in v0.3.0 

func (s UpdateDocumentInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDocumentInput) String 

func (s UpdateDocumentInput) String() string

String returns the string representation

func (*UpdateDocumentInput) Validate 

func (s *UpdateDocumentInput) Validate() error

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

type UpdateDocumentOutput 

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

func (UpdateDocumentOutput) MarshalFields added in v0.3.0 

func (s UpdateDocumentOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDocumentOutput) String 

func (s UpdateDocumentOutput) String() string

String returns the string representation

type UpdateDocumentRequest 

type UpdateDocumentRequest struct {
	*aws.Request
	Input *UpdateDocumentInput
	Copy  func(*UpdateDocumentInput) UpdateDocumentRequest
}

UpdateDocumentRequest is the request type for the UpdateDocument API operation.

func (UpdateDocumentRequest) Send 

func (r UpdateDocumentRequest) Send(ctx context.Context) (*UpdateDocumentResponse, error)

Send marshals and sends the UpdateDocument API request.

type UpdateDocumentResponse added in v0.9.0 

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

UpdateDocumentResponse is the response type for the UpdateDocument API operation.

func (*UpdateDocumentResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateDocumentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateDocument request.

type UpdateDocumentVersionInput 

type UpdateDocumentVersionInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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 DocumentVersionStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateDocumentVersionInput) MarshalFields added in v0.3.0 

func (s UpdateDocumentVersionInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDocumentVersionInput) String 

func (s UpdateDocumentVersionInput) String() string

String returns the string representation

func (*UpdateDocumentVersionInput) Validate 

func (s *UpdateDocumentVersionInput) Validate() error

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

type UpdateDocumentVersionOutput 

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

func (UpdateDocumentVersionOutput) MarshalFields added in v0.3.0 

func (s UpdateDocumentVersionOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDocumentVersionOutput) String 

func (s UpdateDocumentVersionOutput) String() string

String returns the string representation

type UpdateDocumentVersionRequest 

type UpdateDocumentVersionRequest struct {
	*aws.Request
	Input *UpdateDocumentVersionInput
	Copy  func(*UpdateDocumentVersionInput) UpdateDocumentVersionRequest
}

UpdateDocumentVersionRequest is the request type for the UpdateDocumentVersion API operation.

func (UpdateDocumentVersionRequest) Send 

func (r UpdateDocumentVersionRequest) Send(ctx context.Context) (*UpdateDocumentVersionResponse, error)

Send marshals and sends the UpdateDocumentVersion API request.

type UpdateDocumentVersionResponse added in v0.9.0 

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

UpdateDocumentVersionResponse is the response type for the UpdateDocumentVersion API operation.

func (*UpdateDocumentVersionResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateDocumentVersionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateDocumentVersion request.

type UpdateFolderInput 

type UpdateFolderInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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 ResourceStateType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateFolderInput) MarshalFields added in v0.3.0 

func (s UpdateFolderInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFolderInput) String 

func (s UpdateFolderInput) String() string

String returns the string representation

func (*UpdateFolderInput) Validate 

func (s *UpdateFolderInput) Validate() error

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

type UpdateFolderOutput 

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

func (UpdateFolderOutput) MarshalFields added in v0.3.0 

func (s UpdateFolderOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFolderOutput) String 

func (s UpdateFolderOutput) String() string

String returns the string representation

type UpdateFolderRequest 

type UpdateFolderRequest struct {
	*aws.Request
	Input *UpdateFolderInput
	Copy  func(*UpdateFolderInput) UpdateFolderRequest
}

UpdateFolderRequest is the request type for the UpdateFolder API operation.

func (UpdateFolderRequest) Send 

func (r UpdateFolderRequest) Send(ctx context.Context) (*UpdateFolderResponse, error)

Send marshals and sends the UpdateFolder API request.

type UpdateFolderResponse added in v0.9.0 

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

UpdateFolderResponse is the response type for the UpdateFolder API operation.

func (*UpdateFolderResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateFolderResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateFolder request.

type UpdateUserInput 

type UpdateUserInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	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 BooleanEnumType `type:"string" enum:"true"`

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

	// 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 UserType `type:"string" enum:"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 (UpdateUserInput) MarshalFields added in v0.3.0 

func (s UpdateUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserInput) String 

func (s UpdateUserInput) String() string

String returns the string representation

func (*UpdateUserInput) Validate 

func (s *UpdateUserInput) Validate() error

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

type UpdateUserOutput 

type UpdateUserOutput struct {

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

func (UpdateUserOutput) MarshalFields added in v0.3.0 

func (s UpdateUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserOutput) String 

func (s UpdateUserOutput) String() string

String returns the string representation

type UpdateUserRequest 

type UpdateUserRequest struct {
	*aws.Request
	Input *UpdateUserInput
	Copy  func(*UpdateUserInput) UpdateUserRequest
}

UpdateUserRequest is the request type for the UpdateUser API operation.

func (UpdateUserRequest) Send 

func (r UpdateUserRequest) Send(ctx context.Context) (*UpdateUserResponse, error)

Send marshals and sends the UpdateUser API request.

type UpdateUserResponse added in v0.9.0 

type UpdateUserResponse struct {
	*UpdateUserOutput
	// contains filtered or unexported fields
}

UpdateUserResponse is the response type for the UpdateUser API operation.

func (*UpdateUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateUser request.

type UploadMetadata 

type UploadMetadata struct {

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

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

Describes the upload.

func (UploadMetadata) MarshalFields added in v0.3.0 

func (s UploadMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UploadMetadata) String 

func (s UploadMetadata) String() string

String returns the string representation

type User 

type User struct {

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

	// 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 LocaleType `type:"string" enum:"true"`

	// 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 UserStatusType `type:"string" enum:"true"`

	// 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 UserType `type:"string" enum:"true"`

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

Describes a user.

func (User) MarshalFields added in v0.3.0 

func (s User) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (User) String 

func (s User) String() string

String returns the string representation

type UserFilterType 

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

Enum values for UserFilterType

func (UserFilterType) MarshalValue added in v0.3.0 

func (enum UserFilterType) MarshalValue() (string, error)

func (UserFilterType) MarshalValueBuf added in v0.3.0 

func (enum UserFilterType) MarshalValueBuf(b []byte) ([]byte, error)

type UserMetadata 

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) MarshalFields added in v0.3.0 

func (s UserMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UserMetadata) String 

func (s UserMetadata) String() string

String returns the string representation

type UserSortType 

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

Enum values for UserSortType

func (UserSortType) MarshalValue added in v0.3.0 

func (enum UserSortType) MarshalValue() (string, error)

func (UserSortType) MarshalValueBuf added in v0.3.0 

func (enum UserSortType) MarshalValueBuf(b []byte) ([]byte, error)

type UserStatusType 

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

Enum values for UserStatusType

func (UserStatusType) MarshalValue added in v0.3.0 

func (enum UserStatusType) MarshalValue() (string, error)

func (UserStatusType) MarshalValueBuf added in v0.3.0 

func (enum UserStatusType) MarshalValueBuf(b []byte) ([]byte, error)

type UserStorageMetadata 

type UserStorageMetadata struct {

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

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

Describes the storage for a user.

func (UserStorageMetadata) MarshalFields added in v0.3.0 

func (s UserStorageMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UserStorageMetadata) String 

func (s UserStorageMetadata) String() string

String returns the string representation

type UserType 

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

Enum values for UserType

func (UserType) MarshalValue added in v0.3.0 

func (enum UserType) MarshalValue() (string, error)

func (UserType) MarshalValueBuf added in v0.3.0 

func (enum UserType) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

Directories

Path Synopsis
Package workdocsiface provides an interface to enable mocking the Amazon WorkDocs service client for testing your code.
 Package workdocsiface provides an interface to enable mocking the Amazon WorkDocs service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.