aws-sdk-transfer 1.106.0 → 1.108.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 +346 -36
- data/lib/aws-sdk-transfer/client_api.rb +259 -0
- data/lib/aws-sdk-transfer/types.rb +582 -62
- data/lib/aws-sdk-transfer.rb +1 -1
- data/sig/client.rbs +101 -0
- data/sig/types.rbs +171 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dfd49596e7600dd58f111600ec413f880abc1ff7075e9bb2425819ab1621dbdf
|
4
|
+
data.tar.gz: be035845a1687d5ca900a1122b2637c7d8ed2ea243ce8e426e2846d5e4d94aa9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 33975816de23b66584fe4310ab65ed1ebaa95d23cac4af3a47fe87e602c3b6ba521c63aadb55f4547120b4dcb25a27b493339da31d5333203ee4487fa037f2b3
|
7
|
+
data.tar.gz: d6f03492af5149326cf69a44d78ced8132e2b5fb551a97d4ae609daa6b6ea654f48ad59150bdcb914053973b27e859da5ca59c38c1da1a94304dfd33e4066f1f
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.108.0 (2024-12-02)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS Transfer Family now offers Web apps that enables simple and secure access to data stored in Amazon S3.
|
8
|
+
|
9
|
+
1.107.0 (2024-11-06)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.106.0 (2024-10-18)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.108.0
|
@@ -502,8 +502,8 @@ module Aws::Transfer
|
|
502
502
|
#
|
503
503
|
# The following is an `Entry` and `Target` pair example.
|
504
504
|
#
|
505
|
-
# `[
|
506
|
-
#
|
505
|
+
# `[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory"
|
506
|
+
# } ]`
|
507
507
|
#
|
508
508
|
# In most cases, you can use this value instead of the session policy to
|
509
509
|
# lock down your user to the designated home directory ("`chroot`").
|
@@ -512,15 +512,15 @@ module Aws::Transfer
|
|
512
512
|
#
|
513
513
|
# The following is an `Entry` and `Target` pair example for `chroot`.
|
514
514
|
#
|
515
|
-
# `[
|
515
|
+
# `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
|
516
516
|
#
|
517
517
|
# @option params [String] :policy
|
518
518
|
# A session policy for your user so that you can use the same Identity
|
519
519
|
# and Access Management (IAM) role across multiple users. This policy
|
520
520
|
# scopes down a user's access to portions of their Amazon S3 bucket.
|
521
521
|
# Variables that you can use inside this policy include
|
522
|
-
#
|
523
|
-
#
|
522
|
+
# `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and
|
523
|
+
# `${Transfer:HomeBucket}`.
|
524
524
|
#
|
525
525
|
# <note markdown="1"> This policy applies only when the domain of `ServerId` is Amazon S3.
|
526
526
|
# Amazon EFS does not use session policies.
|
@@ -571,7 +571,7 @@ module Aws::Transfer
|
|
571
571
|
# view the SID values by running the following command using Windows
|
572
572
|
# PowerShell.
|
573
573
|
#
|
574
|
-
# `Get-ADGroup -Filter
|
574
|
+
# `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"}
|
575
575
|
# -Properties * | Select SamAccountName,ObjectSid`
|
576
576
|
#
|
577
577
|
# In that command, replace *YourGroupName* with the name of your Active
|
@@ -1045,7 +1045,8 @@ module Aws::Transfer
|
|
1045
1045
|
# `API_GATEWAY`. Accepts an array containing all of the information
|
1046
1046
|
# required to use a directory in `AWS_DIRECTORY_SERVICE` or invoke a
|
1047
1047
|
# customer-supplied authentication API, including the API Gateway URL.
|
1048
|
-
#
|
1048
|
+
# Cannot be specified when `IdentityProviderType` is set to
|
1049
|
+
# `SERVICE_MANAGED`.
|
1049
1050
|
#
|
1050
1051
|
# @option params [String] :identity_provider_type
|
1051
1052
|
# The mode of authentication for a server. The default value is
|
@@ -1324,8 +1325,8 @@ module Aws::Transfer
|
|
1324
1325
|
#
|
1325
1326
|
# The following is an `Entry` and `Target` pair example.
|
1326
1327
|
#
|
1327
|
-
# `[
|
1328
|
-
#
|
1328
|
+
# `[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory"
|
1329
|
+
# } ]`
|
1329
1330
|
#
|
1330
1331
|
# In most cases, you can use this value instead of the session policy to
|
1331
1332
|
# lock your user down to the designated home directory ("`chroot`").
|
@@ -1334,15 +1335,15 @@ module Aws::Transfer
|
|
1334
1335
|
#
|
1335
1336
|
# The following is an `Entry` and `Target` pair example for `chroot`.
|
1336
1337
|
#
|
1337
|
-
# `[
|
1338
|
+
# `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
|
1338
1339
|
#
|
1339
1340
|
# @option params [String] :policy
|
1340
1341
|
# A session policy for your user so that you can use the same Identity
|
1341
1342
|
# and Access Management (IAM) role across multiple users. This policy
|
1342
1343
|
# scopes down a user's access to portions of their Amazon S3 bucket.
|
1343
1344
|
# Variables that you can use inside this policy include
|
1344
|
-
#
|
1345
|
-
#
|
1345
|
+
# `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and
|
1346
|
+
# `${Transfer:HomeBucket}`.
|
1346
1347
|
#
|
1347
1348
|
# <note markdown="1"> This policy applies only when the domain of `ServerId` is Amazon S3.
|
1348
1349
|
# Amazon EFS does not use session policies.
|
@@ -1463,6 +1464,63 @@ module Aws::Transfer
|
|
1463
1464
|
req.send_request(options)
|
1464
1465
|
end
|
1465
1466
|
|
1467
|
+
# Creates a web app based on specified parameters, and returns the ID
|
1468
|
+
# for the new web app.
|
1469
|
+
#
|
1470
|
+
# @option params [required, Types::WebAppIdentityProviderDetails] :identity_provider_details
|
1471
|
+
# You can provide a structure that contains the details for the identity
|
1472
|
+
# provider to use with your web app.
|
1473
|
+
#
|
1474
|
+
# @option params [String] :access_endpoint
|
1475
|
+
# The `AccessEndpoint` is the URL that you provide to your users for
|
1476
|
+
# them to interact with the Transfer Family web app. You can specify a
|
1477
|
+
# custom URL or use the default value.
|
1478
|
+
#
|
1479
|
+
# @option params [Types::WebAppUnits] :web_app_units
|
1480
|
+
# A union that contains the value for number of concurrent connections
|
1481
|
+
# or the user sessions on your web app.
|
1482
|
+
#
|
1483
|
+
# @option params [Array<Types::Tag>] :tags
|
1484
|
+
# Key-value pairs that can be used to group and search for web apps.
|
1485
|
+
#
|
1486
|
+
# @return [Types::CreateWebAppResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1487
|
+
#
|
1488
|
+
# * {Types::CreateWebAppResponse#web_app_id #web_app_id} => String
|
1489
|
+
#
|
1490
|
+
# @example Request syntax with placeholder values
|
1491
|
+
#
|
1492
|
+
# resp = client.create_web_app({
|
1493
|
+
# identity_provider_details: { # required
|
1494
|
+
# identity_center_config: {
|
1495
|
+
# instance_arn: "IdentityCenterInstanceArn",
|
1496
|
+
# role: "Role",
|
1497
|
+
# },
|
1498
|
+
# },
|
1499
|
+
# access_endpoint: "WebAppAccessEndpoint",
|
1500
|
+
# web_app_units: {
|
1501
|
+
# provisioned: 1,
|
1502
|
+
# },
|
1503
|
+
# tags: [
|
1504
|
+
# {
|
1505
|
+
# key: "TagKey", # required
|
1506
|
+
# value: "TagValue", # required
|
1507
|
+
# },
|
1508
|
+
# ],
|
1509
|
+
# })
|
1510
|
+
#
|
1511
|
+
# @example Response structure
|
1512
|
+
#
|
1513
|
+
# resp.web_app_id #=> String
|
1514
|
+
#
|
1515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateWebApp AWS API Documentation
|
1516
|
+
#
|
1517
|
+
# @overload create_web_app(params = {})
|
1518
|
+
# @param [Hash] params ({})
|
1519
|
+
def create_web_app(params = {}, options = {})
|
1520
|
+
req = build_request(:create_web_app, params)
|
1521
|
+
req.send_request(options)
|
1522
|
+
end
|
1523
|
+
|
1466
1524
|
# Allows you to create a workflow with specified steps and step details
|
1467
1525
|
# the workflow invokes after file transfer completes. After creating a
|
1468
1526
|
# workflow, you can associate the workflow created with any transfer
|
@@ -1669,7 +1727,7 @@ module Aws::Transfer
|
|
1669
1727
|
# view the SID values by running the following command using Windows
|
1670
1728
|
# PowerShell.
|
1671
1729
|
#
|
1672
|
-
# `Get-ADGroup -Filter
|
1730
|
+
# `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"}
|
1673
1731
|
# -Properties * | Select SamAccountName,ObjectSid`
|
1674
1732
|
#
|
1675
1733
|
# In that command, replace *YourGroupName* with the name of your Active
|
@@ -1911,6 +1969,52 @@ module Aws::Transfer
|
|
1911
1969
|
req.send_request(options)
|
1912
1970
|
end
|
1913
1971
|
|
1972
|
+
# Deletes the specified web app.
|
1973
|
+
#
|
1974
|
+
# @option params [required, String] :web_app_id
|
1975
|
+
# Provide the unique identifier for the web app that you are deleting.
|
1976
|
+
#
|
1977
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1978
|
+
#
|
1979
|
+
# @example Request syntax with placeholder values
|
1980
|
+
#
|
1981
|
+
# resp = client.delete_web_app({
|
1982
|
+
# web_app_id: "WebAppId", # required
|
1983
|
+
# })
|
1984
|
+
#
|
1985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteWebApp AWS API Documentation
|
1986
|
+
#
|
1987
|
+
# @overload delete_web_app(params = {})
|
1988
|
+
# @param [Hash] params ({})
|
1989
|
+
def delete_web_app(params = {}, options = {})
|
1990
|
+
req = build_request(:delete_web_app, params)
|
1991
|
+
req.send_request(options)
|
1992
|
+
end
|
1993
|
+
|
1994
|
+
# Deletes the `WebAppCustomization` object that corresponds to the web
|
1995
|
+
# app ID specified.
|
1996
|
+
#
|
1997
|
+
# @option params [required, String] :web_app_id
|
1998
|
+
# Provide the unique identifier for the web app that contains the
|
1999
|
+
# customizations that you are deleting.
|
2000
|
+
#
|
2001
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2002
|
+
#
|
2003
|
+
# @example Request syntax with placeholder values
|
2004
|
+
#
|
2005
|
+
# resp = client.delete_web_app_customization({
|
2006
|
+
# web_app_id: "WebAppId", # required
|
2007
|
+
# })
|
2008
|
+
#
|
2009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteWebAppCustomization AWS API Documentation
|
2010
|
+
#
|
2011
|
+
# @overload delete_web_app_customization(params = {})
|
2012
|
+
# @param [Hash] params ({})
|
2013
|
+
def delete_web_app_customization(params = {}, options = {})
|
2014
|
+
req = build_request(:delete_web_app_customization, params)
|
2015
|
+
req.send_request(options)
|
2016
|
+
end
|
2017
|
+
|
1914
2018
|
# Deletes the specified workflow.
|
1915
2019
|
#
|
1916
2020
|
# @option params [required, String] :workflow_id
|
@@ -1952,7 +2056,7 @@ module Aws::Transfer
|
|
1952
2056
|
# view the SID values by running the following command using Windows
|
1953
2057
|
# PowerShell.
|
1954
2058
|
#
|
1955
|
-
# `Get-ADGroup -Filter
|
2059
|
+
# `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"}
|
1956
2060
|
# -Properties * | Select SamAccountName,ObjectSid`
|
1957
2061
|
#
|
1958
2062
|
# In that command, replace *YourGroupName* with the name of your Active
|
@@ -2486,6 +2590,77 @@ module Aws::Transfer
|
|
2486
2590
|
req.send_request(options)
|
2487
2591
|
end
|
2488
2592
|
|
2593
|
+
# Describes the web app that's identified by `WebAppId`.
|
2594
|
+
#
|
2595
|
+
# @option params [required, String] :web_app_id
|
2596
|
+
# Provide the unique identifier for the web app.
|
2597
|
+
#
|
2598
|
+
# @return [Types::DescribeWebAppResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2599
|
+
#
|
2600
|
+
# * {Types::DescribeWebAppResponse#web_app #web_app} => Types::DescribedWebApp
|
2601
|
+
#
|
2602
|
+
# @example Request syntax with placeholder values
|
2603
|
+
#
|
2604
|
+
# resp = client.describe_web_app({
|
2605
|
+
# web_app_id: "WebAppId", # required
|
2606
|
+
# })
|
2607
|
+
#
|
2608
|
+
# @example Response structure
|
2609
|
+
#
|
2610
|
+
# resp.web_app.arn #=> String
|
2611
|
+
# resp.web_app.web_app_id #=> String
|
2612
|
+
# resp.web_app.described_identity_provider_details.identity_center_config.application_arn #=> String
|
2613
|
+
# resp.web_app.described_identity_provider_details.identity_center_config.instance_arn #=> String
|
2614
|
+
# resp.web_app.described_identity_provider_details.identity_center_config.role #=> String
|
2615
|
+
# resp.web_app.access_endpoint #=> String
|
2616
|
+
# resp.web_app.web_app_endpoint #=> String
|
2617
|
+
# resp.web_app.web_app_units.provisioned #=> Integer
|
2618
|
+
# resp.web_app.tags #=> Array
|
2619
|
+
# resp.web_app.tags[0].key #=> String
|
2620
|
+
# resp.web_app.tags[0].value #=> String
|
2621
|
+
#
|
2622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWebApp AWS API Documentation
|
2623
|
+
#
|
2624
|
+
# @overload describe_web_app(params = {})
|
2625
|
+
# @param [Hash] params ({})
|
2626
|
+
def describe_web_app(params = {}, options = {})
|
2627
|
+
req = build_request(:describe_web_app, params)
|
2628
|
+
req.send_request(options)
|
2629
|
+
end
|
2630
|
+
|
2631
|
+
# Describes the web app customization object that's identified by
|
2632
|
+
# `WebAppId`.
|
2633
|
+
#
|
2634
|
+
# @option params [required, String] :web_app_id
|
2635
|
+
# Provide the unique identifier for the web app.
|
2636
|
+
#
|
2637
|
+
# @return [Types::DescribeWebAppCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2638
|
+
#
|
2639
|
+
# * {Types::DescribeWebAppCustomizationResponse#web_app_customization #web_app_customization} => Types::DescribedWebAppCustomization
|
2640
|
+
#
|
2641
|
+
# @example Request syntax with placeholder values
|
2642
|
+
#
|
2643
|
+
# resp = client.describe_web_app_customization({
|
2644
|
+
# web_app_id: "WebAppId", # required
|
2645
|
+
# })
|
2646
|
+
#
|
2647
|
+
# @example Response structure
|
2648
|
+
#
|
2649
|
+
# resp.web_app_customization.arn #=> String
|
2650
|
+
# resp.web_app_customization.web_app_id #=> String
|
2651
|
+
# resp.web_app_customization.title #=> String
|
2652
|
+
# resp.web_app_customization.logo_file #=> String
|
2653
|
+
# resp.web_app_customization.favicon_file #=> String
|
2654
|
+
#
|
2655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWebAppCustomization AWS API Documentation
|
2656
|
+
#
|
2657
|
+
# @overload describe_web_app_customization(params = {})
|
2658
|
+
# @param [Hash] params ({})
|
2659
|
+
def describe_web_app_customization(params = {}, options = {})
|
2660
|
+
req = build_request(:describe_web_app_customization, params)
|
2661
|
+
req.send_request(options)
|
2662
|
+
end
|
2663
|
+
|
2489
2664
|
# Describes the specified workflow.
|
2490
2665
|
#
|
2491
2666
|
# @option params [required, String] :workflow_id
|
@@ -2757,7 +2932,7 @@ module Aws::Transfer
|
|
2757
2932
|
# Lists the details for all the accesses you have on your server.
|
2758
2933
|
#
|
2759
2934
|
# @option params [Integer] :max_results
|
2760
|
-
#
|
2935
|
+
# The maximum number of items to return.
|
2761
2936
|
#
|
2762
2937
|
# @option params [String] :next_token
|
2763
2938
|
# When you can get additional results from the `ListAccesses` call, a
|
@@ -2812,7 +2987,7 @@ module Aws::Transfer
|
|
2812
2987
|
# left off.
|
2813
2988
|
#
|
2814
2989
|
# @option params [Integer] :max_results
|
2815
|
-
# The maximum number of
|
2990
|
+
# The maximum number of items to return.
|
2816
2991
|
#
|
2817
2992
|
# @option params [String] :next_token
|
2818
2993
|
# When you can get additional results from the `ListAgreements` call, a
|
@@ -2867,7 +3042,7 @@ module Aws::Transfer
|
|
2867
3042
|
# you left off.
|
2868
3043
|
#
|
2869
3044
|
# @option params [Integer] :max_results
|
2870
|
-
# The maximum number of
|
3045
|
+
# The maximum number of items to return.
|
2871
3046
|
#
|
2872
3047
|
# @option params [String] :next_token
|
2873
3048
|
# When you can get additional results from the `ListCertificates` call,
|
@@ -2914,7 +3089,7 @@ module Aws::Transfer
|
|
2914
3089
|
# Lists the connectors for the specified Region.
|
2915
3090
|
#
|
2916
3091
|
# @option params [Integer] :max_results
|
2917
|
-
# The maximum number of
|
3092
|
+
# The maximum number of items to return.
|
2918
3093
|
#
|
2919
3094
|
# @option params [String] :next_token
|
2920
3095
|
# When you can get additional results from the `ListConnectors` call, a
|
@@ -2961,7 +3136,7 @@ module Aws::Transfer
|
|
2961
3136
|
# </note>
|
2962
3137
|
#
|
2963
3138
|
# @option params [Integer] :max_results
|
2964
|
-
#
|
3139
|
+
# The maximum number of items to return.
|
2965
3140
|
#
|
2966
3141
|
# @option params [String] :next_token
|
2967
3142
|
# `ListExecutions` returns the `NextToken` parameter in the output. You
|
@@ -3101,7 +3276,7 @@ module Aws::Transfer
|
|
3101
3276
|
# `ServerId` parameter.
|
3102
3277
|
#
|
3103
3278
|
# @option params [Integer] :max_results
|
3104
|
-
# The maximum number of
|
3279
|
+
# The maximum number of items to return.
|
3105
3280
|
#
|
3106
3281
|
# @option params [String] :next_token
|
3107
3282
|
# When there are additional results that were not returned, a
|
@@ -3154,7 +3329,7 @@ module Aws::Transfer
|
|
3154
3329
|
# from where you left off.
|
3155
3330
|
#
|
3156
3331
|
# @option params [Integer] :max_results
|
3157
|
-
# The maximum number of
|
3332
|
+
# The maximum number of items to return.
|
3158
3333
|
#
|
3159
3334
|
# @option params [String] :next_token
|
3160
3335
|
# When there are additional results that were not returned, a
|
@@ -3402,11 +3577,54 @@ module Aws::Transfer
|
|
3402
3577
|
req.send_request(options)
|
3403
3578
|
end
|
3404
3579
|
|
3580
|
+
# Lists all web apps associated with your Amazon Web Services account
|
3581
|
+
# for your current region.
|
3582
|
+
#
|
3583
|
+
# @option params [Integer] :max_results
|
3584
|
+
# The maximum number of items to return.
|
3585
|
+
#
|
3586
|
+
# @option params [String] :next_token
|
3587
|
+
# Returns the `NextToken` parameter in the output. You can then pass the
|
3588
|
+
# `NextToken` parameter in a subsequent command to continue listing
|
3589
|
+
# additional web apps.
|
3590
|
+
#
|
3591
|
+
# @return [Types::ListWebAppsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3592
|
+
#
|
3593
|
+
# * {Types::ListWebAppsResponse#next_token #next_token} => String
|
3594
|
+
# * {Types::ListWebAppsResponse#web_apps #web_apps} => Array<Types::ListedWebApp>
|
3595
|
+
#
|
3596
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3597
|
+
#
|
3598
|
+
# @example Request syntax with placeholder values
|
3599
|
+
#
|
3600
|
+
# resp = client.list_web_apps({
|
3601
|
+
# max_results: 1,
|
3602
|
+
# next_token: "NextToken",
|
3603
|
+
# })
|
3604
|
+
#
|
3605
|
+
# @example Response structure
|
3606
|
+
#
|
3607
|
+
# resp.next_token #=> String
|
3608
|
+
# resp.web_apps #=> Array
|
3609
|
+
# resp.web_apps[0].arn #=> String
|
3610
|
+
# resp.web_apps[0].web_app_id #=> String
|
3611
|
+
# resp.web_apps[0].access_endpoint #=> String
|
3612
|
+
# resp.web_apps[0].web_app_endpoint #=> String
|
3613
|
+
#
|
3614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListWebApps AWS API Documentation
|
3615
|
+
#
|
3616
|
+
# @overload list_web_apps(params = {})
|
3617
|
+
# @param [Hash] params ({})
|
3618
|
+
def list_web_apps(params = {}, options = {})
|
3619
|
+
req = build_request(:list_web_apps, params)
|
3620
|
+
req.send_request(options)
|
3621
|
+
end
|
3622
|
+
|
3405
3623
|
# Lists all workflows associated with your Amazon Web Services account
|
3406
3624
|
# for your current region.
|
3407
3625
|
#
|
3408
3626
|
# @option params [Integer] :max_results
|
3409
|
-
#
|
3627
|
+
# The maximum number of items to return.
|
3410
3628
|
#
|
3411
3629
|
# @option params [String] :next_token
|
3412
3630
|
# `ListWorkflows` returns the `NextToken` parameter in the output. You
|
@@ -3961,8 +4179,8 @@ module Aws::Transfer
|
|
3961
4179
|
#
|
3962
4180
|
# The following is an `Entry` and `Target` pair example.
|
3963
4181
|
#
|
3964
|
-
# `[
|
3965
|
-
#
|
4182
|
+
# `[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory"
|
4183
|
+
# } ]`
|
3966
4184
|
#
|
3967
4185
|
# In most cases, you can use this value instead of the session policy to
|
3968
4186
|
# lock down your user to the designated home directory ("`chroot`").
|
@@ -3971,15 +4189,15 @@ module Aws::Transfer
|
|
3971
4189
|
#
|
3972
4190
|
# The following is an `Entry` and `Target` pair example for `chroot`.
|
3973
4191
|
#
|
3974
|
-
# `[
|
4192
|
+
# `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
|
3975
4193
|
#
|
3976
4194
|
# @option params [String] :policy
|
3977
4195
|
# A session policy for your user so that you can use the same Identity
|
3978
4196
|
# and Access Management (IAM) role across multiple users. This policy
|
3979
4197
|
# scopes down a user's access to portions of their Amazon S3 bucket.
|
3980
4198
|
# Variables that you can use inside this policy include
|
3981
|
-
#
|
3982
|
-
#
|
4199
|
+
# `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and
|
4200
|
+
# `${Transfer:HomeBucket}`.
|
3983
4201
|
#
|
3984
4202
|
# <note markdown="1"> This policy applies only when the domain of `ServerId` is Amazon S3.
|
3985
4203
|
# Amazon EFS does not use session policies.
|
@@ -4030,7 +4248,7 @@ module Aws::Transfer
|
|
4030
4248
|
# view the SID values by running the following command using Windows
|
4031
4249
|
# PowerShell.
|
4032
4250
|
#
|
4033
|
-
# `Get-ADGroup -Filter
|
4251
|
+
# `Get-ADGroup -Filter {samAccountName -like "YourGroupName*"}
|
4034
4252
|
# -Properties * | Select SamAccountName,ObjectSid`
|
4035
4253
|
#
|
4036
4254
|
# In that command, replace *YourGroupName* with the name of your Active
|
@@ -4628,7 +4846,7 @@ module Aws::Transfer
|
|
4628
4846
|
# empty `OnUpload` object, as in the following example.
|
4629
4847
|
#
|
4630
4848
|
# `aws transfer update-server --server-id s-01234567890abcdef
|
4631
|
-
# --workflow-details '
|
4849
|
+
# --workflow-details '{"OnUpload":[]}'`
|
4632
4850
|
#
|
4633
4851
|
# @option params [Array<String>] :structured_log_destinations
|
4634
4852
|
# Specifies the log groups to which your server logs are sent.
|
@@ -4747,7 +4965,7 @@ module Aws::Transfer
|
|
4747
4965
|
#
|
4748
4966
|
# ` aws transfer update-user --server-id <server-id> --user-name
|
4749
4967
|
# admin-user --home-directory-type LOGICAL --home-directory-mappings
|
4750
|
-
# "[
|
4968
|
+
# "[{"Entry":"/", "Target":"/test/admin-user"}]"`
|
4751
4969
|
#
|
4752
4970
|
# @option params [String] :home_directory
|
4753
4971
|
# The landing directory (folder) for a user when they log in to the
|
@@ -4789,8 +5007,8 @@ module Aws::Transfer
|
|
4789
5007
|
#
|
4790
5008
|
# The following is an `Entry` and `Target` pair example.
|
4791
5009
|
#
|
4792
|
-
# `[
|
4793
|
-
#
|
5010
|
+
# `[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory"
|
5011
|
+
# } ]`
|
4794
5012
|
#
|
4795
5013
|
# In most cases, you can use this value instead of the session policy to
|
4796
5014
|
# lock down your user to the designated home directory ("`chroot`").
|
@@ -4799,15 +5017,15 @@ module Aws::Transfer
|
|
4799
5017
|
#
|
4800
5018
|
# The following is an `Entry` and `Target` pair example for `chroot`.
|
4801
5019
|
#
|
4802
|
-
# `[
|
5020
|
+
# `[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]`
|
4803
5021
|
#
|
4804
5022
|
# @option params [String] :policy
|
4805
5023
|
# A session policy for your user so that you can use the same Identity
|
4806
5024
|
# and Access Management (IAM) role across multiple users. This policy
|
4807
5025
|
# scopes down a user's access to portions of their Amazon S3 bucket.
|
4808
5026
|
# Variables that you can use inside this policy include
|
4809
|
-
#
|
4810
|
-
#
|
5027
|
+
# `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and
|
5028
|
+
# `${Transfer:HomeBucket}`.
|
4811
5029
|
#
|
4812
5030
|
# <note markdown="1"> This policy applies only when the domain of `ServerId` is Amazon S3.
|
4813
5031
|
# Amazon EFS does not use session policies.
|
@@ -4901,6 +5119,98 @@ module Aws::Transfer
|
|
4901
5119
|
req.send_request(options)
|
4902
5120
|
end
|
4903
5121
|
|
5122
|
+
# Assigns new properties to a web app. You can modify the access point,
|
5123
|
+
# identity provider details, and the web app units.
|
5124
|
+
#
|
5125
|
+
# @option params [required, String] :web_app_id
|
5126
|
+
# Provide the identifier of the web app that you are updating.
|
5127
|
+
#
|
5128
|
+
# @option params [Types::UpdateWebAppIdentityProviderDetails] :identity_provider_details
|
5129
|
+
# Provide updated identity provider values in a
|
5130
|
+
# `WebAppIdentityProviderDetails` object.
|
5131
|
+
#
|
5132
|
+
# @option params [String] :access_endpoint
|
5133
|
+
# The `AccessEndpoint` is the URL that you provide to your users for
|
5134
|
+
# them to interact with the Transfer Family web app. You can specify a
|
5135
|
+
# custom URL or use the default value.
|
5136
|
+
#
|
5137
|
+
# @option params [Types::WebAppUnits] :web_app_units
|
5138
|
+
# A union that contains the value for number of concurrent connections
|
5139
|
+
# or the user sessions on your web app.
|
5140
|
+
#
|
5141
|
+
# @return [Types::UpdateWebAppResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5142
|
+
#
|
5143
|
+
# * {Types::UpdateWebAppResponse#web_app_id #web_app_id} => String
|
5144
|
+
#
|
5145
|
+
# @example Request syntax with placeholder values
|
5146
|
+
#
|
5147
|
+
# resp = client.update_web_app({
|
5148
|
+
# web_app_id: "WebAppId", # required
|
5149
|
+
# identity_provider_details: {
|
5150
|
+
# identity_center_config: {
|
5151
|
+
# role: "Role",
|
5152
|
+
# },
|
5153
|
+
# },
|
5154
|
+
# access_endpoint: "WebAppAccessEndpoint",
|
5155
|
+
# web_app_units: {
|
5156
|
+
# provisioned: 1,
|
5157
|
+
# },
|
5158
|
+
# })
|
5159
|
+
#
|
5160
|
+
# @example Response structure
|
5161
|
+
#
|
5162
|
+
# resp.web_app_id #=> String
|
5163
|
+
#
|
5164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebApp AWS API Documentation
|
5165
|
+
#
|
5166
|
+
# @overload update_web_app(params = {})
|
5167
|
+
# @param [Hash] params ({})
|
5168
|
+
def update_web_app(params = {}, options = {})
|
5169
|
+
req = build_request(:update_web_app, params)
|
5170
|
+
req.send_request(options)
|
5171
|
+
end
|
5172
|
+
|
5173
|
+
# Assigns new customization properties to a web app. You can modify the
|
5174
|
+
# icon file, logo file, and title.
|
5175
|
+
#
|
5176
|
+
# @option params [required, String] :web_app_id
|
5177
|
+
# Provide the identifier of the web app that you are updating.
|
5178
|
+
#
|
5179
|
+
# @option params [String] :title
|
5180
|
+
# Provide an updated title.
|
5181
|
+
#
|
5182
|
+
# @option params [String, StringIO, File] :logo_file
|
5183
|
+
# Specify logo file data string (in base64 encoding).
|
5184
|
+
#
|
5185
|
+
# @option params [String, StringIO, File] :favicon_file
|
5186
|
+
# Specify icon file data string (in base64 encoding).
|
5187
|
+
#
|
5188
|
+
# @return [Types::UpdateWebAppCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5189
|
+
#
|
5190
|
+
# * {Types::UpdateWebAppCustomizationResponse#web_app_id #web_app_id} => String
|
5191
|
+
#
|
5192
|
+
# @example Request syntax with placeholder values
|
5193
|
+
#
|
5194
|
+
# resp = client.update_web_app_customization({
|
5195
|
+
# web_app_id: "WebAppId", # required
|
5196
|
+
# title: "WebAppTitle",
|
5197
|
+
# logo_file: "data",
|
5198
|
+
# favicon_file: "data",
|
5199
|
+
# })
|
5200
|
+
#
|
5201
|
+
# @example Response structure
|
5202
|
+
#
|
5203
|
+
# resp.web_app_id #=> String
|
5204
|
+
#
|
5205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateWebAppCustomization AWS API Documentation
|
5206
|
+
#
|
5207
|
+
# @overload update_web_app_customization(params = {})
|
5208
|
+
# @param [Hash] params ({})
|
5209
|
+
def update_web_app_customization(params = {}, options = {})
|
5210
|
+
req = build_request(:update_web_app_customization, params)
|
5211
|
+
req.send_request(options)
|
5212
|
+
end
|
5213
|
+
|
4904
5214
|
# @!endgroup
|
4905
5215
|
|
4906
5216
|
# @param params ({})
|
@@ -4919,7 +5229,7 @@ module Aws::Transfer
|
|
4919
5229
|
tracer: tracer
|
4920
5230
|
)
|
4921
5231
|
context[:gem_name] = 'aws-sdk-transfer'
|
4922
|
-
context[:gem_version] = '1.
|
5232
|
+
context[:gem_version] = '1.108.0'
|
4923
5233
|
Seahorse::Client::Request.new(handlers, context)
|
4924
5234
|
end
|
4925
5235
|
|