aws-sdk-datasync 1.53.0 → 1.54.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bda7f8add30800b242b5a88e11ff322675531eebe12557ea5778467e40f5dfc5
4
- data.tar.gz: 81a85eba21bb83f69233fc6d310886ff787222d3a4267fa677c7115e6742b72c
3
+ metadata.gz: 97e0f7d566ea02a14f51a0ef17bbde1a4df491462bd89be863fb45a772066f45
4
+ data.tar.gz: cb9940c9eb487c9d08e31396c65465a29b8716f13dec09632dc3cd9dbe30133f
5
5
  SHA512:
6
- metadata.gz: f452de2c3cf9e85d440bcb51d86d232f956f0e43ea496e88d9f2ddbfd61e018e0f6bf995e88d48c403dc1cb7ba2316128d8e5605fddee06b4b2f58824cf09999
7
- data.tar.gz: 9f07888df256f90b54f78a52f18453811cccb467cee4e2ea1212e07e33c226a132419bbcc547fff32b8a372abeaa9e8b2f75759044a3e3ea45374dac3afeef08
6
+ metadata.gz: 710aa9e20314d90713fe60ae7205adc285983684635576cdfa79a4aeb770320042451fd243ee5502f038279503981d5069861814e1df5d047e1ac8a29f46f9fe
7
+ data.tar.gz: bab2c5dfc026220fd8241247ba9d2ea3a88fde9400248b1c07af6823f512052aed16766d62a857e5ae5c6aa9cbcbb680f03a099277c884d9ba59717d19e77b81
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.54.0 (2023-02-14)
5
+ ------------------
6
+
7
+ * Feature - With this launch, we are giving customers the ability to use older SMB protocol versions, enabling them to use DataSync to copy data to and from their legacy storage arrays.
8
+
4
9
  1.53.0 (2023-01-18)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.53.0
1
+ 1.54.0
@@ -689,12 +689,17 @@ module Aws::DataSync
689
689
  # the same ports.
690
690
  #
691
691
  # @option params [required, String] :storage_virtual_machine_arn
692
- # Specifies the ARN of the storage virtual machine (SVM) on your file
693
- # system where you're copying data to or from.
692
+ # Specifies the ARN of the storage virtual machine (SVM) in your file
693
+ # system where you want to copy data to or from.
694
694
  #
695
695
  # @option params [String] :subdirectory
696
- # Specifies the junction path (also known as a mount point) in the SVM
697
- # volume where you're copying data to or from (for example, `/vol1`).
696
+ # Specifies a path to the file share in the SVM where you'll copy your
697
+ # data.
698
+ #
699
+ # You can specify a junction path (also known as a mount point), qtree
700
+ # path (for NFS file shares), or share name (for SMB file shares). For
701
+ # example, your mount path might be `/vol1`, `/vol1/tree1`, or
702
+ # `/share1`.
698
703
  #
699
704
  # <note markdown="1"> Don't specify a junction path in the SVM's root volume. For more
700
705
  # information, see [Managing FSx for ONTAP storage virtual machines][1]
@@ -727,7 +732,7 @@ module Aws::DataSync
727
732
  # smb: {
728
733
  # domain: "SmbDomain",
729
734
  # mount_options: {
730
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
735
+ # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3, SMB1, SMB2_0
731
736
  # },
732
737
  # password: "SmbPassword", # required
733
738
  # user: "SmbUser", # required
@@ -808,7 +813,7 @@ module Aws::DataSync
808
813
  # smb: {
809
814
  # domain: "SmbDomain",
810
815
  # mount_options: {
811
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
816
+ # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3, SMB1, SMB2_0
812
817
  # },
813
818
  # password: "SmbPassword", # required
814
819
  # user: "SmbUser", # required
@@ -1256,10 +1261,8 @@ module Aws::DataSync
1256
1261
  end
1257
1262
 
1258
1263
  # Creates an endpoint for an Amazon S3 bucket that DataSync can access
1259
- # for a transfer.
1260
- #
1261
- # For more information, see [Create an Amazon S3 location][1] in the
1262
- # *DataSync User Guide*.
1264
+ # for a transfer. For more information, see [Create an Amazon S3
1265
+ # location][1].
1263
1266
  #
1264
1267
  #
1265
1268
  #
@@ -1349,67 +1352,81 @@ module Aws::DataSync
1349
1352
  req.send_request(options)
1350
1353
  end
1351
1354
 
