aws-sdk-datasync 1.67.0 → 1.68.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 99bd220f4b18457447917bd4508d22d96b3a1262b6e18e53c2819623fa2d256f
4
- data.tar.gz: 0ac541cab0ff268f96f0442d7dd7e62c5556f0f9e2223d3b70df7a3c04b06dfd
3
+ metadata.gz: b7e22c7f83246705a4b652bf20f2db9b8a452dd4dfb5527257f8f8afe334f21d
4
+ data.tar.gz: cac1fbe160b3890c2f86647ac112aef0281b15f2789e81060f3eb39b1d086994
5
5
  SHA512:
6
- metadata.gz: 0402540e2ba8143647e2e828ffe079dbdd9937dfbbca55c60239e6869d7b607fb2a13657ec357ef6874f712d5e5efe17c136a66ad3a177132f45f4f77a335ab7
7
- data.tar.gz: 6c52f8e65fdad0ee829593540b9d1f5a2edb66804d28d3cb45c2e3cd746d46159620d38d0b5cb6d7caf40b8a9047c677f148941bfd8f199125678b546752e6fe
6
+ metadata.gz: c888e01400413b54a2ff3aba2625a49cb89c2e0f69de5f973e573ec2cd02af6fa0abedb47c7e3f8f8537efc88f3de068375019bae575765af016553d6ebe5359
7
+ data.tar.gz: 873f95c59b8fdd6b444f6a0fa193ed71b4103e1e0267ff38439861c8c29073d3c31eb9649ef57e695855ac80cbbbf443e8df4f2557482c7d909e9ae7848e812d
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.68.0 (2023-10-30)
5
+ ------------------
6
+
7
+ * Feature - Platform version changes to support AL1 deprecation initiative.
8
+
4
9
  1.67.0 (2023-09-27)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.67.0
1
+ 1.68.0
@@ -857,12 +857,14 @@ module Aws::DataSync
857
857
  end
858
858
 
859
859
  # Creates an endpoint for an Amazon FSx for NetApp ONTAP file system
860
- # that DataSync can access for a transfer. For more information, see
861
- # [Creating a location for FSx for ONTAP][1].
860
+ # that DataSync can use for a data transfer.
861
+ #
862
+ # Before you begin, make sure that you understand how DataSync [accesses
863
+ # an FSx for ONTAP file system][1].
862
864
  #
863
865
  #
864
866
  #
865
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html
867
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access
866
868
  #
867
869
  # @option params [required, Types::FsxProtocol] :protocol
868
870
  # Specifies the data transfer protocol that DataSync uses to access your
@@ -1037,7 +1039,14 @@ module Aws::DataSync
1037
1039
  end
1038
1040
 
1039
1041
  # Creates an endpoint for an Amazon FSx for Windows File Server file
1040
- # system.
1042
+ # system that DataSync can use for a data transfer.
1043
+ #
1044
+ # Before you begin, make sure that you understand how DataSync [accesses
1045
+ # an FSx for Windows File Server][1].
1046
+ #
1047
+ #
1048
+ #
1049
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access
1041
1050
  #
1042
1051
  # @option params [String] :subdirectory
1043
1052
  # Specifies a mount path for your file system using forward slashes.
@@ -1072,8 +1081,9 @@ module Aws::DataSync
1072
1081
  # Specifies the user who has the permissions to access files, folders,
1073
1082
  # and metadata in your file system.
1074
1083
  #
1075
- # For information about choosing a user with sufficient permissions, see
1076
- # [Required permissions][1].
1084
+ # For information about choosing a user with the right level of access
1085
+ # for your transfer, see [required permissions][1] for FSx for Windows
1086
+ # File Server locations.
1077
1087
  #
1078
1088
  #
1079
1089
  #
@@ -1083,10 +1093,27 @@ module Aws::DataSync
1083
1093
  # Specifies the name of the Windows domain that the FSx for Windows File
1084
1094
  # Server belongs to.
1085
1095
  #
1096
+ # If you have multiple domains in your environment, configuring this
1097
+ # parameter makes sure that DataSync connects to the right file server.
1098
+ #
1099
+ # For more information, see [required permissions][1] for FSx for
1100
+ # Windows File Server locations.
1101
+ #
1102
+ #
1103
+ #
1104
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
1105
+ #
1086
1106
  # @option params [required, String] :password
1087
1107
  # Specifies the password of the user who has the permissions to access
1088
1108
  # files and folders in the file system.
