@aws-sdk/client-workdocs 3.294.0 → 3.295.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist-cjs/WorkDocs.js +15 -0
- package/dist-cjs/commands/AbortDocumentVersionUploadCommand.js +4 -4
- package/dist-cjs/commands/ActivateUserCommand.js +4 -4
- package/dist-cjs/commands/AddResourcePermissionsCommand.js +4 -4
- package/dist-cjs/commands/CreateCommentCommand.js +4 -4
- package/dist-cjs/commands/CreateCustomMetadataCommand.js +4 -4
- package/dist-cjs/commands/CreateFolderCommand.js +4 -4
- package/dist-cjs/commands/CreateLabelsCommand.js +4 -4
- package/dist-cjs/commands/CreateNotificationSubscriptionCommand.js +4 -4
- package/dist-cjs/commands/CreateUserCommand.js +4 -4
- package/dist-cjs/commands/DeactivateUserCommand.js +4 -4
- package/dist-cjs/commands/DeleteCommentCommand.js +4 -4
- package/dist-cjs/commands/DeleteCustomMetadataCommand.js +4 -4
- package/dist-cjs/commands/DeleteDocumentCommand.js +4 -4
- package/dist-cjs/commands/DeleteDocumentVersionCommand.js +4 -4
- package/dist-cjs/commands/DeleteFolderCommand.js +4 -4
- package/dist-cjs/commands/DeleteFolderContentsCommand.js +4 -4
- package/dist-cjs/commands/DeleteLabelsCommand.js +4 -4
- package/dist-cjs/commands/DeleteNotificationSubscriptionCommand.js +4 -4
- package/dist-cjs/commands/DeleteUserCommand.js +4 -4
- package/dist-cjs/commands/DescribeActivitiesCommand.js +4 -4
- package/dist-cjs/commands/DescribeCommentsCommand.js +4 -4
- package/dist-cjs/commands/DescribeDocumentVersionsCommand.js +4 -4
- package/dist-cjs/commands/DescribeFolderContentsCommand.js +4 -4
- package/dist-cjs/commands/DescribeGroupsCommand.js +4 -4
- package/dist-cjs/commands/DescribeNotificationSubscriptionsCommand.js +4 -4
- package/dist-cjs/commands/DescribeResourcePermissionsCommand.js +4 -4
- package/dist-cjs/commands/DescribeRootFoldersCommand.js +4 -4
- package/dist-cjs/commands/DescribeUsersCommand.js +4 -4
- package/dist-cjs/commands/GetCurrentUserCommand.js +4 -4
- package/dist-cjs/commands/GetDocumentCommand.js +4 -4
- package/dist-cjs/commands/GetDocumentPathCommand.js +4 -4
- package/dist-cjs/commands/GetDocumentVersionCommand.js +4 -4
- package/dist-cjs/commands/GetFolderCommand.js +4 -4
- package/dist-cjs/commands/GetFolderPathCommand.js +4 -4
- package/dist-cjs/commands/GetResourcesCommand.js +4 -4
- package/dist-cjs/commands/InitiateDocumentVersionUploadCommand.js +4 -4
- package/dist-cjs/commands/RemoveAllResourcePermissionsCommand.js +4 -4
- package/dist-cjs/commands/RemoveResourcePermissionCommand.js +4 -4
- package/dist-cjs/commands/RestoreDocumentVersionsCommand.js +4 -4
- package/dist-cjs/commands/SearchResourcesCommand.js +46 -0
- package/dist-cjs/commands/UpdateDocumentCommand.js +4 -4
- package/dist-cjs/commands/UpdateDocumentVersionCommand.js +4 -4
- package/dist-cjs/commands/UpdateFolderCommand.js +4 -4
- package/dist-cjs/commands/UpdateUserCommand.js +4 -4
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +168 -3
- package/dist-cjs/pagination/DescribeActivitiesPaginator.js +29 -0
- package/dist-cjs/pagination/DescribeCommentsPaginator.js +29 -0
- package/dist-cjs/pagination/DescribeGroupsPaginator.js +29 -0
- package/dist-cjs/pagination/DescribeNotificationSubscriptionsPaginator.js +29 -0
- package/dist-cjs/pagination/DescribeResourcePermissionsPaginator.js +29 -0
- package/dist-cjs/pagination/DescribeRootFoldersPaginator.js +29 -0
- package/dist-cjs/pagination/SearchResourcesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +7 -0
- package/dist-cjs/protocols/Aws_restJson1.js +245 -2
- package/dist-es/WorkDocs.js +15 -0
- package/dist-es/commands/AbortDocumentVersionUploadCommand.js +4 -4
- package/dist-es/commands/ActivateUserCommand.js +4 -4
- package/dist-es/commands/AddResourcePermissionsCommand.js +4 -4
- package/dist-es/commands/CreateCommentCommand.js +4 -4
- package/dist-es/commands/CreateCustomMetadataCommand.js +4 -4
- package/dist-es/commands/CreateFolderCommand.js +4 -4
- package/dist-es/commands/CreateLabelsCommand.js +4 -4
- package/dist-es/commands/CreateNotificationSubscriptionCommand.js +4 -4
- package/dist-es/commands/CreateUserCommand.js +4 -4
- package/dist-es/commands/DeactivateUserCommand.js +4 -4
- package/dist-es/commands/DeleteCommentCommand.js +4 -4
- package/dist-es/commands/DeleteCustomMetadataCommand.js +4 -4
- package/dist-es/commands/DeleteDocumentCommand.js +4 -4
- package/dist-es/commands/DeleteDocumentVersionCommand.js +4 -4
- package/dist-es/commands/DeleteFolderCommand.js +4 -4
- package/dist-es/commands/DeleteFolderContentsCommand.js +4 -4
- package/dist-es/commands/DeleteLabelsCommand.js +4 -4
- package/dist-es/commands/DeleteNotificationSubscriptionCommand.js +4 -4
- package/dist-es/commands/DeleteUserCommand.js +4 -4
- package/dist-es/commands/DescribeActivitiesCommand.js +4 -4
- package/dist-es/commands/DescribeCommentsCommand.js +4 -4
- package/dist-es/commands/DescribeDocumentVersionsCommand.js +4 -4
- package/dist-es/commands/DescribeFolderContentsCommand.js +4 -4
- package/dist-es/commands/DescribeGroupsCommand.js +4 -4
- package/dist-es/commands/DescribeNotificationSubscriptionsCommand.js +4 -4
- package/dist-es/commands/DescribeResourcePermissionsCommand.js +4 -4
- package/dist-es/commands/DescribeRootFoldersCommand.js +4 -4
- package/dist-es/commands/DescribeUsersCommand.js +4 -4
- package/dist-es/commands/GetCurrentUserCommand.js +4 -4
- package/dist-es/commands/GetDocumentCommand.js +4 -4
- package/dist-es/commands/GetDocumentPathCommand.js +4 -4
- package/dist-es/commands/GetDocumentVersionCommand.js +4 -4
- package/dist-es/commands/GetFolderCommand.js +4 -4
- package/dist-es/commands/GetFolderPathCommand.js +4 -4
- package/dist-es/commands/GetResourcesCommand.js +4 -4
- package/dist-es/commands/InitiateDocumentVersionUploadCommand.js +4 -4
- package/dist-es/commands/RemoveAllResourcePermissionsCommand.js +4 -4
- package/dist-es/commands/RemoveResourcePermissionCommand.js +4 -4
- package/dist-es/commands/RestoreDocumentVersionsCommand.js +4 -4
- package/dist-es/commands/SearchResourcesCommand.js +42 -0
- package/dist-es/commands/UpdateDocumentCommand.js +4 -4
- package/dist-es/commands/UpdateDocumentVersionCommand.js +4 -4
- package/dist-es/commands/UpdateFolderCommand.js +4 -4
- package/dist-es/commands/UpdateUserCommand.js +4 -4
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +156 -0
- package/dist-es/pagination/DescribeActivitiesPaginator.js +25 -0
- package/dist-es/pagination/DescribeCommentsPaginator.js +25 -0
- package/dist-es/pagination/DescribeGroupsPaginator.js +25 -0
- package/dist-es/pagination/DescribeNotificationSubscriptionsPaginator.js +25 -0
- package/dist-es/pagination/DescribeResourcePermissionsPaginator.js +25 -0
- package/dist-es/pagination/DescribeRootFoldersPaginator.js +25 -0
- package/dist-es/pagination/SearchResourcesPaginator.js +25 -0
- package/dist-es/pagination/index.js +7 -0
- package/dist-es/protocols/Aws_restJson1.js +241 -0
- package/dist-types/WorkDocs.d.ts +7 -0
- package/dist-types/WorkDocsClient.d.ts +5 -4
- package/dist-types/commands/InitiateDocumentVersionUploadCommand.d.ts +3 -0
- package/dist-types/commands/SearchResourcesCommand.d.ts +56 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +295 -0
- package/dist-types/pagination/DescribeActivitiesPaginator.d.ts +4 -0
- package/dist-types/pagination/DescribeCommentsPaginator.d.ts +4 -0
- package/dist-types/pagination/DescribeGroupsPaginator.d.ts +4 -0
- package/dist-types/pagination/DescribeNotificationSubscriptionsPaginator.d.ts +4 -0
- package/dist-types/pagination/DescribeResourcePermissionsPaginator.d.ts +4 -0
- package/dist-types/pagination/DescribeRootFoldersPaginator.d.ts +4 -0
- package/dist-types/pagination/SearchResourcesPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +7 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/WorkDocs.d.ts +17 -0
- package/dist-types/ts3.4/WorkDocsClient.d.ts +10 -4
- package/dist-types/ts3.4/commands/SearchResourcesCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +4 -5
- package/dist-types/ts3.4/models/models_0.d.ts +156 -0
- package/dist-types/ts3.4/pagination/DescribeActivitiesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/DescribeCommentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/DescribeGroupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/DescribeNotificationSubscriptionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/DescribeResourcePermissionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/DescribeRootFoldersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchResourcesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +7 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +36 -36
|
@@ -270,6 +270,10 @@ export interface CommentMetadata {
|
|
|
270
270
|
* <p>The ID of the user being replied to.</p>
|
|
271
271
|
*/
|
|
272
272
|
RecipientId?: string;
|
|
273
|
+
/**
|
|
274
|
+
* <p>The ID of the user who made the comment.</p>
|
|
275
|
+
*/
|
|
276
|
+
ContributorId?: string;
|
|
273
277
|
}
|
|
274
278
|
/**
|
|
275
279
|
* <p>Describes the metadata of the user.</p>
|
|
@@ -443,6 +447,9 @@ export interface Activity {
|
|
|
443
447
|
*/
|
|
444
448
|
CommentMetadata?: CommentMetadata;
|
|
445
449
|
}
|
|
450
|
+
export declare enum AdditionalResponseFieldType {
|
|
451
|
+
WEBURL = "WEBURL"
|
|
452
|
+
}
|
|
446
453
|
/**
|
|
447
454
|
* <p>Set of options which defines notification preferences of given action.</p>
|
|
448
455
|
*/
|
|
@@ -2038,6 +2045,262 @@ export interface RestoreDocumentVersionsRequest {
|
|
|
2038
2045
|
*/
|
|
2039
2046
|
DocumentId: string | undefined;
|
|
2040
2047
|
}
|
|
2048
|
+
export declare enum ContentCategoryType {
|
|
2049
|
+
AUDIO = "AUDIO",
|
|
2050
|
+
DOCUMENT = "DOCUMENT",
|
|
2051
|
+
IMAGE = "IMAGE",
|
|
2052
|
+
OTHER = "OTHER",
|
|
2053
|
+
PDF = "PDF",
|
|
2054
|
+
PRESENTATION = "PRESENTATION",
|
|
2055
|
+
SOURCE_CODE = "SOURCE_CODE",
|
|
2056
|
+
SPREADSHEET = "SPREADSHEET",
|
|
2057
|
+
VIDEO = "VIDEO"
|
|
2058
|
+
}
|
|
2059
|
+
/**
|
|
2060
|
+
* <p>Filters results based on timestamp range (in epochs).</p>
|
|
2061
|
+
*/
|
|
2062
|
+
export interface DateRangeType {
|
|
2063
|
+
/**
|
|
2064
|
+
* <p>Timestamp range start value (in epochs)</p>
|
|
2065
|
+
*/
|
|
2066
|
+
StartValue?: Date;
|
|
2067
|
+
/**
|
|
2068
|
+
* <p>Timestamp range end value (in epochs).</p>
|
|
2069
|
+
*/
|
|
2070
|
+
EndValue?: Date;
|
|
2071
|
+
}
|
|
2072
|
+
export declare enum PrincipalRoleType {
|
|
2073
|
+
CONTRIBUTOR = "CONTRIBUTOR",
|
|
2074
|
+
COOWNER = "COOWNER",
|
|
2075
|
+
OWNER = "OWNER",
|
|
2076
|
+
VIEWER = "VIEWER"
|
|
2077
|
+
}
|
|
2078
|
+
/**
|
|
2079
|
+
* <p>Filter based on UserIds or GroupIds.</p>
|
|
2080
|
+
*/
|
|
2081
|
+
export interface SearchPrincipalType {
|
|
2082
|
+
/**
|
|
2083
|
+
* <p>UserIds or GroupIds.</p>
|
|
2084
|
+
*/
|
|
2085
|
+
Id: string | undefined;
|
|
2086
|
+
/**
|
|
2087
|
+
* <p>The Role of a User or Group.</p>
|
|
2088
|
+
*/
|
|
2089
|
+
Roles?: (PrincipalRoleType | string)[];
|
|
2090
|
+
}
|
|
2091
|
+
export declare enum SearchResourceType {
|
|
2092
|
+
COMMENT = "COMMENT",
|
|
2093
|
+
DOCUMENT = "DOCUMENT",
|
|
2094
|
+
DOCUMENT_VERSION = "DOCUMENT_VERSION",
|
|
2095
|
+
FOLDER = "FOLDER"
|
|
2096
|
+
}
|
|
2097
|
+
export declare enum SearchCollectionType {
|
|
2098
|
+
OWNED = "OWNED",
|
|
2099
|
+
SHARED_WITH_ME = "SHARED_WITH_ME"
|
|
2100
|
+
}
|
|
2101
|
+
/**
|
|
2102
|
+
* <p>Filter based on size (in bytes).</p>
|
|
2103
|
+
*/
|
|
2104
|
+
export interface LongRangeType {
|
|
2105
|
+
/**
|
|
2106
|
+
* <p>The size start range (in bytes).</p>
|
|
2107
|
+
*/
|
|
2108
|
+
StartValue?: number;
|
|
2109
|
+
/**
|
|
2110
|
+
* <p>The size end range (in bytes).</p>
|
|
2111
|
+
*/
|
|
2112
|
+
EndValue?: number;
|
|
2113
|
+
}
|
|
2114
|
+
export declare enum LanguageCodeType {
|
|
2115
|
+
AR = "AR",
|
|
2116
|
+
BG = "BG",
|
|
2117
|
+
BN = "BN",
|
|
2118
|
+
CS = "CS",
|
|
2119
|
+
DA = "DA",
|
|
2120
|
+
DE = "DE",
|
|
2121
|
+
DEFAULT = "DEFAULT",
|
|
2122
|
+
EL = "EL",
|
|
2123
|
+
EN = "EN",
|
|
2124
|
+
ES = "ES",
|
|
2125
|
+
FA = "FA",
|
|
2126
|
+
FI = "FI",
|
|
2127
|
+
FR = "FR",
|
|
2128
|
+
HI = "HI",
|
|
2129
|
+
HU = "HU",
|
|
2130
|
+
ID = "ID",
|
|
2131
|
+
IT = "IT",
|
|
2132
|
+
JA = "JA",
|
|
2133
|
+
KO = "KO",
|
|
2134
|
+
LT = "LT",
|
|
2135
|
+
LV = "LV",
|
|
2136
|
+
NL = "NL",
|
|
2137
|
+
NO = "NO",
|
|
2138
|
+
PT = "PT",
|
|
2139
|
+
RO = "RO",
|
|
2140
|
+
RU = "RU",
|
|
2141
|
+
SV = "SV",
|
|
2142
|
+
SW = "SW",
|
|
2143
|
+
TH = "TH",
|
|
2144
|
+
TR = "TR",
|
|
2145
|
+
ZH = "ZH"
|
|
2146
|
+
}
|
|
2147
|
+
/**
|
|
2148
|
+
* <p>Filters results based on entity metadata.</p>
|
|
2149
|
+
*/
|
|
2150
|
+
export interface Filters {
|
|
2151
|
+
/**
|
|
2152
|
+
* <p>Filters by the locale of the content or comment.</p>
|
|
2153
|
+
*/
|
|
2154
|
+
TextLocales?: (LanguageCodeType | string)[];
|
|
2155
|
+
/**
|
|
2156
|
+
* <p>Filters by content category.</p>
|
|
2157
|
+
*/
|
|
2158
|
+
ContentCategories?: (ContentCategoryType | string)[];
|
|
2159
|
+
/**
|
|
2160
|
+
* <p>Filters based on entity type.</p>
|
|
2161
|
+
*/
|
|
2162
|
+
ResourceTypes?: (SearchResourceType | string)[];
|
|
2163
|
+
/**
|
|
2164
|
+
* <p>Filter by labels using exact match.</p>
|
|
2165
|
+
*/
|
|
2166
|
+
Labels?: string[];
|
|
2167
|
+
/**
|
|
2168
|
+
* <p>Filter based on UserIds or GroupIds.</p>
|
|
2169
|
+
*/
|
|
2170
|
+
Principals?: SearchPrincipalType[];
|
|
2171
|
+
/**
|
|
2172
|
+
* <p>Filter based on resource’s path.</p>
|
|
2173
|
+
*/
|
|
2174
|
+
AncestorIds?: string[];
|
|
2175
|
+
/**
|
|
2176
|
+
* <p>Filter based on file groupings.</p>
|
|
2177
|
+
*/
|
|
2178
|
+
SearchCollectionTypes?: (SearchCollectionType | string)[];
|
|
2179
|
+
/**
|
|
2180
|
+
* <p>Filter based on size (in bytes).</p>
|
|
2181
|
+
*/
|
|
2182
|
+
SizeRange?: LongRangeType;
|
|
2183
|
+
/**
|
|
2184
|
+
* <p>Filter based on resource’s creation timestamp.</p>
|
|
2185
|
+
*/
|
|
2186
|
+
CreatedRange?: DateRangeType;
|
|
2187
|
+
/**
|
|
2188
|
+
* <p>Filter based on resource’s modified timestamp.</p>
|
|
2189
|
+
*/
|
|
2190
|
+
ModifiedRange?: DateRangeType;
|
|
2191
|
+
}
|
|
2192
|
+
export declare enum OrderByFieldType {
|
|
2193
|
+
CREATED_TIMESTAMP = "CREATED_TIMESTAMP",
|
|
2194
|
+
MODIFIED_TIMESTAMP = "MODIFIED_TIMESTAMP",
|
|
2195
|
+
NAME = "NAME",
|
|
2196
|
+
RELEVANCE = "RELEVANCE",
|
|
2197
|
+
SIZE = "SIZE"
|
|
2198
|
+
}
|
|
2199
|
+
export declare enum SortOrder {
|
|
2200
|
+
ASC = "ASC",
|
|
2201
|
+
DESC = "DESC"
|
|
2202
|
+
}
|
|
2203
|
+
/**
|
|
2204
|
+
* <p>The result of the sort operation.</p>
|
|
2205
|
+
*/
|
|
2206
|
+
export interface SearchSortResult {
|
|
2207
|
+
/**
|
|
2208
|
+
* <p>Sort search results based on this field name.</p>
|
|
2209
|
+
*/
|
|
2210
|
+
Field?: OrderByFieldType | string;
|
|
2211
|
+
/**
|
|
2212
|
+
* <p>Sort direction.</p>
|
|
2213
|
+
*/
|
|
2214
|
+
Order?: SortOrder | string;
|
|
2215
|
+
}
|
|
2216
|
+
export declare enum SearchQueryScopeType {
|
|
2217
|
+
CONTENT = "CONTENT",
|
|
2218
|
+
NAME = "NAME"
|
|
2219
|
+
}
|
|
2220
|
+
export interface SearchResourcesRequest {
|
|
2221
|
+
/**
|
|
2222
|
+
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2223
|
+
*/
|
|
2224
|
+
AuthenticationToken?: string;
|
|
2225
|
+
/**
|
|
2226
|
+
* <p>The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.</p>
|
|
2227
|
+
*/
|
|
2228
|
+
QueryText?: string;
|
|
2229
|
+
/**
|
|
2230
|
+
* <p>Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content</p>
|
|
2231
|
+
*/
|
|
2232
|
+
QueryScopes?: (SearchQueryScopeType | string)[];
|
|
2233
|
+
/**
|
|
2234
|
+
* <p>Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.</p>
|
|
2235
|
+
*/
|
|
2236
|
+
OrganizationId?: string;
|
|
2237
|
+
/**
|
|
2238
|
+
* <p>A list of attributes to include in the response. Used to request fields that are not normally
|
|
2239
|
+
* returned in a standard response.</p>
|
|
2240
|
+
*/
|
|
2241
|
+
AdditionalResponseFields?: (AdditionalResponseFieldType | string)[];
|
|
2242
|
+
/**
|
|
2243
|
+
* <p>Filters results based on entity metadata.</p>
|
|
2244
|
+
*/
|
|
2245
|
+
Filters?: Filters;
|
|
2246
|
+
/**
|
|
2247
|
+
* <p>Order by results in one or more categories.</p>
|
|
2248
|
+
*/
|
|
2249
|
+
OrderBy?: SearchSortResult[];
|
|
2250
|
+
/**
|
|
2251
|
+
* <p>Max results count per page.</p>
|
|
2252
|
+
*/
|
|
2253
|
+
Limit?: number;
|
|
2254
|
+
/**
|
|
2255
|
+
* <p>The marker for the next set of results.</p>
|
|
2256
|
+
*/
|
|
2257
|
+
Marker?: string;
|
|
2258
|
+
}
|
|
2259
|
+
export declare enum ResponseItemType {
|
|
2260
|
+
COMMENT = "COMMENT",
|
|
2261
|
+
DOCUMENT = "DOCUMENT",
|
|
2262
|
+
DOCUMENT_VERSION = "DOCUMENT_VERSION",
|
|
2263
|
+
FOLDER = "FOLDER"
|
|
2264
|
+
}
|
|
2265
|
+
/**
|
|
2266
|
+
* <p>List of Documents, Folders, Comments, and Document Versions matching the query.</p>
|
|
2267
|
+
*/
|
|
2268
|
+
export interface ResponseItem {
|
|
2269
|
+
/**
|
|
2270
|
+
* <p>The type of item being returned.</p>
|
|
2271
|
+
*/
|
|
2272
|
+
ResourceType?: ResponseItemType | string;
|
|
2273
|
+
/**
|
|
2274
|
+
* <p>The webUrl of the item being returned.</p>
|
|
2275
|
+
*/
|
|
2276
|
+
WebUrl?: string;
|
|
2277
|
+
/**
|
|
2278
|
+
* <p>The document that matches the query.</p>
|
|
2279
|
+
*/
|
|
2280
|
+
DocumentMetadata?: DocumentMetadata;
|
|
2281
|
+
/**
|
|
2282
|
+
* <p>The folder that matches the query.</p>
|
|
2283
|
+
*/
|
|
2284
|
+
FolderMetadata?: FolderMetadata;
|
|
2285
|
+
/**
|
|
2286
|
+
* <p>The comment that matches the query.</p>
|
|
2287
|
+
*/
|
|
2288
|
+
CommentMetadata?: CommentMetadata;
|
|
2289
|
+
/**
|
|
2290
|
+
* <p>The document version that matches the metadata.</p>
|
|
2291
|
+
*/
|
|
2292
|
+
DocumentVersionMetadata?: DocumentVersionMetadata;
|
|
2293
|
+
}
|
|
2294
|
+
export interface SearchResourcesResponse {
|
|
2295
|
+
/**
|
|
2296
|
+
* <p>List of Documents, Folders, Comments, and Document Versions matching the query.</p>
|
|
2297
|
+
*/
|
|
2298
|
+
Items?: ResponseItem[];
|
|
2299
|
+
/**
|
|
2300
|
+
* <p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>
|
|
2301
|
+
*/
|
|
2302
|
+
Marker?: string;
|
|
2303
|
+
}
|
|
2041
2304
|
export interface UpdateDocumentRequest {
|
|
2042
2305
|
/**
|
|
2043
2306
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
@@ -2530,6 +2793,38 @@ export declare const RemoveResourcePermissionRequestFilterSensitiveLog: (obj: Re
|
|
|
2530
2793
|
* @internal
|
|
2531
2794
|
*/
|
|
2532
2795
|
export declare const RestoreDocumentVersionsRequestFilterSensitiveLog: (obj: RestoreDocumentVersionsRequest) => any;
|
|
2796
|
+
/**
|
|
2797
|
+
* @internal
|
|
2798
|
+
*/
|
|
2799
|
+
export declare const DateRangeTypeFilterSensitiveLog: (obj: DateRangeType) => any;
|
|
2800
|
+
/**
|
|
2801
|
+
* @internal
|
|
2802
|
+
*/
|
|
2803
|
+
export declare const SearchPrincipalTypeFilterSensitiveLog: (obj: SearchPrincipalType) => any;
|
|
2804
|
+
/**
|
|
2805
|
+
* @internal
|
|
2806
|
+
*/
|
|
2807
|
+
export declare const LongRangeTypeFilterSensitiveLog: (obj: LongRangeType) => any;
|
|
2808
|
+
/**
|
|
2809
|
+
* @internal
|
|
2810
|
+
*/
|
|
2811
|
+
export declare const FiltersFilterSensitiveLog: (obj: Filters) => any;
|
|
2812
|
+
/**
|
|
2813
|
+
* @internal
|
|
2814
|
+
*/
|
|
2815
|
+
export declare const SearchSortResultFilterSensitiveLog: (obj: SearchSortResult) => any;
|
|
2816
|
+
/**
|
|
2817
|
+
* @internal
|
|
2818
|
+
*/
|
|
2819
|
+
export declare const SearchResourcesRequestFilterSensitiveLog: (obj: SearchResourcesRequest) => any;
|
|
2820
|
+
/**
|
|
2821
|
+
* @internal
|
|
2822
|
+
*/
|
|
2823
|
+
export declare const ResponseItemFilterSensitiveLog: (obj: ResponseItem) => any;
|
|
2824
|
+
/**
|
|
2825
|
+
* @internal
|
|
2826
|
+
*/
|
|
2827
|
+
export declare const SearchResourcesResponseFilterSensitiveLog: (obj: SearchResourcesResponse) => any;
|
|
2533
2828
|
/**
|
|
2534
2829
|
* @internal
|
|
2535
2830
|
*/
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { DescribeActivitiesCommandInput, DescribeActivitiesCommandOutput } from "../commands/DescribeActivitiesCommand";
|
|
3
|
+
import { WorkDocsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateDescribeActivities(config: WorkDocsPaginationConfiguration, input: DescribeActivitiesCommandInput, ...additionalArguments: any): Paginator<DescribeActivitiesCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { DescribeCommentsCommandInput, DescribeCommentsCommandOutput } from "../commands/DescribeCommentsCommand";
|
|
3
|
+
import { WorkDocsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateDescribeComments(config: WorkDocsPaginationConfiguration, input: DescribeCommentsCommandInput, ...additionalArguments: any): Paginator<DescribeCommentsCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { DescribeGroupsCommandInput, DescribeGroupsCommandOutput } from "../commands/DescribeGroupsCommand";
|
|
3
|
+
import { WorkDocsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateDescribeGroups(config: WorkDocsPaginationConfiguration, input: DescribeGroupsCommandInput, ...additionalArguments: any): Paginator<DescribeGroupsCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { DescribeNotificationSubscriptionsCommandInput, DescribeNotificationSubscriptionsCommandOutput } from "../commands/DescribeNotificationSubscriptionsCommand";
|
|
3
|
+
import { WorkDocsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateDescribeNotificationSubscriptions(config: WorkDocsPaginationConfiguration, input: DescribeNotificationSubscriptionsCommandInput, ...additionalArguments: any): Paginator<DescribeNotificationSubscriptionsCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { DescribeResourcePermissionsCommandInput, DescribeResourcePermissionsCommandOutput } from "../commands/DescribeResourcePermissionsCommand";
|
|
3
|
+
import { WorkDocsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateDescribeResourcePermissions(config: WorkDocsPaginationConfiguration, input: DescribeResourcePermissionsCommandInput, ...additionalArguments: any): Paginator<DescribeResourcePermissionsCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { DescribeRootFoldersCommandInput, DescribeRootFoldersCommandOutput } from "../commands/DescribeRootFoldersCommand";
|
|
3
|
+
import { WorkDocsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateDescribeRootFolders(config: WorkDocsPaginationConfiguration, input: DescribeRootFoldersCommandInput, ...additionalArguments: any): Paginator<DescribeRootFoldersCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { SearchResourcesCommandInput, SearchResourcesCommandOutput } from "../commands/SearchResourcesCommand";
|
|
3
|
+
import { WorkDocsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateSearchResources(config: WorkDocsPaginationConfiguration, input: SearchResourcesCommandInput, ...additionalArguments: any): Paginator<SearchResourcesCommandOutput>;
|
|
@@ -1,4 +1,11 @@
|
|
|
1
|
+
export * from "./DescribeActivitiesPaginator";
|
|
2
|
+
export * from "./DescribeCommentsPaginator";
|
|
1
3
|
export * from "./DescribeDocumentVersionsPaginator";
|
|
2
4
|
export * from "./DescribeFolderContentsPaginator";
|
|
5
|
+
export * from "./DescribeGroupsPaginator";
|
|
6
|
+
export * from "./DescribeNotificationSubscriptionsPaginator";
|
|
7
|
+
export * from "./DescribeResourcePermissionsPaginator";
|
|
8
|
+
export * from "./DescribeRootFoldersPaginator";
|
|
3
9
|
export * from "./DescribeUsersPaginator";
|
|
4
10
|
export * from "./Interfaces";
|
|
11
|
+
export * from "./SearchResourcesPaginator";
|
|
@@ -39,6 +39,7 @@ import { InitiateDocumentVersionUploadCommandInput, InitiateDocumentVersionUploa
|
|
|
39
39
|
import { RemoveAllResourcePermissionsCommandInput, RemoveAllResourcePermissionsCommandOutput } from "../commands/RemoveAllResourcePermissionsCommand";
|
|
40
40
|
import { RemoveResourcePermissionCommandInput, RemoveResourcePermissionCommandOutput } from "../commands/RemoveResourcePermissionCommand";
|
|
41
41
|
import { RestoreDocumentVersionsCommandInput, RestoreDocumentVersionsCommandOutput } from "../commands/RestoreDocumentVersionsCommand";
|
|
42
|
+
import { SearchResourcesCommandInput, SearchResourcesCommandOutput } from "../commands/SearchResourcesCommand";
|
|
42
43
|
import { UpdateDocumentCommandInput, UpdateDocumentCommandOutput } from "../commands/UpdateDocumentCommand";
|
|
43
44
|
import { UpdateDocumentVersionCommandInput, UpdateDocumentVersionCommandOutput } from "../commands/UpdateDocumentVersionCommand";
|
|
44
45
|
import { UpdateFolderCommandInput, UpdateFolderCommandOutput } from "../commands/UpdateFolderCommand";
|
|
@@ -82,6 +83,7 @@ export declare const serializeAws_restJson1InitiateDocumentVersionUploadCommand:
|
|
|
82
83
|
export declare const serializeAws_restJson1RemoveAllResourcePermissionsCommand: (input: RemoveAllResourcePermissionsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
83
84
|
export declare const serializeAws_restJson1RemoveResourcePermissionCommand: (input: RemoveResourcePermissionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
84
85
|
export declare const serializeAws_restJson1RestoreDocumentVersionsCommand: (input: RestoreDocumentVersionsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
86
|
+
export declare const serializeAws_restJson1SearchResourcesCommand: (input: SearchResourcesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
85
87
|
export declare const serializeAws_restJson1UpdateDocumentCommand: (input: UpdateDocumentCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
86
88
|
export declare const serializeAws_restJson1UpdateDocumentVersionCommand: (input: UpdateDocumentVersionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
87
89
|
export declare const serializeAws_restJson1UpdateFolderCommand: (input: UpdateFolderCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
@@ -125,6 +127,7 @@ export declare const deserializeAws_restJson1InitiateDocumentVersionUploadComman
|
|
|
125
127
|
export declare const deserializeAws_restJson1RemoveAllResourcePermissionsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<RemoveAllResourcePermissionsCommandOutput>;
|
|
126
128
|
export declare const deserializeAws_restJson1RemoveResourcePermissionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<RemoveResourcePermissionCommandOutput>;
|
|
127
129
|
export declare const deserializeAws_restJson1RestoreDocumentVersionsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<RestoreDocumentVersionsCommandOutput>;
|
|
130
|
+
export declare const deserializeAws_restJson1SearchResourcesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SearchResourcesCommandOutput>;
|
|
128
131
|
export declare const deserializeAws_restJson1UpdateDocumentCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateDocumentCommandOutput>;
|
|
129
132
|
export declare const deserializeAws_restJson1UpdateDocumentVersionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateDocumentVersionCommandOutput>;
|
|
130
133
|
export declare const deserializeAws_restJson1UpdateFolderCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateFolderCommandOutput>;
|
|
@@ -155,6 +155,10 @@ import {
|
|
|
155
155
|
RestoreDocumentVersionsCommandInput,
|
|
156
156
|
RestoreDocumentVersionsCommandOutput,
|
|
157
157
|
} from "./commands/RestoreDocumentVersionsCommand";
|
|
158
|
+
import {
|
|
159
|
+
SearchResourcesCommandInput,
|
|
160
|
+
SearchResourcesCommandOutput,
|
|
161
|
+
} from "./commands/SearchResourcesCommand";
|
|
158
162
|
import {
|
|
159
163
|
UpdateDocumentCommandInput,
|
|
160
164
|
UpdateDocumentCommandOutput,
|
|
@@ -686,6 +690,19 @@ export declare class WorkDocs extends WorkDocsClient {
|
|
|
686
690
|
options: __HttpHandlerOptions,
|
|
687
691
|
cb: (err: any, data?: RestoreDocumentVersionsCommandOutput) => void
|
|
688
692
|
): void;
|
|
693
|
+
searchResources(
|
|
694
|
+
args: SearchResourcesCommandInput,
|
|
695
|
+
options?: __HttpHandlerOptions
|
|
696
|
+
): Promise<SearchResourcesCommandOutput>;
|
|
697
|
+
searchResources(
|
|
698
|
+
args: SearchResourcesCommandInput,
|
|
699
|
+
cb: (err: any, data?: SearchResourcesCommandOutput) => void
|
|
700
|
+
): void;
|
|
701
|
+
searchResources(
|
|
702
|
+
args: SearchResourcesCommandInput,
|
|
703
|
+
options: __HttpHandlerOptions,
|
|
704
|
+
cb: (err: any, data?: SearchResourcesCommandOutput) => void
|
|
705
|
+
): void;
|
|
689
706
|
updateDocument(
|
|
690
707
|
args: UpdateDocumentCommandInput,
|
|
691
708
|
options?: __HttpHandlerOptions
|
|
@@ -200,6 +200,10 @@ import {
|
|
|
200
200
|
RestoreDocumentVersionsCommandInput,
|
|
201
201
|
RestoreDocumentVersionsCommandOutput,
|
|
202
202
|
} from "./commands/RestoreDocumentVersionsCommand";
|
|
203
|
+
import {
|
|
204
|
+
SearchResourcesCommandInput,
|
|
205
|
+
SearchResourcesCommandOutput,
|
|
206
|
+
} from "./commands/SearchResourcesCommand";
|
|
203
207
|
import {
|
|
204
208
|
UpdateDocumentCommandInput,
|
|
205
209
|
UpdateDocumentCommandOutput,
|
|
@@ -221,7 +225,7 @@ import {
|
|
|
221
225
|
ClientResolvedEndpointParameters,
|
|
222
226
|
EndpointParameters,
|
|
223
227
|
} from "./endpoint/EndpointParameters";
|
|
224
|
-
export
|
|
228
|
+
export type ServiceInputTypes =
|
|
225
229
|
| AbortDocumentVersionUploadCommandInput
|
|
226
230
|
| ActivateUserCommandInput
|
|
227
231
|
| AddResourcePermissionsCommandInput
|
|
@@ -261,11 +265,12 @@ export declare type ServiceInputTypes =
|
|
|
261
265
|
| RemoveAllResourcePermissionsCommandInput
|
|
262
266
|
| RemoveResourcePermissionCommandInput
|
|
263
267
|
| RestoreDocumentVersionsCommandInput
|
|
268
|
+
| SearchResourcesCommandInput
|
|
264
269
|
| UpdateDocumentCommandInput
|
|
265
270
|
| UpdateDocumentVersionCommandInput
|
|
266
271
|
| UpdateFolderCommandInput
|
|
267
272
|
| UpdateUserCommandInput;
|
|
268
|
-
export
|
|
273
|
+
export type ServiceOutputTypes =
|
|
269
274
|
| AbortDocumentVersionUploadCommandOutput
|
|
270
275
|
| ActivateUserCommandOutput
|
|
271
276
|
| AddResourcePermissionsCommandOutput
|
|
@@ -305,6 +310,7 @@ export declare type ServiceOutputTypes =
|
|
|
305
310
|
| RemoveAllResourcePermissionsCommandOutput
|
|
306
311
|
| RemoveResourcePermissionCommandOutput
|
|
307
312
|
| RestoreDocumentVersionsCommandOutput
|
|
313
|
+
| SearchResourcesCommandOutput
|
|
308
314
|
| UpdateDocumentCommandOutput
|
|
309
315
|
| UpdateDocumentVersionCommandOutput
|
|
310
316
|
| UpdateFolderCommandOutput
|
|
@@ -333,7 +339,7 @@ export interface ClientDefaults
|
|
|
333
339
|
logger?: __Logger;
|
|
334
340
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
335
341
|
}
|
|
336
|
-
|
|
342
|
+
type WorkDocsClientConfigType = Partial<
|
|
337
343
|
__SmithyConfiguration<__HttpHandlerOptions>
|
|
338
344
|
> &
|
|
339
345
|
ClientDefaults &
|
|
@@ -345,7 +351,7 @@ declare type WorkDocsClientConfigType = Partial<
|
|
|
345
351
|
UserAgentInputConfig &
|
|
346
352
|
ClientInputEndpointParameters;
|
|
347
353
|
export interface WorkDocsClientConfig extends WorkDocsClientConfigType {}
|
|
348
|
-
|
|
354
|
+
type WorkDocsClientResolvedConfigType =
|
|
349
355
|
__SmithyResolvedConfiguration<__HttpHandlerOptions> &
|
|
350
356
|
Required<ClientDefaults> &
|
|
351
357
|
RegionResolvedConfig &
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import {
|
|
4
|
+
Handler,
|
|
5
|
+
HttpHandlerOptions as __HttpHandlerOptions,
|
|
6
|
+
MetadataBearer as __MetadataBearer,
|
|
7
|
+
MiddlewareStack,
|
|
8
|
+
} from "@aws-sdk/types";
|
|
9
|
+
import {
|
|
10
|
+
SearchResourcesRequest,
|
|
11
|
+
SearchResourcesResponse,
|
|
12
|
+
} from "../models/models_0";
|
|
13
|
+
import {
|
|
14
|
+
ServiceInputTypes,
|
|
15
|
+
ServiceOutputTypes,
|
|
16
|
+
WorkDocsClientResolvedConfig,
|
|
17
|
+
} from "../WorkDocsClient";
|
|
18
|
+
export interface SearchResourcesCommandInput extends SearchResourcesRequest {}
|
|
19
|
+
export interface SearchResourcesCommandOutput
|
|
20
|
+
extends SearchResourcesResponse,
|
|
21
|
+
__MetadataBearer {}
|
|
22
|
+
export declare class SearchResourcesCommand extends $Command<
|
|
23
|
+
SearchResourcesCommandInput,
|
|
24
|
+
SearchResourcesCommandOutput,
|
|
25
|
+
WorkDocsClientResolvedConfig
|
|
26
|
+
> {
|
|
27
|
+
readonly input: SearchResourcesCommandInput;
|
|
28
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
29
|
+
constructor(input: SearchResourcesCommandInput);
|
|
30
|
+
resolveMiddleware(
|
|
31
|
+
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
|
|
32
|
+
configuration: WorkDocsClientResolvedConfig,
|
|
33
|
+
options?: __HttpHandlerOptions
|
|
34
|
+
): Handler<SearchResourcesCommandInput, SearchResourcesCommandOutput>;
|
|
35
|
+
private serialize;
|
|
36
|
+
private deserialize;
|
|
37
|
+
}
|
|
@@ -37,6 +37,7 @@ export * from "./InitiateDocumentVersionUploadCommand";
|
|
|
37
37
|
export * from "./RemoveAllResourcePermissionsCommand";
|
|
38
38
|
export * from "./RemoveResourcePermissionCommand";
|
|
39
39
|
export * from "./RestoreDocumentVersionsCommand";
|
|
40
|
+
export * from "./SearchResourcesCommand";
|
|
40
41
|
export * from "./UpdateDocumentCommand";
|
|
41
42
|
export * from "./UpdateDocumentVersionCommand";
|
|
42
43
|
export * from "./UpdateFolderCommand";
|
|
@@ -16,10 +16,9 @@ export interface ClientInputEndpointParameters {
|
|
|
16
16
|
| EndpointV2
|
|
17
17
|
| Provider<EndpointV2>;
|
|
18
18
|
}
|
|
19
|
-
export
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
};
|
|
19
|
+
export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
|
|
20
|
+
defaultSigningName: string;
|
|
21
|
+
};
|
|
23
22
|
export declare const resolveClientEndpointParameters: <T>(
|
|
24
23
|
options: T & ClientInputEndpointParameters
|
|
25
24
|
) => T &
|
|
@@ -27,7 +26,7 @@ export declare const resolveClientEndpointParameters: <T>(
|
|
|
27
26
|
defaultSigningName: string;
|
|
28
27
|
};
|
|
29
28
|
export interface EndpointParameters extends __EndpointParameters {
|
|
30
|
-
Region
|
|
29
|
+
Region?: string;
|
|
31
30
|
UseDualStack?: boolean;
|
|
32
31
|
UseFIPS?: boolean;
|
|
33
32
|
Endpoint?: string;
|