aws-sdk-transfer 1.106.0 → 1.108.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -94,7 +94,7 @@ module Aws::Transfer
94
94
  # If the connector should use Basic authentication, the secret needs
95
95
  # to be in the following format:
96
96
  #
97
- # `\{ "Username": "user-name", "Password": "user-password" \}`
97
+ # `{ "Username": "user-name", "Password": "user-password" }`
98
98
  #
99
99
  # Replace `user-name` and `user-password` with the credentials for the
100
100
  # actual user that is being authenticated.
@@ -191,16 +191,16 @@ module Aws::Transfer
191
191
  #
192
192
  # @!attribute [rw] destination_file_location
193
193
  # Specifies the location for the file being copied. Use
194
- # `$\{Transfer:UserName\}` or `$\{Transfer:UploadDate\}` in this field
195
- # to parametrize the destination prefix by username or uploaded date.
194
+ # `${Transfer:UserName}` or `${Transfer:UploadDate}` in this field to
195
+ # parametrize the destination prefix by username or uploaded date.
196
196
  #
197
197
  # * Set the value of `DestinationFileLocation` to
198
- # `$\{Transfer:UserName\}` to copy uploaded files to an Amazon S3
198
+ # `${Transfer:UserName}` to copy uploaded files to an Amazon S3
199
199
  # bucket that is prefixed with the name of the Transfer Family user
200
200
  # that uploaded the file.
201
201
  #
202
202
  # * Set the value of `DestinationFileLocation` to
203
- # `$\{Transfer:UploadDate\}` to copy uploaded files to an Amazon S3
203
+ # `${Transfer:UploadDate}` to copy uploaded files to an Amazon S3
204
204
  # bucket that is prefixed with the date of the upload.
205
205
  #
206
206
  # <note markdown="1"> The system resolves `UploadDate` to a date format of *YYYY-MM-DD*,
@@ -228,12 +228,12 @@ module Aws::Transfer
228
228
  # the output from the previous step, or the originally uploaded file
229
229
  # for the workflow.
230
230
  #
231
- # * To use the previous file as the input, enter `$\{previous.file\}`.
231
+ # * To use the previous file as the input, enter `${previous.file}`.
232
232
  # In this case, this workflow step uses the output file from the
233
233
  # previous workflow step as input. This is the default value.
234
234
  #
235
235
  # * To use the originally uploaded file location as input for this
236
- # step, enter `$\{original.file\}`.
236
+ # step, enter `${original.file}`.
237
237
  # @return [String]
238
238
  #
239
239
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CopyStepDetails AWS API Documentation
@@ -290,8 +290,8 @@ module Aws::Transfer
290
290
  #
291
291
  # The following is an `Entry` and `Target` pair example.
292
292
  #
293
- # `[ \{ "Entry": "/directory1", "Target":
294
- # "/bucket_name/home/mydirectory" \} ]`
293
+ # `[ { "Entry": "/directory1", "Target":
294
+ # "/bucket_name/home/mydirectory" } ]`
295
295
  #
296
296
  # In most cases, you can use this value instead of the session policy
297
297
  # to lock down your user to the designated home directory
@@ -300,7 +300,7 @@ module Aws::Transfer
300
300
  #
301
301
  # The following is an `Entry` and `Target` pair example for `chroot`.
302
302
  #
303
- # `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
303
+ # `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
304
304
  # @return [Array<Types::HomeDirectoryMapEntry>]
305
305
  #
306
306
  # @!attribute [rw] policy
@@ -308,8 +308,8 @@ module Aws::Transfer
308
308
  # and Access Management (IAM) role across multiple users. This policy
309
309
  # scopes down a user's access to portions of their Amazon S3 bucket.
310
310
  # Variables that you can use inside this policy include
311
- # `$\{Transfer:UserName\}`, `$\{Transfer:HomeDirectory\}`, and
312
- # `$\{Transfer:HomeBucket\}`.
311
+ # `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and
312
+ # `${Transfer:HomeBucket}`.
313
313
  #
314
314
  # <note markdown="1"> This policy applies only when the domain of `ServerId` is Amazon S3.
315
315
  # Amazon EFS does not use session policies.
@@ -364,7 +364,7 @@ module Aws::Transfer
364
364
  # you can view the SID values by running the following command using
365
365
  # Windows PowerShell.
366
366
  #
367
- # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
367
+ # `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"}
368
368
  # -Properties * | Select SamAccountName,ObjectSid`
369
369
  #
370
370
  # In that command, replace *YourGroupName* with the name of your
@@ -792,7 +792,7 @@ module Aws::Transfer
792
792
  # `API_GATEWAY`. Accepts an array containing all of the information
793
793
  # required to use a directory in `AWS_DIRECTORY_SERVICE` or invoke a
794
794
  # customer-supplied authentication API, including the API Gateway URL.
795
- # Not required when `IdentityProviderType` is set to
795
+ # Cannot be specified when `IdentityProviderType` is set to
796
796
  # `SERVICE_MANAGED`.
797
797
  # @return [Types::IdentityProviderDetails]
798
798
  #
@@ -1039,8 +1039,8 @@ module Aws::Transfer
1039
1039
  #
1040
1040
  # The following is an `Entry` and `Target` pair example.
1041
1041
  #
1042
- # `[ \{ "Entry": "/directory1", "Target":
1043
- # "/bucket_name/home/mydirectory" \} ]`
1042
+ # `[ { "Entry": "/directory1", "Target":
1043
+ # "/bucket_name/home/mydirectory" } ]`
1044
1044
  #
1045
1045
  # In most cases, you can use this value instead of the session policy
1046
1046
  # to lock your user down to the designated home directory
@@ -1050,7 +1050,7 @@ module Aws::Transfer
1050
1050
  #