1089
1109
  #
1110
+ # For more information, see [required permissions][1] for FSx for
1111
+ # Windows File Server locations.
1112
+ #
1113
+ #
1114
+ #
1115
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
1116
+ #
1090
1117
  # @return [Types::CreateLocationFsxWindowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1091
1118
  #
1092
1119
  # * {Types::CreateLocationFsxWindowsResponse#location_arn #location_arn} => String
@@ -1597,6 +1624,9 @@ module Aws::DataSync
1597
1624
  # Specifies the Windows domain name that your SMB file server belongs
1598
1625
  # to.
1599
1626
  #
1627
+ # If you have multiple domains in your environment, configuring this
1628
+ # parameter makes sure that DataSync connects to the right file server.
1629
+ #
1600
1630
  # For more information, see [required permissions][1] for SMB locations.
1601
1631
  #
1602
1632
  #
@@ -1836,11 +1866,18 @@ module Aws::DataSync
1836
1866
  req.send_request(options)
1837
1867
  end
1838
1868
 
1839
- # Deletes an agent. To specify which agent to delete, use the Amazon
1840
- # Resource Name (ARN) of the agent in your request. The operation
1841
- # disassociates the agent from your Amazon Web Services account.
1842
- # However, it doesn't delete the agent virtual machine (VM) from your
1843
- # on-premises environment.
1869
+ # Removes an DataSync agent resource from your Amazon Web Services
1870
+ # account.
1871
+ #
1872
+ # Keep in mind that this operation (which can't be undone) doesn't
1873
+ # remove the agent's virtual machine (VM) or Amazon EC2 instance from
1874
+ # your storage environment. For next steps, you can delete the VM or
1875
+ # instance from your storage environment or reuse it to [activate a new
1876
+ # agent][1].
1877
+ #
1878
+ #
1879
+ #
1880
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html
1844
1881
  #
1845
1882
  # @option params [required, String] :agent_arn
1846
1883
  # The Amazon Resource Name (ARN) of the agent to delete. Use the
@@ -1909,12 +1946,12 @@ module Aws::DataSync
1909
1946
  req.send_request(options)
1910
1947
  end
1911
1948
 
1912
- # Returns metadata about an DataSync agent, such as its name, endpoint
1913
- # type, and status.
1949
+ # Returns information about an DataSync agent, such as its name, service
1950
+ # endpoint type, and status.
1914
1951
  #
1915
1952
  # @option params [required, String] :agent_arn
1916
- # Specifies the Amazon Resource Name (ARN) of the DataSync agent to
1917
- # describe.
1953
+ # Specifies the Amazon Resource Name (ARN) of the DataSync agent that
1954
+ # you want information about.
1918
1955
  #
1919
1956
  # @return [Types::DescribeAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1920
1957
  #
@@ -1925,6 +1962,7 @@ module Aws::DataSync
1925
1962
  # * {Types::DescribeAgentResponse#creation_time #creation_time} => Time
1926
1963
  # * {Types::DescribeAgentResponse#endpoint_type #endpoint_type} => String
1927
1964
  # * {Types::DescribeAgentResponse#private_link_config #private_link_config} => Types::PrivateLinkConfig
1965
+ # * {Types::DescribeAgentResponse#platform #platform} => Types::Platform
1928
1966
  #
1929
1967
  # @example Request syntax with placeholder values
1930
1968
  #
@@ -1946,6 +1984,7 @@ module Aws::DataSync
1946
1984
  # resp.private_link_config.subnet_arns[0] #=> String
1947
1985
  # resp.private_link_config.security_group_arns #=> Array
1948
1986
  # resp.private_link_config.security_group_arns[0] #=> String
1987
+ # resp.platform.version #=> String
1949
1988
  #
1950
1989
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeAgent AWS API Documentation
1951
1990
  #
@@ -3054,6 +3093,7 @@ module Aws::DataSync
3054
3093
  # resp.agents[0].agent_arn #=> String
3055
3094
  # resp.agents[0].name #=> String
3056
3095
  # resp.agents[0].status #=> String, one of "ONLINE", "OFFLINE"
3096
+ # resp.agents[0].platform.version #=> String
3057
3097
  # resp.next_token #=> String
3058
3098
  #
3059
3099
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListAgents AWS API Documentation
@@ -3673,7 +3713,7 @@ module Aws::DataSync
3673
3713
  req.send_request(options)
3674
3714
  end
3675
3715
 
