aws-sdk-transfer 1.107.0 → 1.109.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/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-transfer/client.rb +379 -10
- data/lib/aws-sdk-transfer/client_api.rb +269 -0
- data/lib/aws-sdk-transfer/types.rb +634 -16
- data/lib/aws-sdk-transfer.rb +1 -1
- data/sig/client.rbs +111 -4
- data/sig/types.rbs +178 -0
- metadata +2 -2
@@ -119,6 +119,14 @@ module Aws::Transfer
|
|
119
119
|
# 'BasicAuthSecretId=""'`
|
120
120
|
# @return [String]
|
121
121
|
#
|
122
|
+
# @!attribute [rw] preserve_content_type
|
123
|
+
# Allows you to use the Amazon S3 `Content-Type` that is associated
|
124
|
+
# with objects in S3 instead of having the content type mapped based
|
125
|
+
# on the file extension. This parameter is enabled by default when you
|
126
|
+
# create an AS2 connector from the console, but disabled by default
|
127
|
+
# when you create an AS2 connector by calling the API directly.
|
128
|
+
# @return [String]
|
129
|
+
#
|
122
130
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/As2ConnectorConfig AWS API Documentation
|
123
131
|
#
|
124
132
|
class As2ConnectorConfig < Struct.new(
|
@@ -130,7 +138,8 @@ module Aws::Transfer
|
|
130
138
|
:signing_algorithm,
|
131
139
|
:mdn_signing_algorithm,
|
132
140
|
:mdn_response,
|
133
|
-
:basic_auth_secret_id
|
141
|
+
:basic_auth_secret_id,
|
142
|
+
:preserve_content_type)
|
134
143
|
SENSITIVE = []
|
135
144
|
include Aws::Structure
|
136
145
|
end
|
@@ -480,6 +489,34 @@ module Aws::Transfer
|
|
480
489
|
# Key-value pairs that can be used to group and search for agreements.
|
481
490
|
# @return [Array<Types::Tag>]
|
482
491
|
#
|
492
|
+
# @!attribute [rw] preserve_filename
|
493
|
+
# Determines whether or not Transfer Family appends a unique string of
|
494
|
+
# characters to the end of the AS2 message payload filename when
|
495
|
+
# saving it.
|
496
|
+
#
|
497
|
+
# * `ENABLED`: the filename provided by your trading parter is
|
498
|
+
# preserved when the file is saved.
|
499
|
+
#
|
500
|
+
# * `DISABLED` (default value): when Transfer Family saves the file,
|
501
|
+
# the filename is adjusted, as described in [File names and
|
502
|
+
# locations][1].
|
503
|
+
#
|
504
|
+
#
|
505
|
+
#
|
506
|
+
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2
|
507
|
+
# @return [String]
|
508
|
+
#
|
509
|
+
# @!attribute [rw] enforce_message_signing
|
510
|
+
# Determines whether or not unsigned messages from your trading
|
511
|
+
# partners will be accepted.
|
512
|
+
#
|
513
|
+
# * `ENABLED`: Transfer Family rejects unsigned messages from your
|
514
|
+
# trading partner.
|
515
|
+
#
|
516
|
+
# * `DISABLED` (default value): Transfer Family accepts unsigned
|
517
|
+
# messages from your trading partner.
|
518
|
+
# @return [String]
|
519
|
+
#
|
483
520
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateAgreementRequest AWS API Documentation
|
484
521
|
#
|
485
522
|
class CreateAgreementRequest < Struct.new(
|
@@ -490,7 +527,9 @@ module Aws::Transfer
|
|
490
527
|
:base_directory,
|
491
528
|
:access_role,
|
492
529
|
:status,
|
493
|
-
:tags
|
530
|
+
:tags,
|
531
|
+
:preserve_filename,
|
532
|
+
:enforce_message_signing)
|
494
533
|
SENSITIVE = []
|
495
534
|
include Aws::Structure
|
496
535
|
end
|
@@ -792,7 +831,7 @@ module Aws::Transfer
|
|
792
831
|
# `API_GATEWAY`. Accepts an array containing all of the information
|
793
832
|
# required to use a directory in `AWS_DIRECTORY_SERVICE` or invoke a
|
794
833
|
# customer-supplied authentication API, including the API Gateway URL.
|
795
|
-
#
|
834
|
+
# Cannot be specified when `IdentityProviderType` is set to
|
796
835
|
# `SERVICE_MANAGED`.
|
797
836
|
# @return [Types::IdentityProviderDetails]
|
798
837
|
#
|
@@ -1172,6 +1211,49 @@ module Aws::Transfer
|
|
1172
1211
|
include Aws::Structure
|
1173
1212
|
end
|
1174
1213
|
|
1214
|
+
# @!attribute [rw] identity_provider_details
|
1215
|
+
# You can provide a structure that contains the details for the
|
1216
|
+
# identity provider to use with your web app.
|
1217
|
+
# @return [Types::WebAppIdentityProviderDetails]
|
1218
|
+
#
|
1219
|
+
# @!attribute [rw] access_endpoint
|
1220
|
+
# The `AccessEndpoint` is the URL that you provide to your users for
|
1221
|
+
# them to interact with the Transfer Family web app. You can specify a
|
1222
|
+
# custom URL or use the default value.
|
1223
|
+
# @return [String]
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] web_app_units
|
1226
|
+
# A union that contains the value for number of concurrent connections
|
1227
|
+
# or the user sessions on your web app.
|
1228
|
+
# @return [Types::WebAppUnits]
|
1229
|
+
#
|
1230
|
+
# @!attribute [rw] tags
|
1231
|
+
# Key-value pairs that can be used to group and search for web apps.
|
1232
|
+
# @return [Array<Types::Tag>]
|
1233
|
+
#
|
1234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateWebAppRequest AWS API Documentation
|
1235
|
+
#
|
1236
|
+
class CreateWebAppRequest < Struct.new(
|
1237
|
+
:identity_provider_details,
|
1238
|
+
:access_endpoint,
|
1239
|
+
:web_app_units,
|
1240
|
+
:tags)
|
1241
|
+
SENSITIVE = []
|
1242
|
+
include Aws::Structure
|
1243
|
+
end
|
1244
|
+
|
1245
|
+
# @!attribute [rw] web_app_id
|
1246
|
+
# Returns a unique identifier for the web app.
|
1247
|
+
# @return [String]
|
1248
|
+
#
|
1249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateWebAppResponse AWS API Documentation
|
1250
|
+
#
|
1251
|
+
class CreateWebAppResponse < Struct.new(
|
1252
|
+
:web_app_id)
|
1253
|
+
SENSITIVE = []
|
1254
|
+
include Aws::Structure
|
1255
|
+
end
|
1256
|
+
|
1175
1257
|
# @!attribute [rw] description
|
1176
1258
|
# A textual description for the workflow.
|
1177
1259
|
# @return [String]
|
@@ -1540,6 +1622,31 @@ module Aws::Transfer
|
|
1540
1622
|
include Aws::Structure
|
1541
1623
|
end
|
1542
1624
|
|
1625
|
+
# @!attribute [rw] web_app_id
|
1626
|
+
# Provide the unique identifier for the web app that contains the
|
1627
|
+
# customizations that you are deleting.
|
1628
|
+
# @return [String]
|
1629
|
+
#
|
1630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteWebAppCustomizationRequest AWS API Documentation
|
1631
|
+
#
|
1632
|
+
class DeleteWebAppCustomizationRequest < Struct.new(
|
1633
|
+
:web_app_id)
|
1634
|
+
SENSITIVE = []
|
1635
|
+
include Aws::Structure
|
1636
|
+
end
|
1637
|
+
|
1638
|
+
# @!attribute [rw] web_app_id
|
1639
|
+
# Provide the unique identifier for the web app that you are deleting.
|
1640
|
+
# @return [String]
|
1641
|
+
#
|
1642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteWebAppRequest AWS API Documentation
|
1643
|
+
#
|
1644
|
+
class DeleteWebAppRequest < Struct.new(
|
1645
|
+
:web_app_id)
|
1646
|
+
SENSITIVE = []
|
1647
|
+
include Aws::Structure
|
1648
|
+
end
|
1649
|
+
|
1543
1650
|
# @!attribute [rw] workflow_id
|
1544
1651
|
# A unique identifier for the workflow.
|
1545
1652
|
# @return [String]
|
@@ -1862,6 +1969,55 @@ module Aws::Transfer
|
|
1862
1969
|
include Aws::Structure
|
1863
1970
|
end
|
1864
1971
|
|
1972
|
+
# @!attribute [rw] web_app_id
|
1973
|
+
# Provide the unique identifier for the web app.
|
1974
|
+
# @return [String]
|
1975
|
+
#
|
1976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWebAppCustomizationRequest AWS API Documentation
|
1977
|
+
#
|
1978
|
+
class DescribeWebAppCustomizationRequest < Struct.new(
|
1979
|
+
:web_app_id)
|
1980
|
+
SENSITIVE = []
|
1981
|
+
include Aws::Structure
|
1982
|
+
end
|
1983
|
+
|
1984
|
+
# @!attribute [rw] web_app_customization
|
1985
|
+
# Returns a structure that contains the details of the web app
|
1986
|
+
# customizations.
|
1987
|
+
# @return [Types::DescribedWebAppCustomization]
|
1988
|
+
#
|
1989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWebAppCustomizationResponse AWS API Documentation
|
1990
|
+
#
|
1991
|
+
class DescribeWebAppCustomizationResponse < Struct.new(
|
1992
|
+
:web_app_customization)
|
1993
|
+
SENSITIVE = []
|
1994
|
+
include Aws::Structure
|
1995
|
+
end
|
1996
|
+
|
1997
|
+
# @!attribute [rw] web_app_id
|
1998
|
+
# Provide the unique identifier for the web app.
|
1999
|
+
# @return [String]
|
2000
|
+
#
|
2001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWebAppRequest AWS API Documentation
|
2002
|
+
#
|
2003
|
+
class DescribeWebAppRequest < Struct.new(
|
2004
|
+
:web_app_id)
|
2005
|
+
SENSITIVE = []
|
2006
|
+
include Aws::Structure
|
2007
|
+
end
|
2008
|
+
|
2009
|
+
# @!attribute [rw] web_app
|
2010
|
+
# Returns a structure that contains the details of the web app.
|
2011
|
+
# @return [Types::DescribedWebApp]
|
2012
|
+
#
|
2013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWebAppResponse AWS API Documentation
|
2014
|
+
#
|
2015
|
+
class DescribeWebAppResponse < Struct.new(
|
2016
|
+
:web_app)
|
2017
|
+
SENSITIVE = []
|
2018
|
+
include Aws::Structure
|
2019
|
+
end
|
2020
|
+
|
1865
2021
|
# @!attribute [rw] workflow_id
|
1866
2022
|
# A unique identifier for the workflow.
|
1867
2023
|
# @return [String]
|
@@ -2076,6 +2232,34 @@ module Aws::Transfer
|
|
2076
2232
|
# Key-value pairs that can be used to group and search for agreements.
|
2077
2233
|
# @return [Array<Types::Tag>]
|
2078
2234
|
#
|
2235
|
+
# @!attribute [rw] preserve_filename
|
2236
|
+
# Determines whether or not Transfer Family appends a unique string of
|
2237
|
+
# characters to the end of the AS2 message payload filename when
|
2238
|
+
# saving it.
|
2239
|
+
#
|
2240
|
+
# * `ENABLED`: the filename provided by your trading parter is
|
2241
|
+
# preserved when the file is saved.
|
2242
|
+
#
|
2243
|
+
# * `DISABLED` (default value): when Transfer Family saves the file,
|
2244
|
+
# the filename is adjusted, as described in [File names and
|
2245
|
+
# locations][1].
|
2246
|
+
#
|
2247
|
+
#
|
2248
|
+
#
|
2249
|
+
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2
|
2250
|
+
# @return [String]
|
2251
|
+
#
|
2252
|
+
# @!attribute [rw] enforce_message_signing
|
2253
|
+
# Determines whether or not unsigned messages from your trading
|
2254
|
+
# partners will be accepted.
|
2255
|
+
#
|
2256
|
+
# * `ENABLED`: Transfer Family rejects unsigned messages from your
|
2257
|
+
# trading partner.
|
2258
|
+
#
|
2259
|
+
# * `DISABLED` (default value): Transfer Family accepts unsigned
|
2260
|
+
# messages from your trading partner.
|
2261
|
+
# @return [String]
|
2262
|
+
#
|
2079
2263
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedAgreement AWS API Documentation
|
2080
2264
|
#
|
2081
2265
|
class DescribedAgreement < Struct.new(
|
@@ -2088,7 +2272,9 @@ module Aws::Transfer
|
|
2088
2272
|
:partner_profile_id,
|
2089
2273
|
:base_directory,
|
2090
2274
|
:access_role,
|
2091
|
-
:tags
|
2275
|
+
:tags,
|
2276
|
+
:preserve_filename,
|
2277
|
+
:enforce_message_signing)
|
2092
2278
|
SENSITIVE = []
|
2093
2279
|
include Aws::Structure
|
2094
2280
|
end
|
@@ -2116,9 +2302,8 @@ module Aws::Transfer
|
|
2116
2302
|
# @return [String]
|
2117
2303
|
#
|
2118
2304
|
# @!attribute [rw] status
|
2119
|
-
#
|
2120
|
-
#
|
2121
|
-
# replace the current certificate when it expires.
|
2305
|
+
# Currently, the only available status is `ACTIVE`: all other values
|
2306
|
+
# are reserved for future use.
|
2122
2307
|
# @return [String]
|
2123
2308
|
#
|
2124
2309
|
# @!attribute [rw] certificate
|
@@ -2401,6 +2586,34 @@ module Aws::Transfer
|
|
2401
2586
|
include Aws::Structure
|
2402
2587
|
end
|
2403
2588
|
|
2589
|
+
# A structure that contains the details of the IAM Identity Center used
|
2590
|
+
# for your web app. Returned during a call to `DescribeWebApp`.
|
2591
|
+
#
|
2592
|
+
# @!attribute [rw] application_arn
|
2593
|
+
# The Amazon Resource Name (ARN) for the IAM Identity Center
|
2594
|
+
# application: this value is set automatically when you create your
|
2595
|
+
# web app.
|
2596
|
+
# @return [String]
|
2597
|
+
#
|
2598
|
+
# @!attribute [rw] instance_arn
|
2599
|
+
# The Amazon Resource Name (ARN) for the IAM Identity Center used for
|
2600
|
+
# the web app.
|
2601
|
+
# @return [String]
|
2602
|
+
#
|
2603
|
+
# @!attribute [rw] role
|
2604
|
+
# The IAM role in IAM Identity Center used for the web app.
|
2605
|
+
# @return [String]
|
2606
|
+
#
|
2607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedIdentityCenterConfig AWS API Documentation
|
2608
|
+
#
|
2609
|
+
class DescribedIdentityCenterConfig < Struct.new(
|
2610
|
+
:application_arn,
|
2611
|
+
:instance_arn,
|
2612
|
+
:role)
|
2613
|
+
SENSITIVE = []
|
2614
|
+
include Aws::Structure
|
2615
|
+
end
|
2616
|
+
|
2404
2617
|
# The details for a local or partner AS2 profile.
|
2405
2618
|
#
|
2406
2619
|
# @!attribute [rw] arn
|
@@ -2924,6 +3137,118 @@ module Aws::Transfer
|
|
2924
3137
|
include Aws::Structure
|
2925
3138
|
end
|
2926
3139
|
|
3140
|
+
# A structure that describes the parameters for the web app, as
|
3141
|
+
# identified by the `WebAppId`.
|
3142
|
+
#
|
3143
|
+
# @!attribute [rw] arn
|
3144
|
+
# The Amazon Resource Name (ARN) of the web app.
|
3145
|
+
# @return [String]
|
3146
|
+
#
|
3147
|
+
# @!attribute [rw] web_app_id
|
3148
|
+
# The unique identifier for the web app.
|
3149
|
+
# @return [String]
|
3150
|
+
#
|
3151
|
+
# @!attribute [rw] described_identity_provider_details
|
3152
|
+
# A structure that contains the details for the identity provider used
|
3153
|
+
# by the web app.
|
3154
|
+
# @return [Types::DescribedWebAppIdentityProviderDetails]
|
3155
|
+
#
|
3156
|
+
# @!attribute [rw] access_endpoint
|
3157
|
+
# The `AccessEndpoint` is the URL that you provide to your users for
|
3158
|
+
# them to interact with the Transfer Family web app. You can specify a
|
3159
|
+
# custom URL or use the default value.
|
3160
|
+
# @return [String]
|
3161
|
+
#
|
3162
|
+
# @!attribute [rw] web_app_endpoint
|
3163
|
+
# The `WebAppEndpoint` is the unique URL for your Transfer Family web
|
3164
|
+
# app. This is the value that you use when you configure **Origins**
|
3165
|
+
# on CloudFront.
|
3166
|
+
# @return [String]
|
3167
|
+
#
|
3168
|
+
# @!attribute [rw] web_app_units
|
3169
|
+
# A union that contains the value for number of concurrent connections
|
3170
|
+
# or the user sessions on your web app.
|
3171
|
+
# @return [Types::WebAppUnits]
|
3172
|
+
#
|
3173
|
+
# @!attribute [rw] tags
|
3174
|
+
# Key-value pairs that can be used to group and search for web apps.
|
3175
|
+
# Tags are metadata attached to web apps for any purpose.
|
3176
|
+
# @return [Array<Types::Tag>]
|
3177
|
+
#
|
3178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedWebApp AWS API Documentation
|
3179
|
+
#
|
3180
|
+
class DescribedWebApp < Struct.new(
|
3181
|
+
:arn,
|
3182
|
+
:web_app_id,
|
3183
|
+
:described_identity_provider_details,
|
3184
|
+
:access_endpoint,
|
3185
|
+
:web_app_endpoint,
|
3186
|
+
:web_app_units,
|
3187
|
+
:tags)
|
3188
|
+
SENSITIVE = []
|
3189
|
+
include Aws::Structure
|
3190
|
+
end
|
3191
|
+
|
3192
|
+
# A structure that contains the customization fields for the web app.
|
3193
|
+
# You can provide a title, logo, and icon to customize the appearance of
|
3194
|
+
# your web app.
|
3195
|
+
#
|
3196
|
+
# @!attribute [rw] arn
|
3197
|
+
# Returns the Amazon Resource Name (ARN) for the web app.
|
3198
|
+
# @return [String]
|
3199
|
+
#
|
3200
|
+
# @!attribute [rw] web_app_id
|
3201
|
+
# Returns the unique identifier for your web app.
|
3202
|
+
# @return [String]
|
3203
|
+
#
|
3204
|
+
# @!attribute [rw] title
|
3205
|
+
# Returns the page title that you defined for your web app.
|
3206
|
+
# @return [String]
|
3207
|
+
#
|
3208
|
+
# @!attribute [rw] logo_file
|
3209
|
+
# Returns a logo file data string (in base64 encoding).
|
3210
|
+
# @return [String]
|
3211
|
+
#
|
3212
|
+
# @!attribute [rw] favicon_file
|
3213
|
+
# Returns a icon file data string (in base64 encoding).
|
3214
|
+
# @return [String]
|
3215
|
+
#
|
3216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedWebAppCustomization AWS API Documentation
|
3217
|
+
#
|
3218
|
+
class DescribedWebAppCustomization < Struct.new(
|
3219
|
+
:arn,
|
3220
|
+
:web_app_id,
|
3221
|
+
:title,
|
3222
|
+
:logo_file,
|
3223
|
+
:favicon_file)
|
3224
|
+
SENSITIVE = [:logo_file, :favicon_file]
|
3225
|
+
include Aws::Structure
|
3226
|
+
end
|
3227
|
+
|
3228
|
+
# Returns a structure that contains the identity provider details for
|
3229
|
+
# your web app.
|
3230
|
+
#
|
3231
|
+
# @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.
|
3232
|
+
#
|
3233
|
+
# @!attribute [rw] identity_center_config
|
3234
|
+
# Returns a structure for your identity provider details. This
|
3235
|
+
# structure contains the instance ARN and role being used for the web
|
3236
|
+
# app.
|
3237
|
+
# @return [Types::DescribedIdentityCenterConfig]
|
3238
|
+
#
|
3239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedWebAppIdentityProviderDetails AWS API Documentation
|
3240
|
+
#
|
3241
|
+
class DescribedWebAppIdentityProviderDetails < Struct.new(
|
3242
|
+
:identity_center_config,
|
3243
|
+
:unknown)
|
3244
|
+
SENSITIVE = []
|
3245
|
+
include Aws::Structure
|
3246
|
+
include Aws::Structure::Union
|
3247
|
+
|
3248
|
+
class IdentityCenterConfig < DescribedWebAppIdentityProviderDetails; end
|
3249
|
+
class Unknown < DescribedWebAppIdentityProviderDetails; end
|
3250
|
+
end
|
3251
|
+
|
2927
3252
|
# Describes the properties of the specified workflow
|
2928
3253
|
#
|
2929
3254
|
# @!attribute [rw] arn
|
@@ -3287,6 +3612,27 @@ module Aws::Transfer
|
|
3287
3612
|
include Aws::Structure
|
3288
3613
|
end
|
3289
3614
|
|
3615
|
+
# A structure that describes the values to use for the IAM Identity
|
3616
|
+
# Center settings when you create or update a web app.
|
3617
|
+
#
|
3618
|
+
# @!attribute [rw] instance_arn
|
3619
|
+
# The Amazon Resource Name (ARN) for the IAM Identity Center used for
|
3620
|
+
# the web app.
|
3621
|
+
# @return [String]
|
3622
|
+
#
|
3623
|
+
# @!attribute [rw] role
|
3624
|
+
# The IAM role in IAM Identity Center used for the web app.
|
3625
|
+
# @return [String]
|
3626
|
+
#
|
3627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/IdentityCenterConfig AWS API Documentation
|
3628
|
+
#
|
3629
|
+
class IdentityCenterConfig < Struct.new(
|
3630
|
+
:instance_arn,
|
3631
|
+
:role)
|
3632
|
+
SENSITIVE = []
|
3633
|
+
include Aws::Structure
|
3634
|
+
end
|
3635
|
+
|
3290
3636
|
# Returns information related to the type of user authentication that is
|
3291
3637
|
# in use for a file transfer protocol-enabled server's users. A server
|
3292
3638
|
# can have only one method of authentication.
|
@@ -3583,7 +3929,7 @@ module Aws::Transfer
|
|
3583
3929
|
end
|
3584
3930
|
|
3585
3931
|
# @!attribute [rw] max_results
|
3586
|
-
#
|
3932
|
+
# The maximum number of items to return.
|
3587
3933
|
# @return [Integer]
|
3588
3934
|
#
|
3589
3935
|
# @!attribute [rw] next_token
|
@@ -3636,7 +3982,7 @@ module Aws::Transfer
|
|
3636
3982
|
end
|
3637
3983
|
|
3638
3984
|
# @!attribute [rw] max_results
|
3639
|
-
# The maximum number of
|
3985
|
+
# The maximum number of items to return.
|
3640
3986
|
# @return [Integer]
|
3641
3987
|
#
|
3642
3988
|
# @!attribute [rw] next_token
|
@@ -3681,7 +4027,7 @@ module Aws::Transfer
|
|
3681
4027
|
end
|
3682
4028
|
|
3683
4029
|
# @!attribute [rw] max_results
|
3684
|
-
# The maximum number of
|
4030
|
+
# The maximum number of items to return.
|
3685
4031
|
# @return [Integer]
|
3686
4032
|
#
|
3687
4033
|
# @!attribute [rw] next_token
|
@@ -3720,7 +4066,7 @@ module Aws::Transfer
|
|
3720
4066
|
end
|
3721
4067
|
|
3722
4068
|
# @!attribute [rw] max_results
|
3723
|
-
# The maximum number of
|
4069
|
+
# The maximum number of items to return.
|
3724
4070
|
# @return [Integer]
|
3725
4071
|
#
|
3726
4072
|
# @!attribute [rw] next_token
|
@@ -3759,7 +4105,7 @@ module Aws::Transfer
|
|
3759
4105
|
end
|
3760
4106
|
|
3761
4107
|
# @!attribute [rw] max_results
|
3762
|
-
#
|
4108
|
+
# The maximum number of items to return.
|
3763
4109
|
# @return [Integer]
|
3764
4110
|
#
|
3765
4111
|
# @!attribute [rw] next_token
|
@@ -3896,7 +4242,7 @@ module Aws::Transfer
|
|
3896
4242
|
end
|
3897
4243
|
|
3898
4244
|
# @!attribute [rw] max_results
|
3899
|
-
# The maximum number of
|
4245
|
+
# The maximum number of items to return.
|
3900
4246
|
# @return [Integer]
|
3901
4247
|
#
|
3902
4248
|
# @!attribute [rw] next_token
|
@@ -3945,7 +4291,7 @@ module Aws::Transfer
|
|
3945
4291
|
end
|
3946
4292
|
|
3947
4293
|
# @!attribute [rw] max_results
|
3948
|
-
# The maximum number of
|
4294
|
+
# The maximum number of items to return.
|
3949
4295
|
# @return [Integer]
|
3950
4296
|
#
|
3951
4297
|
# @!attribute [rw] next_token
|
@@ -4180,7 +4526,45 @@ module Aws::Transfer
|
|
4180
4526
|
end
|
4181
4527
|
|
4182
4528
|
# @!attribute [rw] max_results
|
4183
|
-
#
|
4529
|
+
# The maximum number of items to return.
|
4530
|
+
# @return [Integer]
|
4531
|
+
#
|
4532
|
+
# @!attribute [rw] next_token
|
4533
|
+
# Returns the `NextToken` parameter in the output. You can then pass
|
4534
|
+
# the `NextToken` parameter in a subsequent command to continue
|
4535
|
+
# listing additional web apps.
|
4536
|
+
# @return [String]
|
4537
|
+
#
|
4538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListWebAppsRequest AWS API Documentation
|
4539
|
+
#
|
4540
|
+
class ListWebAppsRequest < Struct.new(
|
4541
|
+
:max_results,
|
4542
|
+
:next_token)
|
4543
|
+
SENSITIVE = []
|
4544
|
+
include Aws::Structure
|
4545
|
+
end
|
4546
|
+
|
4547
|
+
# @!attribute [rw] next_token
|
4548
|
+
# Provide this value for the `NextToken` parameter in a subsequent
|
4549
|
+
# command to continue listing additional web apps.
|
4550
|
+
# @return [String]
|
4551
|
+
#
|
4552
|
+
# @!attribute [rw] web_apps
|
4553
|
+
# Returns, for each listed web app, a structure that contains details
|
4554
|
+
# for the web app.
|
4555
|
+
# @return [Array<Types::ListedWebApp>]
|
4556
|
+
#
|
4557
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListWebAppsResponse AWS API Documentation
|
4558
|
+
#
|
4559
|
+
class ListWebAppsResponse < Struct.new(
|
4560
|
+
:next_token,
|
4561
|
+
:web_apps)
|
4562
|
+
SENSITIVE = []
|
4563
|
+
include Aws::Structure
|
4564
|
+
end
|
4565
|
+
|
4566
|
+
# @!attribute [rw] max_results
|
4567
|
+
# The maximum number of items to return.
|
4184
4568
|
# @return [Integer]
|
4185
4569
|
#
|
4186
4570
|
# @!attribute [rw] next_token
|
@@ -4721,6 +5105,39 @@ module Aws::Transfer
|
|
4721
5105
|
include Aws::Structure
|
4722
5106
|
end
|
4723
5107
|
|
5108
|
+
# a structure that contains details for the web app.
|
5109
|
+
#
|
5110
|
+
# @!attribute [rw] arn
|
5111
|
+
# The Amazon Resource Name (ARN) for the web app.
|
5112
|
+
# @return [String]
|
5113
|
+
#
|
5114
|
+
# @!attribute [rw] web_app_id
|
5115
|
+
# The unique identifier for the web app.
|
5116
|
+
# @return [String]
|
5117
|
+
#
|
5118
|
+
# @!attribute [rw] access_endpoint
|
5119
|
+
# The `AccessEndpoint` is the URL that you provide to your users for
|
5120
|
+
# them to interact with the Transfer Family web app. You can specify a
|
5121
|
+
# custom URL or use the default value.
|
5122
|
+
# @return [String]
|
5123
|
+
#
|
5124
|
+
# @!attribute [rw] web_app_endpoint
|
5125
|
+
# The `WebAppEndpoint` is the unique URL for your Transfer Family web
|
5126
|
+
# app. This is the value that you use when you configure **Origins**
|
5127
|
+
# on CloudFront.
|
5128
|
+
# @return [String]
|
5129
|
+
#
|
5130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedWebApp AWS API Documentation
|
5131
|
+
#
|
5132
|
+
class ListedWebApp < Struct.new(
|
5133
|
+
:arn,
|
5134
|
+
:web_app_id,
|
5135
|
+
:access_endpoint,
|
5136
|
+
:web_app_endpoint)
|
5137
|
+
SENSITIVE = []
|
5138
|
+
include Aws::Structure
|
5139
|
+
end
|
5140
|
+
|
4724
5141
|
# Contains the identifier, text description, and Amazon Resource Name
|
4725
5142
|
# (ARN) for the workflow.
|
4726
5143
|
#
|
@@ -5838,6 +6255,34 @@ module Aws::Transfer
|
|
5838
6255
|
# Manager.
|
5839
6256
|
# @return [String]
|
5840
6257
|
#
|
6258
|
+
# @!attribute [rw] preserve_filename
|
6259
|
+
# Determines whether or not Transfer Family appends a unique string of
|
6260
|
+
# characters to the end of the AS2 message payload filename when
|
6261
|
+
# saving it.
|
6262
|
+
#
|
6263
|
+
# * `ENABLED`: the filename provided by your trading parter is
|
6264
|
+
# preserved when the file is saved.
|
6265
|
+
#
|
6266
|
+
# * `DISABLED` (default value): when Transfer Family saves the file,
|
6267
|
+
# the filename is adjusted, as described in [File names and
|
6268
|
+
# locations][1].
|
6269
|
+
#
|
6270
|
+
#
|
6271
|
+
#
|
6272
|
+
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2
|
6273
|
+
# @return [String]
|
6274
|
+
#
|
6275
|
+
# @!attribute [rw] enforce_message_signing
|
6276
|
+
# Determines whether or not unsigned messages from your trading
|
6277
|
+
# partners will be accepted.
|
6278
|
+
#
|
6279
|
+
# * `ENABLED`: Transfer Family rejects unsigned messages from your
|
6280
|
+
# trading partner.
|
6281
|
+
#
|
6282
|
+
# * `DISABLED` (default value): Transfer Family accepts unsigned
|
6283
|
+
# messages from your trading partner.
|
6284
|
+
# @return [String]
|
6285
|
+
#
|
5841
6286
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateAgreementRequest AWS API Documentation
|
5842
6287
|
#
|
5843
6288
|
class UpdateAgreementRequest < Struct.new(
|
@@ -5848,7 +6293,9 @@ module Aws::Transfer
|
|
5848
6293
|
:local_profile_id,
|
5849
6294
|
:partner_profile_id,
|
5850
6295
|
:base_directory,
|
5851
|
-
:access_role
|
6296
|
+
:access_role,
|
6297
|
+
:preserve_filename,
|
6298
|
+
:enforce_message_signing)
|
5852
6299
|
SENSITIVE = []
|
5853
6300
|
include Aws::Structure
|
5854
6301
|
end
|
@@ -6534,6 +6981,125 @@ module Aws::Transfer
|
|
6534
6981
|
include Aws::Structure
|
6535
6982
|
end
|
6536
6983
|
|
6984
|
+
# @!attribute [rw] web_app_id
|
6985
|
+
# Provide the identifier of the web app that you are updating.
|
6986
|
+
# @return [String]
|
6987
|
+
#
|
6988
|
+
# @!attribute [rw] title
|
6989
|
+
# Provide an updated title.
|
6990
|
+
# @return [String]
|
6991
|
+
#
|
6992
|
+
# @!attribute [rw] logo_file
|
6993
|
+
# Specify logo file data string (in base64 encoding).
|
6994
|
+
# @return [String]
|
6995
|
+
#
|
6996
|
+
# @!attribute [rw] favicon_file
|
6997
|
+
# Specify icon file data string (in base64 encoding).
|
6998
|
+
# @return [String]
|
6999
|
+
#
|
7000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppCustomizationRequest AWS API Documentation
|
7001
|
+
#
|
7002
|
+
class UpdateWebAppCustomizationRequest < Struct.new(
|
7003
|
+
:web_app_id,
|
7004
|
+
:title,
|
7005
|
+
:logo_file,
|
7006
|
+
:favicon_file)
|
7007
|
+
SENSITIVE = [:logo_file, :favicon_file]
|
7008
|
+
include Aws::Structure
|
7009
|
+
end
|
7010
|
+
|
7011
|
+
# @!attribute [rw] web_app_id
|
7012
|
+
# Returns the unique identifier for the web app being updated.
|
7013
|
+
# @return [String]
|
7014
|
+
#
|
7015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppCustomizationResponse AWS API Documentation
|
7016
|
+
#
|
7017
|
+
class UpdateWebAppCustomizationResponse < Struct.new(
|
7018
|
+
:web_app_id)
|
7019
|
+
SENSITIVE = []
|
7020
|
+
include Aws::Structure
|
7021
|
+
end
|
7022
|
+
|
7023
|
+
# A structure that describes the values to use for the IAM Identity
|
7024
|
+
# Center settings when you update a web app.
|
7025
|
+
#
|
7026
|
+
# @!attribute [rw] role
|
7027
|
+
# The IAM role used to access IAM Identity Center.
|
7028
|
+
# @return [String]
|
7029
|
+
#
|
7030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppIdentityCenterConfig AWS API Documentation
|
7031
|
+
#
|
7032
|
+
class UpdateWebAppIdentityCenterConfig < Struct.new(
|
7033
|
+
:role)
|
7034
|
+
SENSITIVE = []
|
7035
|
+
include Aws::Structure
|
7036
|
+
end
|
7037
|
+
|
7038
|
+
# A union that contains the `UpdateWebAppIdentityCenterConfig` object.
|
7039
|
+
#
|
7040
|
+
# @note UpdateWebAppIdentityProviderDetails is a union - when making an API calls you must set exactly one of the members.
|
7041
|
+
#
|
7042
|
+
# @!attribute [rw] identity_center_config
|
7043
|
+
# A structure that describes the values to use for the IAM Identity
|
7044
|
+
# Center settings when you update a web app.
|
7045
|
+
# @return [Types::UpdateWebAppIdentityCenterConfig]
|
7046
|
+
#
|
7047
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppIdentityProviderDetails AWS API Documentation
|
7048
|
+
#
|
7049
|
+
class UpdateWebAppIdentityProviderDetails < Struct.new(
|
7050
|
+
:identity_center_config,
|
7051
|
+
:unknown)
|
7052
|
+
SENSITIVE = []
|
7053
|
+
include Aws::Structure
|
7054
|
+
include Aws::Structure::Union
|
7055
|
+
|
7056
|
+
class IdentityCenterConfig < UpdateWebAppIdentityProviderDetails; end
|
7057
|
+
class Unknown < UpdateWebAppIdentityProviderDetails; end
|
7058
|
+
end
|
7059
|
+
|
7060
|
+
# @!attribute [rw] web_app_id
|
7061
|
+
# Provide the identifier of the web app that you are updating.
|
7062
|
+
# @return [String]
|
7063
|
+
#
|
7064
|
+
# @!attribute [rw] identity_provider_details
|
7065
|
+
# Provide updated identity provider values in a
|
7066
|
+
# `WebAppIdentityProviderDetails` object.
|
7067
|
+
# @return [Types::UpdateWebAppIdentityProviderDetails]
|
7068
|
+
#
|
7069
|
+
# @!attribute [rw] access_endpoint
|
7070
|
+
# The `AccessEndpoint` is the URL that you provide to your users for
|
7071
|
+
# them to interact with the Transfer Family web app. You can specify a
|
7072
|
+
# custom URL or use the default value.
|
7073
|
+
# @return [String]
|
7074
|
+
#
|
7075
|
+
# @!attribute [rw] web_app_units
|
7076
|
+
# A union that contains the value for number of concurrent connections
|
7077
|
+
# or the user sessions on your web app.
|
7078
|
+
# @return [Types::WebAppUnits]
|
7079
|
+
#
|
7080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppRequest AWS API Documentation
|
7081
|
+
#
|
7082
|
+
class UpdateWebAppRequest < Struct.new(
|
7083
|
+
:web_app_id,
|
7084
|
+
:identity_provider_details,
|
7085
|
+
:access_endpoint,
|
7086
|
+
:web_app_units)
|
7087
|
+
SENSITIVE = []
|
7088
|
+
include Aws::Structure
|
7089
|
+
end
|
7090
|
+
|
7091
|
+
# @!attribute [rw] web_app_id
|
7092
|
+
# Returns the unique identifier for the web app being updated.
|
7093
|
+
# @return [String]
|
7094
|
+
#
|
7095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppResponse AWS API Documentation
|
7096
|
+
#
|
7097
|
+
class UpdateWebAppResponse < Struct.new(
|
7098
|
+
:web_app_id)
|
7099
|
+
SENSITIVE = []
|
7100
|
+
include Aws::Structure
|
7101
|
+
end
|
7102
|
+
|
6537
7103
|
# Specifies the user name, server ID, and session ID for a workflow.
|
6538
7104
|
#
|
6539
7105
|
# @!attribute [rw] user_name
|
@@ -6561,6 +7127,58 @@ module Aws::Transfer
|
|
6561
7127
|
include Aws::Structure
|
6562
7128
|
end
|
6563
7129
|
|
7130
|
+
# A union that contains the `IdentityCenterConfig` object.
|
7131
|
+
#
|
7132
|
+
# @note WebAppIdentityProviderDetails is a union - when making an API calls you must set exactly one of the members.
|
7133
|
+
#
|
7134
|
+
# @!attribute [rw] identity_center_config
|
7135
|
+
# A structure that describes the values to use for the IAM Identity
|
7136
|
+
# Center settings when you create a web app.
|
7137
|
+
# @return [Types::IdentityCenterConfig]
|
7138
|
+
#
|
7139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WebAppIdentityProviderDetails AWS API Documentation
|
7140
|
+
#
|
7141
|
+
class WebAppIdentityProviderDetails < Struct.new(
|
7142
|
+
:identity_center_config,
|
7143
|
+
:unknown)
|
7144
|
+
SENSITIVE = []
|
7145
|
+
include Aws::Structure
|
7146
|
+
include Aws::Structure::Union
|
7147
|
+
|
7148
|
+
class IdentityCenterConfig < WebAppIdentityProviderDetails; end
|
7149
|
+
class Unknown < WebAppIdentityProviderDetails; end
|
7150
|
+
end
|
7151
|
+
|
7152
|
+
# Contains an integer value that represents the value for number of
|
7153
|
+
# concurrent connections or the user sessions on your web app.
|
7154
|
+
#
|
7155
|
+
# @note WebAppUnits is a union - when making an API calls you must set exactly one of the members.
|
7156
|
+
#
|
7157
|
+
# @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.
|
7158
|
+
#
|
7159
|
+
# @!attribute [rw] provisioned
|
7160
|
+
# An integer that represents the number of units for your desired
|
7161
|
+
# number of concurrent connections, or the number of user sessions on
|
7162
|
+
# your web app at the same time.
|
7163
|
+
#
|
7164
|
+
# Each increment allows an additional 250 concurrent sessions: a value
|
7165
|
+
# of `1` sets the number of concurrent sessions to 250; `2` sets a
|
7166
|
+
# value of 500, and so on.
|
7167
|
+
# @return [Integer]
|
7168
|
+
#
|
7169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WebAppUnits AWS API Documentation
|
7170
|
+
#
|
7171
|
+
class WebAppUnits < Struct.new(
|
7172
|
+
:provisioned,
|
7173
|
+
:unknown)
|
7174
|
+
SENSITIVE = []
|
7175
|
+
include Aws::Structure
|
7176
|
+
include Aws::Structure::Union
|
7177
|
+
|
7178
|
+
class Provisioned < WebAppUnits; end
|
7179
|
+
class Unknown < WebAppUnits; end
|
7180
|
+
end
|
7181
|
+
|
6564
7182
|
# Specifies the workflow ID for the workflow to assign and the execution
|
6565
7183
|
# role that's used for executing the workflow.
|
6566
7184
|
#
|