1051
1051
  # The following is an `Entry` and `Target` pair example for `chroot`.
1052
1052
  #
1053
- # `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
1053
+ # `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
1054
1054
  # @return [Array<Types::HomeDirectoryMapEntry>]
1055
1055
  #
1056
1056
  # @!attribute [rw] policy
@@ -1058,8 +1058,8 @@ module Aws::Transfer
1058
1058
  # and Access Management (IAM) role across multiple users. This policy
1059
1059
  # scopes down a user's access to portions of their Amazon S3 bucket.
1060
1060
  # Variables that you can use inside this policy include
1061
- # `$\{Transfer:UserName\}`, `$\{Transfer:HomeDirectory\}`, and
1062
- # `$\{Transfer:HomeBucket\}`.
1061
+ # `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and
1062
+ # `${Transfer:HomeBucket}`.
1063
1063
  #
1064
1064
  # <note markdown="1"> This policy applies only when the domain of `ServerId` is Amazon S3.
1065
1065
  # Amazon EFS does not use session policies.
@@ -1172,6 +1172,49 @@ module Aws::Transfer
1172
1172
  include Aws::Structure
1173
1173
  end
1174
1174
 
1175
+ # @!attribute [rw] identity_provider_details
1176
+ # You can provide a structure that contains the details for the
1177
+ # identity provider to use with your web app.
1178
+ # @return [Types::WebAppIdentityProviderDetails]
1179
+ #
1180
+ # @!attribute [rw] access_endpoint
1181
+ # The `AccessEndpoint` is the URL that you provide to your users for
1182
+ # them to interact with the Transfer Family web app. You can specify a
1183
+ # custom URL or use the default value.
1184
+ # @return [String]
1185
+ #
1186
+ # @!attribute [rw] web_app_units
1187
+ # A union that contains the value for number of concurrent connections
1188
+ # or the user sessions on your web app.
1189
+ # @return [Types::WebAppUnits]
1190
+ #
1191
+ # @!attribute [rw] tags
1192
+ # Key-value pairs that can be used to group and search for web apps.
1193
+ # @return [Array<Types::Tag>]
1194
+ #
1195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateWebAppRequest AWS API Documentation
1196
+ #
1197
+ class CreateWebAppRequest < Struct.new(
1198
+ :identity_provider_details,
1199
+ :access_endpoint,
1200
+ :web_app_units,
1201
+ :tags)
1202
+ SENSITIVE = []
1203
+ include Aws::Structure
1204
+ end
1205
+
1206
+ # @!attribute [rw] web_app_id
1207
+ # Returns a unique identifier for the web app.
1208
+ # @return [String]
1209
+ #
1210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateWebAppResponse AWS API Documentation
1211
+ #
1212
+ class CreateWebAppResponse < Struct.new(
1213
+ :web_app_id)
1214
+ SENSITIVE = []
1215
+ include Aws::Structure
1216
+ end
1217
+
1175
1218
  # @!attribute [rw] description
1176
1219
  # A textual description for the workflow.
1177
1220
  # @return [String]
@@ -1262,12 +1305,12 @@ module Aws::Transfer
1262
1305
  # the output from the previous step, or the originally uploaded file
1263
1306
  # for the workflow.
1264
1307
  #
1265
- # * To use the previous file as the input, enter `$\{previous.file\}`.
1308
+ # * To use the previous file as the input, enter `${previous.file}`.
1266
1309
  # In this case, this workflow step uses the output file from the
1267
1310
  # previous workflow step as input. This is the default value.
1268
1311
  #
1269
1312
  # * To use the originally uploaded file location as input for this
1270
- # step, enter `$\{original.file\}`.
1313
+ # step, enter `${original.file}`.
1271
1314
  # @return [String]
1272
1315
  #
1273
1316
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CustomStepDetails AWS API Documentation
@@ -1296,12 +1339,12 @@ module Aws::Transfer
1296
1339
  # the output from the previous step, or the originally uploaded file
1297
1340
  # for the workflow.
1298
1341
  #
1299
- # * To use the previous file as the input, enter `$\{previous.file\}`.
1342
+ # * To use the previous file as the input, enter `${previous.file}`.
1300
1343
  # In this case, this workflow step uses the output file from the
1301
1344
  # previous workflow step as input. This is the default value.
1302
1345
  #
1303
1346
  # * To use the originally uploaded file location as input for this
1304
- # step, enter `$\{original.file\}`.
1347
+ # step, enter `${original.file}`.
1305
1348
  # @return [String]
1306
1349
  #
1307
1350
  # @!attribute [rw] overwrite_existing
@@ -1320,17 +1363,17 @@ module Aws::Transfer
1320
1363
  #
1321
1364
  # @!attribute [rw] destination_file_location
1322
1365
  # Specifies the location for the file being decrypted. Use
1323
- # `$\{Transfer:UserName\}` or `$\{Transfer:UploadDate\}` in this field
1324
- # to parametrize the destination prefix by username or uploaded date.
1366
+ # `${Transfer:UserName}` or `${Transfer:UploadDate}` in this field to
1367
+ # parametrize the destination prefix by username or uploaded date.
1325
1368
  #
1326
1369
  # * Set the value of `DestinationFileLocation` to
1327
- # `$\{Transfer:UserName\}` to decrypt uploaded files to an Amazon S3
1370
+ # `${Transfer:UserName}` to decrypt uploaded files to an Amazon S3
1328
1371
  # bucket that is prefixed with the name of the Transfer Family user
1329
1372
  # that uploaded the file.
1330
1373
  #
1331
1374
  # * Set the value of `DestinationFileLocation` to