3676
- # Updates the name of an agent.
3716
+ # Updates the name of an DataSync agent.
3677
3717
  #
3678
3718
  # @option params [required, String] :agent_arn
3679
3719
  # The Amazon Resource Name (ARN) of the agent to update.
@@ -4031,58 +4071,65 @@ module Aws::DataSync
4031
4071
  req.send_request(options)
4032
4072
  end
4033
4073
 
4034
- # Updates some of the parameters of a previously created location for
4035
- # Server Message Block (SMB) file system access. For information about
4036
- # creating an SMB location, see [Creating a location for SMB][1].
4037
- #
4038
- #
4039
- #
4040
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html
4074
+ # Updates some of the parameters of a Server Message Block (SMB) file
4075
+ # server location that you can use for DataSync transfers.
4041
4076
  #
4042
4077
  # @option params [required, String] :location_arn
4043
- # The Amazon Resource Name (ARN) of the SMB location to update.
4078
+ # Specifies the ARN of the SMB location that you want to update.
4044
4079
  #
4045
4080
  # @option params [String] :subdirectory
4046
- # The subdirectory in the SMB file system that is used to read data from
4047
- # the SMB source location or write data to the SMB destination. The SMB
4048
- # path should be a path that's exported by the SMB server, or a
4049
- # subdirectory of that path. The path should be such that it can be
4050
- # mounted by other SMB clients in your network.
4081
+ # Specifies the name of the share exported by your SMB file server where
4082
+ # DataSync will read or write data. You can include a subdirectory in
4083
+ # the share path (for example, `/path/to/subdirectory`). Make sure that
4084
+ # other SMB clients in your network can also mount this path.
4085
+ #
4086
+ # To copy all data in the specified subdirectory, DataSync must be able
4087
+ # to mount the SMB share and access all of its data. For more
4088
+ # information, see [required permissions][1] for SMB locations.
4051
4089
  #
4052
- # <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example,
4053
- # `/path/to/folder`.
4054
4090
  #
4055
- # </note>
4056
4091
  #
4057
- # To transfer all the data in the folder that you specified, DataSync
4058
- # must have permissions to mount the SMB share and to access all the
4059
- # data in that share. To ensure this, do either of the following:
4092
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
4093
+ #
4094
+ # @option params [String] :user
4095
+ # Specifies the user name that can mount your SMB file server and has
4096
+ # permission to access the files and folders involved in your transfer.
4060
4097
  #
4061
- # * Ensure that the user/password specified belongs to the user who can
4062
- # mount the share and who has the appropriate permissions for all of
4063
- # the files and directories that you want DataSync to access.
4098
+ # For information about choosing a user with the right level of access
4099
+ # for your transfer, see [required permissions][1] for SMB locations.
4064
4100
  #
4065
- # * Use credentials of a member of the Backup Operators group to mount
4066
- # the share.
4067
4101
  #
4068
- # Doing either of these options enables the agent to access the data.
4069
- # For the agent to access directories, you must also enable all execute
4070
- # access.
4071
4102
  #
4072
- # @option params [String] :user
4073
- # The user who can mount the share has the permissions to access files
4074
- # and folders in the SMB share.
4103
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
4075
4104
  #
4076
4105
  # @option params [String] :domain
4077
- # The name of the Windows domain that the SMB server belongs to.
4106
+ # Specifies the Windows domain name that your SMB file server belongs
4107
+ # to.
4108
+ #
4109
+ # If you have multiple domains in your environment, configuring this
4110
+ # parameter makes sure that DataSync connects to the right file server.
4111
+ #
4112
+ # For more information, see [required permissions][1] for SMB locations.
4113
+ #
4114
+ #
4115
+ #
4116
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
4078
4117
  #
4079
4118
  # @option params [String] :password
4080
- # The password of the user who can mount the share has the permissions
4081
- # to access files and folders in the SMB share.
4119
+ # Specifies the password of the user who can mount your SMB file server
4120
+ # and has permission to access the files and folders involved in your
4121
+ # transfer.
4122
+ #
4123
+ # For more information, see [required permissions][1] for SMB locations.
4124
+ #
4125
+ #
4126
+ #
4127
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
4082
4128
  #
4083
4129
  # @option params [Array<String>] :agent_arns
4084
- # The Amazon Resource Names (ARNs) of agents to use for a Simple Message
4085
- # Block (SMB) location.
4130
+ # Specifies the DataSync agent (or agents) which you want to connect to
4131
+ # your SMB file server. You specify an agent by using its Amazon
4132
+ # Resource Name (ARN).
4086
4133
  #
