import { type HostHeaderInputConfig, type HostHeaderResolvedConfig, type UserAgentInputConfig, type UserAgentResolvedConfig } from "@aws-sdk/core/client"; import { type DefaultsMode as __DefaultsMode, type SmithyConfiguration as __SmithyConfiguration, type SmithyResolvedConfiguration as __SmithyResolvedConfiguration, Client as __Client } from "@smithy/core/client"; import { type RegionInputConfig, type RegionResolvedConfig } from "@smithy/core/config"; import { type EndpointInputConfig, type EndpointResolvedConfig } from "@smithy/core/endpoints"; import { type HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/core/protocols"; import { type RetryInputConfig, type RetryResolvedConfig } from "@smithy/core/retry"; import type { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types"; import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider"; import type { AbortDocumentVersionUploadCommandInput, AbortDocumentVersionUploadCommandOutput } from "./commands/AbortDocumentVersionUploadCommand"; import type { ActivateUserCommandInput, ActivateUserCommandOutput } from "./commands/ActivateUserCommand"; import type { AddResourcePermissionsCommandInput, AddResourcePermissionsCommandOutput } from "./commands/AddResourcePermissionsCommand"; import type { CreateCommentCommandInput, CreateCommentCommandOutput } from "./commands/CreateCommentCommand"; import type { CreateCustomMetadataCommandInput, CreateCustomMetadataCommandOutput } from "./commands/CreateCustomMetadataCommand"; import type { CreateFolderCommandInput, CreateFolderCommandOutput } from "./commands/CreateFolderCommand"; import type { CreateLabelsCommandInput, CreateLabelsCommandOutput } from "./commands/CreateLabelsCommand"; import type { CreateNotificationSubscriptionCommandInput, CreateNotificationSubscriptionCommandOutput } from "./commands/CreateNotificationSubscriptionCommand"; import type { CreateUserCommandInput, CreateUserCommandOutput } from "./commands/CreateUserCommand"; import type { DeactivateUserCommandInput, DeactivateUserCommandOutput } from "./commands/DeactivateUserCommand"; import type { DeleteCommentCommandInput, DeleteCommentCommandOutput } from "./commands/DeleteCommentCommand"; import type { DeleteCustomMetadataCommandInput, DeleteCustomMetadataCommandOutput } from "./commands/DeleteCustomMetadataCommand"; import type { DeleteDocumentCommandInput, DeleteDocumentCommandOutput } from "./commands/DeleteDocumentCommand"; import type { DeleteDocumentVersionCommandInput, DeleteDocumentVersionCommandOutput } from "./commands/DeleteDocumentVersionCommand"; import type { DeleteFolderCommandInput, DeleteFolderCommandOutput } from "./commands/DeleteFolderCommand"; import type { DeleteFolderContentsCommandInput, DeleteFolderContentsCommandOutput } from "./commands/DeleteFolderContentsCommand"; import type { DeleteLabelsCommandInput, DeleteLabelsCommandOutput } from "./commands/DeleteLabelsCommand"; import type { DeleteNotificationSubscriptionCommandInput, DeleteNotificationSubscriptionCommandOutput } from "./commands/DeleteNotificationSubscriptionCommand"; import type { DeleteUserCommandInput, DeleteUserCommandOutput } from "./commands/DeleteUserCommand"; import type { DescribeActivitiesCommandInput, DescribeActivitiesCommandOutput } from "./commands/DescribeActivitiesCommand"; import type { DescribeCommentsCommandInput, DescribeCommentsCommandOutput } from "./commands/DescribeCommentsCommand"; import type { DescribeDocumentVersionsCommandInput, DescribeDocumentVersionsCommandOutput } from "./commands/DescribeDocumentVersionsCommand"; import type { DescribeFolderContentsCommandInput, DescribeFolderContentsCommandOutput } from "./commands/DescribeFolderContentsCommand"; import type { DescribeGroupsCommandInput, DescribeGroupsCommandOutput } from "./commands/DescribeGroupsCommand"; import type { DescribeNotificationSubscriptionsCommandInput, DescribeNotificationSubscriptionsCommandOutput } from "./commands/DescribeNotificationSubscriptionsCommand"; import type { DescribeResourcePermissionsCommandInput, DescribeResourcePermissionsCommandOutput } from "./commands/DescribeResourcePermissionsCommand"; import type { DescribeRootFoldersCommandInput, DescribeRootFoldersCommandOutput } from "./commands/DescribeRootFoldersCommand"; import type { DescribeUsersCommandInput, DescribeUsersCommandOutput } from "./commands/DescribeUsersCommand"; import type { GetCurrentUserCommandInput, GetCurrentUserCommandOutput } from "./commands/GetCurrentUserCommand"; import type { GetDocumentCommandInput, GetDocumentCommandOutput } from "./commands/GetDocumentCommand"; import type { GetDocumentPathCommandInput, GetDocumentPathCommandOutput } from "./commands/GetDocumentPathCommand"; import type { GetDocumentVersionCommandInput, GetDocumentVersionCommandOutput } from "./commands/GetDocumentVersionCommand"; import type { GetFolderCommandInput, GetFolderCommandOutput } from "./commands/GetFolderCommand"; import type { GetFolderPathCommandInput, GetFolderPathCommandOutput } from "./commands/GetFolderPathCommand"; import type { GetResourcesCommandInput, GetResourcesCommandOutput } from "./commands/GetResourcesCommand"; import type { InitiateDocumentVersionUploadCommandInput, InitiateDocumentVersionUploadCommandOutput } from "./commands/InitiateDocumentVersionUploadCommand"; import type { RemoveAllResourcePermissionsCommandInput, RemoveAllResourcePermissionsCommandOutput } from "./commands/RemoveAllResourcePermissionsCommand"; import type { RemoveResourcePermissionCommandInput, RemoveResourcePermissionCommandOutput } from "./commands/RemoveResourcePermissionCommand"; import type { RestoreDocumentVersionsCommandInput, RestoreDocumentVersionsCommandOutput } from "./commands/RestoreDocumentVersionsCommand"; import type { SearchResourcesCommandInput, SearchResourcesCommandOutput } from "./commands/SearchResourcesCommand"; import type { UpdateDocumentCommandInput, UpdateDocumentCommandOutput } from "./commands/UpdateDocumentCommand"; import type { UpdateDocumentVersionCommandInput, UpdateDocumentVersionCommandOutput } from "./commands/UpdateDocumentVersionCommand"; import type { UpdateFolderCommandInput, UpdateFolderCommandOutput } from "./commands/UpdateFolderCommand"; import type { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; import { type ClientInputEndpointParameters, type ClientResolvedEndpointParameters, type EndpointParameters } from "./endpoint/EndpointParameters"; import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions"; export { __Client }; /** * @public */ export type ServiceInputTypes = AbortDocumentVersionUploadCommandInput | ActivateUserCommandInput | AddResourcePermissionsCommandInput | CreateCommentCommandInput | CreateCustomMetadataCommandInput | CreateFolderCommandInput | CreateLabelsCommandInput | CreateNotificationSubscriptionCommandInput | CreateUserCommandInput | DeactivateUserCommandInput | DeleteCommentCommandInput | DeleteCustomMetadataCommandInput | DeleteDocumentCommandInput | DeleteDocumentVersionCommandInput | DeleteFolderCommandInput | DeleteFolderContentsCommandInput | DeleteLabelsCommandInput | DeleteNotificationSubscriptionCommandInput | DeleteUserCommandInput | DescribeActivitiesCommandInput | DescribeCommentsCommandInput | DescribeDocumentVersionsCommandInput | DescribeFolderContentsCommandInput | DescribeGroupsCommandInput | DescribeNotificationSubscriptionsCommandInput | DescribeResourcePermissionsCommandInput | DescribeRootFoldersCommandInput | DescribeUsersCommandInput | GetCurrentUserCommandInput | GetDocumentCommandInput | GetDocumentPathCommandInput | GetDocumentVersionCommandInput | GetFolderCommandInput | GetFolderPathCommandInput | GetResourcesCommandInput | InitiateDocumentVersionUploadCommandInput | RemoveAllResourcePermissionsCommandInput | RemoveResourcePermissionCommandInput | RestoreDocumentVersionsCommandInput | SearchResourcesCommandInput | UpdateDocumentCommandInput | UpdateDocumentVersionCommandInput | UpdateFolderCommandInput | UpdateUserCommandInput; /** * @public */ export type ServiceOutputTypes = AbortDocumentVersionUploadCommandOutput | ActivateUserCommandOutput | AddResourcePermissionsCommandOutput | CreateCommentCommandOutput | CreateCustomMetadataCommandOutput | CreateFolderCommandOutput | CreateLabelsCommandOutput | CreateNotificationSubscriptionCommandOutput | CreateUserCommandOutput | DeactivateUserCommandOutput | DeleteCommentCommandOutput | DeleteCustomMetadataCommandOutput | DeleteDocumentCommandOutput | DeleteDocumentVersionCommandOutput | DeleteFolderCommandOutput | DeleteFolderContentsCommandOutput | DeleteLabelsCommandOutput | DeleteNotificationSubscriptionCommandOutput | DeleteUserCommandOutput | DescribeActivitiesCommandOutput | DescribeCommentsCommandOutput | DescribeDocumentVersionsCommandOutput | DescribeFolderContentsCommandOutput | DescribeGroupsCommandOutput | DescribeNotificationSubscriptionsCommandOutput | DescribeResourcePermissionsCommandOutput | DescribeRootFoldersCommandOutput | DescribeUsersCommandOutput | GetCurrentUserCommandOutput | GetDocumentCommandOutput | GetDocumentPathCommandOutput | GetDocumentVersionCommandOutput | GetFolderCommandOutput | GetFolderPathCommandOutput | GetResourcesCommandOutput | InitiateDocumentVersionUploadCommandOutput | RemoveAllResourcePermissionsCommandOutput | RemoveResourcePermissionCommandOutput | RestoreDocumentVersionsCommandOutput | SearchResourcesCommandOutput | UpdateDocumentCommandOutput | UpdateDocumentVersionCommandOutput | UpdateFolderCommandOutput | UpdateUserCommandOutput; /** * @public */ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> { /** * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. */ requestHandler?: __HttpHandlerUserInput; /** * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface * that computes the SHA-256 HMAC or checksum of a string or binary buffer. * @internal */ sha256?: __ChecksumConstructor | __HashConstructor; /** * The function that will be used to convert strings into HTTP endpoints. * @internal */ urlParser?: __UrlParser; /** * A function that can calculate the length of a request body. * @internal */ bodyLengthChecker?: __BodyLengthCalculator; /** * A function that converts a stream into an array of bytes. * @internal */ streamCollector?: __StreamCollector; /** * The function that will be used to convert a base64-encoded string to a byte array. * @internal */ base64Decoder?: __Decoder; /** * The function that will be used to convert binary data to a base64-encoded string. * @internal */ base64Encoder?: __Encoder; /** * The function that will be used to convert a UTF8-encoded string to a byte array. * @internal */ utf8Decoder?: __Decoder; /** * The function that will be used to convert binary data to a UTF-8 encoded string. * @internal */ utf8Encoder?: __Encoder; /** * The runtime environment. * @internal */ runtime?: string; /** * Disable dynamically changing the endpoint of the client based on the hostPrefix * trait of an operation. */ disableHostPrefix?: boolean; /** * Unique service identifier. * @internal */ serviceId?: string; /** * Enables IPv6/IPv4 dualstack endpoint. */ useDualstackEndpoint?: boolean | __Provider; /** * Enables FIPS compatible endpoints. */ useFipsEndpoint?: boolean | __Provider; /** * The AWS region to which this client will send requests */ region?: string | __Provider; /** * Setting a client profile is similar to setting a value for the * AWS_PROFILE environment variable. Setting a profile on a client * in code only affects the single client instance, unlike AWS_PROFILE. * * When set, and only for environments where an AWS configuration * file exists, fields configurable by this file will be retrieved * from the specified profile within that file. * Conflicting code configuration and environment variables will * still have higher priority. * * For client credential resolution that involves checking the AWS * configuration file, the client's profile (this value) will be * used unless a different profile is set in the credential * provider options. * */ profile?: string; /** * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header * @internal */ defaultUserAgentProvider?: __Provider<__UserAgent>; /** * Default credentials provider; Not available in browser runtime. * @deprecated * @internal */ credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider; /** * Value for how many times a request will be made at most in case of retry. */ maxAttempts?: number | __Provider; /** * Specifies which retry algorithm to use. * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/ * */ retryMode?: string | __Provider; /** * Optional logger for logging debug/info/warn/error. */ logger?: __Logger; /** * Optional extensions */ extensions?: RuntimeExtension[]; /** * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK. */ defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>; } /** * @public */ export type WorkDocsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & UserAgentInputConfig & RetryInputConfig & RegionInputConfig & HostHeaderInputConfig & EndpointInputConfig & HttpAuthSchemeInputConfig & ClientInputEndpointParameters; /** * @public * * The configuration interface of WorkDocsClient class constructor that set the region, credentials and other options. */ export interface WorkDocsClientConfig extends WorkDocsClientConfigType { } /** * @public */ export type WorkDocsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required & RuntimeExtensionsConfig & UserAgentResolvedConfig & RetryResolvedConfig & RegionResolvedConfig & HostHeaderResolvedConfig & EndpointResolvedConfig & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters; /** * @public * * The resolved configuration interface of WorkDocsClient class. This is resolved and normalized from the {@link WorkDocsClientConfig | constructor configuration interface}. */ export interface WorkDocsClientResolvedConfig extends WorkDocsClientResolvedConfigType { } /** *

The Amazon 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 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 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 Amazon Web Services 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.

* *

The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:

*
    *
  • *

    * READ (Get*) *

    *
    • *
  • *

    * WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*) *

    *
    • *
  • *

    * LIST (Describe*) *

    *
    • *
  • *

    * DELETE*, CANCEL *

    *
    • *
*

For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.

* * @public */ export declare class WorkDocsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig> { /** * The resolved configuration of WorkDocsClient class. This is resolved and normalized from the {@link WorkDocsClientConfig | constructor configuration interface}. */ readonly config: WorkDocsClientResolvedConfig; constructor(...[configuration]: __CheckOptionalClientConfig); /** * Destroy underlying resources, like sockets. It's usually not necessary to do this. * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. * Otherwise, sockets might stay open for quite a long time before the server terminates them. */ destroy(): void; }