1352
- # Defines a file system on a Server Message Block (SMB) server that can
1353
- # be read from or written to.
1355
+ # Creates an endpoint for a Server Message Block (SMB) file server that
1356
+ # DataSync can access for a transfer. For more information, see
1357
+ # [Creating an SMB location][1].
1358
+ #
1359
+ #
1360
+ #
1361
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html
1354
1362
  #
1355
1363
  # @option params [required, String] :subdirectory
1356
- # The subdirectory in the SMB file system that is used to read data from
1357
- # the SMB source location or write data to the SMB destination. The SMB
1358
- # path should be a path that's exported by the SMB server, or a
1359
- # subdirectory of that path. The path should be such that it can be
1360
- # mounted by other SMB clients in your network.
1364
+ # Specifies the name of the share exported by your SMB file server where
1365
+ # DataSync will read or write data. You can include a subdirectory in
1366
+ # the share path (for example, `/path/to/subdirectory`). Make sure that
1367
+ # other SMB clients in your network can also mount this path.
1361
1368
  #
1362
- # <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example,
1363
- # `/path/to/folder`.
1369
+ # To copy all data in the specified subdirectory, DataSync must be able
1370
+ # to mount the SMB share and access all of its data. For more
1371
+ # information, see [required permissions][1] for SMB locations.
1364
1372
  #
1365
- # </note>
1366
1373
  #
1367
- # To transfer all the data in the folder you specified, DataSync needs
1368
- # to have permissions to mount the SMB share, as well as to access all
1369
- # the data in that share. To ensure this, either ensure that the
1370
- # user/password specified belongs to the user who can mount the share,
1371
- # and who has the appropriate permissions for all of the files and
1372
- # directories that you want DataSync to access, or use credentials of a
1373
- # member of the Backup Operators group to mount the share. Doing either
1374
- # enables the agent to access the data. For the agent to access
1375
- # directories, you must additionally enable all execute access.
1374
+ #
1375
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
1376
1376
  #
1377
1377
  # @option params [required, String] :server_hostname
1378
- # The name of the SMB server. This value is the IP address or Domain
1379
- # Name Service (DNS) name of the SMB server. An agent that is installed
1380
- # on-premises uses this hostname to mount the SMB server in a network.
1378
+ # Specifies the Domain Name Service (DNS) name or IP address of the SMB
1379
+ # file server that your DataSync agent will mount.
1381
1380
  #
1382
- # <note markdown="1"> This name must either be DNS-compliant or must be an IP version 4
1383
- # (IPv4) address.
1381
+ # <note markdown="1"> You can't specify an IP version 6 (IPv6) address.
1384
1382
  #
1385
1383
  # </note>
1386
1384
  #
1387
1385
  # @option params [required, String] :user
1388
- # The user who can mount the share, has the permissions to access files
1389
- # and folders in the SMB share.
1386
+ # Specifies the user name that can mount your SMB file server and has
1387
+ # permission to access the files and folders involved in your transfer.
1388
+ #
1389
+ # For information about choosing a user with the right level of access
1390
+ # for your transfer, see [required permissions][1] for SMB locations.
1390
1391
  #
1391
- # For information about choosing a user name that ensures sufficient
1392
- # permissions to files, folders, and metadata, see the [User
1393
- # setting](create-smb-location.html#SMBuser) for SMB locations.
1392
+ #
1393
+ #
1394
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
1394
1395
  #
1395
1396
  # @option params [String] :domain
1396
- # The name of the Windows domain that the SMB server belongs to.
1397
+ # Specifies the Windows domain name that your SMB file server belongs
1398
+ # to.
1399
+ #
1400
+ # For more information, see [required permissions][1] for SMB locations.
1401
+ #
1402
+ #
1403
+ #
1404
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
1397
1405
  #
1398
1406
  # @option params [required, String] :password
1399
- # The password of the user who can mount the share, has the permissions
1400
- # to access files and folders in the SMB share.
1407
+ # Specifies the password of the user who can mount your SMB file server
1408
+ # and has permission to access the files and folders involved in your
1409
+ # transfer.
1410
+ #
1411
+ # For more information, see [required permissions][1] for SMB locations.
1412
+ #
1413
+ #
1414
+ #
1415
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
1401
1416
  #
1402
1417
  # @option params [required, Array<String>] :agent_arns
