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

package workdocs

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

Index

Constants

const ServiceAPIVersion = "2016-05-01"
const ServiceID = "WorkDocs"

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type AbortDocumentVersionUploadInput

type AbortDocumentVersionUploadInput struct {

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string

	// The ID of the version.
	//
	// This member is required.
	VersionId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type AbortDocumentVersionUploadOutput

type AbortDocumentVersionUploadOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ActivateUserInput

type ActivateUserInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The ID of the user.
	//
	// This member is required.
	UserId *string
}

type ActivateUserOutput

type ActivateUserOutput struct {

	// The user information.
	User *types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AddResourcePermissionsInput

type AddResourcePermissionsInput struct {

	// The notification options.
	NotificationOptions *types.NotificationOptions

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The ID of the resource.
	//
	// This member is required.
	ResourceId *string

	// The users, groups, or organization being granted permission.
	//
	// This member is required.
	Principals []*types.SharePrincipal
}

type AddResourcePermissionsOutput

type AddResourcePermissionsOutput struct {

	// The share results.
	ShareResults []*types.ShareResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client

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

The WorkDocs API is designed for the following use cases:

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.

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.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AbortDocumentVersionUpload

func (c *Client) AbortDocumentVersionUpload(ctx context.Context, params *AbortDocumentVersionUploadInput, optFns ...func(*Options)) (*AbortDocumentVersionUploadOutput, error)

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.

func (*Client) ActivateUser

func (c *Client) ActivateUser(ctx context.Context, params *ActivateUserInput, optFns ...func(*Options)) (*ActivateUserOutput, error)

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

func (*Client) AddResourcePermissions

func (c *Client) AddResourcePermissions(ctx context.Context, params *AddResourcePermissionsInput, optFns ...func(*Options)) (*AddResourcePermissionsOutput, error)

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

func (*Client) CreateComment

func (c *Client) CreateComment(ctx context.Context, params *CreateCommentInput, optFns ...func(*Options)) (*CreateCommentOutput, error)

Adds a new comment to the specified document version.

func (*Client) CreateCustomMetadata

func (c *Client) CreateCustomMetadata(ctx context.Context, params *CreateCustomMetadataInput, optFns ...func(*Options)) (*CreateCustomMetadataOutput, error)

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

func (*Client) CreateFolder

func (c *Client) CreateFolder(ctx context.Context, params *CreateFolderInput, optFns ...func(*Options)) (*CreateFolderOutput, error)

Creates a folder with the specified name and parent folder.

func (*Client) CreateLabels

func (c *Client) CreateLabels(ctx context.Context, params *CreateLabelsInput, optFns ...func(*Options)) (*CreateLabelsOutput, error)

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

func (*Client) CreateNotificationSubscription

func (c *Client) CreateNotificationSubscription(ctx context.Context, params *CreateNotificationSubscriptionInput, optFns ...func(*Options)) (*CreateNotificationSubscriptionOutput, error)

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.

func (*Client) CreateUser

func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)

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.

func (*Client) DeactivateUser

func (c *Client) DeactivateUser(ctx context.Context, params *DeactivateUserInput, optFns ...func(*Options)) (*DeactivateUserOutput, error)

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

func (*Client) DeleteComment

func (c *Client) DeleteComment(ctx context.Context, params *DeleteCommentInput, optFns ...func(*Options)) (*DeleteCommentOutput, error)

Deletes the specified comment from the document version.

func (*Client) DeleteCustomMetadata

func (c *Client) DeleteCustomMetadata(ctx context.Context, params *DeleteCustomMetadataInput, optFns ...func(*Options)) (*DeleteCustomMetadataOutput, error)

Deletes custom metadata from the specified resource.

func (*Client) DeleteDocument

func (c *Client) DeleteDocument(ctx context.Context, params *DeleteDocumentInput, optFns ...func(*Options)) (*DeleteDocumentOutput, error)

Permanently deletes the specified document and its associated metadata.

func (*Client) DeleteFolder

func (c *Client) DeleteFolder(ctx context.Context, params *DeleteFolderInput, optFns ...func(*Options)) (*DeleteFolderOutput, error)

Permanently deletes the specified folder and its contents.

func (*Client) DeleteFolderContents

func (c *Client) DeleteFolderContents(ctx context.Context, params *DeleteFolderContentsInput, optFns ...func(*Options)) (*DeleteFolderContentsOutput, error)

Deletes the contents of the specified folder.

func (*Client) DeleteLabels

func (c *Client) DeleteLabels(ctx context.Context, params *DeleteLabelsInput, optFns ...func(*Options)) (*DeleteLabelsOutput, error)

Deletes the specified list of labels from a resource.

func (*Client) DeleteNotificationSubscription

func (c *Client) DeleteNotificationSubscription(ctx context.Context, params *DeleteNotificationSubscriptionInput, optFns ...func(*Options)) (*DeleteNotificationSubscriptionOutput, error)

Deletes the specified subscription from the specified organization.

func (*Client) DeleteUser

func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)

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