1332
- # `$\{Transfer:UploadDate\}` to decrypt uploaded files to an Amazon
1333
- # S3 bucket that is prefixed with the date of the upload.
1375
+ # `${Transfer:UploadDate}` to decrypt uploaded files to an Amazon S3
1376
+ # bucket that is prefixed with the date of the upload.
1334
1377
  #
1335
1378
  # <note markdown="1"> The system resolves `UploadDate` to a date format of *YYYY-MM-DD*,
1336
1379
  # based on the date the file is uploaded in UTC.
@@ -1363,7 +1406,7 @@ module Aws::Transfer
1363
1406
  # you can view the SID values by running the following command using
1364
1407
  # Windows PowerShell.
1365
1408
  #
1366
- # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
1409
+ # `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"}
1367
1410
  # -Properties * | Select SamAccountName,ObjectSid`
1368
1411
  #
1369
1412
  # In that command, replace *YourGroupName* with the name of your
@@ -1504,12 +1547,12 @@ module Aws::Transfer
1504
1547
  # the output from the previous step, or the originally uploaded file
1505
1548
  # for the workflow.
1506
1549
  #
1507
- # * To use the previous file as the input, enter `$\{previous.file\}`.
1550
+ # * To use the previous file as the input, enter `${previous.file}`.
1508
1551
  # In this case, this workflow step uses the output file from the
1509
1552
  # previous workflow step as input. This is the default value.
1510
1553
  #
1511
1554
  # * To use the originally uploaded file location as input for this
1512
- # step, enter `$\{original.file\}`.
1555
+ # step, enter `${original.file}`.
1513
1556
  # @return [String]
1514
1557
  #
1515
1558
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteStepDetails AWS API Documentation
@@ -1540,6 +1583,31 @@ module Aws::Transfer
1540
1583
  include Aws::Structure
1541
1584
  end
1542
1585
 
1586
+ # @!attribute [rw] web_app_id
1587
+ # Provide the unique identifier for the web app that contains the
1588
+ # customizations that you are deleting.
1589
+ # @return [String]
1590
+ #
1591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteWebAppCustomizationRequest AWS API Documentation
1592
+ #
1593
+ class DeleteWebAppCustomizationRequest < Struct.new(
1594
+ :web_app_id)
1595
+ SENSITIVE = []
1596
+ include Aws::Structure
1597
+ end
1598
+
1599
+ # @!attribute [rw] web_app_id
1600
+ # Provide the unique identifier for the web app that you are deleting.
1601
+ # @return [String]
1602
+ #
1603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteWebAppRequest AWS API Documentation
1604
+ #
1605
+ class DeleteWebAppRequest < Struct.new(
1606
+ :web_app_id)
1607
+ SENSITIVE = []
1608
+ include Aws::Structure
1609
+ end
1610
+
1543
1611
  # @!attribute [rw] workflow_id
1544
1612
  # A unique identifier for the workflow.
1545
1613
  # @return [String]
@@ -1565,7 +1633,7 @@ module Aws::Transfer
1565
1633
  # you can view the SID values by running the following command using
1566
1634
  # Windows PowerShell.
1567
1635
  #
1568
- # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
1636
+ # `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"}
1569
1637
  # -Properties * | Select SamAccountName,ObjectSid`
1570
1638
  #
1571
1639
  # In that command, replace *YourGroupName* with the name of your
@@ -1862,6 +1930,55 @@ module Aws::Transfer
1862
1930
  include Aws::Structure
1863
1931
  end
1864
1932
 
1933
+ # @!attribute [rw] web_app_id
1934
+ # Provide the unique identifier for the web app.
1935
+ # @return [String]
1936
+ #
1937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWebAppCustomizationRequest AWS API Documentation
1938
+ #
1939
+ class DescribeWebAppCustomizationRequest < Struct.new(
1940
+ :web_app_id)
1941
+ SENSITIVE = []
1942
+ include Aws::Structure
1943
+ end
1944
+
1945
+ # @!attribute [rw] web_app_customization
1946
+ # Returns a structure that contains the details of the web app
1947
+ # customizations.
1948
+ # @return [Types::DescribedWebAppCustomization]
1949
+ #
1950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWebAppCustomizationResponse AWS API Documentation
1951
+ #
1952
+ class DescribeWebAppCustomizationResponse < Struct.new(
1953
+ :web_app_customization)
1954
+ SENSITIVE = []
1955
+ include Aws::Structure
1956
+ end
1957
+
1958
+ # @!attribute [rw] web_app_id
1959
+ # Provide the unique identifier for the web app.
1960
+ # @return [String]
1961
+ #
1962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWebAppRequest AWS API Documentation
1963
+ #
1964
+ class DescribeWebAppRequest < Struct.new(
1965
+ :web_app_id)
1966
+ SENSITIVE = []
1967
+ include Aws::Structure
1968
+ end
1969
+
1970
+ # @!attribute [rw] web_app
1971
+ # Returns a structure that contains the details of the web app.
1972
+ # @return [Types::DescribedWebApp]
1973
+ #
1974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWebAppResponse AWS API Documentation
1975
+ #
1976
+ class DescribeWebAppResponse < Struct.new(
1977
+ :web_app)
1978
+ SENSITIVE = []
1979
+ include Aws::Structure
1980
+ end
1981
+
1865
1982
  # @!attribute [rw] workflow_id
1866
1983
  # A unique identifier for the workflow.
1867
1984
  # @return [String]
@@ -1940,8 +2057,8 @@ module Aws::Transfer
1940
2057
  # and Access Management (IAM) role across multiple users. This policy
1941
2058
  # scopes down a user's access to portions of their Amazon S3 bucket.
1942
2059
  # Variables that you can use inside this policy include
1943
- # `$\{Transfer:UserName\}`, `$\{Transfer:HomeDirectory\}`, and
1944
- # `$\{Transfer:HomeBucket\}`.
2060
+ # `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and
2061
+ # `${Transfer:HomeBucket}`.
1945
2062
  # @return [String]