4087
4134
  # @option params [Types::SmbMountOptions] :mount_options
4088
4135
  # Specifies the version of the Server Message Block (SMB) protocol that
@@ -4369,7 +4416,7 @@ module Aws::DataSync
4369
4416
  params: params,
4370
4417
  config: config)
4371
4418
  context[:gem_name] = 'aws-sdk-datasync'
4372
- context[:gem_version] = '1.67.0'
4419
+ context[:gem_version] = '1.68.0'
4373
4420
  Seahorse::Client::Request.new(handlers, context)
4374
4421
  end
4375
4422
 
@@ -21,6 +21,7 @@ module Aws::DataSync
21
21
  AgentList = Shapes::ListShape.new(name: 'AgentList')
22
22
  AgentListEntry = Shapes::StructureShape.new(name: 'AgentListEntry')
23
23
  AgentStatus = Shapes::StringShape.new(name: 'AgentStatus')
24
+ AgentVersion = Shapes::StringShape.new(name: 'AgentVersion')
24
25
  Atime = Shapes::StringShape.new(name: 'Atime')
25
26
  AzureAccessTier = Shapes::StringShape.new(name: 'AzureAccessTier')
26
27
  AzureBlobAuthenticationType = Shapes::StringShape.new(name: 'AzureBlobAuthenticationType')
@@ -228,6 +229,7 @@ module Aws::DataSync
228
229
  PLSecurityGroupArnList = Shapes::ListShape.new(name: 'PLSecurityGroupArnList')
229
230
  PLSubnetArnList = Shapes::ListShape.new(name: 'PLSubnetArnList')
230
231
  PhaseStatus = Shapes::StringShape.new(name: 'PhaseStatus')
232
+ Platform = Shapes::StructureShape.new(name: 'Platform')
231
233
  PosixPermissions = Shapes::StringShape.new(name: 'PosixPermissions')
232
234
  PreserveDeletedFiles = Shapes::StringShape.new(name: 'PreserveDeletedFiles')
233
235
  PreserveDevices = Shapes::StringShape.new(name: 'PreserveDevices')
@@ -356,6 +358,7 @@ module Aws::DataSync
356
358
  AgentListEntry.add_member(:agent_arn, Shapes::ShapeRef.new(shape: AgentArn, location_name: "AgentArn"))
357
359
  AgentListEntry.add_member(:name, Shapes::ShapeRef.new(shape: TagValue, location_name: "Name"))
358
360
  AgentListEntry.add_member(:status, Shapes::ShapeRef.new(shape: AgentStatus, location_name: "Status"))
361
+ AgentListEntry.add_member(:platform, Shapes::ShapeRef.new(shape: Platform, location_name: "Platform"))
359
362
  AgentListEntry.struct_class = Types::AgentListEntry
360
363
 
361
364
  AzureBlobSasConfiguration.add_member(:token, Shapes::ShapeRef.new(shape: AzureBlobSasToken, required: true, location_name: "Token"))
@@ -560,6 +563,7 @@ module Aws::DataSync
560
563
  DescribeAgentResponse.add_member(:creation_time, Shapes::ShapeRef.new(shape: Time, location_name: "CreationTime"))
561
564
  DescribeAgentResponse.add_member(:endpoint_type, Shapes::ShapeRef.new(shape: EndpointType, location_name: "EndpointType"))
562
565
  DescribeAgentResponse.add_member(:private_link_config, Shapes::ShapeRef.new(shape: PrivateLinkConfig, location_name: "PrivateLinkConfig"))
566
+ DescribeAgentResponse.add_member(:platform, Shapes::ShapeRef.new(shape: Platform, location_name: "Platform"))
563
567
  DescribeAgentResponse.struct_class = Types::DescribeAgentResponse
564
568
 
565
569
  DescribeDiscoveryJobRequest.add_member(:discovery_job_arn, Shapes::ShapeRef.new(shape: DiscoveryJobArn, required: true, location_name: "DiscoveryJobArn"))
@@ -1044,6 +1048,9 @@ module Aws::DataSync
1044
1048
 
1045
1049
  PLSubnetArnList.member = Shapes::ShapeRef.new(shape: Ec2SubnetArn)
1046
1050
 