func (*Client) DescribeActivities

func (c *Client) DescribeActivities(ctx context.Context, params *DescribeActivitiesInput, optFns ...func(*Options)) (*DescribeActivitiesOutput, error)

Describes the user activities in a specified time period.

func (*Client) DescribeComments

func (c *Client) DescribeComments(ctx context.Context, params *DescribeCommentsInput, optFns ...func(*Options)) (*DescribeCommentsOutput, error)

List all the comments for the specified document version.

func (*Client) DescribeDocumentVersions

func (c *Client) DescribeDocumentVersions(ctx context.Context, params *DescribeDocumentVersionsInput, optFns ...func(*Options)) (*DescribeDocumentVersionsOutput, error)

Retrieves the document versions for the specified document. By default, only active versions are returned.

func (*Client) DescribeFolderContents

func (c *Client) DescribeFolderContents(ctx context.Context, params *DescribeFolderContentsInput, optFns ...func(*Options)) (*DescribeFolderContentsOutput, error)

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.

func (*Client) DescribeGroups

func (c *Client) DescribeGroups(ctx context.Context, params *DescribeGroupsInput, optFns ...func(*Options)) (*DescribeGroupsOutput, error)

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

func (*Client) DescribeNotificationSubscriptions

func (c *Client) DescribeNotificationSubscriptions(ctx context.Context, params *DescribeNotificationSubscriptionsInput, optFns ...func(*Options)) (*DescribeNotificationSubscriptionsOutput, error)

Lists the specified notification subscriptions.

func (*Client) DescribeResourcePermissions

func (c *Client) DescribeResourcePermissions(ctx context.Context, params *DescribeResourcePermissionsInput, optFns ...func(*Options)) (*DescribeResourcePermissionsOutput, error)

Describes the permissions of a specified resource.

func (*Client) DescribeRootFolders

func (c *Client) DescribeRootFolders(ctx context.Context, params *DescribeRootFoldersInput, optFns ...func(*Options)) (*DescribeRootFoldersOutput, error)

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.

func (*Client) DescribeUsers

func (c *Client) DescribeUsers(ctx context.Context, params *DescribeUsersInput, optFns ...func(*Options)) (*DescribeUsersOutput, error)

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.

func (*Client) GetCurrentUser

func (c *Client) GetCurrentUser(ctx context.Context, params *GetCurrentUserInput, optFns ...func(*Options)) (*GetCurrentUserOutput, error)

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.

func (*Client) GetDocument

func (c *Client) GetDocument(ctx context.Context, params *GetDocumentInput, optFns ...func(*Options)) (*GetDocumentOutput, error)

Retrieves details of a document.

func (*Client) GetDocumentPath

func (c *Client) GetDocumentPath(ctx context.Context, params *GetDocumentPathInput, optFns ...func(*Options)) (*GetDocumentPathOutput, error)

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.

func (*Client) GetDocumentVersion

func (c *Client) GetDocumentVersion(ctx context.Context, params *GetDocumentVersionInput, optFns ...func(*Options)) (*GetDocumentVersionOutput, error)

Retrieves version metadata for the specified document.

func (*Client) GetFolder

func (c *Client) GetFolder(ctx context.Context, params *GetFolderInput, optFns ...func(*Options)) (*GetFolderOutput, error)