1946
2063
  #
1947
2064
  # @!attribute [rw] posix_profile
@@ -1972,7 +2089,7 @@ module Aws::Transfer
1972
2089
  # you can view the SID values by running the following command using
1973
2090
  # Windows PowerShell.
1974
2091
  #
1975
- # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
2092
+ # `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"}
1976
2093
  # -Properties * | Select SamAccountName,ObjectSid`
1977
2094
  #
1978
2095
  # In that command, replace *YourGroupName* with the name of your
@@ -2401,6 +2518,34 @@ module Aws::Transfer
2401
2518
  include Aws::Structure
2402
2519
  end
2403
2520
 
2521
+ # A structure that contains the details of the IAM Identity Center used
2522
+ # for your web app. Returned during a call to `DescribeWebApp`.
2523
+ #
2524
+ # @!attribute [rw] application_arn
2525
+ # The Amazon Resource Name (ARN) for the IAM Identity Center
2526
+ # application: this value is set automatically when you create your
2527
+ # web app.
2528
+ # @return [String]
2529
+ #
2530
+ # @!attribute [rw] instance_arn
2531
+ # The Amazon Resource Name (ARN) for the IAM Identity Center used for
2532
+ # the web app.
2533
+ # @return [String]
2534
+ #
2535
+ # @!attribute [rw] role
2536
+ # The IAM role in IAM Identity Center used for the web app.
2537
+ # @return [String]
2538
+ #
2539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedIdentityCenterConfig AWS API Documentation
2540
+ #
2541
+ class DescribedIdentityCenterConfig < Struct.new(
2542
+ :application_arn,
2543
+ :instance_arn,
2544
+ :role)
2545
+ SENSITIVE = []
2546
+ include Aws::Structure
2547
+ end
2548
+
2404
2549
  # The details for a local or partner AS2 profile.
2405
2550
  #
2406
2551
  # @!attribute [rw] arn
@@ -2866,8 +3011,8 @@ module Aws::Transfer
2866
3011
  # and Access Management (IAM) role across multiple users. This policy
2867
3012
  # scopes down a user's access to portions of their Amazon S3 bucket.
2868
3013
  # Variables that you can use inside this policy include
2869
- # `$\{Transfer:UserName\}`, `$\{Transfer:HomeDirectory\}`, and
2870
- # `$\{Transfer:HomeBucket\}`.
3014
+ # `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and
3015
+ # `${Transfer:HomeBucket}`.
2871
3016
  # @return [String]
2872
3017
  #
2873
3018
  # @!attribute [rw] posix_profile
@@ -2924,6 +3069,118 @@ module Aws::Transfer
2924
3069
  include Aws::Structure
2925
3070
  end
2926
3071
 
3072
+ # A structure that describes the parameters for the web app, as
3073
+ # identified by the `WebAppId`.
3074
+ #
3075
+ # @!attribute [rw] arn
3076
+ # The Amazon Resource Name (ARN) of the web app.
3077
+ # @return [String]
3078
+ #
3079
+ # @!attribute [rw] web_app_id
3080
+ # The unique identifier for the web app.
3081
+ # @return [String]
3082
+ #
3083
+ # @!attribute [rw] described_identity_provider_details
3084
+ # A structure that contains the details for the identity provider used
3085
+ # by the web app.
3086
+ # @return [Types::DescribedWebAppIdentityProviderDetails]
3087
+ #
3088
+ # @!attribute [rw] access_endpoint
3089
+ # The `AccessEndpoint` is the URL that you provide to your users for
3090
+ # them to interact with the Transfer Family web app. You can specify a
3091
+ # custom URL or use the default value.
3092
+ # @return [String]
3093
+ #
3094
+ # @!attribute [rw] web_app_endpoint
3095
+ # The `WebAppEndpoint` is the unique URL for your Transfer Family web
3096
+ # app. This is the value that you use when you configure **Origins**
3097
+ # on CloudFront.
3098
+ # @return [String]
3099
+ #
3100
+ # @!attribute [rw] web_app_units
3101
+ # A union that contains the value for number of concurrent connections
3102
+ # or the user sessions on your web app.
3103
+ # @return [Types::WebAppUnits]
3104
+ #
3105
+ # @!attribute [rw] tags
3106
+ # Key-value pairs that can be used to group and search for web apps.
3107
+ # Tags are metadata attached to web apps for any purpose.
3108
+ # @return [Array<Types::Tag>]
3109
+ #
3110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedWebApp AWS API Documentation
3111
+ #
3112
+ class DescribedWebApp < Struct.new(
3113
+ :arn,
3114
+ :web_app_id,
3115
+ :described_identity_provider_details,
3116
+ :access_endpoint,
3117
+ :web_app_endpoint,
3118
+ :web_app_units,
3119
+ :tags)
3120
+ SENSITIVE = []
3121
+ include Aws::Structure
3122
+ end
3123
+
3124
+ # A structure that contains the customization fields for the web app.
3125
+ # You can provide a title, logo, and icon to customize the appearance of
3126
+ # your web app.
3127
+ #
3128
+ # @!attribute [rw] arn
3129
+ # Returns the Amazon Resource Name (ARN) for the web app.
3130
+ # @return [String]
3131
+ #
3132
+ # @!attribute [rw] web_app_id
3133
+ # Returns the unique identifier for your web app.
3134
+ # @return [String]
3135
+ #
3136
+ # @!attribute [rw] title
3137
+ # Returns the page title that you defined for your web app.
3138
+ # @return [String]
3139
+ #
3140
+ # @!attribute [rw] logo_file
3141
+ # Returns a logo file data string (in base64 encoding).
3142
+ # @return [String]
3143
+ #
3144
+ # @!attribute [rw] favicon_file
3145
+ # Returns a icon file data string (in base64 encoding).
3146
+ # @return [String]
3147
+ #
3148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedWebAppCustomization AWS API Documentation
3149
+ #
3150
+ class DescribedWebAppCustomization < Struct.new(
3151
+ :arn,
3152
+ :web_app_id,
3153
+ :title,
3154
+ :logo_file,
3155
+ :favicon_file)
3156
+ SENSITIVE = [:logo_file, :favicon_file]
3157
+ include Aws::Structure
3158
+ end
3159
+
3160
+ # Returns a structure that contains the identity provider details for
3161
+ # your web app.
3162
+ #
3163
+ # @note DescribedWebAppIdentityProviderDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DescribedWebAppIdentityProviderDetails corresponding to the set member.
3164
+ #
3165
+ # @!attribute [rw] identity_center_config
3166
+ # Returns a structure for your identity provider details. This
3167
+ # structure contains the instance ARN and role being used for the web
3168
+ # app.
3169
+ # @return [Types::DescribedIdentityCenterConfig]
3170
+ #
3171
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedWebAppIdentityProviderDetails AWS API Documentation
3172
+ #
3173
+ class DescribedWebAppIdentityProviderDetails < Struct.new(
3174
+ :identity_center_config,
3175
+ :unknown)
3176
+ SENSITIVE = []
3177
+ include Aws::Structure
3178
+ include Aws::Structure::Union
3179
+
3180
+ class IdentityCenterConfig < DescribedWebAppIdentityProviderDetails; end
3181
+ class Unknown < DescribedWebAppIdentityProviderDetails; end
3182
+ end
3183
+
2927
3184
  # Describes the properties of the specified workflow