1051
+ Platform.add_member(:version, Shapes::ShapeRef.new(shape: AgentVersion, location_name: "Version"))
1052
+ Platform.struct_class = Types::Platform
1053
+
1047
1054
  PrivateLinkConfig.add_member(:vpc_endpoint_id, Shapes::ShapeRef.new(shape: VpcEndpointId, location_name: "VpcEndpointId"))
1048
1055
  PrivateLinkConfig.add_member(:private_link_endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "PrivateLinkEndpoint"))
1049
1056
  PrivateLinkConfig.add_member(:subnet_arns, Shapes::ShapeRef.new(shape: PLSubnetArnList, location_name: "SubnetArns"))
@@ -32,7 +32,7 @@ module Aws::DataSync
32
32
  raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
33
33
  end
34
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"))
35
+ if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
36
36
  return Aws::Endpoints::Endpoint.new(url: "https://datasync-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
37
37
  end
38
38
  raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
@@ -104,20 +104,33 @@ module Aws::DataSync
104
104
  # @return [String]
105
105
  #
106
106
  # @!attribute [rw] status
107
- # The status of an agent. For more information, see [DataSync agent
108
- # statuses][1].
107
+ # The status of an agent.
109
108
  #
109
+ # * If the status is `ONLINE`, the agent is configured properly and
110
+ # ready to use.
110
111
  #
112
+ # * If the status is `OFFLINE`, the agent has been out of contact with
113
+ # DataSync for five minutes or longer. This can happen for a few
114
+ # reasons. For more information, see [What do I do if my agent is
115
+ # offline?][1]
111
116
  #
112
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-agent-statuses.html
117
+ #
118
+ #
119
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline
113
120
  # @return [String]
114
121
  #
122
+ # @!attribute [rw] platform
123
+ # The platform-related details about the agent, such as the version
124
+ # number.
125
+ # @return [Types::Platform]
126
+ #
115
127
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/AgentListEntry AWS API Documentation
116
128
  #
117
129
  class AgentListEntry < Struct.new(
118
130
  :agent_arn,
119
131
  :name,
120
- :status)
132
+ :status,
133
+ :platform)
121
134
  SENSITIVE = []
122
135
  include Aws::Structure
123
136
  end
@@ -664,8 +677,9 @@ module Aws::DataSync
664
677
  # Specifies the user who has the permissions to access files, folders,
665
678
  # and metadata in your file system.
666
679
  #
667
- # For information about choosing a user with sufficient permissions,
668
- # see [Required permissions][1].
680
+ # For information about choosing a user with the right level of access
681
+ # for your transfer, see [required permissions][1] for FSx for Windows
682
+ # File Server locations.
669
683
  #
670
684
  #
671
685
  #
@@ -675,11 +689,29 @@ module Aws::DataSync
675
689
  # @!attribute [rw] domain
676
690
  # Specifies the name of the Windows domain that the FSx for Windows
677
691
  # File Server belongs to.
692
+ #
693
+ # If you have multiple domains in your environment, configuring this
694
+ # parameter makes sure that DataSync connects to the right file
695
+ # server.
696
+ #
697
+ # For more information, see [required permissions][1] for FSx for
698
+ # Windows File Server locations.
699
+ #
700
+ #
701
+ #
702
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
678
703
  # @return [String]
679
704
  #
680
705
  # @!attribute [rw] password
681
706
  # Specifies the password of the user who has the permissions to access
682
707
  # files and folders in the file system.
708
+ #
709
+ # For more information, see [required permissions][1] for FSx for
710
+ # Windows File Server locations.
711
+ #
712
+ #
713
+ #
714
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
683
715
  # @return [String]
684
716
  #
685
717
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxWindowsRequest AWS API Documentation
@@ -1143,6 +1175,10 @@ module Aws::DataSync
1143
1175
  # Specifies the Windows domain name that your SMB file server belongs
1144
1176
  # to.
1145
1177
  #
1178
+ # If you have multiple domains in your environment, configuring this
1179
+ # parameter makes sure that DataSync connects to the right file
1180
+ # server.
1181
+ #
1146
1182
  # For more information, see [required permissions][1] for SMB
1147
1183
  # locations.
1148
1184
  #
@@ -1409,8 +1445,8 @@ module Aws::DataSync
1409
1445
  # DescribeAgent
1410
1446
  #
1411
1447
  # @!attribute [rw] agent_arn
1412
- # Specifies the Amazon Resource Name (ARN) of the DataSync agent to
1413
- # describe.
1448
+ # Specifies the Amazon Resource Name (ARN) of the DataSync agent that
1449
+ # you want information about.
1414
1450
  # @return [String]