Retrieves the metadata of the specified folder.

func (*Client) GetFolderPath

func (c *Client) GetFolderPath(ctx context.Context, params *GetFolderPathInput, optFns ...func(*Options)) (*GetFolderPathOutput, error)

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.

func (*Client) GetResources

func (c *Client) GetResources(ctx context.Context, params *GetResourcesInput, optFns ...func(*Options)) (*GetResourcesOutput, error)

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

func (*Client) InitiateDocumentVersionUpload

func (c *Client) InitiateDocumentVersionUpload(ctx context.Context, params *InitiateDocumentVersionUploadInput, optFns ...func(*Options)) (*InitiateDocumentVersionUploadOutput, error)

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

func (*Client) RemoveAllResourcePermissions

func (c *Client) RemoveAllResourcePermissions(ctx context.Context, params *RemoveAllResourcePermissionsInput, optFns ...func(*Options)) (*RemoveAllResourcePermissionsOutput, error)

Removes all the permissions from the specified resource.

func (*Client) RemoveResourcePermission

func (c *Client) RemoveResourcePermission(ctx context.Context, params *RemoveResourcePermissionInput, optFns ...func(*Options)) (*RemoveResourcePermissionOutput, error)

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

func (*Client) UpdateDocument

func (c *Client) UpdateDocument(ctx context.Context, params *UpdateDocumentInput, optFns ...func(*Options)) (*UpdateDocumentOutput, error)

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

func (*Client) UpdateDocumentVersion

func (c *Client) UpdateDocumentVersion(ctx context.Context, params *UpdateDocumentVersionInput, optFns ...func(*Options)) (*UpdateDocumentVersionOutput, error)

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

func (*Client) UpdateFolder

func (c *Client) UpdateFolder(ctx context.Context, params *UpdateFolderInput, optFns ...func(*Options)) (*UpdateFolderOutput, error)

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

func (*Client) UpdateUser

func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)

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

type CreateCommentInput

type CreateCommentInput struct {

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

	// The ID of the parent comment.
	ParentId *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 types.CommentVisibilityType

	// The ID of the root comment in the thread.
	ThreadId *string

	// The ID of the document version.
	//
	// This member is required.
	VersionId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The text of the comment.
	//
	// This member is required.
	Text *string

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string
}

type CreateCommentOutput

type CreateCommentOutput struct {

	// The comment that has been created.
	Comment *types.Comment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateCustomMetadataInput

type CreateCustomMetadataInput struct {

	// Custom metadata in the form of name-value pairs.
	//
	// This member is required.
	CustomMetadata map[string]*string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The ID of the version, if the custom metadata is being added to a document
	// version.
	VersionId *string

	// The ID of the resource.
	//
	// This member is required.
	ResourceId *string
}

type CreateCustomMetadataOutput

type CreateCustomMetadataOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateFolderInput

type CreateFolderInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The name of the new folder.
	Name *string

	// The ID of the parent folder.
	//
	// This member is required.
	ParentFolderId *string
}

type CreateFolderOutput

type CreateFolderOutput struct {

	// The metadata of the folder.
	Metadata *types.FolderMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateLabelsInput

type CreateLabelsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// List of labels to add to the resource.
	//
	// This member is required.
	Labels []*string

	// The ID of the resource.
	//
	// This member is required.
	ResourceId *string
}

type CreateLabelsOutput

type CreateLabelsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateNotificationSubscriptionInput

type CreateNotificationSubscriptionInput struct {

	// The notification type.
	//
	// This member is required.
	SubscriptionType types.SubscriptionType

	// The protocol to use. The supported value is https, which delivers JSON-encoded
	// messages using HTTPS POST.
	//
	// This member is required.
	Protocol types.SubscriptionProtocolType

	// The endpoint to receive the notifications. If the protocol is HTTPS, the
	// endpoint is a URL that begins with https.
	//
	// This member is required.
	Endpoint *string

	// The ID of the organization.
	//
	// This member is required.
	OrganizationId *string
}

type CreateNotificationSubscriptionOutput