1403
- # The Amazon Resource Names (ARNs) of agents to use for a Simple Message
1404
- # Block (SMB) location.
1418
+ # Specifies the DataSync agent (or agents) which you want to connect to
1419
+ # your SMB file server. You specify an agent by using its Amazon
1420
+ # Resource Name (ARN).
1405
1421
  #
1406
1422
  # @option params [Types::SmbMountOptions] :mount_options
1407
- # The mount options used by DataSync to access the SMB server.
1423
+ # Specifies the version of the SMB protocol that DataSync uses to access
1424
+ # your SMB file server.
1408
1425
  #
1409
1426
  # @option params [Array<Types::TagListEntry>] :tags
1410
- # The key-value pair that represents the tag that you want to add to the
1411
- # location. The value can be an empty string. We recommend using tags to
1412
- # name your resources.
1427
+ # Specifies labels that help you categorize, filter, and search for your
1428
+ # Amazon Web Services resources. We recommend creating at least a name
1429
+ # tag for your location.
1413
1430
  #
1414
1431
  # @return [Types::CreateLocationSmbResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1415
1432
  #
@@ -1425,7 +1442,7 @@ module Aws::DataSync
1425
1442
  # password: "SmbPassword", # required
1426
1443
  # agent_arns: ["AgentArn"], # required
1427
1444
  # mount_options: {
1428
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
1445
+ # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3, SMB1, SMB2_0
1429
1446
  # },
1430
1447
  # tags: [
1431
1448
  # {
@@ -1653,13 +1670,12 @@ module Aws::DataSync
1653
1670
  req.send_request(options)
1654
1671
  end
1655
1672
 
1656
- # Returns metadata such as the name, the network interfaces, and the
1657
- # status (that is, whether the agent is running or not) for an agent. To
1658
- # specify which agent to describe, use the Amazon Resource Name (ARN) of
1659
- # the agent in your request.
1673
+ # Returns metadata about an DataSync agent, such as its name, endpoint
1674
+ # type, and status.
1660
1675
  #
1661
1676
  # @option params [required, String] :agent_arn
1662
- # The Amazon Resource Name (ARN) of the agent to describe.
1677
+ # Specifies the Amazon Resource Name (ARN) of the DataSync agent to
1678
+ # describe.
1663
1679
  #
1664
1680
  # @return [Types::DescribeAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1665
1681
  #
@@ -1817,7 +1833,7 @@ module Aws::DataSync
1817
1833
  # resp.location_uri #=> String
1818
1834
  # resp.protocol.nfs.mount_options.version #=> String, one of "AUTOMATIC", "NFS3", "NFS4_0", "NFS4_1"
1819
1835
  # resp.protocol.smb.domain #=> String
1820
- # resp.protocol.smb.mount_options.version #=> String, one of "AUTOMATIC", "SMB2", "SMB3"
1836
+ # resp.protocol.smb.mount_options.version #=> String, one of "AUTOMATIC", "SMB2", "SMB3", "SMB1", "SMB2_0"
1821
1837
  # resp.protocol.smb.password #=> String
1822
1838
  # resp.protocol.smb.user #=> String
1823
1839
  # resp.security_group_arns #=> Array
@@ -1868,7 +1884,7 @@ module Aws::DataSync
1868
1884
  # resp.security_group_arns[0] #=> String
1869
1885
  # resp.protocol.nfs.mount_options.version #=> String, one of "AUTOMATIC", "NFS3", "NFS4_0", "NFS4_1"
1870
1886
  # resp.protocol.smb.domain #=> String
1871
- # resp.protocol.smb.mount_options.version #=> String, one of "AUTOMATIC", "SMB2", "SMB3"
1887
+ # resp.protocol.smb.mount_options.version #=> String, one of "AUTOMATIC", "SMB2", "SMB3", "SMB1", "SMB2_0"
1872
1888
  # resp.protocol.smb.password #=> String
1873
1889
  # resp.protocol.smb.user #=> String
1874
1890
  # resp.creation_time #=> Time
@@ -2132,7 +2148,7 @@ module Aws::DataSync
2132
2148
  # resp.agent_arns[0] #=> String
2133
2149
  # resp.user #=> String
2134
2150
  # resp.domain #=> String
2135
- # resp.mount_options.version #=> String, one of "AUTOMATIC", "SMB2", "SMB3"
2151
+ # resp.mount_options.version #=> String, one of "AUTOMATIC", "SMB2", "SMB3", "SMB1", "SMB2_0"
2136
2152
  # resp.creation_time #=> Time