1415
1451
  #
1416
1452
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeAgentRequest AWS API Documentation
@@ -1432,34 +1468,56 @@ module Aws::DataSync
1432
1468
  # @return [String]
1433
1469
  #
1434
1470
  # @!attribute [rw] status
1435
- # The status of the agent. If the status is ONLINE, then the agent is
1436
- # configured properly and is available to use. The Running status is
1437
- # the normal running status for an agent. If the status is OFFLINE,
1438
- # the agent's VM is turned off or the agent is in an unhealthy state.
1439
- # When the issue that caused the unhealthy state is resolved, the
1440
- # agent returns to ONLINE status.
1471
+ # The status of the agent.
1472
+ #
1473
+ # * If the status is `ONLINE`, the agent is configured properly and
1474
+ # ready to use.
1475
+ #
1476
+ # * If the status is `OFFLINE`, the agent has been out of contact with
1477
+ # DataSync for five minutes or longer. This can happen for a few
1478
+ # reasons. For more information, see [What do I do if my agent is
1479
+ # offline?][1]
1480
+ #
1481
+ #
1482
+ #
1483
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline
1441
1484
  # @return [String]
1442
1485
  #
1443
1486
  # @!attribute [rw] last_connection_time
1444
- # The time that the agent last connected to DataSync.
1487
+ # The last time that the agent was communicating with the DataSync
1488
+ # service.
1445
1489
  # @return [Time]
1446
1490
  #
1447
1491
  # @!attribute [rw] creation_time
1448
- # The time that the agent was activated (that is, created in your
1449
- # account).
1492
+ # The time that the agent was [activated][1].
1493
+ #
1494
+ #
1495
+ #
1496
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html
1450
1497
  # @return [Time]
1451
1498
  #
1452
1499
  # @!attribute [rw] endpoint_type
1453
- # The type of endpoint that your agent is connected to. If the
1454
- # endpoint is a VPC endpoint, the agent is not accessible over the
1455
- # public internet.
1500
+ # The type of [service endpoint][1] that your agent is connected to.
1501
+ #
1502
+ #
1503
+ #
1504
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html
1456
1505
  # @return [String]
1457
1506
  #
1458
1507
  # @!attribute [rw] private_link_config
1459
- # The subnet and the security group that DataSync used to access a VPC
1460
- # endpoint.
1508
+ # The network configuration that the agent uses when connecting to a
1509
+ # [VPC service endpoint][1].
1510
+ #
1511
+ #
1512
+ #
1513
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc
1461
1514
  # @return [Types::PrivateLinkConfig]
1462
1515
  #
1516
+ # @!attribute [rw] platform
1517
+ # The platform-related details about the agent, such as the version
1518
+ # number.
1519
+ # @return [Types::Platform]
1520
+ #
1463
1521
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeAgentResponse AWS API Documentation
1464
1522
  #
1465
1523
  class DescribeAgentResponse < Struct.new(
@@ -1469,7 +1527,8 @@ module Aws::DataSync
1469
1527
  :last_connection_time,
1470
1528
  :creation_time,
1471
1529
  :endpoint_type,
1472
- :private_link_config)
1530
+ :private_link_config,
1531
+ :platform)
1473
1532
  SENSITIVE = []
1474
1533
  include Aws::Structure
1475
1534
  end
@@ -2587,6 +2646,16 @@ module Aws::DataSync
2587
2646
  # @!attribute [rw] files_verified
2588
2647
  # The number of files, objects, and directories that DataSync verified
2589
2648
  # during your transfer.
2649
+ #
2650
+ # <note markdown="1"> When you configure your task to [verify only the data that's
2651
+ # transferred][1], DataSync doesn't verify directories in some
2652
+ # situations or files that fail to transfer.
2653
+ #
2654
+ # </note>
2655
+ #
2656
+ #
2657
+ #
2658
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html
2590
2659
  # @return [Integer]
2591
2660
  #
2592
2661
  # @!attribute [rw] report_result
@@ -2595,7 +2664,7 @@ module Aws::DataSync
2595
2664
  #
2596
2665
  #
2597
2666
  #
2598
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
2667
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
2599
2668
  # @return [Types::ReportResult]
2600
2669
  #
2601
2670
  # @!attribute [rw] estimated_files_to_delete
@@ -2768,7 +2837,7 @@ module Aws::DataSync
2768
2837
  #
2769
2838
  #
2770
2839
  #