type CreateNotificationSubscriptionOutput struct {

	// The subscription.
	Subscription *types.Subscription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateUserInput

type CreateUserInput struct {

	// The given name of the user.
	//
	// This member is required.
	GivenName *string

	// The surname of the user.
	//
	// This member is required.
	Surname *string

	// The ID of the organization.
	OrganizationId *string

	// The login name of the user.
	//
	// This member is required.
	Username *string

	// The time zone ID of the user.
	TimeZoneId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The amount of storage for the user.
	StorageRule *types.StorageRuleType

	// The email address of the user.
	EmailAddress *string

	// The password of the user.
	//
	// This member is required.
	Password *string
}

type CreateUserOutput

type CreateUserOutput struct {

	// The user information.
	User *types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeactivateUserInput

type DeactivateUserInput struct {

	// The ID of the user.
	//
	// This member is required.
	UserId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type DeactivateUserOutput

type DeactivateUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteCommentInput

type DeleteCommentInput struct {

	// The ID of the comment.
	//
	// This member is required.
	CommentId *string

	// The ID of the document version.
	//
	// This member is required.
	VersionId *string

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type DeleteCommentOutput

type DeleteCommentOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteCustomMetadataInput

type DeleteCustomMetadataInput struct {

	// Flag to indicate removal of all custom metadata properties from the specified
	// resource.
	DeleteAll *bool

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The ID of the resource, either a document or folder.
	//
	// This member is required.
	ResourceId *string

	// The ID of the version, if the custom metadata is being deleted from a document
	// version.
	VersionId *string

	// List of properties to remove.
	Keys []*string
}

type DeleteCustomMetadataOutput

type DeleteCustomMetadataOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDocumentInput

type DeleteDocumentInput struct {

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type DeleteDocumentOutput

type DeleteDocumentOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteFolderContentsInput

type DeleteFolderContentsInput struct {

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type DeleteFolderContentsOutput

type DeleteFolderContentsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteFolderInput

type DeleteFolderInput struct {

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type DeleteFolderOutput

type DeleteFolderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteLabelsInput

type DeleteLabelsInput struct {

	// Flag to request removal of all labels from the specified resource.
	DeleteAll *bool

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The ID of the resource.
	//
	// This member is required.
	ResourceId *string

	// List of labels to delete from the resource.
	Labels []*string
}

type DeleteLabelsOutput

type DeleteLabelsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteNotificationSubscriptionInput

type DeleteNotificationSubscriptionInput struct {

	// The ID of the subscription.
	//
	// This member is required.
	SubscriptionId *string

	// The ID of the organization.
	//
	// This member is required.
	OrganizationId *string
}

type DeleteNotificationSubscriptionOutput

type DeleteNotificationSubscriptionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteUserInput

type DeleteUserInput struct {

	// The ID of the user.
	//
	// This member is required.
	UserId *string

	// Amazon WorkDocs authentication token. Do not set this field when using
	// administrative API actions, as in accessing the API using AWS credentials.
	AuthenticationToken *string
}

type DeleteUserOutput

type DeleteUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeActivitiesInput

type DescribeActivitiesInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// Specifies which activity types to include in the response. If this field is left
	// empty, all activity types are returned.
	ActivityTypes *string

	// The ID of the organization. This is a mandatory parameter when using
	// administrative API (SigV4) requests.
	OrganizationId *string

	// The marker for the next set of results.
	Marker *string

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

	// The maximum number of items to return.
	Limit *int32

	// The timestamp that determines the end time of the activities. The response
	// includes the activities performed before the specified timestamp.
	EndTime *time.Time

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

	// The timestamp that determines the starting time of the activities. The response
	// includes the activities performed after the specified timestamp.
	StartTime *time.Time

	// The document or folder ID for which to describe activity types.
	ResourceId *string
}

type DescribeActivitiesOutput

type DescribeActivitiesOutput struct {

	// The list of activities for the specified user and time period.
	UserActivities []*types.Activity

	// The marker for the next set of results.
	Marker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeCommentsInput

type DescribeCommentsInput struct {

	// The maximum number of items to return.
	Limit *int32

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string

	// The ID of the document version.
	//
	// This member is required.
	VersionId *string

	// The marker for the next set of results. This marker was received from a previous
	// call.
	Marker *string
}

type DescribeCommentsOutput

type DescribeCommentsOutput struct {

	// The marker for the next set of results. This marker was received from a previous
	// call.
	Marker *string

	// The list of comments for the specified document version.
	Comments []*types.Comment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeDocumentVersionsInput

type DescribeDocumentVersionsInput struct {

	// A comma-separated list of values. Specify "INITIALIZED" to include incomplete
	// versions.
	Include *string

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string

	// The maximum number of versions to return with this call.
	Limit *int32

	// Specify "SOURCE" to include initialized versions and a URL for the source
	// document.
	Fields *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type DescribeDocumentVersionsOutput

type DescribeDocumentVersionsOutput struct {

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

	// The document versions.
	DocumentVersions []*types.DocumentVersionMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeFolderContentsInput

type DescribeFolderContentsInput struct {

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string

	// The sorting criteria.
	Sort types.ResourceSortType

	// The marker for the next set of results. This marker was received from a previous
	// call.
	Marker *string

	// The contents to include. Specify "INITIALIZED" to include initialized documents.
	Include *string

	// The maximum number of items to return with this call.
	Limit *int32

	// The order for the contents of the folder.
	Order types.OrderType

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The type of items.
	Type types.FolderContentType
}

type DescribeFolderContentsOutput

type DescribeFolderContentsOutput struct {

	// The subfolders in the specified folder.
	Folders []*types.FolderMetadata

	// The documents in the specified folder.
	Documents []*types.DocumentMetadata

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeGroupsInput

type DescribeGroupsInput struct {

	// A query to describe groups by group name.
	//
	// This member is required.
	SearchQuery *string

	// The maximum number of items to return with this call.
	Limit *int32

	// The ID of the organization.
	OrganizationId *string

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type DescribeGroupsOutput

type DescribeGroupsOutput struct {

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

	// The list of groups.
	Groups []*types.GroupMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeNotificationSubscriptionsInput

type DescribeNotificationSubscriptionsInput struct {

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string

	// The ID of the organization.
	//
	// This member is required.
	OrganizationId *string

	// The maximum number of items to return with this call.
	Limit *int32
}

type DescribeNotificationSubscriptionsOutput

type DescribeNotificationSubscriptionsOutput struct {

	// The subscriptions.
	Subscriptions []*types.Subscription

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeResourcePermissionsInput

type DescribeResourcePermissionsInput struct {

	// The ID of the principal to filter permissions by.
	PrincipalId *string

	// The ID of the resource.
	//
	// This member is required.
	ResourceId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The maximum number of items to return with this call.
	Limit *int32

	// The marker for the next set of results. (You received this marker from a
	// previous call)
	Marker *string
}

type DescribeResourcePermissionsOutput

type DescribeResourcePermissionsOutput struct {

	// The principals.
	Principals []*types.Principal

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeRootFoldersInput

type DescribeRootFoldersInput struct {

	// The maximum number of items to return.
	Limit *int32

	// Amazon WorkDocs authentication token.
	//
	// This member is required.
	AuthenticationToken *string

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string
}

type DescribeRootFoldersOutput

type DescribeRootFoldersOutput struct {

	// The marker for the next set of results.
	Marker *string

	// The user's special folders.
	Folders []*types.FolderMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeUsersInput

type DescribeUsersInput struct {

	// A comma-separated list of values. Specify "STORAGE_METADATA" to include the user
	// storage quota and utilization information.
	Fields *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The order for the results.
	Order types.OrderType

	// The maximum number of items to return.
	Limit *int32

	// The marker for the next set of results. (You received this marker from a
	// previous call.)
	Marker *string

	// The state of the users. Specify "ALL" to include inactive users.
	Include types.UserFilterType

	// The sorting criteria.
	Sort types.UserSortType

	// The IDs of the users.
	UserIds *string

	// A query to filter users by user name.
	Query *string

	// The ID of the organization.
	OrganizationId *string
}

type DescribeUsersOutput

type DescribeUsersOutput struct {

	// The total number of users included in the results.
	TotalNumberOfUsers *int64

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

	// The users.
	Users []*types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type GetCurrentUserInput

type GetCurrentUserInput struct {

	// Amazon WorkDocs authentication token.
	//
	// This member is required.
	AuthenticationToken *string
}

type GetCurrentUserOutput

type GetCurrentUserOutput struct {

	// Metadata of the user.
	User *types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDocumentInput

type GetDocumentInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string

	// Set this to TRUE to include custom metadata in the response.
	IncludeCustomMetadata *bool
}

type GetDocumentOutput

type GetDocumentOutput struct {

	// The custom metadata on the document.
	CustomMetadata map[string]*string

	// The metadata details of the document.
	Metadata *types.DocumentMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDocumentPathInput

type GetDocumentPathInput struct {

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string

	// The maximum number of levels in the hierarchy to return.
	Limit *int32

	// This value is not supported.
	Marker *string

	// A comma-separated list of values. Specify NAME to include the names of the
	// parent folders.
	Fields *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type GetDocumentPathOutput

type GetDocumentPathOutput struct {

	// The path information.
	Path *types.ResourcePath

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDocumentVersionInput

type GetDocumentVersionInput struct {

	// Set this to TRUE to include custom metadata in the response.
	IncludeCustomMetadata *bool

	// The version ID of the document.
	//
	// This member is required.
	VersionId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string

	// A comma-separated list of values. Specify "SOURCE" to include a URL for the
	// source document.
	Fields *string
}

type GetDocumentVersionOutput

type GetDocumentVersionOutput struct {

	// The version metadata.
	Metadata *types.DocumentVersionMetadata

	// The custom metadata on the document version.
	CustomMetadata map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetFolderInput

type GetFolderInput struct {

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string

	// Set to TRUE to include custom metadata in the response.
	IncludeCustomMetadata *bool

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type GetFolderOutput

type GetFolderOutput struct {

	// The custom metadata on the folder.
	CustomMetadata map[string]*string

	// The metadata of the folder.
	Metadata *types.FolderMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetFolderPathInput

type GetFolderPathInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// A comma-separated list of values. Specify "NAME" to include the names of the
	// parent folders.
	Fields *string

	// This value is not supported.
	Marker *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string

	// The maximum number of levels in the hierarchy to return.
	Limit *int32
}

type GetFolderPathOutput

type GetFolderPathOutput struct {

	// The path information.
	Path *types.ResourcePath

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetResourcesInput

type GetResourcesInput struct {

	// The collection type.
	CollectionType types.ResourceCollectionType

	// The marker for the next set of results. This marker was received from a previous
	// call.
	Marker *string

	// The user ID for the resource collection. This is a required field for accessing
	// the API operation using IAM credentials.
	UserId *string

	// The Amazon WorkDocs authentication token. Not required when using AWS
	// administrator credentials to access the API.
	AuthenticationToken *string

	// The maximum number of resources to return.
	Limit *int32
}

type GetResourcesOutput

type GetResourcesOutput struct {

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

	// The documents in the specified collection.
	Documents []*types.DocumentMetadata

	// The folders in the specified folder.
	Folders []*types.FolderMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type InitiateDocumentVersionUploadInput

type InitiateDocumentVersionUploadInput struct {

	// The content type of the document.
	ContentType *string

	// The ID of the document.
	Id *string

	// The ID of the parent folder.
	//
	// This member is required.
	ParentFolderId *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The timestamp when the content of the document was modified.
	ContentModifiedTimestamp *time.Time

	// The name of the document.
	Name *string

	// The size of the document, in bytes.
	DocumentSizeInBytes *int64

	// The timestamp when the content of the document was originally created.
	ContentCreatedTimestamp *time.Time
}

type InitiateDocumentVersionUploadOutput

type InitiateDocumentVersionUploadOutput struct {

	// The upload metadata.
	UploadMetadata *types.UploadMetadata

	// The document metadata.
	Metadata *types.DocumentMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type RemoveAllResourcePermissionsInput

type RemoveAllResourcePermissionsInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The ID of the resource.
	//
	// This member is required.
	ResourceId *string
}

type RemoveAllResourcePermissionsOutput

type RemoveAllResourcePermissionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RemoveResourcePermissionInput

type RemoveResourcePermissionInput struct {

	// The principal type of the resource.
	PrincipalType types.PrincipalType

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The principal ID of the resource.
	//
	// This member is required.
	PrincipalId *string

	// The ID of the resource.
	//
	// This member is required.
	ResourceId *string
}

type RemoveResourcePermissionOutput

type RemoveResourcePermissionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type UpdateDocumentInput

type UpdateDocumentInput struct {

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string

	// The resource state of the document. Only ACTIVE and RECYCLED are supported.
	ResourceState types.ResourceStateType

	// The ID of the parent folder.
	ParentFolderId *string

	// The name of the document.
	Name *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string
}

type UpdateDocumentOutput

type UpdateDocumentOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDocumentVersionInput

type UpdateDocumentVersionInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The ID of the document.
	//
	// This member is required.
	DocumentId *string

	// The version ID of the document.
	//
	// This member is required.
	VersionId *string

	// The status of the version.
	VersionStatus types.DocumentVersionStatus
}

type UpdateDocumentVersionOutput

type UpdateDocumentVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateFolderInput

type UpdateFolderInput struct {

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The resource state of the folder. Only ACTIVE and RECYCLED are accepted values
	// from the API.
	ResourceState types.ResourceStateType

	// The name of the folder.
	Name *string

	// The ID of the parent folder.
	ParentFolderId *string

	// The ID of the folder.
	//
	// This member is required.
	FolderId *string
}

type UpdateFolderOutput

type UpdateFolderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateUserInput

type UpdateUserInput struct {

	// The time zone ID of the user.
	TimeZoneId *string

	// The given name of the user.
	GivenName *string

	// The ID of the user.
	//
	// This member is required.
	UserId *string

	// The locale of the user.
	Locale types.LocaleType

	// The amount of storage for the user.
	StorageRule *types.StorageRuleType

	// Boolean value to determine whether the user is granted Poweruser privileges.
	GrantPoweruserPrivileges types.BooleanEnumType

	// The surname of the user.
	Surname *string

	// Amazon WorkDocs authentication token. Not required when using AWS administrator
	// credentials to access the API.
	AuthenticationToken *string

	// The type of the user.
	Type types.UserType
}

type UpdateUserOutput

type UpdateUserOutput struct {

	// The user information.
	User *types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

api_client.go api_op_AbortDocumentVersionUpload.go api_op_ActivateUser.go api_op_AddResourcePermissions.go api_op_CreateComment.go api_op_CreateCustomMetadata.go api_op_CreateFolder.go api_op_CreateLabels.go api_op_CreateNotificationSubscription.go api_op_CreateUser.go api_op_DeactivateUser.go api_op_DeleteComment.go api_op_DeleteCustomMetadata.go api_op_DeleteDocument.go api_op_DeleteFolder.go api_op_DeleteFolderContents.go api_op_DeleteLabels.go api_op_DeleteNotificationSubscription.go api_op_DeleteUser.go api_op_DescribeActivities.go api_op_DescribeComments.go api_op_DescribeDocumentVersions.go api_op_DescribeFolderContents.go api_op_DescribeGroups.go api_op_DescribeNotificationSubscriptions.go api_op_DescribeResourcePermissions.go api_op_DescribeRootFolders.go api_op_DescribeUsers.go api_op_GetCurrentUser.go api_op_GetDocument.go api_op_GetDocumentPath.go api_op_GetDocumentVersion.go api_op_GetFolder.go api_op_GetFolderPath.go api_op_GetResources.go api_op_InitiateDocumentVersionUpload.go api_op_RemoveAllResourcePermissions.go api_op_RemoveResourcePermission.go api_op_UpdateDocument.go api_op_UpdateDocumentVersion.go api_op_UpdateFolder.go api_op_UpdateUser.go deserializers.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.26.0
Published
Oct 1, 2020
Platform
darwin/amd64
Imports
26 packages
Last checked
now

Tools for package owners.