2137
2153
  #
2138
2154
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationSmb AWS API Documentation
@@ -2300,25 +2316,35 @@ module Aws::DataSync
2300
2316
  req.send_request(options)
2301
2317
  end
2302
2318
 
2303
- # Returns a list of agents owned by an Amazon Web Services account in
2304
- # the Amazon Web Services Region specified in the request. The returned
2305
- # list is ordered by agent Amazon Resource Name (ARN).
2319
+ # Returns a list of DataSync agents that belong to an Amazon Web
2320
+ # Services account in the Amazon Web Services Region specified in the
2321
+ # request.
2306
2322
  #
2307
- # By default, this operation returns a maximum of 100 agents. This
2308
- # operation supports pagination that enables you to optionally reduce
2309
- # the number of agents returned in a response.
2323
+ # With pagination, you can reduce the number of agents returned in a
2324
+ # response. If you get a truncated list of agents in a response, the
2325
+ # response contains a marker that you can specify in your next request
2326
+ # to fetch the next page of agents.
2310
2327
  #
2311
- # If you have more agents than are returned in a response (that is, the
2312
- # response returns only a truncated list of your agents), the response
2313
- # contains a marker that you can specify in your next request to fetch
2314
- # the next page of agents.
2328
+ # `ListAgents` is eventually consistent. This means the result of
2329
+ # running the operation might not reflect that you just created or
2330
+ # deleted an agent. For example, if you create an agent with
2331
+ # [CreateAgent][1] and then immediately run `ListAgents`, that agent
2332
+ # might not show up in the list right away. In situations like this, you
2333
+ # can always confirm whether an agent has been created (or deleted) by
2334
+ # using [DescribeAgent][2].
2335
+ #
2336
+ #
2337
+ #
2338
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html
2339
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html
2315
2340
  #
2316
2341
  # @option params [Integer] :max_results
2317
- # The maximum number of agents to list.
2342
+ # Specifies the maximum number of DataSync agents to list in a response.
2343
+ # By default, a response shows a maximum of 100 agents.
2318
2344
  #
2319
2345
  # @option params [String] :next_token
2320
- # An opaque string that indicates the position at which to begin the
2321
- # next list of agents.
2346
+ # Specifies an opaque string that indicates the position to begin the
2347
+ # next list of results in the response.
2322
2348
  #
2323
2349
  # @return [Types::ListAgentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2324
2350
  #
@@ -3037,7 +3063,8 @@ module Aws::DataSync
3037
3063
  # Block (SMB) location.
3038
3064
  #
3039
3065
  # @option params [Types::SmbMountOptions] :mount_options
3040
- # Specifies how DataSync can access a location using the SMB protocol.
3066
+ # Specifies the version of the Server Message Block (SMB) protocol that
3067
+ # DataSync uses to access an SMB file server.
3041
3068
  #
3042
3069
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3043
3070
  #
@@ -3051,7 +3078,7 @@ module Aws::DataSync
3051
3078
  # password: "SmbPassword",
3052
3079
  # agent_arns: ["AgentArn"],
3053
3080
  # mount_options: {
3054
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
3081
+ # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3, SMB1, SMB2_0
3055
3082
  # },
3056
3083
  # })
3057
3084
  #
@@ -3242,7 +3269,7 @@ module Aws::DataSync
3242
3269
  params: params,
3243
3270
  config: config)
3244
3271
  context[:gem_name] = 'aws-sdk-datasync'
3245
- context[:gem_version] = '1.53.0'
3272
+ context[:gem_version] = '1.54.0'
3246
3273
  Seahorse::Client::Request.new(handlers, context)
3247
3274
  end
3248
3275
 
@@ -50,9 +50,6 @@ module Aws::DataSync
50
50
 
51
51
  def initialize(options = {})
52
52
  self[:region] = options[:region]
53
- if self[:region].nil?
54
- raise ArgumentError, "Missing required EndpointParameter: :region"
55
- end
56
53
  self[:use_dual_stack] = options[:use_dual_stack]
57
54
  self[:use_dual_stack] = false if self[:use_dual_stack].nil?
58
55
  if self[:use_dual_stack].nil?
@@ -14,36 +14,39 @@ module Aws::DataSync
14
14
  use_dual_stack = parameters.use_dual_stack
15
15
  use_fips = parameters.use_fips
16
16
  endpoint = parameters.endpoint