2771
- # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
2840
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
2772
2841
  # @return [Types::TaskReportConfig]
2773
2842
  #
2774
2843
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskResponse AWS API Documentation
@@ -4322,9 +4391,39 @@ module Aws::DataSync
4322
4391
  include Aws::Structure
4323
4392
  end
4324
4393
 
4394
+ # The platform-related details about the DataSync agent, such as the
4395
+ # version number.
4396
+ #
4397
+ # @!attribute [rw] version
4398
+ # The version of the DataSync agent.
4399
+ #
4400
+ # Beginning December 7, 2023, we will discontinue version 1 DataSync
4401
+ # agents. Check the DataSync console to see if you have affected
4402
+ # agents. If you do, [replace][1] those agents before then to avoid
4403
+ # data transfer or storage discovery disruptions. If you need more
4404
+ # help, contact [Amazon Web Services Support][2].
4405
+ #
4406
+ #
4407
+ #
4408
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html
4409
+ # [2]: https://aws.amazon.com/contact-us/
4410
+ # @return [String]
4411
+ #
4412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Platform AWS API Documentation
4413
+ #
4414
+ class Platform < Struct.new(
4415
+ :version)
4416
+ SENSITIVE = []
4417
+ include Aws::Structure
4418
+ end
4419
+
4325
4420
  # Specifies how your DataSync agent connects to Amazon Web Services
4326
- # using a virtual private cloud (VPC) service endpoint. An agent that
4327
- # uses a VPC endpoint isn't accessible over the public internet.
4421
+ # using a [virtual private cloud (VPC) service endpoint][1]. An agent
4422
+ # that uses a VPC endpoint isn't accessible over the public internet.
4423
+ #
4424
+ #
4425
+ #
4426
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc
4328
4427
  #
4329
4428
  # @!attribute [rw] vpc_endpoint_id
4330
4429
  # Specifies the ID of the VPC endpoint that your agent connects to.
@@ -4444,7 +4543,7 @@ module Aws::DataSync
4444
4543
  #
4445
4544
  #
4446
4545
  #
4447
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
4546
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4448
4547
  #
4449
4548
  # @!attribute [rw] s3
4450
4549
  # Specifies the Amazon S3 bucket where DataSync uploads your task
@@ -4464,7 +4563,7 @@ module Aws::DataSync
4464
4563
  #
4465
4564
  #
4466
4565
  #
4467
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
4566
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4468
4567
  #
4469
4568
  # @!attribute [rw] subdirectory
4470
4569
  # Specifies a bucket prefix for your report.
@@ -4483,7 +4582,7 @@ module Aws::DataSync
4483
4582
  #
4484
4583
  #
4485
4584
  #
4486
- # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
4585
+ # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4487
4586
  # @return [String]
4488
4587
  #
4489
4588
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportDestinationS3 AWS API Documentation
@@ -4501,7 +4600,7 @@ module Aws::DataSync
4501
4600
  #
4502
4601
  #
4503
4602
  #
4504
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
4603
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4505
4604
  #
4506
4605
  # @!attribute [rw] report_level
4507
4606
  # Specifies whether your task report includes errors only or successes
@@ -4532,7 +4631,7 @@ module Aws::DataSync
4532
4631
  #
4533
4632
  #
4534
4633
  #
4535
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
4634
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4536
4635
  #
4537
4636
  # @!attribute [rw] transferred
4538
4637
  # Specifies the level of reporting for the files, objects, and
@@ -4577,7 +4676,7 @@ module Aws::DataSync
4577
4676
  #
4578
4677
  #
4579
4678
  #
4580
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
4679
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4581
4680
  #
4582
4681
  # @!attribute [rw] status
4583
4682
  # Indicates whether DataSync is still working on your report, created
@@ -5111,7 +5210,7 @@ module Aws::DataSync
5111
5210
  #
5112
5211
  #
5113
5212
  #
5114
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
5213
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
5115
5214
  #
5116
5215
  # @!attribute [rw] destination
5117
5216
  # Specifies the Amazon S3 bucket where DataSync uploads your task
@@ -5119,7 +5218,7 @@ module Aws::DataSync
5119
5218
  #
5120
5219
  #
5121
5220
  #
5122
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html#task-report-access
5221
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access
5123
5222
  # @return [Types::ReportDestination]
5124
5223
  #
5125
5224
  # @!attribute [rw] output_type
