aws-sdk-transfer 1.28.0 → 1.33.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +178 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-transfer.rb +3 -3
- data/lib/aws-sdk-transfer/client.rb +686 -96
- data/lib/aws-sdk-transfer/client_api.rb +169 -1
- data/lib/aws-sdk-transfer/errors.rb +1 -1
- data/lib/aws-sdk-transfer/resource.rb +1 -1
- data/lib/aws-sdk-transfer/types.rb +997 -116
- metadata +11 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 996c86038af3aaa7227c722e3cd5354b8cdbabd132a8a36be8faac4191059588
|
|
4
|
+
data.tar.gz: 21092ed796a8518b5992865ba1de33825c8449cbf470e17a66a51c1dcb5b48d8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b39c067e39c7125d8bac5d11be5b1275d9d11529d130bb1d693dc000d5338b985bca712c4fc9a63c1d9d18703db158ca6a59a7af691fcd86b3f3dd80a3103714
|
|
7
|
+
data.tar.gz: a0af612b16737ff005eac0d7770203ff1251b878dec11911aff19fd9c476d15046ba18fab0a672110e96171bcebd4e37ff5f35a56e3ae477780c07e7bc5ee5ec
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
Unreleased Changes
|
|
2
|
+
------------------
|
|
3
|
+
|
|
4
|
+
1.33.0 (2021-05-25)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - AWS Transfer Family customers can now use AWS Managed Active Directory or AD Connector to authenticate their end users, enabling seamless migration of file transfer workflows that rely on AD authentication, without changing end users' credentials or needing a custom authorizer.
|
|
8
|
+
|
|
9
|
+
1.32.0 (2021-03-10)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
13
|
+
|
|
14
|
+
1.31.0 (2021-02-25)
|
|
15
|
+
------------------
|
|
16
|
+
|
|
17
|
+
* Feature - Corrected the upper limit for TestIdentityProvider input lengths to 1024 characters
|
|
18
|
+
|
|
19
|
+
1.30.0 (2021-02-02)
|
|
20
|
+
------------------
|
|
21
|
+
|
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
23
|
+
|
|
24
|
+
1.29.0 (2021-01-06)
|
|
25
|
+
------------------
|
|
26
|
+
|
|
27
|
+
* Feature - This release adds support for Amazon EFS, so customers can transfer files over SFTP, FTPS and FTP in and out of Amazon S3 as well as Amazon EFS.
|
|
28
|
+
|
|
29
|
+
1.28.0 (2020-10-15)
|
|
30
|
+
------------------
|
|
31
|
+
|
|
32
|
+
* Feature - Add support to associate VPC Security Groups at server creation.
|
|
33
|
+
|
|
34
|
+
1.27.0 (2020-09-30)
|
|
35
|
+
------------------
|
|
36
|
+
|
|
37
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
38
|
+
|
|
39
|
+
1.26.0 (2020-09-15)
|
|
40
|
+
------------------
|
|
41
|
+
|
|
42
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
43
|
+
|
|
44
|
+
1.25.0 (2020-08-25)
|
|
45
|
+
------------------
|
|
46
|
+
|
|
47
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
48
|
+
|
|
49
|
+
1.24.0 (2020-08-12)
|
|
50
|
+
------------------
|
|
51
|
+
|
|
52
|
+
* Feature - Adds security policies to control cryptographic algorithms advertised by your server, additional characters in usernames and length increase, and FIPS compliant endpoints in the US and Canada regions.
|
|
53
|
+
|
|
54
|
+
1.23.0 (2020-06-23)
|
|
55
|
+
------------------
|
|
56
|
+
|
|
57
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
58
|
+
|
|
59
|
+
1.22.1 (2020-06-11)
|
|
60
|
+
------------------
|
|
61
|
+
|
|
62
|
+
* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
|
|
63
|
+
|
|
64
|
+
1.22.0 (2020-06-10)
|
|
65
|
+
------------------
|
|
66
|
+
|
|
67
|
+
* Issue - This version has been yanked. (#2327).
|
|
68
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
69
|
+
|
|
70
|
+
1.21.0 (2020-06-09)
|
|
71
|
+
------------------
|
|
72
|
+
|
|
73
|
+
* Feature - This release updates the API so customers can test use of Source IP to allow, deny or limit access to data in their S3 buckets after integrating their identity provider.
|
|
74
|
+
|
|
75
|
+
1.20.0 (2020-05-28)
|
|
76
|
+
------------------
|
|
77
|
+
|
|
78
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
79
|
+
|
|
80
|
+
1.19.0 (2020-05-07)
|
|
81
|
+
------------------
|
|
82
|
+
|
|
83
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
84
|
+
|
|
85
|
+
1.18.0 (2020-04-23)
|
|
86
|
+
------------------
|
|
87
|
+
|
|
88
|
+
* Feature - This release adds support for transfers over FTPS and FTP in and out of Amazon S3, which makes it easy to migrate File Transfer Protocol over SSL (FTPS) and FTP workloads to AWS, in addition to the existing support for Secure File Transfer Protocol (SFTP).
|
|
89
|
+
|
|
90
|
+
1.17.0 (2020-03-09)
|
|
91
|
+
------------------
|
|
92
|
+
|
|
93
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
94
|
+
|
|
95
|
+
1.16.0 (2020-01-10)
|
|
96
|
+
------------------
|
|
97
|
+
|
|
98
|
+
* Feature - This release introduces a new endpoint type that allows you to attach Elastic IP addresses from your AWS account with your server's endpoint directly and whitelist access to your server by client's internet IP address(es) using VPC Security Groups.
|
|
99
|
+
|
|
100
|
+
1.15.0 (2019-10-28)
|
|
101
|
+
------------------
|
|
102
|
+
|
|
103
|
+
* Feature - This release adds logical directories support to your AWS SFTP server endpoint, so you can now create logical directory structures mapped to Amazon Simple Storage Service (Amazon S3) bucket paths for users created and stored within the service. Amazon S3 bucket names and paths can now be hidden from AWS SFTP users, providing an additional level of privacy to meet security requirements. You can lock down your SFTP users' access to designated folders (commonly referred to as 'chroot'), and simplify complex folder structures for data distribution through SFTP without replicating files across multiple users.
|
|
104
|
+
|
|
105
|
+
1.14.0 (2019-10-23)
|
|
106
|
+
------------------
|
|
107
|
+
|
|
108
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
109
|
+
|
|
110
|
+
1.13.0 (2019-08-20)
|
|
111
|
+
------------------
|
|
112
|
+
|
|
113
|
+
* Feature - New field in response of TestIdentityProvider
|
|
114
|
+
|
|
115
|
+
1.12.0 (2019-07-25)
|
|
116
|
+
------------------
|
|
117
|
+
|
|
118
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
119
|
+
|
|
120
|
+
1.11.0 (2019-07-01)
|
|
121
|
+
------------------
|
|
122
|
+
|
|
123
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
124
|
+
|
|
125
|
+
1.10.0 (2019-06-17)
|
|
126
|
+
------------------
|
|
127
|
+
|
|
128
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
129
|
+
|
|
130
|
+
1.9.0 (2019-05-21)
|
|
131
|
+
------------------
|
|
132
|
+
|
|
133
|
+
* Feature - API update.
|
|
134
|
+
|
|
135
|
+
1.8.0 (2019-05-15)
|
|
136
|
+
------------------
|
|
137
|
+
|
|
138
|
+
* Feature - API update.
|
|
139
|
+
|
|
140
|
+
1.7.0 (2019-05-14)
|
|
141
|
+
------------------
|
|
142
|
+
|
|
143
|
+
* Feature - API update.
|
|
144
|
+
|
|
145
|
+
1.6.0 (2019-04-29)
|
|
146
|
+
------------------
|
|
147
|
+
|
|
148
|
+
* Feature - API update.
|
|
149
|
+
|
|
150
|
+
1.5.0 (2019-03-27)
|
|
151
|
+
------------------
|
|
152
|
+
|
|
153
|
+
* Feature - API update.
|
|
154
|
+
|
|
155
|
+
1.4.0 (2019-03-21)
|
|
156
|
+
------------------
|
|
157
|
+
|
|
158
|
+
* Feature - API update.
|
|
159
|
+
|
|
160
|
+
1.3.0 (2019-03-18)
|
|
161
|
+
------------------
|
|
162
|
+
|
|
163
|
+
* Feature - API update.
|
|
164
|
+
|
|
165
|
+
1.2.0 (2019-03-14)
|
|
166
|
+
------------------
|
|
167
|
+
|
|
168
|
+
* Feature - API update.
|
|
169
|
+
|
|
170
|
+
1.1.0 (2019-02-21)
|
|
171
|
+
------------------
|
|
172
|
+
|
|
173
|
+
* Feature - API update.
|
|
174
|
+
|
|
175
|
+
1.0.0 (2018-11-26)
|
|
176
|
+
------------------
|
|
177
|
+
|
|
178
|
+
* Feature - Initial release of `aws-sdk-transfer`.
|
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
1.33.0
|
data/lib/aws-sdk-transfer.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -28,7 +28,7 @@ require_relative 'aws-sdk-transfer/customizations'
|
|
|
28
28
|
# structure.
|
|
29
29
|
#
|
|
30
30
|
# transfer = Aws::Transfer::Client.new
|
|
31
|
-
# resp = transfer.
|
|
31
|
+
# resp = transfer.create_access(params)
|
|
32
32
|
#
|
|
33
33
|
# See {Client} for more information.
|
|
34
34
|
#
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-transfer/customizations'
|
|
|
48
48
|
# @!group service
|
|
49
49
|
module Aws::Transfer
|
|
50
50
|
|
|
51
|
-
GEM_VERSION = '1.
|
|
51
|
+
GEM_VERSION = '1.33.0'
|
|
52
52
|
|
|
53
53
|
end
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -337,7 +337,179 @@ module Aws::Transfer
|
|
|
337
337
|
|
|
338
338
|
# @!group API Operations
|
|
339
339
|
|
|
340
|
-
#
|
|
340
|
+
# Used by administrators to choose which groups in the directory should
|
|
341
|
+
# have access to upload and download files over the enabled protocols
|
|
342
|
+
# using AWS Transfer Family. For example, a Microsoft Active Directory
|
|
343
|
+
# might contain 50,000 users, but only a small fraction might need the
|
|
344
|
+
# ability to transfer files to the server. An administrator can use
|
|
345
|
+
# `CreateAccess` to limit the access to the correct set of users who
|
|
346
|
+
# need this ability.
|
|
347
|
+
#
|
|
348
|
+
# @option params [String] :home_directory
|
|
349
|
+
# The landing directory (folder) for a user when they log in to the
|
|
350
|
+
# server using the client.
|
|
351
|
+
#
|
|
352
|
+
# A `HomeDirectory` example is `/directory_name/home/mydirectory`.
|
|
353
|
+
#
|
|
354
|
+
# @option params [String] :home_directory_type
|
|
355
|
+
# The type of landing directory (folder) that you want your users' home
|
|
356
|
+
# directory to be when they log in to the server. If you set it to
|
|
357
|
+
# `PATH`, the user will see the absolute Amazon S3 bucket paths as is in
|
|
358
|
+
# their file transfer protocol clients. If you set it `LOGICAL`, you
|
|
359
|
+
# must provide mappings in the `HomeDirectoryMappings` for how you want
|
|
360
|
+
# to make Amazon S3 paths visible to your users.
|
|
361
|
+
#
|
|
362
|
+
# @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
|
|
363
|
+
# Logical directory mappings that specify what Amazon S3 or Amazon EFS
|
|
364
|
+
# paths and keys should be visible to your user and how you want to make
|
|
365
|
+
# them visible. You must specify the `Entry` and `Target` pair, where
|
|
366
|
+
# `Entry` shows how the path is made visible and `Target` is the actual
|
|
367
|
+
# Amazon S3 or Amazon EFS path. If you only specify a target, it will be
|
|
368
|
+
# displayed as is. You also must ensure that your AWS Identity and
|
|
369
|
+
# Access Management (IAM) role provides access to paths in `Target`.
|
|
370
|
+
# This value can only be set when `HomeDirectoryType` is set to
|
|
371
|
+
# *LOGICAL*.
|
|
372
|
+
#
|
|
373
|
+
# The following is an `Entry` and `Target` pair example.
|
|
374
|
+
#
|
|
375
|
+
# `[ \{ "Entry": "your-personal-report.pdf", "Target":
|
|
376
|
+
# "/bucket3/customized-reports/$\{transfer:UserName\}.pdf" \} ]`
|
|
377
|
+
#
|
|
378
|
+
# In most cases, you can use this value instead of the scope-down policy
|
|
379
|
+
# to lock down your user to the designated home directory
|
|
380
|
+
# ("`chroot`"). To do this, you can set `Entry` to `/` and set
|
|
381
|
+
# `Target` to the `HomeDirectory` parameter value.
|
|
382
|
+
#
|
|
383
|
+
# The following is an `Entry` and `Target` pair example for `chroot`.
|
|
384
|
+
#
|
|
385
|
+
# `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
|
|
386
|
+
#
|
|
387
|
+
# <note markdown="1"> If the target of a logical directory entry does not exist in Amazon S3
|
|
388
|
+
# or Amazon EFS, the entry will be ignored. As a workaround, you can use
|
|
389
|
+
# the Amazon S3 API or EFS API to create 0-byte objects as place holders
|
|
390
|
+
# for your directory. If using the AWS CLI, use the `s3api` or `efsapi`
|
|
391
|
+
# call instead of `s3` or `efs` so you can use the `put-object`
|
|
392
|
+
# operation. For example, you can use the following.
|
|
393
|
+
#
|
|
394
|
+
# `aws s3api put-object --bucket bucketname --key path/to/folder/`
|
|
395
|
+
#
|
|
396
|
+
# The end of the key name must end in a `/` for it to be considered a
|
|
397
|
+
# folder.
|
|
398
|
+
#
|
|
399
|
+
# </note>
|
|
400
|
+
#
|
|
401
|
+
# Required: No
|
|
402
|
+
#
|
|
403
|
+
# @option params [String] :policy
|
|
404
|
+
# A scope-down policy for your user so that you can use the same IAM
|
|
405
|
+
# role across multiple users. This policy scopes down user access to
|
|
406
|
+
# portions of their Amazon S3 bucket. Variables that you can use inside
|
|
407
|
+
# this policy include `$\{Transfer:UserName\}`,
|
|
408
|
+
# `$\{Transfer:HomeDirectory\}`, and `$\{Transfer:HomeBucket\}`.
|
|
409
|
+
#
|
|
410
|
+
# <note markdown="1"> This only applies when domain of `ServerId` is S3. Amazon EFS does not
|
|
411
|
+
# use scope down policy.
|
|
412
|
+
#
|
|
413
|
+
# For scope-down policies, AWS Transfer Family stores the policy as a
|
|
414
|
+
# JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
|
|
415
|
+
# You save the policy as a JSON blob and pass it in the `Policy`
|
|
416
|
+
# argument.
|
|
417
|
+
#
|
|
418
|
+
# For an example of a scope-down policy, see [Example scope-down
|
|
419
|
+
# policy][1].
|
|
420
|
+
#
|
|
421
|
+
# For more information, see [AssumeRole][2] in the *AWS Security Token
|
|
422
|
+
# Service API Reference*.
|
|
423
|
+
#
|
|
424
|
+
# </note>
|
|
425
|
+
#
|
|
426
|
+
#
|
|
427
|
+
#
|
|
428
|
+
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/scope-down-policy.html
|
|
429
|
+
# [2]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
|
|
430
|
+
#
|
|
431
|
+
# @option params [Types::PosixProfile] :posix_profile
|
|
432
|
+
# The full POSIX identity, including user ID (`Uid`), group ID (`Gid`),
|
|
433
|
+
# and any secondary groups IDs (`SecondaryGids`), that controls your
|
|
434
|
+
# users' access to your Amazon EFS file systems. The POSIX permissions
|
|
435
|
+
# that are set on files and directories in your file system determine
|
|
436
|
+
# the level of access your users get when transferring files into and
|
|
437
|
+
# out of your Amazon EFS file systems.
|
|
438
|
+
#
|
|
439
|
+
# @option params [required, String] :role
|
|
440
|
+
# Specifies the IAM role that controls your users' access to your
|
|
441
|
+
# Amazon S3 bucket or EFS file system. The policies attached to this
|
|
442
|
+
# role determine the level of access that you want to provide your users
|
|
443
|
+
# when transferring files into and out of your Amazon S3 bucket or EFS
|
|
444
|
+
# file system. The IAM role should also contain a trust relationship
|
|
445
|
+
# that allows the server to access your resources when servicing your
|
|
446
|
+
# users' transfer requests.
|
|
447
|
+
#
|
|
448
|
+
# @option params [required, String] :server_id
|
|
449
|
+
# A system-assigned unique identifier for a server instance. This is the
|
|
450
|
+
# specific server that you added your user to.
|
|
451
|
+
#
|
|
452
|
+
# @option params [required, String] :external_id
|
|
453
|
+
# A unique identifier that is required to identify specific groups
|
|
454
|
+
# within your directory. The users of the group that you associate have
|
|
455
|
+
# access to your Amazon S3 or Amazon EFS resources over the enabled
|
|
456
|
+
# protocols using AWS Transfer Family. If you know the group name, you
|
|
457
|
+
# can view the SID values by running the following command using Windows
|
|
458
|
+
# PowerShell.
|
|
459
|
+
#
|
|
460
|
+
# `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
|
|
461
|
+
# -Properties * | Select SamaccountName,ObjectSid`
|
|
462
|
+
#
|
|
463
|
+
# In that command, replace *YourGroupName* with the name of your Active
|
|
464
|
+
# Directory group.
|
|
465
|
+
#
|
|
466
|
+
# The regex used to validate this parameter is a string of characters
|
|
467
|
+
# consisting of uppercase and lowercase alphanumeric characters with no
|
|
468
|
+
# spaces. You can also include underscores or any of the following
|
|
469
|
+
# characters: =,.@:/-
|
|
470
|
+
#
|
|
471
|
+
# @return [Types::CreateAccessResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
472
|
+
#
|
|
473
|
+
# * {Types::CreateAccessResponse#server_id #server_id} => String
|
|
474
|
+
# * {Types::CreateAccessResponse#external_id #external_id} => String
|
|
475
|
+
#
|
|
476
|
+
# @example Request syntax with placeholder values
|
|
477
|
+
#
|
|
478
|
+
# resp = client.create_access({
|
|
479
|
+
# home_directory: "HomeDirectory",
|
|
480
|
+
# home_directory_type: "PATH", # accepts PATH, LOGICAL
|
|
481
|
+
# home_directory_mappings: [
|
|
482
|
+
# {
|
|
483
|
+
# entry: "MapEntry", # required
|
|
484
|
+
# target: "MapTarget", # required
|
|
485
|
+
# },
|
|
486
|
+
# ],
|
|
487
|
+
# policy: "Policy",
|
|
488
|
+
# posix_profile: {
|
|
489
|
+
# uid: 1, # required
|
|
490
|
+
# gid: 1, # required
|
|
491
|
+
# secondary_gids: [1],
|
|
492
|
+
# },
|
|
493
|
+
# role: "Role", # required
|
|
494
|
+
# server_id: "ServerId", # required
|
|
495
|
+
# external_id: "ExternalId", # required
|
|
496
|
+
# })
|
|
497
|
+
#
|
|
498
|
+
# @example Response structure
|
|
499
|
+
#
|
|
500
|
+
# resp.server_id #=> String
|
|
501
|
+
# resp.external_id #=> String
|
|
502
|
+
#
|
|
503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateAccess AWS API Documentation
|
|
504
|
+
#
|
|
505
|
+
# @overload create_access(params = {})
|
|
506
|
+
# @param [Hash] params ({})
|
|
507
|
+
def create_access(params = {}, options = {})
|
|
508
|
+
req = build_request(:create_access, params)
|
|
509
|
+
req.send_request(options)
|
|
510
|
+
end
|
|
511
|
+
|
|
512
|
+
# Instantiates an auto-scaling virtual server based on the selected file
|
|
341
513
|
# transfer protocol in AWS. When you make updates to your file transfer
|
|
342
514
|
# protocol-enabled server or when you work with users, use the
|
|
343
515
|
# service-generated `ServerId` property that is assigned to the newly
|
|
@@ -382,21 +554,43 @@ module Aws::Transfer
|
|
|
382
554
|
# [2]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html
|
|
383
555
|
# [3]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html
|
|
384
556
|
#
|
|
557
|
+
# @option params [String] :domain
|
|
558
|
+
# The domain of the storage system that is used for file transfers.
|
|
559
|
+
# There are two domains available: Amazon Simple Storage Service (Amazon
|
|
560
|
+
# S3) and Amazon Elastic File System (Amazon EFS). The default value is
|
|
561
|
+
# S3.
|
|
562
|
+
#
|
|
563
|
+
# <note markdown="1"> After the server is created, the domain cannot be changed.
|
|
564
|
+
#
|
|
565
|
+
# </note>
|
|
566
|
+
#
|
|
385
567
|
# @option params [Types::EndpointDetails] :endpoint_details
|
|
386
568
|
# The virtual private cloud (VPC) endpoint settings that are configured
|
|
387
569
|
# for your server. When you host your endpoint within your VPC, you can
|
|
388
570
|
# make it accessible only to resources within your VPC, or you can
|
|
389
|
-
# attach Elastic
|
|
571
|
+
# attach Elastic IP addresses and make it accessible to clients over the
|
|
390
572
|
# internet. Your VPC's default security groups are automatically
|
|
391
573
|
# assigned to your endpoint.
|
|
392
574
|
#
|
|
393
575
|
# @option params [String] :endpoint_type
|
|
394
|
-
# The type of
|
|
395
|
-
#
|
|
396
|
-
# VPC endpoint
|
|
397
|
-
# only within your VPC
|
|
398
|
-
#
|
|
399
|
-
#
|
|
576
|
+
# The type of endpoint that you want your server to use. You can choose
|
|
577
|
+
# to make your server's endpoint publicly accessible (PUBLIC) or host
|
|
578
|
+
# it inside your VPC. With an endpoint that is hosted in a VPC, you can
|
|
579
|
+
# restrict access to your server and resources only within your VPC or
|
|
580
|
+
# choose to make it internet facing by attaching Elastic IP addresses
|
|
581
|
+
# directly to it.
|
|
582
|
+
#
|
|
583
|
+
# <note markdown="1"> After March 31, 2021, you won't be able to create a server using
|
|
584
|
+
# `EndpointType=VPC_ENDPOINT` in your AWS account if your account
|
|
585
|
+
# hasn't already done so before March 31, 2021. If you have already
|
|
586
|
+
# created servers with `EndpointType=VPC_ENDPOINT` in your AWS account
|
|
587
|
+
# on or before March 31, 2021, you will not be affected. After this
|
|
588
|
+
# date, use `EndpointType`=`VPC`.
|
|
589
|
+
#
|
|
590
|
+
# For more information, see
|
|
591
|
+
# https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
|
|
592
|
+
#
|
|
593
|
+
# It is recommended that you use `VPC` as the `EndpointType`. With this
|
|
400
594
|
# endpoint type, you have the option to directly associate up to three
|
|
401
595
|
# Elastic IPv4 addresses (BYO IP included) with your server's endpoint
|
|
402
596
|
# and use VPC security groups to restrict traffic by the client's
|
|
@@ -421,19 +615,25 @@ module Aws::Transfer
|
|
|
421
615
|
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key
|
|
422
616
|
#
|
|
423
617
|
# @option params [Types::IdentityProviderDetails] :identity_provider_details
|
|
424
|
-
# Required when `IdentityProviderType` is set to `
|
|
425
|
-
# an array containing all of the information
|
|
618
|
+
# Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE`
|
|
619
|
+
# or `API_GATEWAY`. Accepts an array containing all of the information
|
|
620
|
+
# required to use a directory in `AWS_DIRECTORY_SERVICE` or invoke a
|
|
426
621
|
# customer-supplied authentication API, including the API Gateway URL.
|
|
427
622
|
# Not required when `IdentityProviderType` is set to `SERVICE_MANAGED`.
|
|
428
623
|
#
|
|
429
624
|
# @option params [String] :identity_provider_type
|
|
430
625
|
# Specifies the mode of authentication for a server. The default value
|
|
431
626
|
# is `SERVICE_MANAGED`, which allows you to store and access user
|
|
432
|
-
# credentials within the AWS Transfer Family service. Use
|
|
433
|
-
# `
|
|
434
|
-
#
|
|
435
|
-
#
|
|
436
|
-
#
|
|
627
|
+
# credentials within the AWS Transfer Family service. Use
|
|
628
|
+
# `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups
|
|
629
|
+
# in AWS Managed Active Directory or Microsoft Active Directory in your
|
|
630
|
+
# on-premises environment or in AWS using AD Connectors. This option
|
|
631
|
+
# also requires you to provide a Directory ID using the
|
|
632
|
+
# `IdentityProviderDetails` parameter. Use the `API_GATEWAY` value to
|
|
633
|
+
# integrate with an identity provider of your choosing. The
|
|
634
|
+
# `API_GATEWAY` setting requires you to provide an API Gateway endpoint
|
|
635
|
+
# URL to call for authentication using the `IdentityProviderDetails`
|
|
636
|
+
# parameter.
|
|
437
637
|
#
|
|
438
638
|
# @option params [String] :logging_role
|
|
439
639
|
# Allows the service to write your users' activity to your Amazon
|
|
@@ -457,7 +657,8 @@ module Aws::Transfer
|
|
|
457
657
|
# when clients connect to it over FTPS.
|
|
458
658
|
#
|
|
459
659
|
# If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType`
|
|
460
|
-
# must be `VPC` and the `IdentityProviderType` must be
|
|
660
|
+
# must be `VPC` and the `IdentityProviderType` must be
|
|
661
|
+
# `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`.
|
|
461
662
|
#
|
|
462
663
|
# If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be
|
|
463
664
|
# associated.
|
|
@@ -483,6 +684,7 @@ module Aws::Transfer
|
|
|
483
684
|
#
|
|
484
685
|
# resp = client.create_server({
|
|
485
686
|
# certificate: "Certificate",
|
|
687
|
+
# domain: "S3", # accepts S3, EFS
|
|
486
688
|
# endpoint_details: {
|
|
487
689
|
# address_allocation_ids: ["AddressAllocationId"],
|
|
488
690
|
# subnet_ids: ["SubnetId"],
|
|
@@ -495,8 +697,9 @@ module Aws::Transfer
|
|
|
495
697
|
# identity_provider_details: {
|
|
496
698
|
# url: "Url",
|
|
497
699
|
# invocation_role: "Role",
|
|
700
|
+
# directory_id: "DirectoryId",
|
|
498
701
|
# },
|
|
499
|
-
# identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY
|
|
702
|
+
# identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY, AWS_DIRECTORY_SERVICE
|
|
500
703
|
# logging_role: "Role",
|
|
501
704
|
# protocols: ["SFTP"], # accepts SFTP, FTP, FTPS
|
|
502
705
|
# security_policy_name: "SecurityPolicyName",
|
|
@@ -534,8 +737,7 @@ module Aws::Transfer
|
|
|
534
737
|
# The landing directory (folder) for a user when they log in to the
|
|
535
738
|
# server using the client.
|
|
536
739
|
#
|
|
537
|
-
#
|
|
538
|
-
# <code>your-Amazon-S3-bucket-name>/home/username</code> </i>.
|
|
740
|
+
# A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
|
|
539
741
|
#
|
|
540
742
|
# @option params [String] :home_directory_type
|
|
541
743
|
# The type of landing directory (folder) you want your users' home
|
|
@@ -546,31 +748,37 @@ module Aws::Transfer
|
|
|
546
748
|
# you want to make Amazon S3 paths visible to your users.
|
|
547
749
|
#
|
|
548
750
|
# @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
|
|
549
|
-
# Logical directory mappings that specify what Amazon S3
|
|
550
|
-
# should be visible to your user and how you want to make them
|
|
551
|
-
# You will need to specify the
|
|
751
|
+
# Logical directory mappings that specify what Amazon S3 or EFS paths
|
|
752
|
+
# and keys should be visible to your user and how you want to make them
|
|
753
|
+
# visible. You will need to specify the `Entry` and `Target` pair, where
|
|
552
754
|
# `Entry` shows how the path is made visible and `Target` is the actual
|
|
553
|
-
# Amazon S3 path. If you only specify a target, it will be
|
|
554
|
-
# is. You will need to also make sure that your IAM role
|
|
555
|
-
# to paths in `Target`.
|
|
755
|
+
# Amazon S3 or EFS path. If you only specify a target, it will be
|
|
756
|
+
# displayed as is. You will need to also make sure that your IAM role
|
|
757
|
+
# provides access to paths in `Target`. This value can only be set when
|
|
758
|
+
# `HomeDirectoryType` is set to `LOGICAL`.
|
|
556
759
|
#
|
|
557
|
-
#
|
|
558
|
-
#
|
|
559
|
-
#
|
|
760
|
+
# The following is an `Entry` and `Target` pair example.
|
|
761
|
+
#
|
|
762
|
+
# `[ \{ "Entry": "your-personal-report.pdf", "Target":
|
|
763
|
+
# "/bucket3/customized-reports/$\{transfer:UserName\}.pdf" \} ]`
|
|
560
764
|
#
|
|
561
765
|
# In most cases, you can use this value instead of the scope-down policy
|
|
562
|
-
# to lock your user down to the designated home directory
|
|
563
|
-
# To do this, you can set `Entry` to
|
|
564
|
-
# HomeDirectory parameter value.
|
|
565
|
-
#
|
|
566
|
-
#
|
|
567
|
-
#
|
|
568
|
-
#
|
|
569
|
-
#
|
|
570
|
-
# the
|
|
571
|
-
#
|
|
572
|
-
#
|
|
573
|
-
#
|
|
766
|
+
# to lock your user down to the designated home directory
|
|
767
|
+
# ("`chroot`"). To do this, you can set `Entry` to `/` and set
|
|
768
|
+
# `Target` to the HomeDirectory parameter value.
|
|
769
|
+
#
|
|
770
|
+
# The following is an `Entry` and `Target` pair example for `chroot`.
|
|
771
|
+
#
|
|
772
|
+
# `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
|
|
773
|
+
#
|
|
774
|
+
# <note markdown="1"> If the target of a logical directory entry does not exist in Amazon S3
|
|
775
|
+
# or EFS, the entry will be ignored. As a workaround, you can use the
|
|
776
|
+
# Amazon S3 API or EFS API to create 0 byte objects as place holders for
|
|
777
|
+
# your directory. If using the CLI, use the `s3api` or `efsapi` call
|
|
778
|
+
# instead of `s3` or `efs` so you can use the put-object operation. For
|
|
779
|
+
# example, you use the following: `aws s3api put-object --bucket
|
|
780
|
+
# bucketname --key path/to/folder/`. Make sure that the end of the key
|
|
781
|
+
# name ends in a `/` for it to be considered a folder.
|
|
574
782
|
#
|
|
575
783
|
# </note>
|
|
576
784
|
#
|
|
@@ -581,12 +789,15 @@ module Aws::Transfer
|
|
|
581
789
|
# policy include `$\{Transfer:UserName\}`,
|
|
582
790
|
# `$\{Transfer:HomeDirectory\}`, and `$\{Transfer:HomeBucket\}`.
|
|
583
791
|
#
|
|
584
|
-
# <note markdown="1">
|
|
792
|
+
# <note markdown="1"> This only applies when domain of ServerId is S3. EFS does not use
|
|
793
|
+
# scope down policy.
|
|
794
|
+
#
|
|
795
|
+
# For scope-down policies, AWS Transfer Family stores the policy as a
|
|
585
796
|
# JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
|
|
586
797
|
# You save the policy as a JSON blob and pass it in the `Policy`
|
|
587
798
|
# argument.
|
|
588
799
|
#
|
|
589
|
-
# For an example of a scope-down policy, see [
|
|
800
|
+
# For an example of a scope-down policy, see [Example scope-down
|
|
590
801
|
# policy][1].
|
|
591
802
|
#
|
|
592
803
|
# For more information, see [AssumeRole][2] in the *AWS Security Token
|
|
@@ -596,16 +807,25 @@ module Aws::Transfer
|
|
|
596
807
|
#
|
|
597
808
|
#
|
|
598
809
|
#
|
|
599
|
-
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/
|
|
810
|
+
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/scope-down-policy.html
|
|
600
811
|
# [2]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
|
|
601
812
|
#
|
|
813
|
+
# @option params [Types::PosixProfile] :posix_profile
|
|
814
|
+
# Specifies the full POSIX identity, including user ID (`Uid`), group ID
|
|
815
|
+
# (`Gid`), and any secondary groups IDs (`SecondaryGids`), that controls
|
|
816
|
+
# your users' access to your Amazon EFS file systems. The POSIX
|
|
817
|
+
# permissions that are set on files and directories in Amazon EFS
|
|
818
|
+
# determine the level of access your users get when transferring files
|
|
819
|
+
# into and out of your Amazon EFS file systems.
|
|
820
|
+
#
|
|
602
821
|
# @option params [required, String] :role
|
|
603
|
-
#
|
|
604
|
-
# bucket. The policies attached to this
|
|
605
|
-
# access you want to provide your users
|
|
606
|
-
# out of your Amazon S3 bucket or
|
|
607
|
-
#
|
|
608
|
-
# resources when servicing your
|
|
822
|
+
# Specifies the IAM role that controls your users' access to your
|
|
823
|
+
# Amazon S3 bucket or EFS file system. The policies attached to this
|
|
824
|
+
# role will determine the level of access you want to provide your users
|
|
825
|
+
# when transferring files into and out of your Amazon S3 bucket or EFS
|
|
826
|
+
# file system. The IAM role should also contain a trust relationship
|
|
827
|
+
# that allows the server to access your resources when servicing your
|
|
828
|
+
# users' transfer requests.
|
|
609
829
|
#
|
|
610
830
|
# @option params [required, String] :server_id
|
|
611
831
|
# A system-assigned unique identifier for a server instance. This is the
|
|
@@ -644,6 +864,11 @@ module Aws::Transfer
|
|
|
644
864
|
# },
|
|
645
865
|
# ],
|
|
646
866
|
# policy: "Policy",
|
|
867
|
+
# posix_profile: {
|
|
868
|
+
# uid: 1, # required
|
|
869
|
+
# gid: 1, # required
|
|
870
|
+
# secondary_gids: [1],
|
|
871
|
+
# },
|
|
647
872
|
# role: "Role", # required
|
|
648
873
|
# server_id: "ServerId", # required
|
|
649
874
|
# ssh_public_key_body: "SshPublicKeyBody",
|
|
@@ -670,6 +895,50 @@ module Aws::Transfer
|
|
|
670
895
|
req.send_request(options)
|
|
671
896
|
end
|
|
672
897
|
|
|
898
|
+
# Allows you to delete the access specified in the `ServerID` and
|
|
899
|
+
# `ExternalID` parameters.
|
|
900
|
+
#
|
|
901
|
+
# @option params [required, String] :server_id
|
|
902
|
+
# A system-assigned unique identifier for a server that has this user
|
|
903
|
+
# assigned.
|
|
904
|
+
#
|
|
905
|
+
# @option params [required, String] :external_id
|
|
906
|
+
# A unique identifier that is required to identify specific groups
|
|
907
|
+
# within your directory. The users of the group that you associate have
|
|
908
|
+
# access to your Amazon S3 or Amazon EFS resources over the enabled
|
|
909
|
+
# protocols using AWS Transfer Family. If you know the group name, you
|
|
910
|
+
# can view the SID values by running the following command using Windows
|
|
911
|
+
# PowerShell.
|
|
912
|
+
#
|
|
913
|
+
# `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
|
|
914
|
+
# -Properties * | Select SamaccountName,ObjectSid`
|
|
915
|
+
#
|
|
916
|
+
# In that command, replace *YourGroupName* with the name of your Active
|
|
917
|
+
# Directory group.
|
|
918
|
+
#
|
|
919
|
+
# The regex used to validate this parameter is a string of characters
|
|
920
|
+
# consisting of uppercase and lowercase alphanumeric characters with no
|
|
921
|
+
# spaces. You can also include underscores or any of the following
|
|
922
|
+
# characters: =,.@:/-
|
|
923
|
+
#
|
|
924
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
925
|
+
#
|
|
926
|
+
# @example Request syntax with placeholder values
|
|
927
|
+
#
|
|
928
|
+
# resp = client.delete_access({
|
|
929
|
+
# server_id: "ServerId", # required
|
|
930
|
+
# external_id: "ExternalId", # required
|
|
931
|
+
# })
|
|
932
|
+
#
|
|
933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteAccess AWS API Documentation
|
|
934
|
+
#
|
|
935
|
+
# @overload delete_access(params = {})
|
|
936
|
+
# @param [Hash] params ({})
|
|
937
|
+
def delete_access(params = {}, options = {})
|
|
938
|
+
req = build_request(:delete_access, params)
|
|
939
|
+
req.send_request(options)
|
|
940
|
+
end
|
|
941
|
+
|
|
673
942
|
# Deletes the file transfer protocol-enabled server that you specify.
|
|
674
943
|
#
|
|
675
944
|
# No response returns from this operation.
|
|
@@ -763,6 +1032,73 @@ module Aws::Transfer
|
|
|
763
1032
|
req.send_request(options)
|
|
764
1033
|
end
|
|
765
1034
|
|
|
1035
|
+
# Describes the access that is assigned to the specific file transfer
|
|
1036
|
+
# protocol-enabled server, as identified by its `ServerId` property and
|
|
1037
|
+
# its `ExternalID`.
|
|
1038
|
+
#
|
|
1039
|
+
# The response from this call returns the properties of the access that
|
|
1040
|
+
# is associated with the `ServerId` value that was specified.
|
|
1041
|
+
#
|
|
1042
|
+
# @option params [required, String] :server_id
|
|
1043
|
+
# A system-assigned unique identifier for a server that has this access
|
|
1044
|
+
# assigned.
|
|
1045
|
+
#
|
|
1046
|
+
# @option params [required, String] :external_id
|
|
1047
|
+
# A unique identifier that is required to identify specific groups
|
|
1048
|
+
# within your directory. The users of the group you associate have
|
|
1049
|
+
# access to your Amazon S3 or Amazon EFS resources over the enabled
|
|
1050
|
+
# protocols using AWS Transfer Family. If you know the group name, you
|
|
1051
|
+
# can view the SID values by running the following command using Windows
|
|
1052
|
+
# PowerShell.
|
|
1053
|
+
#
|
|
1054
|
+
# `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
|
|
1055
|
+
# -Properties * | Select SamaccountName,ObjectSid`
|
|
1056
|
+
#
|
|
1057
|
+
# In that command, replace *YourGroupName* with the name of your Active
|
|
1058
|
+
# Directory group.
|
|
1059
|
+
#
|
|
1060
|
+
# The regex used to validate this parameter is a string of characters
|
|
1061
|
+
# consisting of uppercase and lowercase alphanumeric characters with no
|
|
1062
|
+
# spaces. You can also include underscores or any of the following
|
|
1063
|
+
# characters: =,.@:/-
|
|
1064
|
+
#
|
|
1065
|
+
# @return [Types::DescribeAccessResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1066
|
+
#
|
|
1067
|
+
# * {Types::DescribeAccessResponse#server_id #server_id} => String
|
|
1068
|
+
# * {Types::DescribeAccessResponse#access #access} => Types::DescribedAccess
|
|
1069
|
+
#
|
|
1070
|
+
# @example Request syntax with placeholder values
|
|
1071
|
+
#
|
|
1072
|
+
# resp = client.describe_access({
|
|
1073
|
+
# server_id: "ServerId", # required
|
|
1074
|
+
# external_id: "ExternalId", # required
|
|
1075
|
+
# })
|
|
1076
|
+
#
|
|
1077
|
+
# @example Response structure
|
|
1078
|
+
#
|
|
1079
|
+
# resp.server_id #=> String
|
|
1080
|
+
# resp.access.home_directory #=> String
|
|
1081
|
+
# resp.access.home_directory_mappings #=> Array
|
|
1082
|
+
# resp.access.home_directory_mappings[0].entry #=> String
|
|
1083
|
+
# resp.access.home_directory_mappings[0].target #=> String
|
|
1084
|
+
# resp.access.home_directory_type #=> String, one of "PATH", "LOGICAL"
|
|
1085
|
+
# resp.access.policy #=> String
|
|
1086
|
+
# resp.access.posix_profile.uid #=> Integer
|
|
1087
|
+
# resp.access.posix_profile.gid #=> Integer
|
|
1088
|
+
# resp.access.posix_profile.secondary_gids #=> Array
|
|
1089
|
+
# resp.access.posix_profile.secondary_gids[0] #=> Integer
|
|
1090
|
+
# resp.access.role #=> String
|
|
1091
|
+
# resp.access.external_id #=> String
|
|
1092
|
+
#
|
|
1093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeAccess AWS API Documentation
|
|
1094
|
+
#
|
|
1095
|
+
# @overload describe_access(params = {})
|
|
1096
|
+
# @param [Hash] params ({})
|
|
1097
|
+
def describe_access(params = {}, options = {})
|
|
1098
|
+
req = build_request(:describe_access, params)
|
|
1099
|
+
req.send_request(options)
|
|
1100
|
+
end
|
|
1101
|
+
|
|
766
1102
|
# Describes the security policy that is attached to your file transfer
|
|
767
1103
|
# protocol-enabled server. The response contains a description of the
|
|
768
1104
|
# security policy's properties. For more information about security
|
|
@@ -832,6 +1168,7 @@ module Aws::Transfer
|
|
|
832
1168
|
#
|
|
833
1169
|
# resp.server.arn #=> String
|
|
834
1170
|
# resp.server.certificate #=> String
|
|
1171
|
+
# resp.server.domain #=> String, one of "S3", "EFS"
|
|
835
1172
|
# resp.server.endpoint_details.address_allocation_ids #=> Array
|
|
836
1173
|
# resp.server.endpoint_details.address_allocation_ids[0] #=> String
|
|
837
1174
|
# resp.server.endpoint_details.subnet_ids #=> Array
|
|
@@ -844,7 +1181,8 @@ module Aws::Transfer
|
|
|
844
1181
|
# resp.server.host_key_fingerprint #=> String
|
|
845
1182
|
# resp.server.identity_provider_details.url #=> String
|
|
846
1183
|
# resp.server.identity_provider_details.invocation_role #=> String
|
|
847
|
-
# resp.server.
|
|
1184
|
+
# resp.server.identity_provider_details.directory_id #=> String
|
|
1185
|
+
# resp.server.identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY", "AWS_DIRECTORY_SERVICE"
|
|
848
1186
|
# resp.server.logging_role #=> String
|
|
849
1187
|
# resp.server.protocols #=> Array
|
|
850
1188
|
# resp.server.protocols[0] #=> String, one of "SFTP", "FTP", "FTPS"
|
|
@@ -902,6 +1240,10 @@ module Aws::Transfer
|
|
|
902
1240
|
# resp.user.home_directory_mappings[0].target #=> String
|
|
903
1241
|
# resp.user.home_directory_type #=> String, one of "PATH", "LOGICAL"
|
|
904
1242
|
# resp.user.policy #=> String
|
|
1243
|
+
# resp.user.posix_profile.uid #=> Integer
|
|
1244
|
+
# resp.user.posix_profile.gid #=> Integer
|
|
1245
|
+
# resp.user.posix_profile.secondary_gids #=> Array
|
|
1246
|
+
# resp.user.posix_profile.secondary_gids[0] #=> Integer
|
|
905
1247
|
# resp.user.role #=> String
|
|
906
1248
|
# resp.user.ssh_public_keys #=> Array
|
|
907
1249
|
# resp.user.ssh_public_keys[0].date_imported #=> Time
|
|
@@ -966,6 +1308,56 @@ module Aws::Transfer
|
|
|
966
1308
|
req.send_request(options)
|
|
967
1309
|
end
|
|
968
1310
|
|
|
1311
|
+
# Lists the details for all the accesses you have on your server.
|
|
1312
|
+
#
|
|
1313
|
+
# @option params [Integer] :max_results
|
|
1314
|
+
# Specifies the maximum number of access SIDs to return.
|
|
1315
|
+
#
|
|
1316
|
+
# @option params [String] :next_token
|
|
1317
|
+
# When you can get additional results from the `ListAccesses` call, a
|
|
1318
|
+
# `NextToken` parameter is returned in the output. You can then pass in
|
|
1319
|
+
# a subsequent command to the `NextToken` parameter to continue listing
|
|
1320
|
+
# additional accesses.
|
|
1321
|
+
#
|
|
1322
|
+
# @option params [required, String] :server_id
|
|
1323
|
+
# A system-assigned unique identifier for a server that has users
|
|
1324
|
+
# assigned to it.
|
|
1325
|
+
#
|
|
1326
|
+
# @return [Types::ListAccessesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1327
|
+
#
|
|
1328
|
+
# * {Types::ListAccessesResponse#next_token #next_token} => String
|
|
1329
|
+
# * {Types::ListAccessesResponse#server_id #server_id} => String
|
|
1330
|
+
# * {Types::ListAccessesResponse#accesses #accesses} => Array<Types::ListedAccess>
|
|
1331
|
+
#
|
|
1332
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1333
|
+
#
|
|
1334
|
+
# @example Request syntax with placeholder values
|
|
1335
|
+
#
|
|
1336
|
+
# resp = client.list_accesses({
|
|
1337
|
+
# max_results: 1,
|
|
1338
|
+
# next_token: "NextToken",
|
|
1339
|
+
# server_id: "ServerId", # required
|
|
1340
|
+
# })
|
|
1341
|
+
#
|
|
1342
|
+
# @example Response structure
|
|
1343
|
+
#
|
|
1344
|
+
# resp.next_token #=> String
|
|
1345
|
+
# resp.server_id #=> String
|
|
1346
|
+
# resp.accesses #=> Array
|
|
1347
|
+
# resp.accesses[0].home_directory #=> String
|
|
1348
|
+
# resp.accesses[0].home_directory_type #=> String, one of "PATH", "LOGICAL"
|
|
1349
|
+
# resp.accesses[0].role #=> String
|
|
1350
|
+
# resp.accesses[0].external_id #=> String
|
|
1351
|
+
#
|
|
1352
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListAccesses AWS API Documentation
|
|
1353
|
+
#
|
|
1354
|
+
# @overload list_accesses(params = {})
|
|
1355
|
+
# @param [Hash] params ({})
|
|
1356
|
+
def list_accesses(params = {}, options = {})
|
|
1357
|
+
req = build_request(:list_accesses, params)
|
|
1358
|
+
req.send_request(options)
|
|
1359
|
+
end
|
|
1360
|
+
|
|
969
1361
|
# Lists the security policies that are attached to your file transfer
|
|
970
1362
|
# protocol-enabled servers.
|
|
971
1363
|
#
|
|
@@ -1040,7 +1432,8 @@ module Aws::Transfer
|
|
|
1040
1432
|
# resp.next_token #=> String
|
|
1041
1433
|
# resp.servers #=> Array
|
|
1042
1434
|
# resp.servers[0].arn #=> String
|
|
1043
|
-
# resp.servers[0].
|
|
1435
|
+
# resp.servers[0].domain #=> String, one of "S3", "EFS"
|
|
1436
|
+
# resp.servers[0].identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY", "AWS_DIRECTORY_SERVICE"
|
|
1044
1437
|
# resp.servers[0].endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
|
|
1045
1438
|
# resp.servers[0].logging_role #=> String
|
|
1046
1439
|
# resp.servers[0].server_id #=> String
|
|
@@ -1056,8 +1449,8 @@ module Aws::Transfer
|
|
|
1056
1449
|
req.send_request(options)
|
|
1057
1450
|
end
|
|
1058
1451
|
|
|
1059
|
-
# Lists all of the tags associated with the Amazon Resource
|
|
1060
|
-
# you specify. The resource can be a user, server, or role.
|
|
1452
|
+
# Lists all of the tags associated with the Amazon Resource Name (ARN)
|
|
1453
|
+
# that you specify. The resource can be a user, server, or role.
|
|
1061
1454
|
#
|
|
1062
1455
|
# @option params [required, String] :arn
|
|
1063
1456
|
# Requests the tags associated with a particular Amazon Resource Name
|
|
@@ -1268,11 +1661,12 @@ module Aws::Transfer
|
|
|
1268
1661
|
end
|
|
1269
1662
|
|
|
1270
1663
|
# If the `IdentityProviderType` of a file transfer protocol-enabled
|
|
1271
|
-
# server is `API_Gateway`, tests whether your
|
|
1272
|
-
# successfully. We highly recommend that you
|
|
1273
|
-
# your authentication method as soon as you
|
|
1274
|
-
# so, you can troubleshoot issues with the
|
|
1275
|
-
# ensure that your users can
|
|
1664
|
+
# server is `AWS_DIRECTORY_SERVICE` or `API_Gateway`, tests whether your
|
|
1665
|
+
# identity provider is set up successfully. We highly recommend that you
|
|
1666
|
+
# call this operation to test your authentication method as soon as you
|
|
1667
|
+
# create your server. By doing so, you can troubleshoot issues with the
|
|
1668
|
+
# identity provider integration to ensure that your users can
|
|
1669
|
+
# successfully use the service.
|
|
1276
1670
|
#
|
|
1277
1671
|
# @option params [required, String] :server_id
|
|
1278
1672
|
# A system-assigned identifier for a specific server. That server's
|
|
@@ -1365,6 +1759,173 @@ module Aws::Transfer
|
|
|
1365
1759
|
req.send_request(options)
|
|
1366
1760
|
end
|
|
1367
1761
|
|
|
1762
|
+
# Allows you to update parameters for the access specified in the
|
|
1763
|
+
# `ServerID` and `ExternalID` parameters.
|
|
1764
|
+
#
|
|
1765
|
+
# @option params [String] :home_directory
|
|
1766
|
+
# The landing directory (folder) for a user when they log in to the
|
|
1767
|
+
# server using the client.
|
|
1768
|
+
#
|
|
1769
|
+
# A `HomeDirectory` example is `/directory_name/home/mydirectory`.
|
|
1770
|
+
#
|
|
1771
|
+
# @option params [String] :home_directory_type
|
|
1772
|
+
# The type of landing directory (folder) that you want your users' home
|
|
1773
|
+
# directory to be when they log in to the server. If you set it to
|
|
1774
|
+
# `PATH`, the user will see the absolute Amazon S3 bucket paths as is in
|
|
1775
|
+
# their file transfer protocol clients. If you set it `LOGICAL`, you
|
|
1776
|
+
# must provide mappings in the `HomeDirectoryMappings` for how you want
|
|
1777
|
+
# to make Amazon S3 paths visible to your users.
|
|
1778
|
+
#
|
|
1779
|
+
# @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
|
|
1780
|
+
# Logical directory mappings that specify what Amazon S3 or Amazon EFS
|
|
1781
|
+
# paths and keys should be visible to your user and how you want to make
|
|
1782
|
+
# them visible. You must specify the `Entry` and `Target` pair, where
|
|
1783
|
+
# `Entry` shows how the path is made visible and `Target` is the actual
|
|
1784
|
+
# Amazon S3 or Amazon EFS path. If you only specify a target, it will be
|
|
1785
|
+
# displayed as is. You also must ensure that your AWS Identity and
|
|
1786
|
+
# Access Management (IAM) role provides access to paths in `Target`.
|
|
1787
|
+
# This value can only be set when `HomeDirectoryType` is set to
|
|
1788
|
+
# *LOGICAL*.
|
|
1789
|
+
#
|
|
1790
|
+
# The following is an `Entry` and `Target` pair example.
|
|
1791
|
+
#
|
|
1792
|
+
# `[ \{ "Entry": "your-personal-report.pdf", "Target":
|
|
1793
|
+
# "/bucket3/customized-reports/$\{transfer:UserName\}.pdf" \} ]`
|
|
1794
|
+
#
|
|
1795
|
+
# In most cases, you can use this value instead of the scope-down policy
|
|
1796
|
+
# to lock down your user to the designated home directory
|
|
1797
|
+
# ("`chroot`"). To do this, you can set `Entry` to `/` and set
|
|
1798
|
+
# `Target` to the `HomeDirectory` parameter value.
|
|
1799
|
+
#
|
|
1800
|
+
# The following is an `Entry` and `Target` pair example for `chroot`.
|
|
1801
|
+
#
|
|
1802
|
+
# `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
|
|
1803
|
+
#
|
|
1804
|
+
# <note markdown="1"> If the target of a logical directory entry does not exist in Amazon S3
|
|
1805
|
+
# or Amazon EFS, the entry will be ignored. As a workaround, you can use
|
|
1806
|
+
# the Amazon S3 API or EFS API to create 0-byte objects as place holders
|
|
1807
|
+
# for your directory. If using the AWS CLI, use the `s3api` or `efsapi`
|
|
1808
|
+
# call instead of `s3` or `efs` so you can use the `put-object`
|
|
1809
|
+
# operation. For example, you can use the following.
|
|
1810
|
+
#
|
|
1811
|
+
# `aws s3api put-object --bucket bucketname --key path/to/folder/`
|
|
1812
|
+
#
|
|
1813
|
+
# The end of the key name must end in a `/` for it to be considered a
|
|
1814
|
+
# folder.
|
|
1815
|
+
#
|
|
1816
|
+
# </note>
|
|
1817
|
+
#
|
|
1818
|
+
# Required: No
|
|
1819
|
+
#
|
|
1820
|
+
# @option params [String] :policy
|
|
1821
|
+
# A scope-down policy for your user so that you can use the same IAM
|
|
1822
|
+
# role across multiple users. This policy scopes down user access to
|
|
1823
|
+
# portions of their Amazon S3 bucket. Variables that you can use inside
|
|
1824
|
+
# this policy include `$\{Transfer:UserName\}`,
|
|
1825
|
+
# `$\{Transfer:HomeDirectory\}`, and `$\{Transfer:HomeBucket\}`.
|
|
1826
|
+
#
|
|
1827
|
+
# <note markdown="1"> This only applies when domain of `ServerId` is S3. Amazon EFS does not
|
|
1828
|
+
# use scope down policy.
|
|
1829
|
+
#
|
|
1830
|
+
# For scope-down policies, AWS Transfer Family stores the policy as a
|
|
1831
|
+
# JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
|
|
1832
|
+
# You save the policy as a JSON blob and pass it in the `Policy`
|
|
1833
|
+
# argument.
|
|
1834
|
+
#
|
|
1835
|
+
# For an example of a scope-down policy, see [Example scope-down
|
|
1836
|
+
# policy][1].
|
|
1837
|
+
#
|
|
1838
|
+
# For more information, see [AssumeRole][2] in the *AWS Security Token
|
|
1839
|
+
# Service API Reference*.
|
|
1840
|
+
#
|
|
1841
|
+
# </note>
|
|
1842
|
+
#
|
|
1843
|
+
#
|
|
1844
|
+
#
|
|
1845
|
+
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/scope-down-policy.html
|
|
1846
|
+
# [2]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
|
|
1847
|
+
#
|
|
1848
|
+
# @option params [Types::PosixProfile] :posix_profile
|
|
1849
|
+
# The full POSIX identity, including user ID (`Uid`), group ID (`Gid`),
|
|
1850
|
+
# and any secondary groups IDs (`SecondaryGids`), that controls your
|
|
1851
|
+
# users' access to your Amazon EFS file systems. The POSIX permissions
|
|
1852
|
+
# that are set on files and directories in your file system determine
|
|
1853
|
+
# the level of access your users get when transferring files into and
|
|
1854
|
+
# out of your Amazon EFS file systems.
|
|
1855
|
+
#
|
|
1856
|
+
# @option params [String] :role
|
|
1857
|
+
# Specifies the IAM role that controls your users' access to your
|
|
1858
|
+
# Amazon S3 bucket or EFS file system. The policies attached to this
|
|
1859
|
+
# role determine the level of access that you want to provide your users
|
|
1860
|
+
# when transferring files into and out of your Amazon S3 bucket or EFS
|
|
1861
|
+
# file system. The IAM role should also contain a trust relationship
|
|
1862
|
+
# that allows the server to access your resources when servicing your
|
|
1863
|
+
# users' transfer requests.
|
|
1864
|
+
#
|
|
1865
|
+
# @option params [required, String] :server_id
|
|
1866
|
+
# A system-assigned unique identifier for a server instance. This is the
|
|
1867
|
+
# specific server that you added your user to.
|
|
1868
|
+
#
|
|
1869
|
+
# @option params [required, String] :external_id
|
|
1870
|
+
# A unique identifier that is required to identify specific groups
|
|
1871
|
+
# within your directory. The users of the group that you associate have
|
|
1872
|
+
# access to your Amazon S3 or Amazon EFS resources over the enabled
|
|
1873
|
+
# protocols using AWS Transfer Family. If you know the group name, you
|
|
1874
|
+
# can view the SID values by running the following command using Windows
|
|
1875
|
+
# PowerShell.
|
|
1876
|
+
#
|
|
1877
|
+
# `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
|
|
1878
|
+
# -Properties * | Select SamaccountName,ObjectSid`
|
|
1879
|
+
#
|
|
1880
|
+
# In that command, replace *YourGroupName* with the name of your Active
|
|
1881
|
+
# Directory group.
|
|
1882
|
+
#
|
|
1883
|
+
# The regex used to validate this parameter is a string of characters
|
|
1884
|
+
# consisting of uppercase and lowercase alphanumeric characters with no
|
|
1885
|
+
# spaces. You can also include underscores or any of the following
|
|
1886
|
+
# characters: =,.@:/-
|
|
1887
|
+
#
|
|
1888
|
+
# @return [Types::UpdateAccessResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1889
|
+
#
|
|
1890
|
+
# * {Types::UpdateAccessResponse#server_id #server_id} => String
|
|
1891
|
+
# * {Types::UpdateAccessResponse#external_id #external_id} => String
|
|
1892
|
+
#
|
|
1893
|
+
# @example Request syntax with placeholder values
|
|
1894
|
+
#
|
|
1895
|
+
# resp = client.update_access({
|
|
1896
|
+
# home_directory: "HomeDirectory",
|
|
1897
|
+
# home_directory_type: "PATH", # accepts PATH, LOGICAL
|
|
1898
|
+
# home_directory_mappings: [
|
|
1899
|
+
# {
|
|
1900
|
+
# entry: "MapEntry", # required
|
|
1901
|
+
# target: "MapTarget", # required
|
|
1902
|
+
# },
|
|
1903
|
+
# ],
|
|
1904
|
+
# policy: "Policy",
|
|
1905
|
+
# posix_profile: {
|
|
1906
|
+
# uid: 1, # required
|
|
1907
|
+
# gid: 1, # required
|
|
1908
|
+
# secondary_gids: [1],
|
|
1909
|
+
# },
|
|
1910
|
+
# role: "Role",
|
|
1911
|
+
# server_id: "ServerId", # required
|
|
1912
|
+
# external_id: "ExternalId", # required
|
|
1913
|
+
# })
|
|
1914
|
+
#
|
|
1915
|
+
# @example Response structure
|
|
1916
|
+
#
|
|
1917
|
+
# resp.server_id #=> String
|
|
1918
|
+
# resp.external_id #=> String
|
|
1919
|
+
#
|
|
1920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateAccess AWS API Documentation
|
|
1921
|
+
#
|
|
1922
|
+
# @overload update_access(params = {})
|
|
1923
|
+
# @param [Hash] params ({})
|
|
1924
|
+
def update_access(params = {}, options = {})
|
|
1925
|
+
req = build_request(:update_access, params)
|
|
1926
|
+
req.send_request(options)
|
|
1927
|
+
end
|
|
1928
|
+
|
|
1368
1929
|
# Updates the file transfer protocol-enabled server's properties after
|
|
1369
1930
|
# that server has been created.
|
|
1370
1931
|
#
|
|
@@ -1418,12 +1979,24 @@ module Aws::Transfer
|
|
|
1418
1979
|
# with your server's endpoint.
|
|
1419
1980
|
#
|
|
1420
1981
|
# @option params [String] :endpoint_type
|
|
1421
|
-
# The type of endpoint that you want your server to
|
|
1422
|
-
#
|
|
1423
|
-
#
|
|
1424
|
-
# within your VPC
|
|
1425
|
-
#
|
|
1426
|
-
#
|
|
1982
|
+
# The type of endpoint that you want your server to use. You can choose
|
|
1983
|
+
# to make your server's endpoint publicly accessible (PUBLIC) or host
|
|
1984
|
+
# it inside your VPC. With an endpoint that is hosted in a VPC, you can
|
|
1985
|
+
# restrict access to your server and resources only within your VPC or
|
|
1986
|
+
# choose to make it internet facing by attaching Elastic IP addresses
|
|
1987
|
+
# directly to it.
|
|
1988
|
+
#
|
|
1989
|
+
# <note markdown="1"> After March 31, 2021, you won't be able to create a server using
|
|
1990
|
+
# `EndpointType=VPC_ENDPOINT` in your AWS account if your account
|
|
1991
|
+
# hasn't already done so before March 31, 2021. If you have already
|
|
1992
|
+
# created servers with `EndpointType=VPC_ENDPOINT` in your AWS account
|
|
1993
|
+
# on or before March 31, 2021, you will not be affected. After this
|
|
1994
|
+
# date, use `EndpointType`=`VPC`.
|
|
1995
|
+
#
|
|
1996
|
+
# For more information, see
|
|
1997
|
+
# https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
|
|
1998
|
+
#
|
|
1999
|
+
# It is recommended that you use `VPC` as the `EndpointType`. With this
|
|
1427
2000
|
# endpoint type, you have the option to directly associate up to three
|
|
1428
2001
|
# Elastic IPv4 addresses (BYO IP included) with your server's endpoint
|
|
1429
2002
|
# and use VPC security groups to restrict traffic by the client's
|
|
@@ -1453,8 +2026,8 @@ module Aws::Transfer
|
|
|
1453
2026
|
#
|
|
1454
2027
|
# @option params [String] :logging_role
|
|
1455
2028
|
# Changes the AWS Identity and Access Management (IAM) role that allows
|
|
1456
|
-
# Amazon S3 events to be logged in Amazon CloudWatch,
|
|
1457
|
-
# or off.
|
|
2029
|
+
# Amazon S3 or Amazon EFS events to be logged in Amazon CloudWatch,
|
|
2030
|
+
# turning logging on or off.
|
|
1458
2031
|
#
|
|
1459
2032
|
# @option params [Array<String>] :protocols
|
|
1460
2033
|
# Specifies the file transfer protocol or protocols over which your file
|
|
@@ -1474,7 +2047,8 @@ module Aws::Transfer
|
|
|
1474
2047
|
# when clients connect to it over FTPS.
|
|
1475
2048
|
#
|
|
1476
2049
|
# If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType`
|
|
1477
|
-
# must be `VPC` and the `IdentityProviderType` must be
|
|
2050
|
+
# must be `VPC` and the `IdentityProviderType` must be
|
|
2051
|
+
# `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`.
|
|
1478
2052
|
#
|
|
1479
2053
|
# If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be
|
|
1480
2054
|
# associated.
|
|
@@ -1513,6 +2087,7 @@ module Aws::Transfer
|
|
|
1513
2087
|
# identity_provider_details: {
|
|
1514
2088
|
# url: "Url",
|
|
1515
2089
|
# invocation_role: "Role",
|
|
2090
|
+
# directory_id: "DirectoryId",
|
|
1516
2091
|
# },
|
|
1517
2092
|
# logging_role: "NullableRole",
|
|
1518
2093
|
# protocols: ["SFTP"], # accepts SFTP, FTP, FTPS
|
|
@@ -1549,37 +2124,39 @@ module Aws::Transfer
|
|
|
1549
2124
|
# @option params [String] :home_directory_type
|
|
1550
2125
|
# The type of landing directory (folder) you want your users' home
|
|
1551
2126
|
# directory to be when they log into the server. If you set it to
|
|
1552
|
-
# `PATH`, the user will see the absolute Amazon S3 bucket
|
|
1553
|
-
# their file transfer protocol clients. If you set it
|
|
1554
|
-
# will need to provide mappings in the
|
|
1555
|
-
# you want to make Amazon S3
|
|
2127
|
+
# `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths
|
|
2128
|
+
# as is in their file transfer protocol clients. If you set it
|
|
2129
|
+
# `LOGICAL`, you will need to provide mappings in the
|
|
2130
|
+
# `HomeDirectoryMappings` for how you want to make Amazon S3 or EFS
|
|
2131
|
+
# paths visible to your users.
|
|
1556
2132
|
#
|
|
1557
2133
|
# @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
|
|
1558
|
-
# Logical directory mappings that specify what Amazon S3
|
|
1559
|
-
# should be visible to your user and how you want to make
|
|
1560
|
-
# You will need to specify the "`Entry`" and
|
|
1561
|
-
# `Entry` shows how the path is made visible
|
|
1562
|
-
#
|
|
1563
|
-
#
|
|
1564
|
-
# to paths in `Target`. The
|
|
2134
|
+
# Logical directory mappings that specify what Amazon S3 or Amazon EFS
|
|
2135
|
+
# paths and keys should be visible to your user and how you want to make
|
|
2136
|
+
# them visible. You will need to specify the "`Entry`" and
|
|
2137
|
+
# "`Target`" pair, where `Entry` shows how the path is made visible
|
|
2138
|
+
# and `Target` is the actual Amazon S3 or Amazon EFS path. If you only
|
|
2139
|
+
# specify a target, it will be displayed as is. You will need to also
|
|
2140
|
+
# make sure that your IAM role provides access to paths in `Target`. The
|
|
2141
|
+
# following is an example.
|
|
1565
2142
|
#
|
|
1566
2143
|
# `'[ "/bucket2/documentation", \{ "Entry": "your-personal-report.pdf",
|
|
1567
2144
|
# "Target": "/bucket3/customized-reports/$\{transfer:UserName\}.pdf" \}
|
|
1568
2145
|
# ]'`
|
|
1569
2146
|
#
|
|
1570
2147
|
# In most cases, you can use this value instead of the scope-down policy
|
|
1571
|
-
# to lock your user
|
|
1572
|
-
# To do this, you can set `Entry` to '/' and set
|
|
1573
|
-
# HomeDirectory parameter value.
|
|
1574
|
-
#
|
|
1575
|
-
# <note markdown="1"> If the target of a logical directory entry does not exist in Amazon
|
|
1576
|
-
#
|
|
1577
|
-
# S3 API to create 0
|
|
1578
|
-
# If using the CLI, use the `s3api`
|
|
1579
|
-
#
|
|
1580
|
-
# s3api put-object --bucket
|
|
1581
|
-
# that the end of the key
|
|
1582
|
-
# folder.
|
|
2148
|
+
# to lock down your user to the designated home directory
|
|
2149
|
+
# ("`chroot`"). To do this, you can set `Entry` to '/' and set
|
|
2150
|
+
# `Target` to the HomeDirectory parameter value.
|
|
2151
|
+
#
|
|
2152
|
+
# <note markdown="1"> If the target of a logical directory entry does not exist in Amazon S3
|
|
2153
|
+
# or EFS, the entry will be ignored. As a workaround, you can use the
|
|
2154
|
+
# Amazon S3 API or EFS API to create 0-byte objects as place holders for
|
|
2155
|
+
# your directory. If using the AWS CLI, use the `s3api` or `efsapi` call
|
|
2156
|
+
# instead of `s3` `efs` so you can use the put-object operation. For
|
|
2157
|
+
# example, you use the following: `aws s3api put-object --bucket
|
|
2158
|
+
# bucketname --key path/to/folder/`. Make sure that the end of the key
|
|
2159
|
+
# name ends in a / for it to be considered a folder.
|
|
1583
2160
|
#
|
|
1584
2161
|
# </note>
|
|
1585
2162
|
#
|
|
@@ -1608,13 +2185,21 @@ module Aws::Transfer
|
|
|
1608
2185
|
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down
|
|
1609
2186
|
# [2]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
|
|
1610
2187
|
#
|
|
2188
|
+
# @option params [Types::PosixProfile] :posix_profile
|
|
2189
|
+
# Specifies the full POSIX identity, including user ID (`Uid`), group ID
|
|
2190
|
+
# (`Gid`), and any secondary groups IDs (`SecondaryGids`), that controls
|
|
2191
|
+
# your users' access to your Amazon Elastic File Systems (Amazon EFS).
|
|
2192
|
+
# The POSIX permissions that are set on files and directories in your
|
|
2193
|
+
# file system determines the level of access your users get when
|
|
2194
|
+
# transferring files into and out of your Amazon EFS file systems.
|
|
2195
|
+
#
|
|
1611
2196
|
# @option params [String] :role
|
|
1612
2197
|
# The IAM role that controls your users' access to your Amazon S3
|
|
1613
|
-
# bucket. The policies attached to this role
|
|
2198
|
+
# bucket. The policies attached to this role determine the level of
|
|
1614
2199
|
# access you want to provide your users when transferring files into and
|
|
1615
|
-
# out of your
|
|
1616
|
-
#
|
|
1617
|
-
#
|
|
2200
|
+
# out of your S3 bucket or buckets. The IAM role should also contain a
|
|
2201
|
+
# trust relationship that allows the server to access your resources
|
|
2202
|
+
# when servicing your users' transfer requests.
|
|
1618
2203
|
#
|
|
1619
2204
|
# @option params [required, String] :server_id
|
|
1620
2205
|
# A system-assigned unique identifier for a server instance that the
|
|
@@ -1645,6 +2230,11 @@ module Aws::Transfer
|
|
|
1645
2230
|
# },
|
|
1646
2231
|
# ],
|
|
1647
2232
|
# policy: "Policy",
|
|
2233
|
+
# posix_profile: {
|
|
2234
|
+
# uid: 1, # required
|
|
2235
|
+
# gid: 1, # required
|
|
2236
|
+
# secondary_gids: [1],
|
|
2237
|
+
# },
|
|
1648
2238
|
# role: "Role",
|
|
1649
2239
|
# server_id: "ServerId", # required
|
|
1650
2240
|
# user_name: "UserName", # required
|
|
@@ -1677,7 +2267,7 @@ module Aws::Transfer
|
|
|
1677
2267
|
params: params,
|
|
1678
2268
|
config: config)
|
|
1679
2269
|
context[:gem_name] = 'aws-sdk-transfer'
|
|
1680
|
-
context[:gem_version] = '1.
|
|
2270
|
+
context[:gem_version] = '1.33.0'
|
|
1681
2271
|
Seahorse::Client::Request.new(handlers, context)
|
|
1682
2272
|
end
|
|
1683
2273
|
|