2928
3185
  #
2929
3186
  # @!attribute [rw] arn
@@ -3254,7 +3511,7 @@ module Aws::Transfer
3254
3511
  #
3255
3512
  # The following is an `Entry` and `Target` pair example for `chroot`.
3256
3513
  #
3257
- # `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
3514
+ # `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
3258
3515
  #
3259
3516
  # @!attribute [rw] entry
3260
3517
  # Represents an entry for `HomeDirectoryMappings`.
@@ -3287,6 +3544,27 @@ module Aws::Transfer
3287
3544
  include Aws::Structure
3288
3545
  end
3289
3546
 
3547
+ # A structure that describes the values to use for the IAM Identity
3548
+ # Center settings when you create or update a web app.
3549
+ #
3550
+ # @!attribute [rw] instance_arn
3551
+ # The Amazon Resource Name (ARN) for the IAM Identity Center used for
3552
+ # the web app.
3553
+ # @return [String]
3554
+ #
3555
+ # @!attribute [rw] role
3556
+ # The IAM role in IAM Identity Center used for the web app.
3557
+ # @return [String]
3558
+ #
3559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/IdentityCenterConfig AWS API Documentation
3560
+ #
3561
+ class IdentityCenterConfig < Struct.new(
3562
+ :instance_arn,
3563
+ :role)
3564
+ SENSITIVE = []
3565
+ include Aws::Structure
3566
+ end
3567
+
3290
3568
  # Returns information related to the type of user authentication that is
3291
3569
  # in use for a file transfer protocol-enabled server's users. A server
3292
3570
  # can have only one method of authentication.
@@ -3583,7 +3861,7 @@ module Aws::Transfer
3583
3861
  end
3584
3862
 
3585
3863
  # @!attribute [rw] max_results
3586
- # Specifies the maximum number of access SIDs to return.
3864
+ # The maximum number of items to return.
3587
3865
  # @return [Integer]
3588
3866
  #
3589
3867
  # @!attribute [rw] next_token
@@ -3636,7 +3914,7 @@ module Aws::Transfer
3636
3914
  end
3637
3915
 
3638
3916
  # @!attribute [rw] max_results
3639
- # The maximum number of agreements to return.
3917
+ # The maximum number of items to return.
3640
3918
  # @return [Integer]
3641
3919
  #
3642
3920
  # @!attribute [rw] next_token
@@ -3681,7 +3959,7 @@ module Aws::Transfer
3681
3959
  end
3682
3960
 
3683
3961
  # @!attribute [rw] max_results
3684
- # The maximum number of certificates to return.
3962
+ # The maximum number of items to return.
3685
3963
  # @return [Integer]
3686
3964
  #
3687
3965
  # @!attribute [rw] next_token
@@ -3720,7 +3998,7 @@ module Aws::Transfer
3720
3998
  end
3721
3999
 
3722
4000
  # @!attribute [rw] max_results
3723
- # The maximum number of connectors to return.
4001
+ # The maximum number of items to return.
3724
4002
  # @return [Integer]
3725
4003
  #
3726
4004
  # @!attribute [rw] next_token
@@ -3759,7 +4037,7 @@ module Aws::Transfer
3759
4037
  end
3760
4038
 
3761
4039
  # @!attribute [rw] max_results
3762
- # Specifies the maximum number of executions to return.
4040
+ # The maximum number of items to return.
3763
4041
  # @return [Integer]
3764
4042
  #
3765
4043
  # @!attribute [rw] next_token
@@ -3896,7 +4174,7 @@ module Aws::Transfer
3896
4174
  end
3897
4175
 
3898
4176
  # @!attribute [rw] max_results
3899
- # The maximum number of host keys to return.
4177
+ # The maximum number of items to return.
3900
4178
  # @return [Integer]
3901
4179
  #
3902
4180
  # @!attribute [rw] next_token
@@ -3945,7 +4223,7 @@ module Aws::Transfer
3945
4223
  end
3946
4224
 
3947
4225
  # @!attribute [rw] max_results