@@ -5578,54 +5677,71 @@ module Aws::DataSync
5578
5677
  class UpdateLocationObjectStorageResponse < Aws::EmptyStructure; end
5579
5678
 
5580
5679
  # @!attribute [rw] location_arn
5581
- # The Amazon Resource Name (ARN) of the SMB location to update.
5680
+ # Specifies the ARN of the SMB location that you want to update.
5582
5681
  # @return [String]
5583
5682
  #
5584
5683
  # @!attribute [rw] subdirectory
5585
- # The subdirectory in the SMB file system that is used to read data
5586
- # from the SMB source location or write data to the SMB destination.
5587
- # The SMB path should be a path that's exported by the SMB server, or
5588
- # a subdirectory of that path. The path should be such that it can be
5589
- # mounted by other SMB clients in your network.
5590
- #
5591
- # <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example,
5592
- # `/path/to/folder`.
5593
- #
5594
- # </note>
5684
+ # Specifies the name of the share exported by your SMB file server
5685
+ # where DataSync will read or write data. You can include a
5686
+ # subdirectory in the share path (for example,
5687
+ # `/path/to/subdirectory`). Make sure that other SMB clients in your
5688
+ # network can also mount this path.
5595
5689
  #
5596
- # To transfer all the data in the folder that you specified, DataSync
5597
- # must have permissions to mount the SMB share and to access all the
5598
- # data in that share. To ensure this, do either of the following:
5690
+ # To copy all data in the specified subdirectory, DataSync must be
5691
+ # able to mount the SMB share and access all of its data. For more
5692
+ # information, see [required permissions][1] for SMB locations.
5599
5693
  #
5600
- # * Ensure that the user/password specified belongs to the user who
5601
- # can mount the share and who has the appropriate permissions for
5602
- # all of the files and directories that you want DataSync to access.
5603
5694
  #
5604
- # * Use credentials of a member of the Backup Operators group to mount
5605
- # the share.
5606
5695
  #
5607
- # Doing either of these options enables the agent to access the data.
5608
- # For the agent to access directories, you must also enable all
5609
- # execute access.
5696
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
5610
5697
  # @return [String]
5611
5698
  #
5612
5699
  # @!attribute [rw] user
5613
- # The user who can mount the share has the permissions to access files
5614
- # and folders in the SMB share.
5700
+ # Specifies the user name that can mount your SMB file server and has
5701
+ # permission to access the files and folders involved in your
5702
+ # transfer.
5703
+ #
5704
+ # For information about choosing a user with the right level of access
5705
+ # for your transfer, see [required permissions][1] for SMB locations.
5706
+ #
5707
+ #
5708
+ #
5709
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
5615
5710
  # @return [String]
5616
5711
  #
5617
5712
  # @!attribute [rw] domain
5618
- # The name of the Windows domain that the SMB server belongs to.
5713
+ # Specifies the Windows domain name that your SMB file server belongs
5714
+ # to.
5715
+ #
5716
+ # If you have multiple domains in your environment, configuring this
5717
+ # parameter makes sure that DataSync connects to the right file
5718
+ # server.
5719
+ #
5720
+ # For more information, see [required permissions][1] for SMB
5721
+ # locations.
5722
+ #
5723
+ #
5724
+ #
5725
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
5619
5726
  # @return [String]
5620
5727
  #
5621
5728
  # @!attribute [rw] password
5622
- # The password of the user who can mount the share has the permissions
5623
- # to access files and folders in the SMB share.
5729
+ # Specifies the password of the user who can mount your SMB file
5730
+ # server and has permission to access the files and folders involved
5731
+ # in your transfer.
5732
+ #
5733
+ # For more information, see [required permissions][1] for SMB
5734
+ # locations.
5735
+ #
5736
+ #
5737
+ #
5738
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
5624
5739
  # @return [String]
5625
5740
  #
5626
5741
  # @!attribute [rw] agent_arns
5627
- # The Amazon Resource Names (ARNs) of agents to use for a Simple
5628
- # Message Block (SMB) location.
5742
+ # Specifies the DataSync agent (or agents) which you want to connect
5743
+ # to your SMB file server. You specify an agent by using its Amazon
5744
+ # Resource Name (ARN).
5629
5745
  # @return [Array<String>]
5630
5746
  #
5631
5747
  # @!attribute [rw] mount_options
@@ -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.67.0'
55
+ GEM_VERSION = '1.68.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.67.0
4
+ version: 1.68.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-09-27 00:00:00.000000000 Z
11
+ date: 2023-10-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core