aws-sdk-transfer 1.23.0 → 1.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-transfer.rb +3 -2
- data/lib/aws-sdk-transfer/client.rb +218 -112
- data/lib/aws-sdk-transfer/client_api.rb +74 -0
- data/lib/aws-sdk-transfer/types.rb +336 -204
- metadata +4 -4
@@ -27,14 +27,18 @@ module Aws::Transfer
|
|
27
27
|
DeleteServerRequest = Shapes::StructureShape.new(name: 'DeleteServerRequest')
|
28
28
|
DeleteSshPublicKeyRequest = Shapes::StructureShape.new(name: 'DeleteSshPublicKeyRequest')
|
29
29
|
DeleteUserRequest = Shapes::StructureShape.new(name: 'DeleteUserRequest')
|
30
|
+
DescribeSecurityPolicyRequest = Shapes::StructureShape.new(name: 'DescribeSecurityPolicyRequest')
|
31
|
+
DescribeSecurityPolicyResponse = Shapes::StructureShape.new(name: 'DescribeSecurityPolicyResponse')
|
30
32
|
DescribeServerRequest = Shapes::StructureShape.new(name: 'DescribeServerRequest')
|
31
33
|
DescribeServerResponse = Shapes::StructureShape.new(name: 'DescribeServerResponse')
|
32
34
|
DescribeUserRequest = Shapes::StructureShape.new(name: 'DescribeUserRequest')
|
33
35
|
DescribeUserResponse = Shapes::StructureShape.new(name: 'DescribeUserResponse')
|
36
|
+
DescribedSecurityPolicy = Shapes::StructureShape.new(name: 'DescribedSecurityPolicy')
|
34
37
|
DescribedServer = Shapes::StructureShape.new(name: 'DescribedServer')
|
35
38
|
DescribedUser = Shapes::StructureShape.new(name: 'DescribedUser')
|
36
39
|
EndpointDetails = Shapes::StructureShape.new(name: 'EndpointDetails')
|
37
40
|
EndpointType = Shapes::StringShape.new(name: 'EndpointType')
|
41
|
+
Fips = Shapes::BooleanShape.new(name: 'Fips')
|
38
42
|
HomeDirectory = Shapes::StringShape.new(name: 'HomeDirectory')
|
39
43
|
HomeDirectoryMapEntry = Shapes::StructureShape.new(name: 'HomeDirectoryMapEntry')
|
40
44
|
HomeDirectoryMappings = Shapes::ListShape.new(name: 'HomeDirectoryMappings')
|
@@ -48,6 +52,8 @@ module Aws::Transfer
|
|
48
52
|
InternalServiceError = Shapes::StructureShape.new(name: 'InternalServiceError')
|
49
53
|
InvalidNextTokenException = Shapes::StructureShape.new(name: 'InvalidNextTokenException')
|
50
54
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
55
|
+
ListSecurityPoliciesRequest = Shapes::StructureShape.new(name: 'ListSecurityPoliciesRequest')
|
56
|
+
ListSecurityPoliciesResponse = Shapes::StructureShape.new(name: 'ListSecurityPoliciesResponse')
|
51
57
|
ListServersRequest = Shapes::StructureShape.new(name: 'ListServersRequest')
|
52
58
|
ListServersResponse = Shapes::StructureShape.new(name: 'ListServersResponse')
|
53
59
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
@@ -74,6 +80,12 @@ module Aws::Transfer
|
|
74
80
|
Response = Shapes::StringShape.new(name: 'Response')
|
75
81
|
RetryAfterSeconds = Shapes::StringShape.new(name: 'RetryAfterSeconds')
|
76
82
|
Role = Shapes::StringShape.new(name: 'Role')
|
83
|
+
SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
|
84
|
+
SecurityGroupIds = Shapes::ListShape.new(name: 'SecurityGroupIds')
|
85
|
+
SecurityPolicyName = Shapes::StringShape.new(name: 'SecurityPolicyName')
|
86
|
+
SecurityPolicyNames = Shapes::ListShape.new(name: 'SecurityPolicyNames')
|
87
|
+
SecurityPolicyOption = Shapes::StringShape.new(name: 'SecurityPolicyOption')
|
88
|
+
SecurityPolicyOptions = Shapes::ListShape.new(name: 'SecurityPolicyOptions')
|
77
89
|
ServerId = Shapes::StringShape.new(name: 'ServerId')
|
78
90
|
ServiceErrorMessage = Shapes::StringShape.new(name: 'ServiceErrorMessage')
|
79
91
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
@@ -126,6 +138,7 @@ module Aws::Transfer
|
|
126
138
|
CreateServerRequest.add_member(:identity_provider_type, Shapes::ShapeRef.new(shape: IdentityProviderType, location_name: "IdentityProviderType"))
|
127
139
|
CreateServerRequest.add_member(:logging_role, Shapes::ShapeRef.new(shape: Role, location_name: "LoggingRole"))
|
128
140
|
CreateServerRequest.add_member(:protocols, Shapes::ShapeRef.new(shape: Protocols, location_name: "Protocols"))
|
141
|
+
CreateServerRequest.add_member(:security_policy_name, Shapes::ShapeRef.new(shape: SecurityPolicyName, location_name: "SecurityPolicyName"))
|
129
142
|
CreateServerRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
130
143
|
CreateServerRequest.struct_class = Types::CreateServerRequest
|
131
144
|
|
@@ -159,6 +172,12 @@ module Aws::Transfer
|
|
159
172
|
DeleteUserRequest.add_member(:user_name, Shapes::ShapeRef.new(shape: UserName, required: true, location_name: "UserName"))
|
160
173
|
DeleteUserRequest.struct_class = Types::DeleteUserRequest
|
161
174
|
|
175
|
+
DescribeSecurityPolicyRequest.add_member(:security_policy_name, Shapes::ShapeRef.new(shape: SecurityPolicyName, required: true, location_name: "SecurityPolicyName"))
|
176
|
+
DescribeSecurityPolicyRequest.struct_class = Types::DescribeSecurityPolicyRequest
|
177
|
+
|
178
|
+
DescribeSecurityPolicyResponse.add_member(:security_policy, Shapes::ShapeRef.new(shape: DescribedSecurityPolicy, required: true, location_name: "SecurityPolicy"))
|
179
|
+
DescribeSecurityPolicyResponse.struct_class = Types::DescribeSecurityPolicyResponse
|
180
|
+
|
162
181
|
DescribeServerRequest.add_member(:server_id, Shapes::ShapeRef.new(shape: ServerId, required: true, location_name: "ServerId"))
|
163
182
|
DescribeServerRequest.struct_class = Types::DescribeServerRequest
|
164
183
|
|
@@ -173,6 +192,14 @@ module Aws::Transfer
|
|
173
192
|
DescribeUserResponse.add_member(:user, Shapes::ShapeRef.new(shape: DescribedUser, required: true, location_name: "User"))
|
174
193
|
DescribeUserResponse.struct_class = Types::DescribeUserResponse
|
175
194
|
|
195
|
+
DescribedSecurityPolicy.add_member(:fips, Shapes::ShapeRef.new(shape: Fips, location_name: "Fips"))
|
196
|
+
DescribedSecurityPolicy.add_member(:security_policy_name, Shapes::ShapeRef.new(shape: SecurityPolicyName, required: true, location_name: "SecurityPolicyName"))
|
197
|
+
DescribedSecurityPolicy.add_member(:ssh_ciphers, Shapes::ShapeRef.new(shape: SecurityPolicyOptions, location_name: "SshCiphers"))
|
198
|
+
DescribedSecurityPolicy.add_member(:ssh_kexs, Shapes::ShapeRef.new(shape: SecurityPolicyOptions, location_name: "SshKexs"))
|
199
|
+
DescribedSecurityPolicy.add_member(:ssh_macs, Shapes::ShapeRef.new(shape: SecurityPolicyOptions, location_name: "SshMacs"))
|
200
|
+
DescribedSecurityPolicy.add_member(:tls_ciphers, Shapes::ShapeRef.new(shape: SecurityPolicyOptions, location_name: "TlsCiphers"))
|
201
|
+
DescribedSecurityPolicy.struct_class = Types::DescribedSecurityPolicy
|
202
|
+
|
176
203
|
DescribedServer.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "Arn"))
|
177
204
|
DescribedServer.add_member(:certificate, Shapes::ShapeRef.new(shape: Certificate, location_name: "Certificate"))
|
178
205
|
DescribedServer.add_member(:endpoint_details, Shapes::ShapeRef.new(shape: EndpointDetails, location_name: "EndpointDetails"))
|
@@ -182,6 +209,7 @@ module Aws::Transfer
|
|
182
209
|
DescribedServer.add_member(:identity_provider_type, Shapes::ShapeRef.new(shape: IdentityProviderType, location_name: "IdentityProviderType"))
|
183
210
|
DescribedServer.add_member(:logging_role, Shapes::ShapeRef.new(shape: Role, location_name: "LoggingRole"))
|
184
211
|
DescribedServer.add_member(:protocols, Shapes::ShapeRef.new(shape: Protocols, location_name: "Protocols"))
|
212
|
+
DescribedServer.add_member(:security_policy_name, Shapes::ShapeRef.new(shape: SecurityPolicyName, location_name: "SecurityPolicyName"))
|
185
213
|
DescribedServer.add_member(:server_id, Shapes::ShapeRef.new(shape: ServerId, location_name: "ServerId"))
|
186
214
|
DescribedServer.add_member(:state, Shapes::ShapeRef.new(shape: State, location_name: "State"))
|
187
215
|
DescribedServer.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
@@ -203,6 +231,7 @@ module Aws::Transfer
|
|
203
231
|
EndpointDetails.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, location_name: "SubnetIds"))
|
204
232
|
EndpointDetails.add_member(:vpc_endpoint_id, Shapes::ShapeRef.new(shape: VpcEndpointId, location_name: "VpcEndpointId"))
|
205
233
|
EndpointDetails.add_member(:vpc_id, Shapes::ShapeRef.new(shape: VpcId, location_name: "VpcId"))
|
234
|
+
EndpointDetails.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: SecurityGroupIds, location_name: "SecurityGroupIds"))
|
206
235
|
EndpointDetails.struct_class = Types::EndpointDetails
|
207
236
|
|
208
237
|
HomeDirectoryMapEntry.add_member(:entry, Shapes::ShapeRef.new(shape: MapEntry, required: true, location_name: "Entry"))
|
@@ -234,6 +263,14 @@ module Aws::Transfer
|
|
234
263
|
InvalidRequestException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
|
235
264
|
InvalidRequestException.struct_class = Types::InvalidRequestException
|
236
265
|
|
266
|
+
ListSecurityPoliciesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
267
|
+
ListSecurityPoliciesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
268
|
+
ListSecurityPoliciesRequest.struct_class = Types::ListSecurityPoliciesRequest
|
269
|
+
|
270
|
+
ListSecurityPoliciesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
271
|
+
ListSecurityPoliciesResponse.add_member(:security_policy_names, Shapes::ShapeRef.new(shape: SecurityPolicyNames, required: true, location_name: "SecurityPolicyNames"))
|
272
|
+
ListSecurityPoliciesResponse.struct_class = Types::ListSecurityPoliciesResponse
|
273
|
+
|
237
274
|
ListServersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
238
275
|
ListServersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
239
276
|
ListServersRequest.struct_class = Types::ListServersRequest
|
@@ -295,6 +332,12 @@ module Aws::Transfer
|
|
295
332
|
ResourceNotFoundException.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, required: true, location_name: "ResourceType"))
|
296
333
|
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
297
334
|
|
335
|
+
SecurityGroupIds.member = Shapes::ShapeRef.new(shape: SecurityGroupId)
|
336
|
+
|
337
|
+
SecurityPolicyNames.member = Shapes::ShapeRef.new(shape: SecurityPolicyName)
|
338
|
+
|
339
|
+
SecurityPolicyOptions.member = Shapes::ShapeRef.new(shape: SecurityPolicyOption)
|
340
|
+
|
298
341
|
ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: ServiceErrorMessage, location_name: "Message"))
|
299
342
|
ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
|
300
343
|
|
@@ -352,6 +395,7 @@ module Aws::Transfer
|
|
352
395
|
UpdateServerRequest.add_member(:identity_provider_details, Shapes::ShapeRef.new(shape: IdentityProviderDetails, location_name: "IdentityProviderDetails"))
|
353
396
|
UpdateServerRequest.add_member(:logging_role, Shapes::ShapeRef.new(shape: NullableRole, location_name: "LoggingRole"))
|
354
397
|
UpdateServerRequest.add_member(:protocols, Shapes::ShapeRef.new(shape: Protocols, location_name: "Protocols"))
|
398
|
+
UpdateServerRequest.add_member(:security_policy_name, Shapes::ShapeRef.new(shape: SecurityPolicyName, location_name: "SecurityPolicyName"))
|
355
399
|
UpdateServerRequest.add_member(:server_id, Shapes::ShapeRef.new(shape: ServerId, required: true, location_name: "ServerId"))
|
356
400
|
UpdateServerRequest.struct_class = Types::UpdateServerRequest
|
357
401
|
|
@@ -456,6 +500,18 @@ module Aws::Transfer
|
|
456
500
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
457
501
|
end)
|
458
502
|
|
503
|
+
api.add_operation(:describe_security_policy, Seahorse::Model::Operation.new.tap do |o|
|
504
|
+
o.name = "DescribeSecurityPolicy"
|
505
|
+
o.http_method = "POST"
|
506
|
+
o.http_request_uri = "/"
|
507
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeSecurityPolicyRequest)
|
508
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeSecurityPolicyResponse)
|
509
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
510
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
|
511
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
512
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
513
|
+
end)
|
514
|
+
|
459
515
|
api.add_operation(:describe_server, Seahorse::Model::Operation.new.tap do |o|
|
460
516
|
o.name = "DescribeServer"
|
461
517
|
o.http_method = "POST"
|
@@ -494,6 +550,24 @@ module Aws::Transfer
|
|
494
550
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
495
551
|
end)
|
496
552
|
|
553
|
+
api.add_operation(:list_security_policies, Seahorse::Model::Operation.new.tap do |o|
|
554
|
+
o.name = "ListSecurityPolicies"
|
555
|
+
o.http_method = "POST"
|
556
|
+
o.http_request_uri = "/"
|
557
|
+
o.input = Shapes::ShapeRef.new(shape: ListSecurityPoliciesRequest)
|
558
|
+
o.output = Shapes::ShapeRef.new(shape: ListSecurityPoliciesResponse)
|
559
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
560
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
|
561
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
|
562
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
563
|
+
o[:pager] = Aws::Pager.new(
|
564
|
+
limit_key: "max_results",
|
565
|
+
tokens: {
|
566
|
+
"next_token" => "next_token"
|
567
|
+
}
|
568
|
+
)
|
569
|
+
end)
|
570
|
+
|
497
571
|
api.add_operation(:list_servers, Seahorse::Model::Operation.new.tap do |o|
|
498
572
|
o.name = "ListServers"
|
499
573
|
o.http_method = "POST"
|
@@ -48,6 +48,7 @@ module Aws::Transfer
|
|
48
48
|
# subnet_ids: ["SubnetId"],
|
49
49
|
# vpc_endpoint_id: "VpcEndpointId",
|
50
50
|
# vpc_id: "VpcId",
|
51
|
+
# security_group_ids: ["SecurityGroupId"],
|
51
52
|
# },
|
52
53
|
# endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
|
53
54
|
# host_key: "HostKey",
|
@@ -58,6 +59,7 @@ module Aws::Transfer
|
|
58
59
|
# identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY
|
59
60
|
# logging_role: "Role",
|
60
61
|
# protocols: ["SFTP"], # accepts SFTP, FTP, FTPS
|
62
|
+
# security_policy_name: "SecurityPolicyName",
|
61
63
|
# tags: [
|
62
64
|
# {
|
63
65
|
# key: "TagKey", # required
|
@@ -108,18 +110,18 @@ module Aws::Transfer
|
|
108
110
|
#
|
109
111
|
# @!attribute [rw] endpoint_details
|
110
112
|
# The virtual private cloud (VPC) endpoint settings that are
|
111
|
-
# configured for your
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
113
|
+
# configured for your server. When you host your endpoint within your
|
114
|
+
# VPC, you can make it accessible only to resources within your VPC,
|
115
|
+
# or you can attach Elastic IPs and make it accessible to clients over
|
116
|
+
# the internet. Your VPC's default security groups are automatically
|
117
|
+
# assigned to your endpoint.
|
116
118
|
# @return [Types::EndpointDetails]
|
117
119
|
#
|
118
120
|
# @!attribute [rw] endpoint_type
|
119
|
-
# The type of VPC endpoint that you want your
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
121
|
+
# The type of VPC endpoint that you want your server to connect to.
|
122
|
+
# You can choose to connect to the public internet or a VPC endpoint.
|
123
|
+
# With a VPC endpoint, you can restrict access to your server and
|
124
|
+
# resources only within your VPC.
|
123
125
|
#
|
124
126
|
# <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With
|
125
127
|
# this endpoint type, you have the option to directly associate up to
|
@@ -156,13 +158,13 @@ module Aws::Transfer
|
|
156
158
|
# @return [Types::IdentityProviderDetails]
|
157
159
|
#
|
158
160
|
# @!attribute [rw] identity_provider_type
|
159
|
-
# Specifies the mode of authentication for a
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
161
|
+
# Specifies the mode of authentication for a server. The default value
|
162
|
+
# is `SERVICE_MANAGED`, which allows you to store and access user
|
163
|
+
# credentials within the AWS Transfer Family service. Use the
|
164
|
+
# `API_GATEWAY` value to integrate with an identity provider of your
|
165
|
+
# choosing. The `API_GATEWAY` setting requires you to provide an API
|
166
|
+
# Gateway endpoint URL to call for authentication using the
|
167
|
+
# `IdentityProviderDetails` parameter.
|
166
168
|
# @return [String]
|
167
169
|
#
|
168
170
|
# @!attribute [rw] logging_role
|
@@ -201,9 +203,13 @@ module Aws::Transfer
|
|
201
203
|
# </note>
|
202
204
|
# @return [Array<String>]
|
203
205
|
#
|
206
|
+
# @!attribute [rw] security_policy_name
|
207
|
+
# Specifies the name of the security policy that is attached to the
|
208
|
+
# server.
|
209
|
+
# @return [String]
|
210
|
+
#
|
204
211
|
# @!attribute [rw] tags
|
205
|
-
# Key-value pairs that can be used to group and search for
|
206
|
-
# transfer protocol-enabled servers.
|
212
|
+
# Key-value pairs that can be used to group and search for servers.
|
207
213
|
# @return [Array<Types::Tag>]
|
208
214
|
#
|
209
215
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerRequest AWS API Documentation
|
@@ -217,14 +223,14 @@ module Aws::Transfer
|
|
217
223
|
:identity_provider_type,
|
218
224
|
:logging_role,
|
219
225
|
:protocols,
|
226
|
+
:security_policy_name,
|
220
227
|
:tags)
|
221
228
|
SENSITIVE = [:host_key]
|
222
229
|
include Aws::Structure
|
223
230
|
end
|
224
231
|
|
225
232
|
# @!attribute [rw] server_id
|
226
|
-
# The service-assigned ID of the
|
227
|
-
# that is created.
|
233
|
+
# The service-assigned ID of the server that is created.
|
228
234
|
# @return [String]
|
229
235
|
#
|
230
236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerResponse AWS API Documentation
|
@@ -262,7 +268,7 @@ module Aws::Transfer
|
|
262
268
|
#
|
263
269
|
# @!attribute [rw] home_directory
|
264
270
|
# The landing directory (folder) for a user when they log in to the
|
265
|
-
#
|
271
|
+
# server using the client.
|
266
272
|
#
|
267
273
|
# An example is <i>
|
268
274
|
# <code>your-Amazon-S3-bucket-name>/home/username</code> </i>.
|
@@ -270,12 +276,11 @@ module Aws::Transfer
|
|
270
276
|
#
|
271
277
|
# @!attribute [rw] home_directory_type
|
272
278
|
# The type of landing directory (folder) you want your users' home
|
273
|
-
# directory to be when they log into the
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
# Amazon S3 paths visible to your users.
|
279
|
+
# directory to be when they log into the server. If you set it to
|
280
|
+
# `PATH`, the user will see the absolute Amazon S3 bucket paths as is
|
281
|
+
# in their file transfer protocol clients. If you set it `LOGICAL`,
|
282
|
+
# you will need to provide mappings in the `HomeDirectoryMappings` for
|
283
|
+
# how you want to make Amazon S3 paths visible to your users.
|
279
284
|
# @return [String]
|
280
285
|
#
|
281
286
|
# @!attribute [rw] home_directory_mappings
|
@@ -299,7 +304,7 @@ module Aws::Transfer
|
|
299
304
|
#
|
300
305
|
# <note markdown="1"> If the target of a logical directory entry does not exist in Amazon
|
301
306
|
# S3, the entry will be ignored. As a workaround, you can use the
|
302
|
-
# Amazon S3
|
307
|
+
# Amazon S3 API to create 0 byte objects as place holders for your
|
303
308
|
# directory. If using the CLI, use the `s3api` call instead of `s3` so
|
304
309
|
# you can use the put-object operation. For example, you use the
|
305
310
|
# following: `aws s3api put-object --bucket bucketname --key
|
@@ -340,20 +345,18 @@ module Aws::Transfer
|
|
340
345
|
# bucket. The policies attached to this role will determine the level
|
341
346
|
# of access you want to provide your users when transferring files
|
342
347
|
# into and out of your Amazon S3 bucket or buckets. The IAM role
|
343
|
-
# should also contain a trust relationship that allows the
|
344
|
-
#
|
345
|
-
# servicing your users' transfer requests.
|
348
|
+
# should also contain a trust relationship that allows the server to
|
349
|
+
# access your resources when servicing your users' transfer requests.
|
346
350
|
# @return [String]
|
347
351
|
#
|
348
352
|
# @!attribute [rw] server_id
|
349
|
-
# A system-assigned unique identifier for a
|
350
|
-
#
|
351
|
-
# you added your user to.
|
353
|
+
# A system-assigned unique identifier for a server instance. This is
|
354
|
+
# the specific server that you added your user to.
|
352
355
|
# @return [String]
|
353
356
|
#
|
354
357
|
# @!attribute [rw] ssh_public_key_body
|
355
358
|
# The public portion of the Secure Shell (SSH) key used to
|
356
|
-
# authenticate the user to the
|
359
|
+
# authenticate the user to the server.
|
357
360
|
# @return [String]
|
358
361
|
#
|
359
362
|
# @!attribute [rw] tags
|
@@ -362,11 +365,12 @@ module Aws::Transfer
|
|
362
365
|
# @return [Array<Types::Tag>]
|
363
366
|
#
|
364
367
|
# @!attribute [rw] user_name
|
365
|
-
# A unique string that identifies a user and is associated with a
|
366
|
-
#
|
367
|
-
#
|
368
|
-
#
|
369
|
-
# and
|
368
|
+
# A unique string that identifies a user and is associated with a as
|
369
|
+
# specified by the `ServerId`. This user name must be a minimum of 3
|
370
|
+
# and a maximum of 100 characters long. The following are valid
|
371
|
+
# characters: a-z, A-Z, 0-9, underscore '\_', hyphen '-', period
|
372
|
+
# '.', and at sign '@'. The user name can't start with a hyphen,
|
373
|
+
# period, or at sign.
|
370
374
|
# @return [String]
|
371
375
|
#
|
372
376
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUserRequest AWS API Documentation
|
@@ -386,13 +390,12 @@ module Aws::Transfer
|
|
386
390
|
end
|
387
391
|
|
388
392
|
# @!attribute [rw] server_id
|
389
|
-
# The ID of the
|
390
|
-
# attached to.
|
393
|
+
# The ID of the server that the user is attached to.
|
391
394
|
# @return [String]
|
392
395
|
#
|
393
396
|
# @!attribute [rw] user_name
|
394
397
|
# A unique string that identifies a user account associated with a
|
395
|
-
#
|
398
|
+
# server.
|
396
399
|
# @return [String]
|
397
400
|
#
|
398
401
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUserResponse AWS API Documentation
|
@@ -412,8 +415,7 @@ module Aws::Transfer
|
|
412
415
|
# }
|
413
416
|
#
|
414
417
|
# @!attribute [rw] server_id
|
415
|
-
# A unique system-assigned identifier for a
|
416
|
-
# protocol-enabled server instance.
|
418
|
+
# A unique system-assigned identifier for a server instance.
|
417
419
|
# @return [String]
|
418
420
|
#
|
419
421
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServerRequest AWS API Documentation
|
@@ -466,13 +468,13 @@ module Aws::Transfer
|
|
466
468
|
# }
|
467
469
|
#
|
468
470
|
# @!attribute [rw] server_id
|
469
|
-
# A system-assigned unique identifier for a
|
470
|
-
#
|
471
|
+
# A system-assigned unique identifier for a server instance that has
|
472
|
+
# the user assigned to it.
|
471
473
|
# @return [String]
|
472
474
|
#
|
473
475
|
# @!attribute [rw] user_name
|
474
476
|
# A unique string that identifies a user that is being deleted from a
|
475
|
-
#
|
477
|
+
# server.
|
476
478
|
# @return [String]
|
477
479
|
#
|
478
480
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUserRequest AWS API Documentation
|
@@ -484,6 +486,38 @@ module Aws::Transfer
|
|
484
486
|
include Aws::Structure
|
485
487
|
end
|
486
488
|
|
489
|
+
# @note When making an API call, you may pass DescribeSecurityPolicyRequest
|
490
|
+
# data as a hash:
|
491
|
+
#
|
492
|
+
# {
|
493
|
+
# security_policy_name: "SecurityPolicyName", # required
|
494
|
+
# }
|
495
|
+
#
|
496
|
+
# @!attribute [rw] security_policy_name
|
497
|
+
# Specifies the name of the security policy that is attached to the
|
498
|
+
# server.
|
499
|
+
# @return [String]
|
500
|
+
#
|
501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeSecurityPolicyRequest AWS API Documentation
|
502
|
+
#
|
503
|
+
class DescribeSecurityPolicyRequest < Struct.new(
|
504
|
+
:security_policy_name)
|
505
|
+
SENSITIVE = []
|
506
|
+
include Aws::Structure
|
507
|
+
end
|
508
|
+
|
509
|
+
# @!attribute [rw] security_policy
|
510
|
+
# An array containing the properties of the security policy.
|
511
|
+
# @return [Types::DescribedSecurityPolicy]
|
512
|
+
#
|
513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeSecurityPolicyResponse AWS API Documentation
|
514
|
+
#
|
515
|
+
class DescribeSecurityPolicyResponse < Struct.new(
|
516
|
+
:security_policy)
|
517
|
+
SENSITIVE = []
|
518
|
+
include Aws::Structure
|
519
|
+
end
|
520
|
+
|
487
521
|
# @note When making an API call, you may pass DescribeServerRequest
|
488
522
|
# data as a hash:
|
489
523
|
#
|
@@ -492,8 +526,7 @@ module Aws::Transfer
|
|
492
526
|
# }
|
493
527
|
#
|
494
528
|
# @!attribute [rw] server_id
|
495
|
-
# A system-assigned unique identifier for a
|
496
|
-
# protocol-enabled server.
|
529
|
+
# A system-assigned unique identifier for a server.
|
497
530
|
# @return [String]
|
498
531
|
#
|
499
532
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServerRequest AWS API Documentation
|
@@ -505,8 +538,8 @@ module Aws::Transfer
|
|
505
538
|
end
|
506
539
|
|
507
540
|
# @!attribute [rw] server
|
508
|
-
# An array containing the properties of a
|
509
|
-
#
|
541
|
+
# An array containing the properties of a server with the `ServerID`
|
542
|
+
# you specified.
|
510
543
|
# @return [Types::DescribedServer]
|
511
544
|
#
|
512
545
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServerResponse AWS API Documentation
|
@@ -526,15 +559,14 @@ module Aws::Transfer
|
|
526
559
|
# }
|
527
560
|
#
|
528
561
|
# @!attribute [rw] server_id
|
529
|
-
# A system-assigned unique identifier for a
|
530
|
-
#
|
562
|
+
# A system-assigned unique identifier for a server that has this user
|
563
|
+
# assigned.
|
531
564
|
# @return [String]
|
532
565
|
#
|
533
566
|
# @!attribute [rw] user_name
|
534
|
-
# The name of the user assigned to one or more
|
535
|
-
#
|
536
|
-
#
|
537
|
-
# transfer tasks.
|
567
|
+
# The name of the user assigned to one or more servers. User names are
|
568
|
+
# part of the sign-in credentials to use the AWS Transfer Family
|
569
|
+
# service and perform file transfer tasks.
|
538
570
|
# @return [String]
|
539
571
|
#
|
540
572
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUserRequest AWS API Documentation
|
@@ -547,8 +579,8 @@ module Aws::Transfer
|
|
547
579
|
end
|
548
580
|
|
549
581
|
# @!attribute [rw] server_id
|
550
|
-
# A system-assigned unique identifier for a
|
551
|
-
#
|
582
|
+
# A system-assigned unique identifier for a server that has this user
|
583
|
+
# assigned.
|
552
584
|
# @return [String]
|
553
585
|
#
|
554
586
|
# @!attribute [rw] user
|
@@ -565,17 +597,64 @@ module Aws::Transfer
|
|
565
597
|
include Aws::Structure
|
566
598
|
end
|
567
599
|
|
600
|
+
# Describes the properties of a security policy that was specified. For
|
601
|
+
# more information about security policies, see [Working with security
|
602
|
+
# policies][1].
|
603
|
+
#
|
604
|
+
#
|
605
|
+
#
|
606
|
+
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html
|
607
|
+
#
|
608
|
+
# @!attribute [rw] fips
|
609
|
+
# Specifies whether this policy enables Federal Information Processing
|
610
|
+
# Standards (FIPS).
|
611
|
+
# @return [Boolean]
|
612
|
+
#
|
613
|
+
# @!attribute [rw] security_policy_name
|
614
|
+
# Specifies the name of the security policy that is attached to the
|
615
|
+
# server.
|
616
|
+
# @return [String]
|
617
|
+
#
|
618
|
+
# @!attribute [rw] ssh_ciphers
|
619
|
+
# Specifies the enabled Secure Shell (SSH) cipher encryption
|
620
|
+
# algorithms in the security policy that is attached to the server.
|
621
|
+
# @return [Array<String>]
|
622
|
+
#
|
623
|
+
# @!attribute [rw] ssh_kexs
|
624
|
+
# Specifies the enabled SSH key exchange (KEX) encryption algorithms
|
625
|
+
# in the security policy that is attached to the server.
|
626
|
+
# @return [Array<String>]
|
627
|
+
#
|
628
|
+
# @!attribute [rw] ssh_macs
|
629
|
+
# Specifies the enabled SSH message authentication code (MAC)
|
630
|
+
# encryption algorithms in the security policy that is attached to the
|
631
|
+
# server.
|
632
|
+
# @return [Array<String>]
|
633
|
+
#
|
634
|
+
# @!attribute [rw] tls_ciphers
|
635
|
+
# Specifies the enabled Transport Layer Security (TLS) cipher
|
636
|
+
# encryption algorithms in the security policy that is attached to the
|
637
|
+
# server.
|
638
|
+
# @return [Array<String>]
|
639
|
+
#
|
640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedSecurityPolicy AWS API Documentation
|
641
|
+
#
|
642
|
+
class DescribedSecurityPolicy < Struct.new(
|
643
|
+
:fips,
|
644
|
+
:security_policy_name,
|
645
|
+
:ssh_ciphers,
|
646
|
+
:ssh_kexs,
|
647
|
+
:ssh_macs,
|
648
|
+
:tls_ciphers)
|
649
|
+
SENSITIVE = []
|
650
|
+
include Aws::Structure
|
651
|
+
end
|
652
|
+
|
568
653
|
# Describes the properties of a file transfer protocol-enabled server
|
569
|
-
# that was specified.
|
570
|
-
# server Amazon Resource Name (ARN), the certificate ARN (if the FTPS
|
571
|
-
# protocol was selected), the endpoint type and details, the
|
572
|
-
# authentication configuration and type, the logging role, the file
|
573
|
-
# transfer protocol or protocols, the server ID and state, and assigned
|
574
|
-
# tags or metadata.
|
654
|
+
# that was specified.
|
575
655
|
#
|
576
656
|
# @!attribute [rw] arn
|
577
|
-
# Specifies the unique Amazon Resource Name (ARN)
|
578
|
-
# protocol-enabled server to be described.
|
657
|
+
# Specifies the unique Amazon Resource Name (ARN) of the server.
|
579
658
|
# @return [String]
|
580
659
|
#
|
581
660
|
# @!attribute [rw] certificate
|
@@ -585,14 +664,13 @@ module Aws::Transfer
|
|
585
664
|
#
|
586
665
|
# @!attribute [rw] endpoint_details
|
587
666
|
# Specifies the virtual private cloud (VPC) endpoint settings that you
|
588
|
-
# configured for your
|
667
|
+
# configured for your server.
|
589
668
|
# @return [Types::EndpointDetails]
|
590
669
|
#
|
591
670
|
# @!attribute [rw] endpoint_type
|
592
|
-
# Defines the type of endpoint that your
|
593
|
-
#
|
594
|
-
#
|
595
|
-
# internet.
|
671
|
+
# Defines the type of endpoint that your server is connected to. If
|
672
|
+
# your server is connected to a VPC endpoint, your server isn't
|
673
|
+
# accessible over the public internet.
|
596
674
|
# @return [String]
|
597
675
|
#
|
598
676
|
# @!attribute [rw] host_key_fingerprint
|
@@ -604,23 +682,23 @@ module Aws::Transfer
|
|
604
682
|
# @!attribute [rw] identity_provider_details
|
605
683
|
# Specifies information to call a customer-supplied authentication
|
606
684
|
# API. This field is not populated when the `IdentityProviderType` of
|
607
|
-
# a
|
685
|
+
# a server is `SERVICE_MANAGED`.
|
608
686
|
# @return [Types::IdentityProviderDetails]
|
609
687
|
#
|
610
688
|
# @!attribute [rw] identity_provider_type
|
611
689
|
# Specifies the mode of authentication method enabled for this
|
612
690
|
# service. A value of `SERVICE_MANAGED` means that you are using this
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
#
|
691
|
+
# server to store and access user credentials within the service. A
|
692
|
+
# value of `API_GATEWAY` indicates that you have integrated an API
|
693
|
+
# Gateway endpoint that will be invoked for authenticating your user
|
694
|
+
# into the service.
|
617
695
|
# @return [String]
|
618
696
|
#
|
619
697
|
# @!attribute [rw] logging_role
|
620
698
|
# Specifies the AWS Identity and Access Management (IAM) role that
|
621
|
-
# allows a
|
622
|
-
#
|
623
|
-
#
|
699
|
+
# allows a server to turn on Amazon CloudWatch logging for Amazon S3
|
700
|
+
# events. When set, user activity can be viewed in your CloudWatch
|
701
|
+
# logs.
|
624
702
|
# @return [String]
|
625
703
|
#
|
626
704
|
# @!attribute [rw] protocols
|
@@ -637,17 +715,21 @@ module Aws::Transfer
|
|
637
715
|
# * `FTP` (File Transfer Protocol): Unencrypted file transfer
|
638
716
|
# @return [Array<String>]
|
639
717
|
#
|
718
|
+
# @!attribute [rw] security_policy_name
|
719
|
+
# Specifies the name of the security policy that is attached to the
|
720
|
+
# server.
|
721
|
+
# @return [String]
|
722
|
+
#
|
640
723
|
# @!attribute [rw] server_id
|
641
|
-
# Specifies the unique system-assigned identifier for a
|
642
|
-
#
|
724
|
+
# Specifies the unique system-assigned identifier for a server that
|
725
|
+
# you instantiate.
|
643
726
|
# @return [String]
|
644
727
|
#
|
645
728
|
# @!attribute [rw] state
|
646
|
-
# Specifies the condition of a
|
647
|
-
#
|
648
|
-
#
|
649
|
-
#
|
650
|
-
# operations.
|
729
|
+
# Specifies the condition of a server for the server that was
|
730
|
+
# described. A value of `ONLINE` indicates that the server can accept
|
731
|
+
# jobs and transfer files. A `State` value of `OFFLINE` means that the
|
732
|
+
# server cannot perform file transfer operations.
|
651
733
|
#
|
652
734
|
# The states of `STARTING` and `STOPPING` indicate that the server is
|
653
735
|
# in an intermediate state, either not fully able to respond, or not
|
@@ -657,13 +739,12 @@ module Aws::Transfer
|
|
657
739
|
#
|
658
740
|
# @!attribute [rw] tags
|
659
741
|
# Specifies the key-value pairs that you can use to search for and
|
660
|
-
# group
|
661
|
-
# the server that was described.
|
742
|
+
# group servers that were assigned to the server that was described.
|
662
743
|
# @return [Array<Types::Tag>]
|
663
744
|
#
|
664
745
|
# @!attribute [rw] user_count
|
665
|
-
# Specifies the number of users that are assigned to a
|
666
|
-
#
|
746
|
+
# Specifies the number of users that are assigned to a server you
|
747
|
+
# specified with the `ServerId`.
|
667
748
|
# @return [Integer]
|
668
749
|
#
|
669
750
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedServer AWS API Documentation
|
@@ -678,6 +759,7 @@ module Aws::Transfer
|
|
678
759
|
:identity_provider_type,
|
679
760
|
:logging_role,
|
680
761
|
:protocols,
|
762
|
+
:security_policy_name,
|
681
763
|
:server_id,
|
682
764
|
:state,
|
683
765
|
:tags,
|
@@ -686,7 +768,7 @@ module Aws::Transfer
|
|
686
768
|
include Aws::Structure
|
687
769
|
end
|
688
770
|
|
689
|
-
#
|
771
|
+
# Describes the properties of a user that was specified.
|
690
772
|
#
|
691
773
|
# @!attribute [rw] arn
|
692
774
|
# Specifies the unique Amazon Resource Name (ARN) for the user that
|
@@ -735,9 +817,8 @@ module Aws::Transfer
|
|
735
817
|
# Amazon S3 bucket. The policies attached to this role will determine
|
736
818
|
# the level of access you want to provide your users when transferring
|
737
819
|
# files into and out of your Amazon S3 bucket or buckets. The IAM role
|
738
|
-
# should also contain a trust relationship that allows a
|
739
|
-
#
|
740
|
-
# users' transfer requests.
|
820
|
+
# should also contain a trust relationship that allows a server to
|
821
|
+
# access your resources when servicing your users' transfer requests.
|
741
822
|
# @return [String]
|
742
823
|
#
|
743
824
|
# @!attribute [rw] ssh_public_keys
|
@@ -753,8 +834,7 @@ module Aws::Transfer
|
|
753
834
|
# @!attribute [rw] user_name
|
754
835
|
# Specifies the name of the user that was requested to be described.
|
755
836
|
# User names are used for authentication purposes. This is the string
|
756
|
-
# that will be used by your user when they log in to your
|
757
|
-
# transfer protocol-enabled server.
|
837
|
+
# that will be used by your user when they log in to your server.
|
758
838
|
# @return [String]
|
759
839
|
#
|
760
840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedUser AWS API Documentation
|
@@ -787,23 +867,24 @@ module Aws::Transfer
|
|
787
867
|
# subnet_ids: ["SubnetId"],
|
788
868
|
# vpc_endpoint_id: "VpcEndpointId",
|
789
869
|
# vpc_id: "VpcId",
|
870
|
+
# security_group_ids: ["SecurityGroupId"],
|
790
871
|
# }
|
791
872
|
#
|
792
873
|
# @!attribute [rw] address_allocation_ids
|
793
874
|
# A list of address allocation IDs that are required to attach an
|
794
|
-
# Elastic IP address to your
|
795
|
-
# endpoint. This is only valid in the `UpdateServer` API.
|
875
|
+
# Elastic IP address to your server's endpoint.
|
796
876
|
#
|
797
|
-
# <note markdown="1"> This property can only be
|
877
|
+
# <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`
|
878
|
+
# and it is only valid in the `UpdateServer` API.
|
798
879
|
#
|
799
880
|
# </note>
|
800
881
|
# @return [Array<String>]
|
801
882
|
#
|
802
883
|
# @!attribute [rw] subnet_ids
|
803
|
-
# A list of subnet IDs that are required to host your
|
804
|
-
#
|
884
|
+
# A list of subnet IDs that are required to host your server endpoint
|
885
|
+
# in your VPC.
|
805
886
|
#
|
806
|
-
# <note markdown="1"> This property can only be
|
887
|
+
# <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
|
807
888
|
#
|
808
889
|
# </note>
|
809
890
|
# @return [Array<String>]
|
@@ -811,33 +892,46 @@ module Aws::Transfer
|
|
811
892
|
# @!attribute [rw] vpc_endpoint_id
|
812
893
|
# The ID of the VPC endpoint.
|
813
894
|
#
|
814
|
-
# <note markdown="1"> This property can only be
|
895
|
+
# <note markdown="1"> This property can only be set when `EndpointType` is set to
|
815
896
|
# `VPC_ENDPOINT`.
|
816
897
|
#
|
817
898
|
# </note>
|
818
899
|
# @return [String]
|
819
900
|
#
|
820
901
|
# @!attribute [rw] vpc_id
|
821
|
-
# The VPC ID of the VPC in which a
|
822
|
-
# server's endpoint will be hosted.
|
902
|
+
# The VPC ID of the VPC in which a server's endpoint will be hosted.
|
823
903
|
#
|
824
|
-
# <note markdown="1"> This property can only be
|
904
|
+
# <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
|
825
905
|
#
|
826
906
|
# </note>
|
827
907
|
# @return [String]
|
828
908
|
#
|
909
|
+
# @!attribute [rw] security_group_ids
|
910
|
+
# A list of security groups IDs that are available to attach to your
|
911
|
+
# server's endpoint.
|
912
|
+
#
|
913
|
+
# <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
|
914
|
+
#
|
915
|
+
# You can only edit the `SecurityGroupIds` property in the
|
916
|
+
# `UpdateServer` API and only if you are changing the `EndpointType`
|
917
|
+
# from `PUBLIC` or `VPC_ENDPOINT` to `VPC`.
|
918
|
+
#
|
919
|
+
# </note>
|
920
|
+
# @return [Array<String>]
|
921
|
+
#
|
829
922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/EndpointDetails AWS API Documentation
|
830
923
|
#
|
831
924
|
class EndpointDetails < Struct.new(
|
832
925
|
:address_allocation_ids,
|
833
926
|
:subnet_ids,
|
834
927
|
:vpc_endpoint_id,
|
835
|
-
:vpc_id
|
928
|
+
:vpc_id,
|
929
|
+
:security_group_ids)
|
836
930
|
SENSITIVE = []
|
837
931
|
include Aws::Structure
|
838
932
|
end
|
839
933
|
|
840
|
-
# Represents an object that contains entries and
|
934
|
+
# Represents an object that contains entries and targets for
|
841
935
|
# `HomeDirectoryMappings`.
|
842
936
|
#
|
843
937
|
# @note When making an API call, you may pass HomeDirectoryMapEntry
|
@@ -906,8 +1000,7 @@ module Aws::Transfer
|
|
906
1000
|
# }
|
907
1001
|
#
|
908
1002
|
# @!attribute [rw] server_id
|
909
|
-
# A system-assigned unique identifier for a
|
910
|
-
# protocol-enabled server.
|
1003
|
+
# A system-assigned unique identifier for a server.
|
911
1004
|
# @return [String]
|
912
1005
|
#
|
913
1006
|
# @!attribute [rw] ssh_public_key_body
|
@@ -915,8 +1008,8 @@ module Aws::Transfer
|
|
915
1008
|
# @return [String]
|
916
1009
|
#
|
917
1010
|
# @!attribute [rw] user_name
|
918
|
-
# The name of the user account that is assigned to one or more
|
919
|
-
#
|
1011
|
+
# The name of the user account that is assigned to one or more
|
1012
|
+
# servers.
|
920
1013
|
# @return [String]
|
921
1014
|
#
|
922
1015
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKeyRequest AWS API Documentation
|
@@ -929,14 +1022,12 @@ module Aws::Transfer
|
|
929
1022
|
include Aws::Structure
|
930
1023
|
end
|
931
1024
|
|
932
|
-
# Identifies the user, the
|
933
|
-
#
|
934
|
-
#
|
935
|
-
# are associated with.
|
1025
|
+
# Identifies the user, the server they belong to, and the identifier of
|
1026
|
+
# the SSH public key associated with that user. A user can have more
|
1027
|
+
# than one key on each server that they are associated with.
|
936
1028
|
#
|
937
1029
|
# @!attribute [rw] server_id
|
938
|
-
# A system-assigned unique identifier for a
|
939
|
-
# protocol-enabled server.
|
1030
|
+
# A system-assigned unique identifier for a server.
|
940
1031
|
# @return [String]
|
941
1032
|
#
|
942
1033
|
# @!attribute [rw] ssh_public_key_id
|
@@ -997,6 +1088,55 @@ module Aws::Transfer
|
|
997
1088
|
include Aws::Structure
|
998
1089
|
end
|
999
1090
|
|
1091
|
+
# @note When making an API call, you may pass ListSecurityPoliciesRequest
|
1092
|
+
# data as a hash:
|
1093
|
+
#
|
1094
|
+
# {
|
1095
|
+
# max_results: 1,
|
1096
|
+
# next_token: "NextToken",
|
1097
|
+
# }
|
1098
|
+
#
|
1099
|
+
# @!attribute [rw] max_results
|
1100
|
+
# Specifies the number of security policies to return as a response to
|
1101
|
+
# the `ListSecurityPolicies` query.
|
1102
|
+
# @return [Integer]
|
1103
|
+
#
|
1104
|
+
# @!attribute [rw] next_token
|
1105
|
+
# When additional results are obtained from the `ListSecurityPolicies`
|
1106
|
+
# command, a `NextToken` parameter is returned in the output. You can
|
1107
|
+
# then pass the `NextToken` parameter in a subsequent command to
|
1108
|
+
# continue listing additional security policies.
|
1109
|
+
# @return [String]
|
1110
|
+
#
|
1111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListSecurityPoliciesRequest AWS API Documentation
|
1112
|
+
#
|
1113
|
+
class ListSecurityPoliciesRequest < Struct.new(
|
1114
|
+
:max_results,
|
1115
|
+
:next_token)
|
1116
|
+
SENSITIVE = []
|
1117
|
+
include Aws::Structure
|
1118
|
+
end
|
1119
|
+
|
1120
|
+
# @!attribute [rw] next_token
|
1121
|
+
# When you can get additional results from the `ListSecurityPolicies`
|
1122
|
+
# operation, a `NextToken` parameter is returned in the output. In a
|
1123
|
+
# following command, you can pass in the `NextToken` parameter to
|
1124
|
+
# continue listing security policies.
|
1125
|
+
# @return [String]
|
1126
|
+
#
|
1127
|
+
# @!attribute [rw] security_policy_names
|
1128
|
+
# An array of security policies that were listed.
|
1129
|
+
# @return [Array<String>]
|
1130
|
+
#
|
1131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListSecurityPoliciesResponse AWS API Documentation
|
1132
|
+
#
|
1133
|
+
class ListSecurityPoliciesResponse < Struct.new(
|
1134
|
+
:next_token,
|
1135
|
+
:security_policy_names)
|
1136
|
+
SENSITIVE = []
|
1137
|
+
include Aws::Structure
|
1138
|
+
end
|
1139
|
+
|
1000
1140
|
# @note When making an API call, you may pass ListServersRequest
|
1001
1141
|
# data as a hash:
|
1002
1142
|
#
|
@@ -1006,15 +1146,15 @@ module Aws::Transfer
|
|
1006
1146
|
# }
|
1007
1147
|
#
|
1008
1148
|
# @!attribute [rw] max_results
|
1009
|
-
# Specifies the number of
|
1010
|
-
#
|
1149
|
+
# Specifies the number of servers to return as a response to the
|
1150
|
+
# `ListServers` query.
|
1011
1151
|
# @return [Integer]
|
1012
1152
|
#
|
1013
1153
|
# @!attribute [rw] next_token
|
1014
|
-
# When additional results are obtained from the`ListServers` command,
|
1154
|
+
# When additional results are obtained from the `ListServers` command,
|
1015
1155
|
# a `NextToken` parameter is returned in the output. You can then pass
|
1016
1156
|
# the `NextToken` parameter in a subsequent command to continue
|
1017
|
-
# listing additional
|
1157
|
+
# listing additional servers.
|
1018
1158
|
# @return [String]
|
1019
1159
|
#
|
1020
1160
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServersRequest AWS API Documentation
|
@@ -1030,11 +1170,11 @@ module Aws::Transfer
|
|
1030
1170
|
# When you can get additional results from the `ListServers`
|
1031
1171
|
# operation, a `NextToken` parameter is returned in the output. In a
|
1032
1172
|
# following command, you can pass in the `NextToken` parameter to
|
1033
|
-
# continue listing additional
|
1173
|
+
# continue listing additional servers.
|
1034
1174
|
# @return [String]
|
1035
1175
|
#
|
1036
1176
|
# @!attribute [rw] servers
|
1037
|
-
# An array of
|
1177
|
+
# An array of servers that were listed.
|
1038
1178
|
# @return [Array<Types::ListedServer>]
|
1039
1179
|
#
|
1040
1180
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServersResponse AWS API Documentation
|
@@ -1132,8 +1272,8 @@ module Aws::Transfer
|
|
1132
1272
|
# @return [String]
|
1133
1273
|
#
|
1134
1274
|
# @!attribute [rw] server_id
|
1135
|
-
# A system-assigned unique identifier for a
|
1136
|
-
#
|
1275
|
+
# A system-assigned unique identifier for a server that has users
|
1276
|
+
# assigned to it.
|
1137
1277
|
# @return [String]
|
1138
1278
|
#
|
1139
1279
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsersRequest AWS API Documentation
|
@@ -1154,8 +1294,8 @@ module Aws::Transfer
|
|
1154
1294
|
# @return [String]
|
1155
1295
|
#
|
1156
1296
|
# @!attribute [rw] server_id
|
1157
|
-
# A system-assigned unique identifier for a
|
1158
|
-
#
|
1297
|
+
# A system-assigned unique identifier for a server that the users are
|
1298
|
+
# assigned to.
|
1159
1299
|
# @return [String]
|
1160
1300
|
#
|
1161
1301
|
# @!attribute [rw] users
|
@@ -1177,42 +1317,38 @@ module Aws::Transfer
|
|
1177
1317
|
# specified.
|
1178
1318
|
#
|
1179
1319
|
# @!attribute [rw] arn
|
1180
|
-
# Specifies the unique Amazon Resource Name (ARN) for a
|
1181
|
-
#
|
1320
|
+
# Specifies the unique Amazon Resource Name (ARN) for a server to be
|
1321
|
+
# listed.
|
1182
1322
|
# @return [String]
|
1183
1323
|
#
|
1184
1324
|
# @!attribute [rw] identity_provider_type
|
1185
1325
|
# Specifies the authentication method used to validate a user for a
|
1186
|
-
#
|
1187
|
-
#
|
1188
|
-
#
|
1189
|
-
# `SERVICE_MANAGED` or `API_GATEWAY`.
|
1326
|
+
# server that was specified. This can include Secure Shell (SSH), user
|
1327
|
+
# name and password combinations, or your own custom authentication
|
1328
|
+
# method. Valid values include `SERVICE_MANAGED` or `API_GATEWAY`.
|
1190
1329
|
# @return [String]
|
1191
1330
|
#
|
1192
1331
|
# @!attribute [rw] endpoint_type
|
1193
|
-
# Specifies the type of VPC endpoint that your
|
1194
|
-
#
|
1195
|
-
#
|
1196
|
-
# internet.
|
1332
|
+
# Specifies the type of VPC endpoint that your server is connected to.
|
1333
|
+
# If your server is connected to a VPC endpoint, your server isn't
|
1334
|
+
# accessible over the public internet.
|
1197
1335
|
# @return [String]
|
1198
1336
|
#
|
1199
1337
|
# @!attribute [rw] logging_role
|
1200
1338
|
# Specifies the AWS Identity and Access Management (IAM) role that
|
1201
|
-
# allows a
|
1202
|
-
# CloudWatch logging.
|
1339
|
+
# allows a server to turn on Amazon CloudWatch logging.
|
1203
1340
|
# @return [String]
|
1204
1341
|
#
|
1205
1342
|
# @!attribute [rw] server_id
|
1206
|
-
# Specifies the unique system assigned identifier for
|
1207
|
-
#
|
1343
|
+
# Specifies the unique system assigned identifier for the servers that
|
1344
|
+
# were listed.
|
1208
1345
|
# @return [String]
|
1209
1346
|
#
|
1210
1347
|
# @!attribute [rw] state
|
1211
|
-
# Specifies the condition of a
|
1212
|
-
#
|
1213
|
-
#
|
1214
|
-
#
|
1215
|
-
# operations.
|
1348
|
+
# Specifies the condition of a server for the server that was
|
1349
|
+
# described. A value of `ONLINE` indicates that the server can accept
|
1350
|
+
# jobs and transfer files. A `State` value of `OFFLINE` means that the
|
1351
|
+
# server cannot perform file transfer operations.
|
1216
1352
|
#
|
1217
1353
|
# The states of `STARTING` and `STOPPING` indicate that the server is
|
1218
1354
|
# in an intermediate state, either not fully able to respond, or not
|
@@ -1221,8 +1357,8 @@ module Aws::Transfer
|
|
1221
1357
|
# @return [String]
|
1222
1358
|
#
|
1223
1359
|
# @!attribute [rw] user_count
|
1224
|
-
# Specifies the number of users that are assigned to a
|
1225
|
-
#
|
1360
|
+
# Specifies the number of users that are assigned to a server you
|
1361
|
+
# specified with the `ServerId`.
|
1226
1362
|
# @return [Integer]
|
1227
1363
|
#
|
1228
1364
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedServer AWS API Documentation
|
@@ -1389,8 +1525,7 @@ module Aws::Transfer
|
|
1389
1525
|
# }
|
1390
1526
|
#
|
1391
1527
|
# @!attribute [rw] server_id
|
1392
|
-
# A system-assigned unique identifier for a
|
1393
|
-
# protocol-enabled server that you start.
|
1528
|
+
# A system-assigned unique identifier for a server that you start.
|
1394
1529
|
# @return [String]
|
1395
1530
|
#
|
1396
1531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServerRequest AWS API Documentation
|
@@ -1409,8 +1544,7 @@ module Aws::Transfer
|
|
1409
1544
|
# }
|
1410
1545
|
#
|
1411
1546
|
# @!attribute [rw] server_id
|
1412
|
-
# A system-assigned unique identifier for a
|
1413
|
-
# protocol-enabled server that you stopped.
|
1547
|
+
# A system-assigned unique identifier for a server that you stopped.
|
1414
1548
|
# @return [String]
|
1415
1549
|
#
|
1416
1550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServerRequest AWS API Documentation
|
@@ -1499,9 +1633,8 @@ module Aws::Transfer
|
|
1499
1633
|
# }
|
1500
1634
|
#
|
1501
1635
|
# @!attribute [rw] server_id
|
1502
|
-
# A system-assigned identifier for a specific
|
1503
|
-
#
|
1504
|
-
# is tested with a user name and password.
|
1636
|
+
# A system-assigned identifier for a specific server. That server's
|
1637
|
+
# user authentication method is tested with a user name and password.
|
1505
1638
|
# @return [String]
|
1506
1639
|
#
|
1507
1640
|
# @!attribute [rw] server_protocol
|
@@ -1621,6 +1754,7 @@ module Aws::Transfer
|
|
1621
1754
|
# subnet_ids: ["SubnetId"],
|
1622
1755
|
# vpc_endpoint_id: "VpcEndpointId",
|
1623
1756
|
# vpc_id: "VpcId",
|
1757
|
+
# security_group_ids: ["SecurityGroupId"],
|
1624
1758
|
# },
|
1625
1759
|
# endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
|
1626
1760
|
# host_key: "HostKey",
|
@@ -1630,6 +1764,7 @@ module Aws::Transfer
|
|
1630
1764
|
# },
|
1631
1765
|
# logging_role: "NullableRole",
|
1632
1766
|
# protocols: ["SFTP"], # accepts SFTP, FTP, FTPS
|
1767
|
+
# security_policy_name: "SecurityPolicyName",
|
1633
1768
|
# server_id: "ServerId", # required
|
1634
1769
|
# }
|
1635
1770
|
#
|
@@ -1675,18 +1810,17 @@ module Aws::Transfer
|
|
1675
1810
|
#
|
1676
1811
|
# @!attribute [rw] endpoint_details
|
1677
1812
|
# The virtual private cloud (VPC) endpoint settings that are
|
1678
|
-
# configured for your
|
1679
|
-
#
|
1680
|
-
#
|
1681
|
-
#
|
1682
|
-
# server's endpoint.
|
1813
|
+
# configured for your server. With a VPC endpoint, you can restrict
|
1814
|
+
# access to your server to resources only within your VPC. To control
|
1815
|
+
# incoming internet traffic, you will need to associate one or more
|
1816
|
+
# Elastic IP addresses with your server's endpoint.
|
1683
1817
|
# @return [Types::EndpointDetails]
|
1684
1818
|
#
|
1685
1819
|
# @!attribute [rw] endpoint_type
|
1686
|
-
# The type of endpoint that you want your
|
1687
|
-
#
|
1688
|
-
#
|
1689
|
-
#
|
1820
|
+
# The type of endpoint that you want your server to connect to. You
|
1821
|
+
# can choose to connect to the public internet or a VPC endpoint. With
|
1822
|
+
# a VPC endpoint, you can restrict access to your server and resources
|
1823
|
+
# only within your VPC.
|
1690
1824
|
#
|
1691
1825
|
# <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With
|
1692
1826
|
# this endpoint type, you have the option to directly associate up to
|
@@ -1703,9 +1837,8 @@ module Aws::Transfer
|
|
1703
1837
|
# my-new-server-key`.
|
1704
1838
|
#
|
1705
1839
|
# If you aren't planning to migrate existing users from an existing
|
1706
|
-
#
|
1707
|
-
#
|
1708
|
-
# disruptive.
|
1840
|
+
# server to a new server, don't update the host key. Accidentally
|
1841
|
+
# changing a server's host key can be disruptive.
|
1709
1842
|
#
|
1710
1843
|
# For more information, see [Change the host key for your SFTP-enabled
|
1711
1844
|
# server][1] in the *AWS Transfer Family User Guide*.
|
@@ -1757,10 +1890,14 @@ module Aws::Transfer
|
|
1757
1890
|
# </note>
|
1758
1891
|
# @return [Array<String>]
|
1759
1892
|
#
|
1893
|
+
# @!attribute [rw] security_policy_name
|
1894
|
+
# Specifies the name of the security policy that is attached to the
|
1895
|
+
# server.
|
1896
|
+
# @return [String]
|
1897
|
+
#
|
1760
1898
|
# @!attribute [rw] server_id
|
1761
|
-
# A system-assigned unique identifier for a
|
1762
|
-
#
|
1763
|
-
# to.
|
1899
|
+
# A system-assigned unique identifier for a server instance that the
|
1900
|
+
# user account is assigned to.
|
1764
1901
|
# @return [String]
|
1765
1902
|
#
|
1766
1903
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServerRequest AWS API Documentation
|
@@ -1773,14 +1910,15 @@ module Aws::Transfer
|
|
1773
1910
|
:identity_provider_details,
|
1774
1911
|
:logging_role,
|
1775
1912
|
:protocols,
|
1913
|
+
:security_policy_name,
|
1776
1914
|
:server_id)
|
1777
1915
|
SENSITIVE = [:host_key]
|
1778
1916
|
include Aws::Structure
|
1779
1917
|
end
|
1780
1918
|
|
1781
1919
|
# @!attribute [rw] server_id
|
1782
|
-
# A system-assigned unique identifier for a
|
1783
|
-
#
|
1920
|
+
# A system-assigned unique identifier for a server that the user
|
1921
|
+
# account is assigned to.
|
1784
1922
|
# @return [String]
|
1785
1923
|
#
|
1786
1924
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServerResponse AWS API Documentation
|
@@ -1811,20 +1949,18 @@ module Aws::Transfer
|
|
1811
1949
|
#
|
1812
1950
|
# @!attribute [rw] home_directory
|
1813
1951
|
# Specifies the landing directory (folder) for a user when they log in
|
1814
|
-
# to the
|
1815
|
-
# transfer protocol client.
|
1952
|
+
# to the server using their file transfer protocol client.
|
1816
1953
|
#
|
1817
1954
|
# An example is `your-Amazon-S3-bucket-name>/home/username`.
|
1818
1955
|
# @return [String]
|
1819
1956
|
#
|
1820
1957
|
# @!attribute [rw] home_directory_type
|
1821
1958
|
# The type of landing directory (folder) you want your users' home
|
1822
|
-
# directory to be when they log into the
|
1823
|
-
#
|
1824
|
-
#
|
1825
|
-
#
|
1826
|
-
#
|
1827
|
-
# Amazon S3 paths visible to your users.
|
1959
|
+
# directory to be when they log into the server. If you set it to
|
1960
|
+
# `PATH`, the user will see the absolute Amazon S3 bucket paths as is
|
1961
|
+
# in their file transfer protocol clients. If you set it `LOGICAL`,
|
1962
|
+
# you will need to provide mappings in the `HomeDirectoryMappings` for
|
1963
|
+
# how you want to make Amazon S3 paths visible to your users.
|
1828
1964
|
# @return [String]
|
1829
1965
|
#
|
1830
1966
|
# @!attribute [rw] home_directory_mappings
|
@@ -1848,7 +1984,7 @@ module Aws::Transfer
|
|
1848
1984
|
#
|
1849
1985
|
# <note markdown="1"> If the target of a logical directory entry does not exist in Amazon
|
1850
1986
|
# S3, the entry will be ignored. As a workaround, you can use the
|
1851
|
-
# Amazon S3
|
1987
|
+
# Amazon S3 API to create 0 byte objects as place holders for your
|
1852
1988
|
# directory. If using the CLI, use the `s3api` call instead of `s3` so
|
1853
1989
|
# you can use the put-object operation. For example, you use the
|
1854
1990
|
# following: `aws s3api put-object --bucket bucketname --key
|
@@ -1889,24 +2025,22 @@ module Aws::Transfer
|
|
1889
2025
|
# bucket. The policies attached to this role will determine the level
|
1890
2026
|
# of access you want to provide your users when transferring files
|
1891
2027
|
# into and out of your Amazon S3 bucket or buckets. The IAM role
|
1892
|
-
# should also contain a trust relationship that allows the
|
1893
|
-
#
|
1894
|
-
# servicing your users' transfer requests.
|
2028
|
+
# should also contain a trust relationship that allows the server to
|
2029
|
+
# access your resources when servicing your users' transfer requests.
|
1895
2030
|
# @return [String]
|
1896
2031
|
#
|
1897
2032
|
# @!attribute [rw] server_id
|
1898
|
-
# A system-assigned unique identifier for a
|
1899
|
-
#
|
1900
|
-
# to.
|
2033
|
+
# A system-assigned unique identifier for a server instance that the
|
2034
|
+
# user account is assigned to.
|
1901
2035
|
# @return [String]
|
1902
2036
|
#
|
1903
2037
|
# @!attribute [rw] user_name
|
1904
|
-
# A unique string that identifies a user and is associated with a
|
1905
|
-
#
|
1906
|
-
#
|
1907
|
-
#
|
1908
|
-
#
|
1909
|
-
#
|
2038
|
+
# A unique string that identifies a user and is associated with a
|
2039
|
+
# server as specified by the `ServerId`. This user name must be a
|
2040
|
+
# minimum of 3 and a maximum of 100 characters long. The following are
|
2041
|
+
# valid characters: a-z, A-Z, 0-9, underscore '\_', hyphen '-',
|
2042
|
+
# period '.', and at sign '@'. The user name can't start with a
|
2043
|
+
# hyphen, period, or at sign.
|
1910
2044
|
# @return [String]
|
1911
2045
|
#
|
1912
2046
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUserRequest AWS API Documentation
|
@@ -1923,19 +2057,17 @@ module Aws::Transfer
|
|
1923
2057
|
include Aws::Structure
|
1924
2058
|
end
|
1925
2059
|
|
1926
|
-
# `UpdateUserResponse` returns the user name and
|
1927
|
-
#
|
1928
|
-
# properties.
|
2060
|
+
# `UpdateUserResponse` returns the user name and identifier for the
|
2061
|
+
# request to update a user's properties.
|
1929
2062
|
#
|
1930
2063
|
# @!attribute [rw] server_id
|
1931
|
-
# A system-assigned unique identifier for a
|
1932
|
-
#
|
1933
|
-
# to.
|
2064
|
+
# A system-assigned unique identifier for a server instance that the
|
2065
|
+
# user account is assigned to.
|
1934
2066
|
# @return [String]
|
1935
2067
|
#
|
1936
2068
|
# @!attribute [rw] user_name
|
1937
|
-
# The unique identifier for a user that is assigned to a
|
1938
|
-
#
|
2069
|
+
# The unique identifier for a user that is assigned to a server
|
2070
|
+
# instance that was specified in the request.
|
1939
2071
|
# @return [String]
|
1940
2072
|
#
|
1941
2073
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUserResponse AWS API Documentation
|