3948
- # The maximum number of profiles to return.
4226
+ # The maximum number of items to return.
3949
4227
  # @return [Integer]
3950
4228
  #
3951
4229
  # @!attribute [rw] next_token
@@ -4180,7 +4458,45 @@ module Aws::Transfer
4180
4458
  end
4181
4459
 
4182
4460
  # @!attribute [rw] max_results
4183
- # Specifies the maximum number of workflows to return.
4461
+ # The maximum number of items to return.
4462
+ # @return [Integer]
4463
+ #
4464
+ # @!attribute [rw] next_token
4465
+ # Returns the `NextToken` parameter in the output. You can then pass
4466
+ # the `NextToken` parameter in a subsequent command to continue
4467
+ # listing additional web apps.
4468
+ # @return [String]
4469
+ #
4470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListWebAppsRequest AWS API Documentation
4471
+ #
4472
+ class ListWebAppsRequest < Struct.new(
4473
+ :max_results,
4474
+ :next_token)
4475
+ SENSITIVE = []
4476
+ include Aws::Structure
4477
+ end
4478
+
4479
+ # @!attribute [rw] next_token
4480
+ # Provide this value for the `NextToken` parameter in a subsequent
4481
+ # command to continue listing additional web apps.
4482
+ # @return [String]
4483
+ #
4484
+ # @!attribute [rw] web_apps
4485
+ # Returns, for each listed web app, a structure that contains details
4486
+ # for the web app.
4487
+ # @return [Array<Types::ListedWebApp>]
4488
+ #
4489
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListWebAppsResponse AWS API Documentation
4490
+ #
4491
+ class ListWebAppsResponse < Struct.new(
4492
+ :next_token,
4493
+ :web_apps)
4494
+ SENSITIVE = []
4495
+ include Aws::Structure
4496
+ end
4497
+
4498
+ # @!attribute [rw] max_results
4499
+ # The maximum number of items to return.
4184
4500
  # @return [Integer]
4185
4501
  #
4186
4502
  # @!attribute [rw] next_token
@@ -4269,7 +4585,7 @@ module Aws::Transfer
4269
4585
  # you can view the SID values by running the following command using
4270
4586
  # Windows PowerShell.
4271
4587
  #
4272
- # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
4588
+ # `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"}
4273
4589
  # -Properties * | Select SamAccountName,ObjectSid`
4274
4590
  #
4275
4591
  # In that command, replace *YourGroupName* with the name of your
@@ -4721,6 +5037,39 @@ module Aws::Transfer
4721
5037
  include Aws::Structure
4722
5038
  end
4723
5039
 
5040
+ # a structure that contains details for the web app.
5041
+ #
5042
+ # @!attribute [rw] arn
5043
+ # The Amazon Resource Name (ARN) for the web app.
5044
+ # @return [String]
5045
+ #
5046
+ # @!attribute [rw] web_app_id
5047
+ # The unique identifier for the web app.
5048
+ # @return [String]
5049
+ #
5050
+ # @!attribute [rw] access_endpoint
5051
+ # The `AccessEndpoint` is the URL that you provide to your users for
5052
+ # them to interact with the Transfer Family web app. You can specify a
5053
+ # custom URL or use the default value.
5054
+ # @return [String]
5055
+ #
5056
+ # @!attribute [rw] web_app_endpoint
5057
+ # The `WebAppEndpoint` is the unique URL for your Transfer Family web
5058
+ # app. This is the value that you use when you configure **Origins**
5059
+ # on CloudFront.
5060
+ # @return [String]
5061
+ #
5062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedWebApp AWS API Documentation
5063
+ #
5064
+ class ListedWebApp < Struct.new(
5065
+ :arn,
5066
+ :web_app_id,
5067
+ :access_endpoint,
5068
+ :web_app_endpoint)
5069
+ SENSITIVE = []
5070
+ include Aws::Structure
5071
+ end
5072
+
4724
5073
  # Contains the identifier, text description, and Amazon Resource Name
4725
5074
  # (ARN) for the workflow.
4726
5075
  #
@@ -5424,12 +5773,12 @@ module Aws::Transfer
5424
5773
  # the output from the previous step, or the originally uploaded file
5425
5774
  # for the workflow.
5426
5775
  #
5427
- # * To use the previous file as the input, enter `$\{previous.file\}`.
5776
+ # * To use the previous file as the input, enter `${previous.file}`.
5428
5777
  # In this case, this workflow step uses the output file from the
5429
5778
  # previous workflow step as input. This is the default value.
5430
5779
  #
5431
5780
  # * To use the originally uploaded file location as input for this
5432
- # step, enter `$\{original.file\}`.
5781
+ # step, enter `${original.file}`.
5433
5782
  # @return [String]
5434
5783
  #
5435
5784
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagStepDetails AWS API Documentation
@@ -5645,8 +5994,8 @@ module Aws::Transfer
5645
5994
  #
5646
5995
  # The following is an `Entry` and `Target` pair example.
5647
5996
  #
5648
- # `[ \{ "Entry": "/directory1", "Target":
5649
- # "/bucket_name/home/mydirectory" \} ]`
5997
+ # `[ { "Entry": "/directory1", "Target":
5998
+ # "/bucket_name/home/mydirectory" } ]`
5650
5999
  #
5651
6000
  # In most cases, you can use this value instead of the session policy
5652
6001
  # to lock down your user to the designated home directory
@@ -5655,7 +6004,7 @@ module Aws::Transfer
5655
6004
  #
5656
6005
  # The following is an `Entry` and `Target` pair example for `chroot`.
5657
6006
  #
5658
- # `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
6007
+ # `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
5659
6008
  # @return [Array<Types::HomeDirectoryMapEntry>]
5660
6009
  #
5661
6010
  # @!attribute [rw] policy
