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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 89e89b06f869efa7fad2c3e43d87843735ef3e5d36c3b1cb6b0c4cac683ccb1f
|
4
|
+
data.tar.gz: da5ff735f853c4435db6215cf5165cb0f306e7a26c55005dd1b7d789b6523e02
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b2f43ad16252874ed6da0efd9ea7f6ea9efd3e7108dbd5fcec306190c177136a2641a2f2b8e6c4d7a3b6bf3dcb08e54f3aa638430e31a8ab39275ee576b1081b
|
7
|
+
data.tar.gz: 266e9d63ba36997527e94367d35fb6dd35b8c4c372be4e4871e6be801d02e26034709cbdadb65633b42a21bccd1e8bed637b3b5ac881e81f6600dc2540a364ce
|
data/lib/aws-sdk-transfer.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-transfer/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::Transfer
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.28.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::Transfer
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::Transfer
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -369,17 +384,17 @@ module Aws::Transfer
|
|
369
384
|
#
|
370
385
|
# @option params [Types::EndpointDetails] :endpoint_details
|
371
386
|
# The virtual private cloud (VPC) endpoint settings that are configured
|
372
|
-
# for your
|
373
|
-
#
|
374
|
-
#
|
375
|
-
#
|
376
|
-
#
|
387
|
+
# for your server. When you host your endpoint within your VPC, you can
|
388
|
+
# make it accessible only to resources within your VPC, or you can
|
389
|
+
# attach Elastic IPs and make it accessible to clients over the
|
390
|
+
# internet. Your VPC's default security groups are automatically
|
391
|
+
# assigned to your endpoint.
|
377
392
|
#
|
378
393
|
# @option params [String] :endpoint_type
|
379
|
-
# The type of VPC endpoint that you want your
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
394
|
+
# The type of VPC endpoint that you want your server to connect to. You
|
395
|
+
# can choose to connect to the public internet or a VPC endpoint. With a
|
396
|
+
# VPC endpoint, you can restrict access to your server and resources
|
397
|
+
# only within your VPC.
|
383
398
|
#
|
384
399
|
# <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With this
|
385
400
|
# endpoint type, you have the option to directly associate up to three
|
@@ -412,13 +427,13 @@ module Aws::Transfer
|
|
412
427
|
# Not required when `IdentityProviderType` is set to `SERVICE_MANAGED`.
|
413
428
|
#
|
414
429
|
# @option params [String] :identity_provider_type
|
415
|
-
# Specifies the mode of authentication for a
|
416
|
-
#
|
417
|
-
#
|
418
|
-
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
#
|
430
|
+
# Specifies the mode of authentication for a server. The default value
|
431
|
+
# is `SERVICE_MANAGED`, which allows you to store and access user
|
432
|
+
# credentials within the AWS Transfer Family service. Use the
|
433
|
+
# `API_GATEWAY` value to integrate with an identity provider of your
|
434
|
+
# choosing. The `API_GATEWAY` setting requires you to provide an API
|
435
|
+
# Gateway endpoint URL to call for authentication using the
|
436
|
+
# `IdentityProviderDetails` parameter.
|
422
437
|
#
|
423
438
|
# @option params [String] :logging_role
|
424
439
|
# Allows the service to write your users' activity to your Amazon
|
@@ -453,9 +468,12 @@ module Aws::Transfer
|
|
453
468
|
#
|
454
469
|
# </note>
|
455
470
|
#
|
471
|
+
# @option params [String] :security_policy_name
|
472
|
+
# Specifies the name of the security policy that is attached to the
|
473
|
+
# server.
|
474
|
+
#
|
456
475
|
# @option params [Array<Types::Tag>] :tags
|
457
|
-
# Key-value pairs that can be used to group and search for
|
458
|
-
# protocol-enabled servers.
|
476
|
+
# Key-value pairs that can be used to group and search for servers.
|
459
477
|
#
|
460
478
|
# @return [Types::CreateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
461
479
|
#
|
@@ -470,6 +488,7 @@ module Aws::Transfer
|
|
470
488
|
# subnet_ids: ["SubnetId"],
|
471
489
|
# vpc_endpoint_id: "VpcEndpointId",
|
472
490
|
# vpc_id: "VpcId",
|
491
|
+
# security_group_ids: ["SecurityGroupId"],
|
473
492
|
# },
|
474
493
|
# endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
|
475
494
|
# host_key: "HostKey",
|
@@ -480,6 +499,7 @@ module Aws::Transfer
|
|
480
499
|
# identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY
|
481
500
|
# logging_role: "Role",
|
482
501
|
# protocols: ["SFTP"], # accepts SFTP, FTP, FTPS
|
502
|
+
# security_policy_name: "SecurityPolicyName",
|
483
503
|
# tags: [
|
484
504
|
# {
|
485
505
|
# key: "TagKey", # required
|
@@ -511,20 +531,19 @@ module Aws::Transfer
|
|
511
531
|
# can be used to group and search for users.
|
512
532
|
#
|
513
533
|
# @option params [String] :home_directory
|
514
|
-
# The landing directory (folder) for a user when they log in to the
|
515
|
-
#
|
534
|
+
# The landing directory (folder) for a user when they log in to the
|
535
|
+
# server using the client.
|
516
536
|
#
|
517
537
|
# An example is <i>
|
518
538
|
# <code>your-Amazon-S3-bucket-name>/home/username</code> </i>.
|
519
539
|
#
|
520
540
|
# @option params [String] :home_directory_type
|
521
541
|
# The type of landing directory (folder) you want your users' home
|
522
|
-
# directory to be when they log into the
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
# visible to your users.
|
542
|
+
# directory to be when they log into the server. If you set it to
|
543
|
+
# `PATH`, the user will see the absolute Amazon S3 bucket paths as is in
|
544
|
+
# their file transfer protocol clients. If you set it `LOGICAL`, you
|
545
|
+
# will need to provide mappings in the `HomeDirectoryMappings` for how
|
546
|
+
# you want to make Amazon S3 paths visible to your users.
|
528
547
|
#
|
529
548
|
# @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
|
530
549
|
# Logical directory mappings that specify what Amazon S3 paths and keys
|
@@ -546,7 +565,7 @@ module Aws::Transfer
|
|
546
565
|
#
|
547
566
|
# <note markdown="1"> If the target of a logical directory entry does not exist in Amazon
|
548
567
|
# S3, the entry will be ignored. As a workaround, you can use the Amazon
|
549
|
-
# S3
|
568
|
+
# S3 API to create 0 byte objects as place holders for your directory.
|
550
569
|
# If using the CLI, use the `s3api` call instead of `s3` so you can use
|
551
570
|
# the put-object operation. For example, you use the following: `aws
|
552
571
|
# s3api put-object --bucket bucketname --key path/to/folder/`. Make sure
|
@@ -585,29 +604,28 @@ module Aws::Transfer
|
|
585
604
|
# bucket. The policies attached to this role will determine the level of
|
586
605
|
# access you want to provide your users when transferring files into and
|
587
606
|
# out of your Amazon S3 bucket or buckets. The IAM role should also
|
588
|
-
# contain a trust relationship that allows the
|
589
|
-
#
|
590
|
-
# users' transfer requests.
|
607
|
+
# contain a trust relationship that allows the server to access your
|
608
|
+
# resources when servicing your users' transfer requests.
|
591
609
|
#
|
592
610
|
# @option params [required, String] :server_id
|
593
|
-
# A system-assigned unique identifier for a
|
594
|
-
#
|
595
|
-
# added your user to.
|
611
|
+
# A system-assigned unique identifier for a server instance. This is the
|
612
|
+
# specific server that you added your user to.
|
596
613
|
#
|
597
614
|
# @option params [String] :ssh_public_key_body
|
598
615
|
# The public portion of the Secure Shell (SSH) key used to authenticate
|
599
|
-
# the user to the
|
616
|
+
# the user to the server.
|
600
617
|
#
|
601
618
|
# @option params [Array<Types::Tag>] :tags
|
602
619
|
# Key-value pairs that can be used to group and search for users. Tags
|
603
620
|
# are metadata attached to users for any purpose.
|
604
621
|
#
|
605
622
|
# @option params [required, String] :user_name
|
606
|
-
# A unique string that identifies a user and is associated with a
|
607
|
-
#
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
623
|
+
# A unique string that identifies a user and is associated with a as
|
624
|
+
# specified by the `ServerId`. This user name must be a minimum of 3 and
|
625
|
+
# a maximum of 100 characters long. The following are valid characters:
|
626
|
+
# a-z, A-Z, 0-9, underscore '\_', hyphen '-', period '.', and at
|
627
|
+
# sign '@'. The user name can't start with a hyphen, period, or at
|
628
|
+
# sign.
|
611
629
|
#
|
612
630
|
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
613
631
|
#
|
@@ -657,8 +675,7 @@ module Aws::Transfer
|
|
657
675
|
# No response returns from this operation.
|
658
676
|
#
|
659
677
|
# @option params [required, String] :server_id
|
660
|
-
# A unique system-assigned identifier for a
|
661
|
-
# protocol-enabled server instance.
|
678
|
+
# A unique system-assigned identifier for a server instance.
|
662
679
|
#
|
663
680
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
664
681
|
#
|
@@ -721,12 +738,12 @@ module Aws::Transfer
|
|
721
738
|
# </note>
|
722
739
|
#
|
723
740
|
# @option params [required, String] :server_id
|
724
|
-
# A system-assigned unique identifier for a
|
725
|
-
#
|
741
|
+
# A system-assigned unique identifier for a server instance that has the
|
742
|
+
# user assigned to it.
|
726
743
|
#
|
727
744
|
# @option params [required, String] :user_name
|
728
745
|
# A unique string that identifies a user that is being deleted from a
|
729
|
-
#
|
746
|
+
# server.
|
730
747
|
#
|
731
748
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
732
749
|
#
|
@@ -746,6 +763,51 @@ module Aws::Transfer
|
|
746
763
|
req.send_request(options)
|
747
764
|
end
|
748
765
|
|
766
|
+
# Describes the security policy that is attached to your file transfer
|
767
|
+
# protocol-enabled server. The response contains a description of the
|
768
|
+
# security policy's properties. For more information about security
|
769
|
+
# policies, see [Working with security policies][1].
|
770
|
+
#
|
771
|
+
#
|
772
|
+
#
|
773
|
+
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html
|
774
|
+
#
|
775
|
+
# @option params [required, String] :security_policy_name
|
776
|
+
# Specifies the name of the security policy that is attached to the
|
777
|
+
# server.
|
778
|
+
#
|
779
|
+
# @return [Types::DescribeSecurityPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
780
|
+
#
|
781
|
+
# * {Types::DescribeSecurityPolicyResponse#security_policy #security_policy} => Types::DescribedSecurityPolicy
|
782
|
+
#
|
783
|
+
# @example Request syntax with placeholder values
|
784
|
+
#
|
785
|
+
# resp = client.describe_security_policy({
|
786
|
+
# security_policy_name: "SecurityPolicyName", # required
|
787
|
+
# })
|
788
|
+
#
|
789
|
+
# @example Response structure
|
790
|
+
#
|
791
|
+
# resp.security_policy.fips #=> Boolean
|
792
|
+
# resp.security_policy.security_policy_name #=> String
|
793
|
+
# resp.security_policy.ssh_ciphers #=> Array
|
794
|
+
# resp.security_policy.ssh_ciphers[0] #=> String
|
795
|
+
# resp.security_policy.ssh_kexs #=> Array
|
796
|
+
# resp.security_policy.ssh_kexs[0] #=> String
|
797
|
+
# resp.security_policy.ssh_macs #=> Array
|
798
|
+
# resp.security_policy.ssh_macs[0] #=> String
|
799
|
+
# resp.security_policy.tls_ciphers #=> Array
|
800
|
+
# resp.security_policy.tls_ciphers[0] #=> String
|
801
|
+
#
|
802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeSecurityPolicy AWS API Documentation
|
803
|
+
#
|
804
|
+
# @overload describe_security_policy(params = {})
|
805
|
+
# @param [Hash] params ({})
|
806
|
+
def describe_security_policy(params = {}, options = {})
|
807
|
+
req = build_request(:describe_security_policy, params)
|
808
|
+
req.send_request(options)
|
809
|
+
end
|
810
|
+
|
749
811
|
# Describes a file transfer protocol-enabled server that you specify by
|
750
812
|
# passing the `ServerId` parameter.
|
751
813
|
#
|
@@ -754,8 +816,7 @@ module Aws::Transfer
|
|
754
816
|
# `EndpointDetails`.
|
755
817
|
#
|
756
818
|
# @option params [required, String] :server_id
|
757
|
-
# A system-assigned unique identifier for a
|
758
|
-
# protocol-enabled server.
|
819
|
+
# A system-assigned unique identifier for a server.
|
759
820
|
#
|
760
821
|
# @return [Types::DescribeServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
761
822
|
#
|
@@ -777,6 +838,8 @@ module Aws::Transfer
|
|
777
838
|
# resp.server.endpoint_details.subnet_ids[0] #=> String
|
778
839
|
# resp.server.endpoint_details.vpc_endpoint_id #=> String
|
779
840
|
# resp.server.endpoint_details.vpc_id #=> String
|
841
|
+
# resp.server.endpoint_details.security_group_ids #=> Array
|
842
|
+
# resp.server.endpoint_details.security_group_ids[0] #=> String
|
780
843
|
# resp.server.endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
|
781
844
|
# resp.server.host_key_fingerprint #=> String
|
782
845
|
# resp.server.identity_provider_details.url #=> String
|
@@ -785,6 +848,7 @@ module Aws::Transfer
|
|
785
848
|
# resp.server.logging_role #=> String
|
786
849
|
# resp.server.protocols #=> Array
|
787
850
|
# resp.server.protocols[0] #=> String, one of "SFTP", "FTP", "FTPS"
|
851
|
+
# resp.server.security_policy_name #=> String
|
788
852
|
# resp.server.server_id #=> String
|
789
853
|
# resp.server.state #=> String, one of "OFFLINE", "ONLINE", "STARTING", "STOPPING", "START_FAILED", "STOP_FAILED"
|
790
854
|
# resp.server.tags #=> Array
|
@@ -808,14 +872,13 @@ module Aws::Transfer
|
|
808
872
|
# associated with the `ServerId` value that was specified.
|
809
873
|
#
|
810
874
|
# @option params [required, String] :server_id
|
811
|
-
# A system-assigned unique identifier for a
|
812
|
-
#
|
875
|
+
# A system-assigned unique identifier for a server that has this user
|
876
|
+
# assigned.
|
813
877
|
#
|
814
878
|
# @option params [required, String] :user_name
|
815
|
-
# The name of the user assigned to one or more
|
816
|
-
#
|
817
|
-
#
|
818
|
-
# transfer tasks.
|
879
|
+
# The name of the user assigned to one or more servers. User names are
|
880
|
+
# part of the sign-in credentials to use the AWS Transfer Family service
|
881
|
+
# and perform file transfer tasks.
|
819
882
|
#
|
820
883
|
# @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
821
884
|
#
|
@@ -866,15 +929,13 @@ module Aws::Transfer
|
|
866
929
|
# the name of the `SshPublicKeyId`.
|
867
930
|
#
|
868
931
|
# @option params [required, String] :server_id
|
869
|
-
# A system-assigned unique identifier for a
|
870
|
-
# protocol-enabled server.
|
932
|
+
# A system-assigned unique identifier for a server.
|
871
933
|
#
|
872
934
|
# @option params [required, String] :ssh_public_key_body
|
873
935
|
# The public key portion of an SSH key pair.
|
874
936
|
#
|
875
937
|
# @option params [required, String] :user_name
|
876
|
-
# The name of the user account that is assigned to one or more
|
877
|
-
# transfer protocol-enabled servers.
|
938
|
+
# The name of the user account that is assigned to one or more servers.
|
878
939
|
#
|
879
940
|
# @return [Types::ImportSshPublicKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
880
941
|
#
|
@@ -905,18 +966,60 @@ module Aws::Transfer
|
|
905
966
|
req.send_request(options)
|
906
967
|
end
|
907
968
|
|
969
|
+
# Lists the security policies that are attached to your file transfer
|
970
|
+
# protocol-enabled servers.
|
971
|
+
#
|
972
|
+
# @option params [Integer] :max_results
|
973
|
+
# Specifies the number of security policies to return as a response to
|
974
|
+
# the `ListSecurityPolicies` query.
|
975
|
+
#
|
976
|
+
# @option params [String] :next_token
|
977
|
+
# When additional results are obtained from the `ListSecurityPolicies`
|
978
|
+
# command, a `NextToken` parameter is returned in the output. You can
|
979
|
+
# then pass the `NextToken` parameter in a subsequent command to
|
980
|
+
# continue listing additional security policies.
|
981
|
+
#
|
982
|
+
# @return [Types::ListSecurityPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
983
|
+
#
|
984
|
+
# * {Types::ListSecurityPoliciesResponse#next_token #next_token} => String
|
985
|
+
# * {Types::ListSecurityPoliciesResponse#security_policy_names #security_policy_names} => Array<String>
|
986
|
+
#
|
987
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
988
|
+
#
|
989
|
+
# @example Request syntax with placeholder values
|
990
|
+
#
|
991
|
+
# resp = client.list_security_policies({
|
992
|
+
# max_results: 1,
|
993
|
+
# next_token: "NextToken",
|
994
|
+
# })
|
995
|
+
#
|
996
|
+
# @example Response structure
|
997
|
+
#
|
998
|
+
# resp.next_token #=> String
|
999
|
+
# resp.security_policy_names #=> Array
|
1000
|
+
# resp.security_policy_names[0] #=> String
|
1001
|
+
#
|
1002
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListSecurityPolicies AWS API Documentation
|
1003
|
+
#
|
1004
|
+
# @overload list_security_policies(params = {})
|
1005
|
+
# @param [Hash] params ({})
|
1006
|
+
def list_security_policies(params = {}, options = {})
|
1007
|
+
req = build_request(:list_security_policies, params)
|
1008
|
+
req.send_request(options)
|
1009
|
+
end
|
1010
|
+
|
908
1011
|
# Lists the file transfer protocol-enabled servers that are associated
|
909
1012
|
# with your AWS account.
|
910
1013
|
#
|
911
1014
|
# @option params [Integer] :max_results
|
912
|
-
# Specifies the number of
|
913
|
-
#
|
1015
|
+
# Specifies the number of servers to return as a response to the
|
1016
|
+
# `ListServers` query.
|
914
1017
|
#
|
915
1018
|
# @option params [String] :next_token
|
916
|
-
# When additional results are obtained from the`ListServers` command, a
|
1019
|
+
# When additional results are obtained from the `ListServers` command, a
|
917
1020
|
# `NextToken` parameter is returned in the output. You can then pass the
|
918
1021
|
# `NextToken` parameter in a subsequent command to continue listing
|
919
|
-
# additional
|
1022
|
+
# additional servers.
|
920
1023
|
#
|
921
1024
|
# @return [Types::ListServersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
922
1025
|
#
|
@@ -1018,8 +1121,8 @@ module Aws::Transfer
|
|
1018
1121
|
# additional users.
|
1019
1122
|
#
|
1020
1123
|
# @option params [required, String] :server_id
|
1021
|
-
# A system-assigned unique identifier for a
|
1022
|
-
#
|
1124
|
+
# A system-assigned unique identifier for a server that has users
|
1125
|
+
# assigned to it.
|
1023
1126
|
#
|
1024
1127
|
# @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1025
1128
|
#
|
@@ -1070,8 +1173,7 @@ module Aws::Transfer
|
|
1070
1173
|
# No response is returned from this call.
|
1071
1174
|
#
|
1072
1175
|
# @option params [required, String] :server_id
|
1073
|
-
# A system-assigned unique identifier for a
|
1074
|
-
# protocol-enabled server that you start.
|
1176
|
+
# A system-assigned unique identifier for a server that you start.
|
1075
1177
|
#
|
1076
1178
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1077
1179
|
#
|
@@ -1094,8 +1196,12 @@ module Aws::Transfer
|
|
1094
1196
|
# `ONLINE` to `OFFLINE`. An `OFFLINE` server cannot accept and process
|
1095
1197
|
# file transfer jobs. Information tied to your server, such as server
|
1096
1198
|
# and user properties, are not affected by stopping your server.
|
1097
|
-
#
|
1098
|
-
#
|
1199
|
+
#
|
1200
|
+
# <note markdown="1"> Stopping the server will not reduce or impact your file transfer
|
1201
|
+
# protocol endpoint billing; you must delete the server to stop being
|
1202
|
+
# billed.
|
1203
|
+
#
|
1204
|
+
# </note>
|
1099
1205
|
#
|
1100
1206
|
# The state of `STOPPING` indicates that the server is in an
|
1101
1207
|
# intermediate state, either not fully able to respond, or not fully
|
@@ -1104,8 +1210,7 @@ module Aws::Transfer
|
|
1104
1210
|
# No response is returned from this call.
|
1105
1211
|
#
|
1106
1212
|
# @option params [required, String] :server_id
|
1107
|
-
# A system-assigned unique identifier for a
|
1108
|
-
# protocol-enabled server that you stopped.
|
1213
|
+
# A system-assigned unique identifier for a server that you stopped.
|
1109
1214
|
#
|
1110
1215
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1111
1216
|
#
|
@@ -1170,9 +1275,8 @@ module Aws::Transfer
|
|
1170
1275
|
# ensure that your users can successfully use the service.
|
1171
1276
|
#
|
1172
1277
|
# @option params [required, String] :server_id
|
1173
|
-
# A system-assigned identifier for a specific
|
1174
|
-
#
|
1175
|
-
# tested with a user name and password.
|
1278
|
+
# A system-assigned identifier for a specific server. That server's
|
1279
|
+
# user authentication method is tested with a user name and password.
|
1176
1280
|
#
|
1177
1281
|
# @option params [String] :server_protocol
|
1178
1282
|
# The type of file transfer protocol to be tested.
|
@@ -1308,16 +1412,16 @@ module Aws::Transfer
|
|
1308
1412
|
#
|
1309
1413
|
# @option params [Types::EndpointDetails] :endpoint_details
|
1310
1414
|
# The virtual private cloud (VPC) endpoint settings that are configured
|
1311
|
-
# for your
|
1312
|
-
#
|
1313
|
-
#
|
1314
|
-
#
|
1415
|
+
# for your server. With a VPC endpoint, you can restrict access to your
|
1416
|
+
# server to resources only within your VPC. To control incoming internet
|
1417
|
+
# traffic, you will need to associate one or more Elastic IP addresses
|
1418
|
+
# with your server's endpoint.
|
1315
1419
|
#
|
1316
1420
|
# @option params [String] :endpoint_type
|
1317
|
-
# The type of endpoint that you want your
|
1318
|
-
#
|
1319
|
-
#
|
1320
|
-
#
|
1421
|
+
# The type of endpoint that you want your server to connect to. You can
|
1422
|
+
# choose to connect to the public internet or a VPC endpoint. With a VPC
|
1423
|
+
# endpoint, you can restrict access to your server and resources only
|
1424
|
+
# within your VPC.
|
1321
1425
|
#
|
1322
1426
|
# <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With this
|
1323
1427
|
# endpoint type, you have the option to directly associate up to three
|
@@ -1333,9 +1437,8 @@ module Aws::Transfer
|
|
1333
1437
|
# my-new-server-key`.
|
1334
1438
|
#
|
1335
1439
|
# If you aren't planning to migrate existing users from an existing
|
1336
|
-
#
|
1337
|
-
#
|
1338
|
-
# disruptive.
|
1440
|
+
# server to a new server, don't update the host key. Accidentally
|
1441
|
+
# changing a server's host key can be disruptive.
|
1339
1442
|
#
|
1340
1443
|
# For more information, see [Change the host key for your SFTP-enabled
|
1341
1444
|
# server][1] in the *AWS Transfer Family User Guide*.
|
@@ -1382,9 +1485,13 @@ module Aws::Transfer
|
|
1382
1485
|
#
|
1383
1486
|
# </note>
|
1384
1487
|
#
|
1488
|
+
# @option params [String] :security_policy_name
|
1489
|
+
# Specifies the name of the security policy that is attached to the
|
1490
|
+
# server.
|
1491
|
+
#
|
1385
1492
|
# @option params [required, String] :server_id
|
1386
|
-
# A system-assigned unique identifier for a
|
1387
|
-
#
|
1493
|
+
# A system-assigned unique identifier for a server instance that the
|
1494
|
+
# user account is assigned to.
|
1388
1495
|
#
|
1389
1496
|
# @return [Types::UpdateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1390
1497
|
#
|
@@ -1399,6 +1506,7 @@ module Aws::Transfer
|
|
1399
1506
|
# subnet_ids: ["SubnetId"],
|
1400
1507
|
# vpc_endpoint_id: "VpcEndpointId",
|
1401
1508
|
# vpc_id: "VpcId",
|
1509
|
+
# security_group_ids: ["SecurityGroupId"],
|
1402
1510
|
# },
|
1403
1511
|
# endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
|
1404
1512
|
# host_key: "HostKey",
|
@@ -1408,6 +1516,7 @@ module Aws::Transfer
|
|
1408
1516
|
# },
|
1409
1517
|
# logging_role: "NullableRole",
|
1410
1518
|
# protocols: ["SFTP"], # accepts SFTP, FTP, FTPS
|
1519
|
+
# security_policy_name: "SecurityPolicyName",
|
1411
1520
|
# server_id: "ServerId", # required
|
1412
1521
|
# })
|
1413
1522
|
#
|
@@ -1433,19 +1542,17 @@ module Aws::Transfer
|
|
1433
1542
|
#
|
1434
1543
|
# @option params [String] :home_directory
|
1435
1544
|
# Specifies the landing directory (folder) for a user when they log in
|
1436
|
-
# to the
|
1437
|
-
# protocol client.
|
1545
|
+
# to the server using their file transfer protocol client.
|
1438
1546
|
#
|
1439
1547
|
# An example is `your-Amazon-S3-bucket-name>/home/username`.
|
1440
1548
|
#
|
1441
1549
|
# @option params [String] :home_directory_type
|
1442
1550
|
# The type of landing directory (folder) you want your users' home
|
1443
|
-
# directory to be when they log into the
|
1444
|
-
#
|
1445
|
-
#
|
1446
|
-
#
|
1447
|
-
#
|
1448
|
-
# visible to your users.
|
1551
|
+
# 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 paths as is in
|
1553
|
+
# their file transfer protocol clients. If you set it `LOGICAL`, you
|
1554
|
+
# will need to provide mappings in the `HomeDirectoryMappings` for how
|
1555
|
+
# you want to make Amazon S3 paths visible to your users.
|
1449
1556
|
#
|
1450
1557
|
# @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
|
1451
1558
|
# Logical directory mappings that specify what Amazon S3 paths and keys
|
@@ -1467,7 +1574,7 @@ module Aws::Transfer
|
|
1467
1574
|
#
|
1468
1575
|
# <note markdown="1"> If the target of a logical directory entry does not exist in Amazon
|
1469
1576
|
# S3, the entry will be ignored. As a workaround, you can use the Amazon
|
1470
|
-
# S3
|
1577
|
+
# S3 API to create 0 byte objects as place holders for your directory.
|
1471
1578
|
# If using the CLI, use the `s3api` call instead of `s3` so you can use
|
1472
1579
|
# the put-object operation. For example, you use the following: `aws
|
1473
1580
|
# s3api put-object --bucket bucketname --key path/to/folder/`. Make sure
|
@@ -1506,21 +1613,20 @@ module Aws::Transfer
|
|
1506
1613
|
# bucket. The policies attached to this role will determine the level of
|
1507
1614
|
# access you want to provide your users when transferring files into and
|
1508
1615
|
# out of your Amazon S3 bucket or buckets. The IAM role should also
|
1509
|
-
# contain a trust relationship that allows the
|
1510
|
-
#
|
1511
|
-
# users' transfer requests.
|
1616
|
+
# contain a trust relationship that allows the server to access your
|
1617
|
+
# resources when servicing your users' transfer requests.
|
1512
1618
|
#
|
1513
1619
|
# @option params [required, String] :server_id
|
1514
|
-
# A system-assigned unique identifier for a
|
1515
|
-
#
|
1620
|
+
# A system-assigned unique identifier for a server instance that the
|
1621
|
+
# user account is assigned to.
|
1516
1622
|
#
|
1517
1623
|
# @option params [required, String] :user_name
|
1518
|
-
# A unique string that identifies a user and is associated with a
|
1519
|
-
#
|
1520
|
-
#
|
1521
|
-
#
|
1522
|
-
#
|
1523
|
-
#
|
1624
|
+
# A unique string that identifies a user and is associated with a server
|
1625
|
+
# as specified by the `ServerId`. This user name must be a minimum of 3
|
1626
|
+
# and a maximum of 100 characters long. The following are valid
|
1627
|
+
# characters: a-z, A-Z, 0-9, underscore '\_', hyphen '-', period
|
1628
|
+
# '.', and at sign '@'. The user name can't start with a hyphen,
|
1629
|
+
# period, or at sign.
|
1524
1630
|
#
|
1525
1631
|
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1526
1632
|
#
|
@@ -1571,7 +1677,7 @@ module Aws::Transfer
|
|
1571
1677
|
params: params,
|
1572
1678
|
config: config)
|
1573
1679
|
context[:gem_name] = 'aws-sdk-transfer'
|
1574
|
-
context[:gem_version] = '1.
|
1680
|
+
context[:gem_version] = '1.28.0'
|
1575
1681
|
Seahorse::Client::Request.new(handlers, context)
|
1576
1682
|
end
|
1577
1683
|
|