17
- if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
18
- if Aws::Endpoints::Matchers.set?(endpoint)
19
- if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
20
- raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
21
- end
22
- if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
23
- raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
24
- end
25
- return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
26
- end
27
- if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
28
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
29
- return Aws::Endpoints::Endpoint.new(url: "https://datasync-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
30
- end
31
- raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
32
- end
17
+ if Aws::Endpoints::Matchers.set?(endpoint)
33
18
  if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
34
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
35
- return Aws::Endpoints::Endpoint.new(url: "https://datasync-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
36
- end
37
- raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
19
+ raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
38
20
  end
39
21
  if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
40
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
41
- return Aws::Endpoints::Endpoint.new(url: "https://datasync.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
22
+ raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
23
+ end
24
+ return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
25
+ end
26
+ if Aws::Endpoints::Matchers.set?(region)
27
+ if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
28
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
29
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
30
+ return Aws::Endpoints::Endpoint.new(url: "https://datasync-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
31
+ end
32
+ raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
33
+ end
34
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
35
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
36
+ return Aws::Endpoints::Endpoint.new(url: "https://datasync-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
37
+ end
38
+ raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
39
+ end
40
+ if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
41
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
42
+ return Aws::Endpoints::Endpoint.new(url: "https://datasync.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
43
+ end
44
+ raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
42
45
  end
43
- raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
46
+ return Aws::Endpoints::Endpoint.new(url: "https://datasync.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
44
47
  end
45
- return Aws::Endpoints::Endpoint.new(url: "https://datasync.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
46
48
  end
49
+ raise ArgumentError, "Invalid Configuration: Missing Region"
47
50
  raise ArgumentError, 'No endpoint could be resolved'
48
51
 
49
52
  end
@@ -10,24 +10,28 @@
10
10
  module Aws::DataSync
11
11
  module Types
12
12
 
13
- # Represents a single entry in a list of agents. `AgentListEntry`
14
- # returns an array that contains a list of agents when the
15
- # [ListAgents][1] operation is called.
13
+ # Represents a single entry in a list (or array) of DataSync agents when
14
+ # you call the [ListAgents][1] operation.
16
15
  #
17
16
  #
18
17
  #
19
18
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html
20
19
  #
21
20
  # @!attribute [rw] agent_arn
22
- # The Amazon Resource Name (ARN) of the agent.
21
+ # The Amazon Resource Name (ARN) of a DataSync agent.
23
22
  # @return [String]
24
23
  #
25
24
  # @!attribute [rw] name
26
- # The name of the agent.
25
+ # The name of an agent.
27
26
  # @return [String]
28
27
  #
29
28
  # @!attribute [rw] status
30
- # The status of the agent.
29
+ # The status of an agent. For more information, see [DataSync agent
30
+ # statuses][1].
31
+ #
32
+ #
33
+ #
34
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-agent-statuses.html
31
35
  # @return [String]
32
36
  #
33
37
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/AgentListEntry AWS API Documentation
@@ -303,13 +307,18 @@ module Aws::DataSync
303
307
  # @return [Array<String>]
304
308
  #
305
309
  # @!attribute [rw] storage_virtual_machine_arn
306
- # Specifies the ARN of the storage virtual machine (SVM) on your file
307
- # system where you're copying data to or from.
310
+ # Specifies the ARN of the storage virtual machine (SVM) in your file
311
+ # system where you want to copy data to or from.
308
312
  # @return [String]
309
313
  #
310
314
  # @!attribute [rw] subdirectory
311
- # Specifies the junction path (also known as a mount point) in the SVM
312
- # volume where you're copying data to or from (for example, `/vol1`).
315
+ # Specifies a path to the file share in the SVM where you'll copy
316
+ # your data.
317
+ #
318
+ # You can specify a junction path (also known as a mount point), qtree
319
+ # path (for NFS file shares), or share name (for SMB file shares). For
320
+ # example, your mount path might be `/vol1`, `/vol1/tree1`, or
321
+ # `/share1`.
313
322
  #
314
323
  # <note markdown="1"> Don't specify a junction path in the SVM's root volume. For more
315
324
  # information, see [Managing FSx for ONTAP storage virtual
@@ -900,71 +909,83 @@ module Aws::DataSync
900
909
  # CreateLocationSmbRequest
901
910
  #
902
911
  # @!attribute [rw] subdirectory
903
- # The subdirectory in the SMB file system that is used to read data
904
- # from the SMB source location or write data to the SMB destination.
905
- # The SMB path should be a path that's exported by the SMB server, or
906
- # a subdirectory of that path. The path should be such that it can be
907
- # mounted by other SMB clients in your network.
912
+ # Specifies the name of the share exported by your SMB file server
913
+ # where DataSync will read or write data. You can include a
914
+ # subdirectory in the share path (for example,
915
+ # `/path/to/subdirectory`). Make sure that other SMB clients in your
916
+ # network can also mount this path.
908
917
  #
909
- # <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example,
910
- # `/path/to/folder`.
918
+ # To copy all data in the specified subdirectory, DataSync must be
919
+ # able to mount the SMB share and access all of its data. For more
920
+ # information, see [required permissions][1] for SMB locations.
911
921
  #
912
- # </note>
913
922
  #
914
- # To transfer all the data in the folder you specified, DataSync needs
915
- # to have permissions to mount the SMB share, as well as to access all
916
- # the data in that share. To ensure this, either ensure that the
917
- # user/password specified belongs to the user who can mount the share,
918
- # and who has the appropriate permissions for all of the files and
919
- # directories that you want DataSync to access, or use credentials of
920
- # a member of the Backup Operators group to mount the share. Doing
921
- # either enables the agent to access the data. For the agent to access
922
- # directories, you must additionally enable all execute access.
923
+ #
924
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
923
925
  # @return [String]
924
926
  #
925
927
  # @!attribute [rw] server_hostname
926
- # The name of the SMB server. This value is the IP address or Domain
927
- # Name Service (DNS) name of the SMB server. An agent that is
928
- # installed on-premises uses this hostname to mount the SMB server in
929
- # a network.
928
+ # Specifies the Domain Name Service (DNS) name or IP address of the
929
+ # SMB file server that your DataSync agent will mount.
930
930
  #
931
- # <note markdown="1"> This name must either be DNS-compliant or must be an IP version 4
932
- # (IPv4) address.
931
+ # <note markdown="1"> You can't specify an IP version 6 (IPv6) address.
933
932
  #
934
933
  # </note>
935
934
  # @return [String]
936
935
  #
937
936
  # @!attribute [rw] user
938
- # The user who can mount the share, has the permissions to access
939
- # files and folders in the SMB share.
937
+ # Specifies the user name that can mount your SMB file server and has
938
+ # permission to access the files and folders involved in your
939
+ # transfer.
940
940
  #
941
- # For information about choosing a user name that ensures sufficient
942
- # permissions to files, folders, and metadata, see the [User
943
- # setting](create-smb-location.html#SMBuser) for SMB locations.
941
+ # For information about choosing a user with the right level of access
942
+ # for your transfer, see [required permissions][1] for SMB locations.
943
+ #
944
+ #
945
+ #
946
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
944
947
  # @return [String]
945
948
  #
946
949
  # @!attribute [rw] domain
947
- # The name of the Windows domain that the SMB server belongs to.
950
+ # Specifies the Windows domain name that your SMB file server belongs
951
+ # to.
952
+ #
953
+ # For more information, see [required permissions][1] for SMB
954
+ # locations.
955
+ #
956
+ #
957
+ #
958
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
948
959
  # @return [String]
949
960
  #
950
961
  # @!attribute [rw] password
951
- # The password of the user who can mount the share, has the
952
- # permissions to access files and folders in the SMB share.
962
+ # Specifies the password of the user who can mount your SMB file
963
+ # server and has permission to access the files and folders involved
964
+ # in your transfer.
965
+ #
966
+ # For more information, see [required permissions][1] for SMB
967
+ # locations.
968
+ #
969
+ #
970
+ #
971
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
953
972
  # @return [String]
954
973
  #
955
974
  # @!attribute [rw] agent_arns
956
- # The Amazon Resource Names (ARNs) of agents to use for a Simple
957
- # Message Block (SMB) location.
975
+ # Specifies the DataSync agent (or agents) which you want to connect
976
+ # to your SMB file server. You specify an agent by using its Amazon
977
+ # Resource Name (ARN).
958
978
  # @return [Array<String>]
959
979
  #
960
980
  # @!attribute [rw] mount_options
961
- # The mount options used by DataSync to access the SMB server.
981
+ # Specifies the version of the SMB protocol that DataSync uses to
982
+ # access your SMB file server.
962
983
  # @return [Types::SmbMountOptions]
963
984
  #
964
985
  # @!attribute [rw] tags
965
- # The key-value pair that represents the tag that you want to add to
966
- # the location. The value can be an empty string. We recommend using
967
- # tags to name your resources.
986
+ # Specifies labels that help you categorize, filter, and search for
987
+ # your Amazon Web Services resources. We recommend creating at least a
988
+ # name tag for your location.
968
989
  # @return [Array<Types::TagListEntry>]
969
990
  #
970
991
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationSmbRequest AWS API Documentation
@@ -985,8 +1006,7 @@ module Aws::DataSync
985
1006
  # CreateLocationSmbResponse
986
1007
  #
987
1008
  # @!attribute [rw] location_arn
988
- # The Amazon Resource Name (ARN) of the source SMB file system
989
- # location that is created.
1009
+ # The ARN of the SMB location that you created.
990
1010
  # @return [String]
991
1011
  #
992
1012
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationSmbResponse AWS API Documentation
@@ -1159,7 +1179,8 @@ module Aws::DataSync
1159
1179
  # DescribeAgent
1160
1180
  #
1161
1181
  # @!attribute [rw] agent_arn
1162
- # The Amazon Resource Name (ARN) of the agent to describe.
1182
+ # Specifies the Amazon Resource Name (ARN) of the DataSync agent to
1183
+ # describe.
1163
1184
  # @return [String]
1164
1185
  #
1165
1186
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeAgentRequest AWS API Documentation
@@ -1173,7 +1194,7 @@ module Aws::DataSync
1173
1194
  # DescribeAgentResponse
1174
1195
  #
1175
1196
  # @!attribute [rw] agent_arn
1176
- # The Amazon Resource Name (ARN) of the agent.
1197
+ # The ARN of the agent.
1177
1198
  # @return [String]
1178
1199
  #
1179
1200
  # @!attribute [rw] name
@@ -2239,7 +2260,8 @@ module Aws::DataSync
2239
2260
  # @return [String]
2240
2261
  #
2241
2262
  # @!attribute [rw] mount_options
2242
- # Specifies how DataSync can access a location using the SMB protocol.
2263
+ # Specifies the version of the Server Message Block (SMB) protocol
2264
+ # that DataSync uses to access an SMB file server.
2243
2265
  # @return [Types::SmbMountOptions]
2244
2266
  #
2245
2267
  # @!attribute [rw] password
@@ -2359,12 +2381,13 @@ module Aws::DataSync
2359
2381
  # ListAgentsRequest
2360
2382
  #
2361
2383
  # @!attribute [rw] max_results
2362
- # The maximum number of agents to list.
2384
+ # Specifies the maximum number of DataSync agents to list in a
2385
+ # response. By default, a response shows a maximum of 100 agents.
2363
2386
  # @return [Integer]
2364
2387
  #
2365
2388
  # @!attribute [rw] next_token
2366
- # An opaque string that indicates the position at which to begin the
2367
- # next list of agents.
2389
+ # Specifies an opaque string that indicates the position to begin the
2390
+ # next list of results in the response.
2368
2391
  # @return [String]
2369
2392
  #
2370
2393
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListAgentsRequest AWS API Documentation
@@ -2379,12 +2402,14 @@ module Aws::DataSync
2379
2402
  # ListAgentsResponse
2380
2403
  #
2381
2404
  # @!attribute [rw] agents
2382
- # A list of agents in your account.
2405
+ # A list of DataSync agents in your Amazon Web Services account in the
2406
+ # Amazon Web Services Region specified in the request. The list is
2407
+ # ordered by the agents' Amazon Resource Names (ARNs).
2383
2408
  # @return [Array<Types::AgentListEntry>]
2384
2409
  #
2385
2410
  # @!attribute [rw] next_token
2386
- # An opaque string that indicates the position at which to begin
2387
- # returning the next list of agents.
2411
+ # The opaque string that indicates the position to begin the next list
2412
+ # of results in the response.
2388
2413
  # @return [String]
2389
2414
  #
2390
2415
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListAgentsResponse AWS API Documentation
@@ -2775,7 +2800,7 @@ module Aws::DataSync
2775
2800
  # Some storage classes have specific behaviors that can affect your
2776
2801
  # Amazon S3 storage cost. For detailed information, see
2777
2802
  # [Considerations when working with Amazon S3 storage classes in
2778
- # DataSync ][1].
2803
+ # DataSync][1].
2779
2804
  #
2780
2805
  #
2781
2806
  #
@@ -2871,7 +2896,7 @@ module Aws::DataSync
2871
2896
  # Amazon S3 storage cost. If your task deletes objects, you might
2872
2897
  # incur minimum storage duration charges for certain storage classes.
2873
2898
  # For detailed information, see [Considerations when working with
2874
- # Amazon S3 storage classes in DataSync ][1].
2899
+ # Amazon S3 storage classes in DataSync][1].
2875
2900
  #
2876
2901
  # Default value: `PRESERVE`
2877
2902
  #
@@ -2880,6 +2905,12 @@ module Aws::DataSync
2880
2905
  # `REMOVE`\: Delete destination files that aren’t present in the
2881
2906
  # source.
2882
2907
  #
2908
+ # <note markdown="1"> If you set this parameter to `REMOVE`, you can't set `TransferMode`
2909
+ # to `ALL`. When you transfer all data, DataSync doesn't scan your
2910
+ # destination location and doesn't know what to delete.
2911
+ #
2912
+ # </note>
2913
+ #
2883
2914
  #
2884
2915
  #
2885
2916
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
@@ -3137,13 +3168,46 @@ module Aws::DataSync
3137
3168
  include Aws::Structure
3138
3169
  end
3139
3170
 
3140
- # Specifies how DataSync can access a location using the SMB protocol.
3171
+ # Specifies the version of the Server Message Block (SMB) protocol that
3172
+ # DataSync uses to access an SMB file server.
3141
3173
  #
3142
3174
  # @!attribute [rw] version
3143
- # Specifies the SMB version that you want DataSync to use when
3144
- # mounting your SMB share. If you don't specify a version, DataSync
3145
- # defaults to `AUTOMATIC` and chooses a version based on negotiation
3146
- # with the SMB server.
3175
+ # By default, DataSync automatically chooses an SMB protocol version
3176
+ # based on negotiation with your SMB file server. You also can
3177
+ # configure DataSync to use a specific SMB version, but we recommend
3178
+ # doing this only if DataSync has trouble negotiating with the SMB
3179
+ # file server automatically.
3180
+ #
3181
+ # These are the following options for configuring the SMB version:
3182
+ #
3183
+ # * `AUTOMATIC` (default): DataSync and the SMB file server negotiate
3184
+ # a protocol version that they mutually support. (DataSync supports
3185
+ # SMB versions 1.0 and later.)
3186
+ #
3187
+ # This is the recommended option. If you instead choose a specific
3188
+ # version that your file server doesn't support, you may get an
3189
+ # `Operation Not Supported` error.
3190
+ #
3191
+ # * `SMB3`\: Restricts the protocol negotiation to only SMB version
3192
+ # 3.0.2.
3193
+ #
3194
+ # * `SMB2`\: Restricts the protocol negotiation to only SMB version
3195
+ # 2.1.
3196
+ #
3197
+ # * `SMB2_0`\: Restricts the protocol negotiation to only SMB version
3198
+ # 2.0.
3199
+ #
3200
+ # * `SMB1`\: Restricts the protocol negotiation to only SMB version
3201
+ # 1.0.
3202
+ #
3203
+ # <note markdown="1"> The `SMB1` option isn't available when [creating an Amazon FSx
3204
+ # for NetApp ONTAP location][1].
3205
+ #
3206
+ # </note>
3207
+ #
3208
+ #
3209
+ #
3210
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html
3147
3211
  # @return [String]
3148
3212
  #
3149
3213
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/SmbMountOptions AWS API Documentation
@@ -3765,7 +3829,8 @@ module Aws::DataSync
3765
3829
  # @return [Array<String>]
3766
3830
  #
3767
3831
  # @!attribute [rw] mount_options
3768
- # Specifies how DataSync can access a location using the SMB protocol.
3832
+ # Specifies the version of the Server Message Block (SMB) protocol
3833
+ # that DataSync uses to access an SMB file server.
3769
3834
  # @return [Types::SmbMountOptions]
3770
3835
  #
3771
3836
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationSmbRequest AWS API Documentation
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-datasync/customizations'
52
52
  # @!group service
53
53
  module Aws::DataSync
54
54
 
55
- GEM_VERSION = '1.53.0'
55
+ GEM_VERSION = '1.54.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-datasync
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.53.0
4
+ version: 1.54.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-01-18 00:00:00.000000000 Z
11
+ date: 2023-02-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core