aws-sdk-workdocs 1.0.0 → 1.1.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-workdocs.rb +1 -1
- data/lib/aws-sdk-workdocs/client.rb +200 -133
- data/lib/aws-sdk-workdocs/client_api.rb +47 -8
- data/lib/aws-sdk-workdocs/types.rb +245 -131
- metadata +5 -3
@@ -19,6 +19,7 @@ module Aws::WorkDocs
|
|
19
19
|
AddResourcePermissionsRequest = Shapes::StructureShape.new(name: 'AddResourcePermissionsRequest')
|
20
20
|
AddResourcePermissionsResponse = Shapes::StructureShape.new(name: 'AddResourcePermissionsResponse')
|
21
21
|
AuthenticationHeaderType = Shapes::StringShape.new(name: 'AuthenticationHeaderType')
|
22
|
+
BooleanEnumType = Shapes::StringShape.new(name: 'BooleanEnumType')
|
22
23
|
BooleanType = Shapes::BooleanShape.new(name: 'BooleanType')
|
23
24
|
Comment = Shapes::StructureShape.new(name: 'Comment')
|
24
25
|
CommentIdType = Shapes::StringShape.new(name: 'CommentIdType')
|
@@ -65,6 +66,8 @@ module Aws::WorkDocs
|
|
65
66
|
DescribeDocumentVersionsResponse = Shapes::StructureShape.new(name: 'DescribeDocumentVersionsResponse')
|
66
67
|
DescribeFolderContentsRequest = Shapes::StructureShape.new(name: 'DescribeFolderContentsRequest')
|
67
68
|
DescribeFolderContentsResponse = Shapes::StructureShape.new(name: 'DescribeFolderContentsResponse')
|
69
|
+
DescribeGroupsRequest = Shapes::StructureShape.new(name: 'DescribeGroupsRequest')
|
70
|
+
DescribeGroupsResponse = Shapes::StructureShape.new(name: 'DescribeGroupsResponse')
|
68
71
|
DescribeNotificationSubscriptionsRequest = Shapes::StructureShape.new(name: 'DescribeNotificationSubscriptionsRequest')
|
69
72
|
DescribeNotificationSubscriptionsResponse = Shapes::StructureShape.new(name: 'DescribeNotificationSubscriptionsResponse')
|
70
73
|
DescribeResourcePermissionsRequest = Shapes::StructureShape.new(name: 'DescribeResourcePermissionsRequest')
|
@@ -121,13 +124,13 @@ module Aws::WorkDocs
|
|
121
124
|
InitiateDocumentVersionUploadResponse = Shapes::StructureShape.new(name: 'InitiateDocumentVersionUploadResponse')
|
122
125
|
InvalidArgumentException = Shapes::StructureShape.new(name: 'InvalidArgumentException')
|
123
126
|
InvalidOperationException = Shapes::StructureShape.new(name: 'InvalidOperationException')
|
124
|
-
|
125
|
-
Labels = Shapes::ListShape.new(name: 'Labels')
|
127
|
+
InvalidPasswordException = Shapes::StructureShape.new(name: 'InvalidPasswordException')
|
126
128
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
127
129
|
LimitType = Shapes::IntegerShape.new(name: 'LimitType')
|
128
130
|
LocaleType = Shapes::StringShape.new(name: 'LocaleType')
|
129
131
|
MarkerType = Shapes::StringShape.new(name: 'MarkerType')
|
130
132
|
MessageType = Shapes::StringShape.new(name: 'MessageType')
|
133
|
+
NotificationOptions = Shapes::StructureShape.new(name: 'NotificationOptions')
|
131
134
|
OrderType = Shapes::StringShape.new(name: 'OrderType')
|
132
135
|
OrganizationUserList = Shapes::ListShape.new(name: 'OrganizationUserList')
|
133
136
|
PageMarkerType = Shapes::StringShape.new(name: 'PageMarkerType')
|
@@ -135,6 +138,7 @@ module Aws::WorkDocs
|
|
135
138
|
PasswordType = Shapes::StringShape.new(name: 'PasswordType')
|
136
139
|
PermissionInfo = Shapes::StructureShape.new(name: 'PermissionInfo')
|
137
140
|
PermissionInfoList = Shapes::ListShape.new(name: 'PermissionInfoList')
|
141
|
+
PositiveIntegerType = Shapes::IntegerShape.new(name: 'PositiveIntegerType')
|
138
142
|
PositiveSizeType = Shapes::IntegerShape.new(name: 'PositiveSizeType')
|
139
143
|
Principal = Shapes::StructureShape.new(name: 'Principal')
|
140
144
|
PrincipalList = Shapes::ListShape.new(name: 'PrincipalList')
|
@@ -161,6 +165,8 @@ module Aws::WorkDocs
|
|
161
165
|
ShareResult = Shapes::StructureShape.new(name: 'ShareResult')
|
162
166
|
ShareResultsList = Shapes::ListShape.new(name: 'ShareResultsList')
|
163
167
|
ShareStatusType = Shapes::StringShape.new(name: 'ShareStatusType')
|
168
|
+
SharedLabel = Shapes::StringShape.new(name: 'SharedLabel')
|
169
|
+
SharedLabels = Shapes::ListShape.new(name: 'SharedLabels')
|
164
170
|
SignedHeaderMap = Shapes::MapShape.new(name: 'SignedHeaderMap')
|
165
171
|
SizeType = Shapes::IntegerShape.new(name: 'SizeType')
|
166
172
|
StorageLimitExceededException = Shapes::StructureShape.new(name: 'StorageLimitExceededException')
|
@@ -223,6 +229,7 @@ module Aws::WorkDocs
|
|
223
229
|
AddResourcePermissionsRequest.add_member(:authentication_token, Shapes::ShapeRef.new(shape: AuthenticationHeaderType, location: "header", location_name: "Authentication"))
|
224
230
|
AddResourcePermissionsRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceIdType, required: true, location: "uri", location_name: "ResourceId"))
|
225
231
|
AddResourcePermissionsRequest.add_member(:principals, Shapes::ShapeRef.new(shape: SharePrincipalList, required: true, location_name: "Principals"))
|
232
|
+
AddResourcePermissionsRequest.add_member(:notification_options, Shapes::ShapeRef.new(shape: NotificationOptions, location_name: "NotificationOptions"))
|
226
233
|
AddResourcePermissionsRequest.struct_class = Types::AddResourcePermissionsRequest
|
227
234
|
|
228
235
|
AddResourcePermissionsResponse.add_member(:share_results, Shapes::ShapeRef.new(shape: ShareResultsList, location_name: "ShareResults"))
|
@@ -278,7 +285,7 @@ module Aws::WorkDocs
|
|
278
285
|
CreateFolderResponse.struct_class = Types::CreateFolderResponse
|
279
286
|
|
280
287
|
CreateLabelsRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceIdType, required: true, location: "uri", location_name: "ResourceId"))
|
281
|
-
CreateLabelsRequest.add_member(:labels, Shapes::ShapeRef.new(shape:
|
288
|
+
CreateLabelsRequest.add_member(:labels, Shapes::ShapeRef.new(shape: SharedLabels, required: true, location_name: "Labels"))
|
282
289
|
CreateLabelsRequest.add_member(:authentication_token, Shapes::ShapeRef.new(shape: AuthenticationHeaderType, location: "header", location_name: "Authentication"))
|
283
290
|
CreateLabelsRequest.struct_class = Types::CreateLabelsRequest
|
284
291
|
|
@@ -345,7 +352,7 @@ module Aws::WorkDocs
|
|
345
352
|
|
346
353
|
DeleteLabelsRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceIdType, required: true, location: "uri", location_name: "ResourceId"))
|
347
354
|
DeleteLabelsRequest.add_member(:authentication_token, Shapes::ShapeRef.new(shape: AuthenticationHeaderType, location: "header", location_name: "Authentication"))
|
348
|
-
DeleteLabelsRequest.add_member(:labels, Shapes::ShapeRef.new(shape:
|
355
|
+
DeleteLabelsRequest.add_member(:labels, Shapes::ShapeRef.new(shape: SharedLabels, location: "querystring", location_name: "labels"))
|
349
356
|
DeleteLabelsRequest.add_member(:delete_all, Shapes::ShapeRef.new(shape: BooleanType, location: "querystring", location_name: "deleteAll"))
|
350
357
|
DeleteLabelsRequest.struct_class = Types::DeleteLabelsRequest
|
351
358
|
|
@@ -410,6 +417,17 @@ module Aws::WorkDocs
|
|
410
417
|
DescribeFolderContentsResponse.add_member(:marker, Shapes::ShapeRef.new(shape: PageMarkerType, location_name: "Marker"))
|
411
418
|
DescribeFolderContentsResponse.struct_class = Types::DescribeFolderContentsResponse
|
412
419
|
|
420
|
+
DescribeGroupsRequest.add_member(:authentication_token, Shapes::ShapeRef.new(shape: AuthenticationHeaderType, location: "header", location_name: "Authentication"))
|
421
|
+
DescribeGroupsRequest.add_member(:search_query, Shapes::ShapeRef.new(shape: SearchQueryType, required: true, location: "querystring", location_name: "searchQuery"))
|
422
|
+
DescribeGroupsRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: IdType, location: "querystring", location_name: "organizationId"))
|
423
|
+
DescribeGroupsRequest.add_member(:marker, Shapes::ShapeRef.new(shape: MarkerType, location: "querystring", location_name: "marker"))
|
424
|
+
DescribeGroupsRequest.add_member(:limit, Shapes::ShapeRef.new(shape: PositiveIntegerType, location: "querystring", location_name: "limit"))
|
425
|
+
DescribeGroupsRequest.struct_class = Types::DescribeGroupsRequest
|
426
|
+
|
427
|
+
DescribeGroupsResponse.add_member(:groups, Shapes::ShapeRef.new(shape: GroupMetadataList, location_name: "Groups"))
|
428
|
+
DescribeGroupsResponse.add_member(:marker, Shapes::ShapeRef.new(shape: MarkerType, location_name: "Marker"))
|
429
|
+
DescribeGroupsResponse.struct_class = Types::DescribeGroupsResponse
|
430
|
+
|
413
431
|
DescribeNotificationSubscriptionsRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: IdType, required: true, location: "uri", location_name: "OrganizationId"))
|
414
432
|
DescribeNotificationSubscriptionsRequest.add_member(:marker, Shapes::ShapeRef.new(shape: PageMarkerType, location: "querystring", location_name: "marker"))
|
415
433
|
DescribeNotificationSubscriptionsRequest.add_member(:limit, Shapes::ShapeRef.new(shape: LimitType, location: "querystring", location_name: "limit"))
|
@@ -421,6 +439,7 @@ module Aws::WorkDocs
|
|
421
439
|
|
422
440
|
DescribeResourcePermissionsRequest.add_member(:authentication_token, Shapes::ShapeRef.new(shape: AuthenticationHeaderType, location: "header", location_name: "Authentication"))
|
423
441
|
DescribeResourcePermissionsRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceIdType, required: true, location: "uri", location_name: "ResourceId"))
|
442
|
+
DescribeResourcePermissionsRequest.add_member(:principal_id, Shapes::ShapeRef.new(shape: IdType, location: "querystring", location_name: "principalId"))
|
424
443
|
DescribeResourcePermissionsRequest.add_member(:limit, Shapes::ShapeRef.new(shape: LimitType, location: "querystring", location_name: "limit"))
|
425
444
|
DescribeResourcePermissionsRequest.add_member(:marker, Shapes::ShapeRef.new(shape: PageMarkerType, location: "querystring", location_name: "marker"))
|
426
445
|
DescribeResourcePermissionsRequest.struct_class = Types::DescribeResourcePermissionsRequest
|
@@ -451,7 +470,7 @@ module Aws::WorkDocs
|
|
451
470
|
DescribeUsersRequest.struct_class = Types::DescribeUsersRequest
|
452
471
|
|
453
472
|
DescribeUsersResponse.add_member(:users, Shapes::ShapeRef.new(shape: OrganizationUserList, location_name: "Users"))
|
454
|
-
DescribeUsersResponse.add_member(:total_number_of_users, Shapes::ShapeRef.new(shape: SizeType, location_name: "TotalNumberOfUsers"))
|
473
|
+
DescribeUsersResponse.add_member(:total_number_of_users, Shapes::ShapeRef.new(shape: SizeType, deprecated: true, location_name: "TotalNumberOfUsers"))
|
455
474
|
DescribeUsersResponse.add_member(:marker, Shapes::ShapeRef.new(shape: PageMarkerType, location_name: "Marker"))
|
456
475
|
DescribeUsersResponse.struct_class = Types::DescribeUsersResponse
|
457
476
|
|
@@ -462,7 +481,7 @@ module Aws::WorkDocs
|
|
462
481
|
DocumentMetadata.add_member(:modified_timestamp, Shapes::ShapeRef.new(shape: TimestampType, location_name: "ModifiedTimestamp"))
|
463
482
|
DocumentMetadata.add_member(:latest_version_metadata, Shapes::ShapeRef.new(shape: DocumentVersionMetadata, location_name: "LatestVersionMetadata"))
|
464
483
|
DocumentMetadata.add_member(:resource_state, Shapes::ShapeRef.new(shape: ResourceStateType, location_name: "ResourceState"))
|
465
|
-
DocumentMetadata.add_member(:labels, Shapes::ShapeRef.new(shape:
|
484
|
+
DocumentMetadata.add_member(:labels, Shapes::ShapeRef.new(shape: SharedLabels, location_name: "Labels"))
|
466
485
|
DocumentMetadata.struct_class = Types::DocumentMetadata
|
467
486
|
|
468
487
|
DocumentMetadataList.member = Shapes::ShapeRef.new(shape: DocumentMetadata)
|
@@ -500,7 +519,7 @@ module Aws::WorkDocs
|
|
500
519
|
FolderMetadata.add_member(:modified_timestamp, Shapes::ShapeRef.new(shape: TimestampType, location_name: "ModifiedTimestamp"))
|
501
520
|
FolderMetadata.add_member(:resource_state, Shapes::ShapeRef.new(shape: ResourceStateType, location_name: "ResourceState"))
|
502
521
|
FolderMetadata.add_member(:signature, Shapes::ShapeRef.new(shape: HashType, location_name: "Signature"))
|
503
|
-
FolderMetadata.add_member(:labels, Shapes::ShapeRef.new(shape:
|
522
|
+
FolderMetadata.add_member(:labels, Shapes::ShapeRef.new(shape: SharedLabels, location_name: "Labels"))
|
504
523
|
FolderMetadata.add_member(:size, Shapes::ShapeRef.new(shape: SizeType, location_name: "Size"))
|
505
524
|
FolderMetadata.add_member(:latest_version_size, Shapes::ShapeRef.new(shape: SizeType, location_name: "LatestVersionSize"))
|
506
525
|
FolderMetadata.struct_class = Types::FolderMetadata
|
@@ -582,7 +601,9 @@ module Aws::WorkDocs
|
|
582
601
|
InitiateDocumentVersionUploadResponse.add_member(:upload_metadata, Shapes::ShapeRef.new(shape: UploadMetadata, location_name: "UploadMetadata"))
|
583
602
|
InitiateDocumentVersionUploadResponse.struct_class = Types::InitiateDocumentVersionUploadResponse
|
584
603
|
|
585
|
-
|
604
|
+
NotificationOptions.add_member(:send_email, Shapes::ShapeRef.new(shape: BooleanType, location_name: "SendEmail"))
|
605
|
+
NotificationOptions.add_member(:email_message, Shapes::ShapeRef.new(shape: MessageType, location_name: "EmailMessage"))
|
606
|
+
NotificationOptions.struct_class = Types::NotificationOptions
|
586
607
|
|
587
608
|
OrganizationUserList.member = Shapes::ShapeRef.new(shape: User)
|
588
609
|
|
@@ -647,6 +668,8 @@ module Aws::WorkDocs
|
|
647
668
|
|
648
669
|
ShareResultsList.member = Shapes::ShapeRef.new(shape: ShareResult)
|
649
670
|
|
671
|
+
SharedLabels.member = Shapes::ShapeRef.new(shape: SharedLabel)
|
672
|
+
|
650
673
|
SignedHeaderMap.key = Shapes::ShapeRef.new(shape: HeaderNameType)
|
651
674
|
SignedHeaderMap.value = Shapes::ShapeRef.new(shape: HeaderValueType)
|
652
675
|
|
@@ -689,6 +712,7 @@ module Aws::WorkDocs
|
|
689
712
|
UpdateUserRequest.add_member(:storage_rule, Shapes::ShapeRef.new(shape: StorageRuleType, location_name: "StorageRule"))
|
690
713
|
UpdateUserRequest.add_member(:time_zone_id, Shapes::ShapeRef.new(shape: TimeZoneIdType, location_name: "TimeZoneId"))
|
691
714
|
UpdateUserRequest.add_member(:locale, Shapes::ShapeRef.new(shape: LocaleType, location_name: "Locale"))
|
715
|
+
UpdateUserRequest.add_member(:grant_poweruser_privileges, Shapes::ShapeRef.new(shape: BooleanEnumType, location_name: "GrantPoweruserPrivileges"))
|
692
716
|
UpdateUserRequest.struct_class = Types::UpdateUserRequest
|
693
717
|
|
694
718
|
UpdateUserResponse.add_member(:user, Shapes::ShapeRef.new(shape: User, location_name: "User"))
|
@@ -1058,6 +1082,18 @@ module Aws::WorkDocs
|
|
1058
1082
|
)
|
1059
1083
|
end)
|
1060
1084
|
|
1085
|
+
api.add_operation(:describe_groups, Seahorse::Model::Operation.new.tap do |o|
|
1086
|
+
o.name = "DescribeGroups"
|
1087
|
+
o.http_method = "GET"
|
1088
|
+
o.http_request_uri = "/api/v1/groups"
|
1089
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeGroupsRequest)
|
1090
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeGroupsResponse)
|
1091
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedOperationException)
|
1092
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
1093
|
+
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
1094
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1095
|
+
end)
|
1096
|
+
|
1061
1097
|
api.add_operation(:describe_notification_subscriptions, Seahorse::Model::Operation.new.tap do |o|
|
1062
1098
|
o.name = "DescribeNotificationSubscriptions"
|
1063
1099
|
o.http_method = "GET"
|
@@ -1138,6 +1174,7 @@ module Aws::WorkDocs
|
|
1138
1174
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
1139
1175
|
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
1140
1176
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1177
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidPasswordException)
|
1141
1178
|
end)
|
1142
1179
|
|
1143
1180
|
api.add_operation(:get_document_path, Seahorse::Model::Operation.new.tap do |o|
|
@@ -1165,6 +1202,7 @@ module Aws::WorkDocs
|
|
1165
1202
|
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
1166
1203
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1167
1204
|
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
1205
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidPasswordException)
|
1168
1206
|
end)
|
1169
1207
|
|
1170
1208
|
api.add_operation(:get_folder, Seahorse::Model::Operation.new.tap do |o|
|
@@ -1301,6 +1339,7 @@ module Aws::WorkDocs
|
|
1301
1339
|
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
1302
1340
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1303
1341
|
o.errors << Shapes::ShapeRef.new(shape: DeactivatingLastSystemUserException)
|
1342
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
1304
1343
|
end)
|
1305
1344
|
end
|
1306
1345
|
|
@@ -18,9 +18,9 @@ module Aws::WorkDocs
|
|
18
18
|
# }
|
19
19
|
#
|
20
20
|
# @!attribute [rw] authentication_token
|
21
|
-
# Amazon WorkDocs authentication token.
|
22
|
-
#
|
23
|
-
#
|
21
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
22
|
+
# using administrative API actions, as in accessing the API using AWS
|
23
|
+
# credentials.
|
24
24
|
# @return [String]
|
25
25
|
#
|
26
26
|
# @!attribute [rw] document_id
|
@@ -53,9 +53,9 @@ module Aws::WorkDocs
|
|
53
53
|
# @return [String]
|
54
54
|
#
|
55
55
|
# @!attribute [rw] authentication_token
|
56
|
-
# Amazon WorkDocs authentication token.
|
57
|
-
#
|
58
|
-
#
|
56
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
57
|
+
# using administrative API actions, as in accessing the API using AWS
|
58
|
+
# credentials.
|
59
59
|
# @return [String]
|
60
60
|
#
|
61
61
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUserRequest AWS API Documentation
|
@@ -143,12 +143,16 @@ module Aws::WorkDocs
|
|
143
143
|
# role: "VIEWER", # required, accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
|
144
144
|
# },
|
145
145
|
# ],
|
146
|
+
# notification_options: {
|
147
|
+
# send_email: false,
|
148
|
+
# email_message: "MessageType",
|
149
|
+
# },
|
146
150
|
# }
|
147
151
|
#
|
148
152
|
# @!attribute [rw] authentication_token
|
149
|
-
# Amazon WorkDocs authentication token.
|
150
|
-
#
|
151
|
-
#
|
153
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
154
|
+
# using administrative API actions, as in accessing the API using AWS
|
155
|
+
# credentials.
|
152
156
|
# @return [String]
|
153
157
|
#
|
154
158
|
# @!attribute [rw] resource_id
|
@@ -159,12 +163,17 @@ module Aws::WorkDocs
|
|
159
163
|
# The users, groups, or organization being granted permission.
|
160
164
|
# @return [Array<Types::SharePrincipal>]
|
161
165
|
#
|
166
|
+
# @!attribute [rw] notification_options
|
167
|
+
# The notification options.
|
168
|
+
# @return [Types::NotificationOptions]
|
169
|
+
#
|
162
170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AddResourcePermissionsRequest AWS API Documentation
|
163
171
|
#
|
164
172
|
class AddResourcePermissionsRequest < Struct.new(
|
165
173
|
:authentication_token,
|
166
174
|
:resource_id,
|
167
|
-
:principals
|
175
|
+
:principals,
|
176
|
+
:notification_options)
|
168
177
|
include Aws::Structure
|
169
178
|
end
|
170
179
|
|
@@ -247,9 +256,11 @@ module Aws::WorkDocs
|
|
247
256
|
# @return [Types::User]
|
248
257
|
#
|
249
258
|
# @!attribute [rw] created_timestamp
|
259
|
+
# The timestamp that the comment was created.
|
250
260
|
# @return [Time]
|
251
261
|
#
|
252
262
|
# @!attribute [rw] comment_status
|
263
|
+
# The status of the comment.
|
253
264
|
# @return [String]
|
254
265
|
#
|
255
266
|
# @!attribute [rw] recipient_id
|
@@ -282,9 +293,9 @@ module Aws::WorkDocs
|
|
282
293
|
# }
|
283
294
|
#
|
284
295
|
# @!attribute [rw] authentication_token
|
285
|
-
# Amazon WorkDocs authentication token.
|
286
|
-
#
|
287
|
-
#
|
296
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
297
|
+
# using administrative API actions, as in accessing the API using AWS
|
298
|
+
# credentials.
|
288
299
|
# @return [String]
|
289
300
|
#
|
290
301
|
# @!attribute [rw] document_id
|
@@ -357,9 +368,9 @@ module Aws::WorkDocs
|
|
357
368
|
# }
|
358
369
|
#
|
359
370
|
# @!attribute [rw] authentication_token
|
360
|
-
# Amazon WorkDocs authentication token.
|
361
|
-
#
|
362
|
-
#
|
371
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
372
|
+
# using administrative API actions, as in accessing the API using AWS
|
373
|
+
# credentials.
|
363
374
|
# @return [String]
|
364
375
|
#
|
365
376
|
# @!attribute [rw] resource_id
|
@@ -399,9 +410,9 @@ module Aws::WorkDocs
|
|
399
410
|
# }
|
400
411
|
#
|
401
412
|
# @!attribute [rw] authentication_token
|
402
|
-
# Amazon WorkDocs authentication token.
|
403
|
-
#
|
404
|
-
#
|
413
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
414
|
+
# using administrative API actions, as in accessing the API using AWS
|
415
|
+
# credentials.
|
405
416
|
# @return [String]
|
406
417
|
#
|
407
418
|
# @!attribute [rw] name
|
@@ -437,7 +448,7 @@ module Aws::WorkDocs
|
|
437
448
|
#
|
438
449
|
# {
|
439
450
|
# resource_id: "ResourceIdType", # required
|
440
|
-
# labels: ["
|
451
|
+
# labels: ["SharedLabel"], # required
|
441
452
|
# authentication_token: "AuthenticationHeaderType",
|
442
453
|
# }
|
443
454
|
#
|
@@ -450,9 +461,9 @@ module Aws::WorkDocs
|
|
450
461
|
# @return [Array<String>]
|
451
462
|
#
|
452
463
|
# @!attribute [rw] authentication_token
|
453
|
-
# Amazon WorkDocs authentication token.
|
454
|
-
#
|
455
|
-
#
|
464
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
465
|
+
# using administrative API actions, as in accessing the API using AWS
|
466
|
+
# credentials.
|
456
467
|
# @return [String]
|
457
468
|
#
|
458
469
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabelsRequest AWS API Documentation
|
@@ -489,7 +500,7 @@ module Aws::WorkDocs
|
|
489
500
|
#
|
490
501
|
# @!attribute [rw] protocol
|
491
502
|
# The protocol to use. The supported value is https, which delivers
|
492
|
-
# JSON-encoded
|
503
|
+
# JSON-encoded messages using HTTPS POST.
|
493
504
|
# @return [String]
|
494
505
|
#
|
495
506
|
# @!attribute [rw] subscription_type
|
@@ -568,9 +579,9 @@ module Aws::WorkDocs
|
|
568
579
|
# @return [Types::StorageRuleType]
|
569
580
|
#
|
570
581
|
# @!attribute [rw] authentication_token
|
571
|
-
# Amazon WorkDocs authentication token.
|
572
|
-
#
|
573
|
-
#
|
582
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
583
|
+
# using administrative API actions, as in accessing the API using AWS
|
584
|
+
# credentials.
|
574
585
|
# @return [String]
|
575
586
|
#
|
576
587
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUserRequest AWS API Documentation
|
@@ -612,9 +623,9 @@ module Aws::WorkDocs
|
|
612
623
|
# @return [String]
|
613
624
|
#
|
614
625
|
# @!attribute [rw] authentication_token
|
615
|
-
# Amazon WorkDocs authentication token.
|
616
|
-
#
|
617
|
-
#
|
626
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
627
|
+
# using administrative API actions, as in accessing the API using AWS
|
628
|
+
# credentials.
|
618
629
|
# @return [String]
|
619
630
|
#
|
620
631
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUserRequest AWS API Documentation
|
@@ -636,9 +647,9 @@ module Aws::WorkDocs
|
|
636
647
|
# }
|
637
648
|
#
|
638
649
|
# @!attribute [rw] authentication_token
|
639
|
-
# Amazon WorkDocs authentication token.
|
640
|
-
#
|
641
|
-
#
|
650
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
651
|
+
# using administrative API actions, as in accessing the API using AWS
|
652
|
+
# credentials.
|
642
653
|
# @return [String]
|
643
654
|
#
|
644
655
|
# @!attribute [rw] document_id
|
@@ -675,9 +686,9 @@ module Aws::WorkDocs
|
|
675
686
|
# }
|
676
687
|
#
|
677
688
|
# @!attribute [rw] authentication_token
|
678
|
-
# Amazon WorkDocs authentication token.
|
679
|
-
#
|
680
|
-
#
|
689
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
690
|
+
# using administrative API actions, as in accessing the API using AWS
|
691
|
+
# credentials.
|
681
692
|
# @return [String]
|
682
693
|
#
|
683
694
|
# @!attribute [rw] resource_id
|
@@ -722,9 +733,9 @@ module Aws::WorkDocs
|
|
722
733
|
# }
|
723
734
|
#
|
724
735
|
# @!attribute [rw] authentication_token
|
725
|
-
# Amazon WorkDocs authentication token.
|
726
|
-
#
|
727
|
-
#
|
736
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
737
|
+
# using administrative API actions, as in accessing the API using AWS
|
738
|
+
# credentials.
|
728
739
|
# @return [String]
|
729
740
|
#
|
730
741
|
# @!attribute [rw] document_id
|
@@ -748,9 +759,9 @@ module Aws::WorkDocs
|
|
748
759
|
# }
|
749
760
|
#
|
750
761
|
# @!attribute [rw] authentication_token
|
751
|
-
# Amazon WorkDocs authentication token.
|
752
|
-
#
|
753
|
-
#
|
762
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
763
|
+
# using administrative API actions, as in accessing the API using AWS
|
764
|
+
# credentials.
|
754
765
|
# @return [String]
|
755
766
|
#
|
756
767
|
# @!attribute [rw] folder_id
|
@@ -774,9 +785,9 @@ module Aws::WorkDocs
|
|
774
785
|
# }
|
775
786
|
#
|
776
787
|
# @!attribute [rw] authentication_token
|
777
|
-
# Amazon WorkDocs authentication token.
|
778
|
-
#
|
779
|
-
#
|
788
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
789
|
+
# using administrative API actions, as in accessing the API using AWS
|
790
|
+
# credentials.
|
780
791
|
# @return [String]
|
781
792
|
#
|
782
793
|
# @!attribute [rw] folder_id
|
@@ -797,7 +808,7 @@ module Aws::WorkDocs
|
|
797
808
|
# {
|
798
809
|
# resource_id: "ResourceIdType", # required
|
799
810
|
# authentication_token: "AuthenticationHeaderType",
|
800
|
-
# labels: ["
|
811
|
+
# labels: ["SharedLabel"],
|
801
812
|
# delete_all: false,
|
802
813
|
# }
|
803
814
|
#
|
@@ -806,9 +817,9 @@ module Aws::WorkDocs
|
|
806
817
|
# @return [String]
|
807
818
|
#
|
808
819
|
# @!attribute [rw] authentication_token
|
809
|
-
# Amazon WorkDocs authentication token.
|
810
|
-
#
|
811
|
-
#
|
820
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
821
|
+
# using administrative API actions, as in accessing the API using AWS
|
822
|
+
# credentials.
|
812
823
|
# @return [String]
|
813
824
|
#
|
814
825
|
# @!attribute [rw] labels
|
@@ -866,9 +877,9 @@ module Aws::WorkDocs
|
|
866
877
|
# }
|
867
878
|
#
|
868
879
|
# @!attribute [rw] authentication_token
|
869
|
-
# Amazon WorkDocs authentication token.
|
870
|
-
#
|
871
|
-
#
|
880
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
881
|
+
# using administrative API actions, as in accessing the API using AWS
|
882
|
+
# credentials.
|
872
883
|
# @return [String]
|
873
884
|
#
|
874
885
|
# @!attribute [rw] user_id
|
@@ -897,19 +908,19 @@ module Aws::WorkDocs
|
|
897
908
|
# }
|
898
909
|
#
|
899
910
|
# @!attribute [rw] authentication_token
|
900
|
-
# Amazon WorkDocs authentication token.
|
901
|
-
#
|
902
|
-
#
|
911
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
912
|
+
# using administrative API actions, as in accessing the API using AWS
|
913
|
+
# credentials.
|
903
914
|
# @return [String]
|
904
915
|
#
|
905
916
|
# @!attribute [rw] start_time
|
906
|
-
# The timestamp that determines the starting time of the activities
|
907
|
-
#
|
917
|
+
# The timestamp that determines the starting time of the activities.
|
918
|
+
# The response includes the activities performed after the specified
|
908
919
|
# timestamp.
|
909
920
|
# @return [Time]
|
910
921
|
#
|
911
922
|
# @!attribute [rw] end_time
|
912
|
-
# The timestamp that determines the end time of the activities
|
923
|
+
# The timestamp that determines the end time of the activities. The
|
913
924
|
# response includes the activities performed before the specified
|
914
925
|
# timestamp.
|
915
926
|
# @return [Time]
|
@@ -930,8 +941,7 @@ module Aws::WorkDocs
|
|
930
941
|
# @return [Integer]
|
931
942
|
#
|
932
943
|
# @!attribute [rw] marker
|
933
|
-
# The marker for the next set of results.
|
934
|
-
# from a previous call.)
|
944
|
+
# The marker for the next set of results.
|
935
945
|
# @return [String]
|
936
946
|
#
|
937
947
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeActivitiesRequest AWS API Documentation
|
@@ -975,9 +985,9 @@ module Aws::WorkDocs
|
|
975
985
|
# }
|
976
986
|
#
|
977
987
|
# @!attribute [rw] authentication_token
|
978
|
-
# Amazon WorkDocs authentication token.
|
979
|
-
#
|
980
|
-
#
|
988
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
989
|
+
# using administrative API actions, as in accessing the API using AWS
|
990
|
+
# credentials.
|
981
991
|
# @return [String]
|
982
992
|
#
|
983
993
|
# @!attribute [rw] document_id
|
@@ -1038,9 +1048,9 @@ module Aws::WorkDocs
|
|
1038
1048
|
# }
|
1039
1049
|
#
|
1040
1050
|
# @!attribute [rw] authentication_token
|
1041
|
-
# Amazon WorkDocs authentication token.
|
1042
|
-
#
|
1043
|
-
#
|
1051
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1052
|
+
# using administrative API actions, as in accessing the API using AWS
|
1053
|
+
# credentials.
|
1044
1054
|
# @return [String]
|
1045
1055
|
#
|
1046
1056
|
# @!attribute [rw] document_id
|
@@ -1110,9 +1120,9 @@ module Aws::WorkDocs
|
|
1110
1120
|
# }
|
1111
1121
|
#
|
1112
1122
|
# @!attribute [rw] authentication_token
|
1113
|
-
# Amazon WorkDocs authentication token.
|
1114
|
-
#
|
1115
|
-
#
|
1123
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1124
|
+
# using administrative API actions, as in accessing the API using AWS
|
1125
|
+
# credentials.
|
1116
1126
|
# @return [String]
|
1117
1127
|
#
|
1118
1128
|
# @!attribute [rw] folder_id
|
@@ -1181,6 +1191,68 @@ module Aws::WorkDocs
|
|
1181
1191
|
include Aws::Structure
|
1182
1192
|
end
|
1183
1193
|
|
1194
|
+
# @note When making an API call, you may pass DescribeGroupsRequest
|
1195
|
+
# data as a hash:
|
1196
|
+
#
|
1197
|
+
# {
|
1198
|
+
# authentication_token: "AuthenticationHeaderType",
|
1199
|
+
# search_query: "SearchQueryType", # required
|
1200
|
+
# organization_id: "IdType",
|
1201
|
+
# marker: "MarkerType",
|
1202
|
+
# limit: 1,
|
1203
|
+
# }
|
1204
|
+
#
|
1205
|
+
# @!attribute [rw] authentication_token
|
1206
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1207
|
+
# using administrative API actions, as in accessing the API using AWS
|
1208
|
+
# credentials.
|
1209
|
+
# @return [String]
|
1210
|
+
#
|
1211
|
+
# @!attribute [rw] search_query
|
1212
|
+
# A query to describe groups by group name.
|
1213
|
+
# @return [String]
|
1214
|
+
#
|
1215
|
+
# @!attribute [rw] organization_id
|
1216
|
+
# The ID of the organization.
|
1217
|
+
# @return [String]
|
1218
|
+
#
|
1219
|
+
# @!attribute [rw] marker
|
1220
|
+
# The marker for the next set of results. (You received this marker
|
1221
|
+
# from a previous call.)
|
1222
|
+
# @return [String]
|
1223
|
+
#
|
1224
|
+
# @!attribute [rw] limit
|
1225
|
+
# The maximum number of items to return with this call.
|
1226
|
+
# @return [Integer]
|
1227
|
+
#
|
1228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeGroupsRequest AWS API Documentation
|
1229
|
+
#
|
1230
|
+
class DescribeGroupsRequest < Struct.new(
|
1231
|
+
:authentication_token,
|
1232
|
+
:search_query,
|
1233
|
+
:organization_id,
|
1234
|
+
:marker,
|
1235
|
+
:limit)
|
1236
|
+
include Aws::Structure
|
1237
|
+
end
|
1238
|
+
|
1239
|
+
# @!attribute [rw] groups
|
1240
|
+
# The list of groups.
|
1241
|
+
# @return [Array<Types::GroupMetadata>]
|
1242
|
+
#
|
1243
|
+
# @!attribute [rw] marker
|
1244
|
+
# The marker to use when requesting the next set of results. If there
|
1245
|
+
# are no additional results, the string is empty.
|
1246
|
+
# @return [String]
|
1247
|
+
#
|
1248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeGroupsResponse AWS API Documentation
|
1249
|
+
#
|
1250
|
+
class DescribeGroupsResponse < Struct.new(
|
1251
|
+
:groups,
|
1252
|
+
:marker)
|
1253
|
+
include Aws::Structure
|
1254
|
+
end
|
1255
|
+
|
1184
1256
|
# @note When making an API call, you may pass DescribeNotificationSubscriptionsRequest
|
1185
1257
|
# data as a hash:
|
1186
1258
|
#
|
@@ -1235,20 +1307,25 @@ module Aws::WorkDocs
|
|
1235
1307
|
# {
|
1236
1308
|
# authentication_token: "AuthenticationHeaderType",
|
1237
1309
|
# resource_id: "ResourceIdType", # required
|
1310
|
+
# principal_id: "IdType",
|
1238
1311
|
# limit: 1,
|
1239
1312
|
# marker: "PageMarkerType",
|
1240
1313
|
# }
|
1241
1314
|
#
|
1242
1315
|
# @!attribute [rw] authentication_token
|
1243
|
-
# Amazon WorkDocs authentication token.
|
1244
|
-
#
|
1245
|
-
#
|
1316
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1317
|
+
# using administrative API actions, as in accessing the API using AWS
|
1318
|
+
# credentials.
|
1246
1319
|
# @return [String]
|
1247
1320
|
#
|
1248
1321
|
# @!attribute [rw] resource_id
|
1249
1322
|
# The ID of the resource.
|
1250
1323
|
# @return [String]
|
1251
1324
|
#
|
1325
|
+
# @!attribute [rw] principal_id
|
1326
|
+
# The ID of the principal to filter permissions by.
|
1327
|
+
# @return [String]
|
1328
|
+
#
|
1252
1329
|
# @!attribute [rw] limit
|
1253
1330
|
# The maximum number of items to return with this call.
|
1254
1331
|
# @return [Integer]
|
@@ -1263,6 +1340,7 @@ module Aws::WorkDocs
|
|
1263
1340
|
class DescribeResourcePermissionsRequest < Struct.new(
|
1264
1341
|
:authentication_token,
|
1265
1342
|
:resource_id,
|
1343
|
+
:principal_id,
|
1266
1344
|
:limit,
|
1267
1345
|
:marker)
|
1268
1346
|
include Aws::Structure
|
@@ -1295,9 +1373,9 @@ module Aws::WorkDocs
|
|
1295
1373
|
# }
|
1296
1374
|
#
|
1297
1375
|
# @!attribute [rw] authentication_token
|
1298
|
-
# Amazon WorkDocs authentication token.
|
1299
|
-
#
|
1300
|
-
#
|
1376
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1377
|
+
# using administrative API actions, as in accessing the API using AWS
|
1378
|
+
# credentials.
|
1301
1379
|
# @return [String]
|
1302
1380
|
#
|
1303
1381
|
# @!attribute [rw] limit
|
@@ -1351,9 +1429,9 @@ module Aws::WorkDocs
|
|
1351
1429
|
# }
|
1352
1430
|
#
|
1353
1431
|
# @!attribute [rw] authentication_token
|
1354
|
-
# Amazon WorkDocs authentication token.
|
1355
|
-
#
|
1356
|
-
#
|
1432
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1433
|
+
# using administrative API actions, as in accessing the API using AWS
|
1434
|
+
# credentials.
|
1357
1435
|
# @return [String]
|
1358
1436
|
#
|
1359
1437
|
# @!attribute [rw] organization_id
|
@@ -1507,20 +1585,20 @@ module Aws::WorkDocs
|
|
1507
1585
|
# @return [String]
|
1508
1586
|
#
|
1509
1587
|
# @!attribute [rw] created_timestamp
|
1510
|
-
# The
|
1588
|
+
# The timestamp when the document was first uploaded.
|
1511
1589
|
# @return [Time]
|
1512
1590
|
#
|
1513
1591
|
# @!attribute [rw] modified_timestamp
|
1514
|
-
# The
|
1592
|
+
# The timestamp when the document was last uploaded.
|
1515
1593
|
# @return [Time]
|
1516
1594
|
#
|
1517
1595
|
# @!attribute [rw] content_created_timestamp
|
1518
|
-
# The
|
1596
|
+
# The timestamp when the content of the document was originally
|
1519
1597
|
# created.
|
1520
1598
|
# @return [Time]
|
1521
1599
|
#
|
1522
1600
|
# @!attribute [rw] content_modified_timestamp
|
1523
|
-
# The
|
1601
|
+
# The timestamp when the content of the document was modified.
|
1524
1602
|
# @return [Time]
|
1525
1603
|
#
|
1526
1604
|
# @!attribute [rw] creator_id
|
@@ -1626,7 +1704,9 @@ module Aws::WorkDocs
|
|
1626
1704
|
# }
|
1627
1705
|
#
|
1628
1706
|
# @!attribute [rw] authentication_token
|
1629
|
-
# Amazon WorkDocs authentication token.
|
1707
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1708
|
+
# using administrative API actions, as in accessing the API using AWS
|
1709
|
+
# credentials.
|
1630
1710
|
# @return [String]
|
1631
1711
|
#
|
1632
1712
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetCurrentUserRequest AWS API Documentation
|
@@ -1659,9 +1739,9 @@ module Aws::WorkDocs
|
|
1659
1739
|
# }
|
1660
1740
|
#
|
1661
1741
|
# @!attribute [rw] authentication_token
|
1662
|
-
# Amazon WorkDocs authentication token.
|
1663
|
-
#
|
1664
|
-
#
|
1742
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1743
|
+
# using administrative API actions, as in accessing the API using AWS
|
1744
|
+
# credentials.
|
1665
1745
|
# @return [String]
|
1666
1746
|
#
|
1667
1747
|
# @!attribute [rw] document_id
|
@@ -1713,9 +1793,9 @@ module Aws::WorkDocs
|
|
1713
1793
|
# }
|
1714
1794
|
#
|
1715
1795
|
# @!attribute [rw] authentication_token
|
1716
|
-
# Amazon WorkDocs authentication token.
|
1717
|
-
#
|
1718
|
-
#
|
1796
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1797
|
+
# using administrative API actions, as in accessing the API using AWS
|
1798
|
+
# credentials.
|
1719
1799
|
# @return [String]
|
1720
1800
|
#
|
1721
1801
|
# @!attribute [rw] document_id
|
@@ -1763,9 +1843,9 @@ module Aws::WorkDocs
|
|
1763
1843
|
# }
|
1764
1844
|
#
|
1765
1845
|
# @!attribute [rw] authentication_token
|
1766
|
-
# Amazon WorkDocs authentication token.
|
1767
|
-
#
|
1768
|
-
#
|
1846
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1847
|
+
# using administrative API actions, as in accessing the API using AWS
|
1848
|
+
# credentials.
|
1769
1849
|
# @return [String]
|
1770
1850
|
#
|
1771
1851
|
# @!attribute [rw] document_id
|
@@ -1824,9 +1904,9 @@ module Aws::WorkDocs
|
|
1824
1904
|
# }
|
1825
1905
|
#
|
1826
1906
|
# @!attribute [rw] authentication_token
|
1827
|
-
# Amazon WorkDocs authentication token.
|
1828
|
-
#
|
1829
|
-
#
|
1907
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1908
|
+
# using administrative API actions, as in accessing the API using AWS
|
1909
|
+
# credentials.
|
1830
1910
|
# @return [String]
|
1831
1911
|
#
|
1832
1912
|
# @!attribute [rw] folder_id
|
@@ -1878,9 +1958,9 @@ module Aws::WorkDocs
|
|
1878
1958
|
# }
|
1879
1959
|
#
|
1880
1960
|
# @!attribute [rw] authentication_token
|
1881
|
-
# Amazon WorkDocs authentication token.
|
1882
|
-
#
|
1883
|
-
#
|
1961
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
1962
|
+
# using administrative API actions, as in accessing the API using AWS
|
1963
|
+
# credentials.
|
1884
1964
|
# @return [String]
|
1885
1965
|
#
|
1886
1966
|
# @!attribute [rw] folder_id
|
@@ -1949,9 +2029,9 @@ module Aws::WorkDocs
|
|
1949
2029
|
# }
|
1950
2030
|
#
|
1951
2031
|
# @!attribute [rw] authentication_token
|
1952
|
-
# Amazon WorkDocs authentication token.
|
1953
|
-
#
|
1954
|
-
#
|
2032
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
2033
|
+
# using administrative API actions, as in accessing the API using AWS
|
2034
|
+
# credentials.
|
1955
2035
|
# @return [String]
|
1956
2036
|
#
|
1957
2037
|
# @!attribute [rw] id
|
@@ -1963,12 +2043,12 @@ module Aws::WorkDocs
|
|
1963
2043
|
# @return [String]
|
1964
2044
|
#
|
1965
2045
|
# @!attribute [rw] content_created_timestamp
|
1966
|
-
# The
|
2046
|
+
# The timestamp when the content of the document was originally
|
1967
2047
|
# created.
|
1968
2048
|
# @return [Time]
|
1969
2049
|
#
|
1970
2050
|
# @!attribute [rw] content_modified_timestamp
|
1971
|
-
# The
|
2051
|
+
# The timestamp when the content of the document was modified.
|
1972
2052
|
# @return [Time]
|
1973
2053
|
#
|
1974
2054
|
# @!attribute [rw] content_type
|
@@ -2013,7 +2093,34 @@ module Aws::WorkDocs
|
|
2013
2093
|
include Aws::Structure
|
2014
2094
|
end
|
2015
2095
|
|
2016
|
-
#
|
2096
|
+
# Set of options which defines notification preferences of given action.
|
2097
|
+
#
|
2098
|
+
# @note When making an API call, you may pass NotificationOptions
|
2099
|
+
# data as a hash:
|
2100
|
+
#
|
2101
|
+
# {
|
2102
|
+
# send_email: false,
|
2103
|
+
# email_message: "MessageType",
|
2104
|
+
# }
|
2105
|
+
#
|
2106
|
+
# @!attribute [rw] send_email
|
2107
|
+
# Boolean value to indicate an email notification should be sent to
|
2108
|
+
# the receipients.
|
2109
|
+
# @return [Boolean]
|
2110
|
+
#
|
2111
|
+
# @!attribute [rw] email_message
|
2112
|
+
# Text value to be included in the email body.
|
2113
|
+
# @return [String]
|
2114
|
+
#
|
2115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/NotificationOptions AWS API Documentation
|
2116
|
+
#
|
2117
|
+
class NotificationOptions < Struct.new(
|
2118
|
+
:send_email,
|
2119
|
+
:email_message)
|
2120
|
+
include Aws::Structure
|
2121
|
+
end
|
2122
|
+
|
2123
|
+
# Describes the users or user groups.
|
2017
2124
|
#
|
2018
2125
|
# @!attribute [rw] users
|
2019
2126
|
# The list of users.
|
@@ -2081,9 +2188,9 @@ module Aws::WorkDocs
|
|
2081
2188
|
# }
|
2082
2189
|
#
|
2083
2190
|
# @!attribute [rw] authentication_token
|
2084
|
-
# Amazon WorkDocs authentication token.
|
2085
|
-
#
|
2086
|
-
#
|
2191
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
2192
|
+
# using administrative API actions, as in accessing the API using AWS
|
2193
|
+
# credentials.
|
2087
2194
|
# @return [String]
|
2088
2195
|
#
|
2089
2196
|
# @!attribute [rw] resource_id
|
@@ -2109,9 +2216,9 @@ module Aws::WorkDocs
|
|
2109
2216
|
# }
|
2110
2217
|
#
|
2111
2218
|
# @!attribute [rw] authentication_token
|
2112
|
-
# Amazon WorkDocs authentication token.
|
2113
|
-
#
|
2114
|
-
#
|
2219
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
2220
|
+
# using administrative API actions, as in accessing the API using AWS
|
2221
|
+
# credentials.
|
2115
2222
|
# @return [String]
|
2116
2223
|
#
|
2117
2224
|
# @!attribute [rw] resource_id
|
@@ -2147,7 +2254,7 @@ module Aws::WorkDocs
|
|
2147
2254
|
# @return [String]
|
2148
2255
|
#
|
2149
2256
|
# @!attribute [rw] original_name
|
2150
|
-
# The original name of the resource
|
2257
|
+
# The original name of the resource before a rename operation.
|
2151
2258
|
# @return [String]
|
2152
2259
|
#
|
2153
2260
|
# @!attribute [rw] id
|
@@ -2337,9 +2444,9 @@ module Aws::WorkDocs
|
|
2337
2444
|
# }
|
2338
2445
|
#
|
2339
2446
|
# @!attribute [rw] authentication_token
|
2340
|
-
# Amazon WorkDocs authentication token.
|
2341
|
-
#
|
2342
|
-
#
|
2447
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
2448
|
+
# using administrative API actions, as in accessing the API using AWS
|
2449
|
+
# credentials.
|
2343
2450
|
# @return [String]
|
2344
2451
|
#
|
2345
2452
|
# @!attribute [rw] document_id
|
@@ -2355,8 +2462,8 @@ module Aws::WorkDocs
|
|
2355
2462
|
# @return [String]
|
2356
2463
|
#
|
2357
2464
|
# @!attribute [rw] resource_state
|
2358
|
-
# The resource state of the document.
|
2359
|
-
#
|
2465
|
+
# The resource state of the document. Only ACTIVE and RECYCLED are
|
2466
|
+
# supported.
|
2360
2467
|
# @return [String]
|
2361
2468
|
#
|
2362
2469
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentRequest AWS API Documentation
|
@@ -2381,9 +2488,9 @@ module Aws::WorkDocs
|
|
2381
2488
|
# }
|
2382
2489
|
#
|
2383
2490
|
# @!attribute [rw] authentication_token
|
2384
|
-
# Amazon WorkDocs authentication token.
|
2385
|
-
#
|
2386
|
-
#
|
2491
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
2492
|
+
# using administrative API actions, as in accessing the API using AWS
|
2493
|
+
# credentials.
|
2387
2494
|
# @return [String]
|
2388
2495
|
#
|
2389
2496
|
# @!attribute [rw] document_id
|
@@ -2420,9 +2527,9 @@ module Aws::WorkDocs
|
|
2420
2527
|
# }
|
2421
2528
|
#
|
2422
2529
|
# @!attribute [rw] authentication_token
|
2423
|
-
# Amazon WorkDocs authentication token.
|
2424
|
-
#
|
2425
|
-
#
|
2530
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
2531
|
+
# using administrative API actions, as in accessing the API using AWS
|
2532
|
+
# credentials.
|
2426
2533
|
# @return [String]
|
2427
2534
|
#
|
2428
2535
|
# @!attribute [rw] folder_id
|
@@ -2438,8 +2545,8 @@ module Aws::WorkDocs
|
|
2438
2545
|
# @return [String]
|
2439
2546
|
#
|
2440
2547
|
# @!attribute [rw] resource_state
|
2441
|
-
# The resource state of the folder.
|
2442
|
-
#
|
2548
|
+
# The resource state of the folder. Only ACTIVE and RECYCLED are
|
2549
|
+
# accepted values from the API.
|
2443
2550
|
# @return [String]
|
2444
2551
|
#
|
2445
2552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateFolderRequest AWS API Documentation
|
@@ -2461,19 +2568,20 @@ module Aws::WorkDocs
|
|
2461
2568
|
# user_id: "IdType", # required
|
2462
2569
|
# given_name: "UserAttributeValueType",
|
2463
2570
|
# surname: "UserAttributeValueType",
|
2464
|
-
# type: "USER", # accepts USER, ADMIN
|
2571
|
+
# type: "USER", # accepts USER, ADMIN, POWERUSER, MINIMALUSER, WORKSPACESUSER
|
2465
2572
|
# storage_rule: {
|
2466
2573
|
# storage_allocated_in_bytes: 1,
|
2467
2574
|
# storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
|
2468
2575
|
# },
|
2469
2576
|
# time_zone_id: "TimeZoneIdType",
|
2470
2577
|
# locale: "en", # accepts en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default
|
2578
|
+
# grant_poweruser_privileges: "TRUE", # accepts TRUE, FALSE
|
2471
2579
|
# }
|
2472
2580
|
#
|
2473
2581
|
# @!attribute [rw] authentication_token
|
2474
|
-
# Amazon WorkDocs authentication token.
|
2475
|
-
#
|
2476
|
-
#
|
2582
|
+
# Amazon WorkDocs authentication token. Do not set this field when
|
2583
|
+
# using administrative API actions, as in accessing the API using AWS
|
2584
|
+
# credentials.
|
2477
2585
|
# @return [String]
|
2478
2586
|
#
|
2479
2587
|
# @!attribute [rw] user_id
|
@@ -2504,6 +2612,11 @@ module Aws::WorkDocs
|
|
2504
2612
|
# The locale of the user.
|
2505
2613
|
# @return [String]
|
2506
2614
|
#
|
2615
|
+
# @!attribute [rw] grant_poweruser_privileges
|
2616
|
+
# Boolean value to determine whether the user is granted Poweruser
|
2617
|
+
# privileges.
|
2618
|
+
# @return [String]
|
2619
|
+
#
|
2507
2620
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateUserRequest AWS API Documentation
|
2508
2621
|
#
|
2509
2622
|
class UpdateUserRequest < Struct.new(
|
@@ -2514,7 +2627,8 @@ module Aws::WorkDocs
|
|
2514
2627
|
:type,
|
2515
2628
|
:storage_rule,
|
2516
2629
|
:time_zone_id,
|
2517
|
-
:locale
|
2630
|
+
:locale,
|
2631
|
+
:grant_poweruser_privileges)
|
2518
2632
|
include Aws::Structure
|
2519
2633
|
end
|
2520
2634
|
|
@@ -2637,7 +2751,7 @@ module Aws::WorkDocs
|
|
2637
2751
|
# @return [String]
|
2638
2752
|
#
|
2639
2753
|
# @!attribute [rw] username
|
2640
|
-
# The
|
2754
|
+
# The name of the user.
|
2641
2755
|
# @return [String]
|
2642
2756
|
#
|
2643
2757
|
# @!attribute [rw] given_name
|
@@ -2666,7 +2780,7 @@ module Aws::WorkDocs
|
|
2666
2780
|
# Describes the storage for a user.
|
2667
2781
|
#
|
2668
2782
|
# @!attribute [rw] storage_utilized_in_bytes
|
2669
|
-
# The amount of storage
|
2783
|
+
# The amount of storage used, in bytes.
|
2670
2784
|
# @return [Integer]
|
2671
2785
|
#
|
2672
2786
|
# @!attribute [rw] storage_rule
|