@@ -5663,8 +6012,8 @@ module Aws::Transfer
5663
6012
  # and Access Management (IAM) role across multiple users. This policy
5664
6013
  # scopes down a user's access to portions of their Amazon S3 bucket.
5665
6014
  # Variables that you can use inside this policy include
5666
- # `$\{Transfer:UserName\}`, `$\{Transfer:HomeDirectory\}`, and
5667
- # `$\{Transfer:HomeBucket\}`.
6015
+ # `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and
6016
+ # `${Transfer:HomeBucket}`.
5668
6017
  #
5669
6018
  # <note markdown="1"> This policy applies only when the domain of `ServerId` is Amazon S3.
5670
6019
  # Amazon EFS does not use session policies.
@@ -5719,7 +6068,7 @@ module Aws::Transfer
5719
6068
  # you can view the SID values by running the following command using
5720
6069
  # Windows PowerShell.
5721
6070
  #
5722
- # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
6071
+ # `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"}
5723
6072
  # -Properties * | Select SamAccountName,ObjectSid`
5724
6073
  #
5725
6074
  # In that command, replace *YourGroupName* with the name of your
@@ -6309,7 +6658,7 @@ module Aws::Transfer
6309
6658
  # empty `OnUpload` object, as in the following example.
6310
6659
  #
6311
6660
  # `aws transfer update-server --server-id s-01234567890abcdef
6312
- # --workflow-details '\{"OnUpload":[]\}'`
6661
+ # --workflow-details '{"OnUpload":[]}'`
6313
6662
  # @return [Types::WorkflowDetails]
6314
6663
  #
6315
6664
  # @!attribute [rw] structured_log_destinations
@@ -6420,8 +6769,8 @@ module Aws::Transfer
6420
6769
  #
6421
6770
  # The following is an `Entry` and `Target` pair example.
6422
6771
  #
6423
- # `[ \{ "Entry": "/directory1", "Target":
6424
- # "/bucket_name/home/mydirectory" \} ]`
6772
+ # `[ { "Entry": "/directory1", "Target":
6773
+ # "/bucket_name/home/mydirectory" } ]`
6425
6774
  #
6426
6775
  # In most cases, you can use this value instead of the session policy
6427
6776
  # to lock down your user to the designated home directory
@@ -6430,7 +6779,7 @@ module Aws::Transfer
6430
6779
  #
6431
6780
  # The following is an `Entry` and `Target` pair example for `chroot`.
6432
6781
  #
6433
- # `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
6782
+ # `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
6434
6783
  # @return [Array<Types::HomeDirectoryMapEntry>]
6435
6784
  #
6436
6785
  # @!attribute [rw] policy
@@ -6438,8 +6787,8 @@ module Aws::Transfer
6438
6787
  # and Access Management (IAM) role across multiple users. This policy
6439
6788
  # scopes down a user's access to portions of their Amazon S3 bucket.
6440
6789
  # Variables that you can use inside this policy include
6441
- # `$\{Transfer:UserName\}`, `$\{Transfer:HomeDirectory\}`, and
6442
- # `$\{Transfer:HomeBucket\}`.
6790
+ # `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and
6791
+ # `${Transfer:HomeBucket}`.
6443
6792
  #
6444
6793
  # <note markdown="1"> This policy applies only when the domain of `ServerId` is Amazon S3.
6445
6794
  # Amazon EFS does not use session policies.
@@ -6534,6 +6883,125 @@ module Aws::Transfer
6534
6883
  include Aws::Structure
6535
6884
  end
6536
6885
 
6886
+ # @!attribute [rw] web_app_id
6887
+ # Provide the identifier of the web app that you are updating.
6888
+ # @return [String]
6889
+ #
6890
+ # @!attribute [rw] title
6891
+ # Provide an updated title.
6892
+ # @return [String]
6893
+ #
6894
+ # @!attribute [rw] logo_file
6895
+ # Specify logo file data string (in base64 encoding).
6896
+ # @return [String]
6897
+ #
6898
+ # @!attribute [rw] favicon_file
6899
+ # Specify icon file data string (in base64 encoding).
6900
+ # @return [String]
6901
+ #
6902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppCustomizationRequest AWS API Documentation
6903
+ #
6904
+ class UpdateWebAppCustomizationRequest < Struct.new(
6905
+ :web_app_id,
6906
+ :title,
6907
+ :logo_file,
6908
+ :favicon_file)
6909
+ SENSITIVE = [:logo_file, :favicon_file]
6910
+ include Aws::Structure
6911
+ end
6912
+
6913
+ # @!attribute [rw] web_app_id
6914
+ # Returns the unique identifier for the web app being updated.
6915
+ # @return [String]
6916
+ #
6917
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppCustomizationResponse AWS API Documentation
6918
+ #
6919
+ class UpdateWebAppCustomizationResponse < Struct.new(
6920
+ :web_app_id)
6921
+ SENSITIVE = []
6922
+ include Aws::Structure
6923
+ end
6924
+
6925
+ # A structure that describes the values to use for the IAM Identity
6926
+ # Center settings when you update a web app.
6927
+ #
6928
+ # @!attribute [rw] role
6929
+ # The IAM role used to access IAM Identity Center.
6930
+ # @return [String]
6931
+ #
6932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppIdentityCenterConfig AWS API Documentation
6933
+ #
6934
+ class UpdateWebAppIdentityCenterConfig < Struct.new(
6935
+ :role)
6936
+ SENSITIVE = []
6937
+ include Aws::Structure
6938
+ end
6939
+
6940
+ # A union that contains the `UpdateWebAppIdentityCenterConfig` object.
6941
+ #
6942
+ # @note UpdateWebAppIdentityProviderDetails is a union - when making an API calls you must set exactly one of the members.
6943
+ #
6944
+ # @!attribute [rw] identity_center_config
6945
+ # A structure that describes the values to use for the IAM Identity
6946
+ # Center settings when you update a web app.
6947
+ # @return [Types::UpdateWebAppIdentityCenterConfig]
6948
+ #
6949
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppIdentityProviderDetails AWS API Documentation
6950
+ #
6951
+ class UpdateWebAppIdentityProviderDetails < Struct.new(
6952
+ :identity_center_config,
6953
+ :unknown)
6954
+ SENSITIVE = []
6955
+ include Aws::Structure
6956
+ include Aws::Structure::Union
6957
+
6958
+ class IdentityCenterConfig < UpdateWebAppIdentityProviderDetails; end
6959
+ class Unknown < UpdateWebAppIdentityProviderDetails; end
6960
+ end
6961
+
6962
+ # @!attribute [rw] web_app_id
6963
+ # Provide the identifier of the web app that you are updating.
6964
+ # @return [String]
6965
+ #
6966
+ # @!attribute [rw] identity_provider_details
6967
+ # Provide updated identity provider values in a
6968
+ # `WebAppIdentityProviderDetails` object.
6969
+ # @return [Types::UpdateWebAppIdentityProviderDetails]
6970
+ #
6971
+ # @!attribute [rw] access_endpoint
6972
+ # The `AccessEndpoint` is the URL that you provide to your users for
6973
+ # them to interact with the Transfer Family web app. You can specify a
6974
+ # custom URL or use the default value.
6975
+ # @return [String]
6976
+ #
6977
+ # @!attribute [rw] web_app_units
6978
+ # A union that contains the value for number of concurrent connections
6979
+ # or the user sessions on your web app.
6980
+ # @return [Types::WebAppUnits]
6981
+ #
6982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppRequest AWS API Documentation
6983
+ #
6984
+ class UpdateWebAppRequest < Struct.new(
6985
+ :web_app_id,
6986
+ :identity_provider_details,
6987
+ :access_endpoint,
6988
+ :web_app_units)
6989
+ SENSITIVE = []
6990
+ include Aws::Structure
6991
+ end
6992
+
6993
+ # @!attribute [rw] web_app_id
6994
+ # Returns the unique identifier for the web app being updated.
6995
+ # @return [String]
6996
+ #
6997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppResponse AWS API Documentation
6998
+ #
6999
+ class UpdateWebAppResponse < Struct.new(
7000
+ :web_app_id)
7001
+ SENSITIVE = []
7002
+ include Aws::Structure
7003
+ end
7004
+
6537
7005
  # Specifies the user name, server ID, and session ID for a workflow.
6538
7006
  #
6539
7007
  # @!attribute [rw] user_name
@@ -6561,6 +7029,58 @@ module Aws::Transfer
6561
7029
  include Aws::Structure
6562
7030
  end
6563
7031
 
7032
+ # A union that contains the `IdentityCenterConfig` object.
7033
+ #
7034
+ # @note WebAppIdentityProviderDetails is a union - when making an API calls you must set exactly one of the members.
7035
+ #
7036
+ # @!attribute [rw] identity_center_config
7037
+ # A structure that describes the values to use for the IAM Identity
7038
+ # Center settings when you create a web app.
7039
+ # @return [Types::IdentityCenterConfig]
7040
+ #
7041
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WebAppIdentityProviderDetails AWS API Documentation
7042
+ #
7043
+ class WebAppIdentityProviderDetails < Struct.new(
7044
+ :identity_center_config,
7045
+ :unknown)
7046
+ SENSITIVE = []
7047
+ include Aws::Structure
7048
+ include Aws::Structure::Union
7049
+
7050
+ class IdentityCenterConfig < WebAppIdentityProviderDetails; end
7051
+ class Unknown < WebAppIdentityProviderDetails; end
7052
+ end
7053
+
7054
+ # Contains an integer value that represents the value for number of
7055
+ # concurrent connections or the user sessions on your web app.
7056
+ #
7057
+ # @note WebAppUnits is a union - when making an API calls you must set exactly one of the members.
7058
+ #
7059
+ # @note WebAppUnits is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of WebAppUnits corresponding to the set member.
7060
+ #
7061
+ # @!attribute [rw] provisioned
7062
+ # An integer that represents the number of units for your desired
7063
+ # number of concurrent connections, or the number of user sessions on
7064
+ # your web app at the same time.
7065
+ #
7066
+ # Each increment allows an additional 250 concurrent sessions: a value
7067
+ # of `1` sets the number of concurrent sessions to 250; `2` sets a
7068
+ # value of 500, and so on.
7069
+ # @return [Integer]
7070
+ #
7071
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WebAppUnits AWS API Documentation
7072
+ #
7073
+ class WebAppUnits < Struct.new(
7074
+ :provisioned,
7075
+ :unknown)
7076
+ SENSITIVE = []
7077
+ include Aws::Structure
7078
+ include Aws::Structure::Union
7079
+
7080
+ class Provisioned < WebAppUnits; end
7081
+ class Unknown < WebAppUnits; end
7082
+ end
7083
+
6564
7084
  # Specifies the workflow ID for the workflow to assign and the execution
6565
7085
  # role that's used for executing the workflow.
6566
7086
  #
@@ -6600,7 +7120,7 @@ module Aws::Transfer
6600
7120
  # empty `OnUpload` object, as in the following example.
6601
7121
  #
6602
7122
  # `aws transfer update-server --server-id s-01234567890abcdef
6603
- # --workflow-details '\{"OnUpload":[]\}'`
7123
+ # --workflow-details '{"OnUpload":[]}'`
6604
7124
  #
6605
7125
  # <note markdown="1"> `OnUpload` can contain a maximum of one `WorkflowDetail` object.
6606
7126
  #