aws-sdk-datasync 1.26.0 → 1.31.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -172,6 +172,14 @@ module Aws::DataSync
172
172
  UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
173
173
  UpdateAgentRequest = Shapes::StructureShape.new(name: 'UpdateAgentRequest')
174
174
  UpdateAgentResponse = Shapes::StructureShape.new(name: 'UpdateAgentResponse')
175
+ UpdateLocationNfsRequest = Shapes::StructureShape.new(name: 'UpdateLocationNfsRequest')
176
+ UpdateLocationNfsResponse = Shapes::StructureShape.new(name: 'UpdateLocationNfsResponse')
177
+ UpdateLocationObjectStorageRequest = Shapes::StructureShape.new(name: 'UpdateLocationObjectStorageRequest')
178
+ UpdateLocationObjectStorageResponse = Shapes::StructureShape.new(name: 'UpdateLocationObjectStorageResponse')
179
+ UpdateLocationSmbRequest = Shapes::StructureShape.new(name: 'UpdateLocationSmbRequest')
180
+ UpdateLocationSmbResponse = Shapes::StructureShape.new(name: 'UpdateLocationSmbResponse')
181
+ UpdateTaskExecutionRequest = Shapes::StructureShape.new(name: 'UpdateTaskExecutionRequest')
182
+ UpdateTaskExecutionResponse = Shapes::StructureShape.new(name: 'UpdateTaskExecutionResponse')
175
183
  UpdateTaskRequest = Shapes::StructureShape.new(name: 'UpdateTaskRequest')
176
184
  UpdateTaskResponse = Shapes::StructureShape.new(name: 'UpdateTaskResponse')
177
185
  VerifyMode = Shapes::StringShape.new(name: 'VerifyMode')
@@ -253,6 +261,7 @@ module Aws::DataSync
253
261
  CreateLocationS3Request.add_member(:s3_bucket_arn, Shapes::ShapeRef.new(shape: S3BucketArn, required: true, location_name: "S3BucketArn"))
254
262
  CreateLocationS3Request.add_member(:s3_storage_class, Shapes::ShapeRef.new(shape: S3StorageClass, location_name: "S3StorageClass"))
255
263
  CreateLocationS3Request.add_member(:s3_config, Shapes::ShapeRef.new(shape: S3Config, required: true, location_name: "S3Config"))
264
+ CreateLocationS3Request.add_member(:agent_arns, Shapes::ShapeRef.new(shape: AgentArnList, location_name: "AgentArns"))
256
265
  CreateLocationS3Request.add_member(:tags, Shapes::ShapeRef.new(shape: InputTagList, location_name: "Tags"))
257
266
  CreateLocationS3Request.struct_class = Types::CreateLocationS3Request
258
267
 
@@ -361,6 +370,7 @@ module Aws::DataSync
361
370
  DescribeLocationS3Response.add_member(:location_uri, Shapes::ShapeRef.new(shape: LocationUri, location_name: "LocationUri"))
362
371
  DescribeLocationS3Response.add_member(:s3_storage_class, Shapes::ShapeRef.new(shape: S3StorageClass, location_name: "S3StorageClass"))
363
372
  DescribeLocationS3Response.add_member(:s3_config, Shapes::ShapeRef.new(shape: S3Config, location_name: "S3Config"))
373
+ DescribeLocationS3Response.add_member(:agent_arns, Shapes::ShapeRef.new(shape: AgentArnList, location_name: "AgentArns"))
364
374
  DescribeLocationS3Response.add_member(:creation_time, Shapes::ShapeRef.new(shape: Time, location_name: "CreationTime"))
365
375
  DescribeLocationS3Response.struct_class = Types::DescribeLocationS3Response
366
376
 
@@ -603,6 +613,42 @@ module Aws::DataSync
603
613
 
604
614
  UpdateAgentResponse.struct_class = Types::UpdateAgentResponse
605
615
 
616
+ UpdateLocationNfsRequest.add_member(:location_arn, Shapes::ShapeRef.new(shape: LocationArn, required: true, location_name: "LocationArn"))
617
+ UpdateLocationNfsRequest.add_member(:subdirectory, Shapes::ShapeRef.new(shape: NfsSubdirectory, location_name: "Subdirectory"))
618
+ UpdateLocationNfsRequest.add_member(:on_prem_config, Shapes::ShapeRef.new(shape: OnPremConfig, location_name: "OnPremConfig"))
619
+ UpdateLocationNfsRequest.add_member(:mount_options, Shapes::ShapeRef.new(shape: NfsMountOptions, location_name: "MountOptions"))
620
+ UpdateLocationNfsRequest.struct_class = Types::UpdateLocationNfsRequest
621
+
622
+ UpdateLocationNfsResponse.struct_class = Types::UpdateLocationNfsResponse
623
+
624
+ UpdateLocationObjectStorageRequest.add_member(:location_arn, Shapes::ShapeRef.new(shape: LocationArn, required: true, location_name: "LocationArn"))
625
+ UpdateLocationObjectStorageRequest.add_member(:server_port, Shapes::ShapeRef.new(shape: ObjectStorageServerPort, location_name: "ServerPort"))
626
+ UpdateLocationObjectStorageRequest.add_member(:server_protocol, Shapes::ShapeRef.new(shape: ObjectStorageServerProtocol, location_name: "ServerProtocol"))
627
+ UpdateLocationObjectStorageRequest.add_member(:subdirectory, Shapes::ShapeRef.new(shape: S3Subdirectory, location_name: "Subdirectory"))
628
+ UpdateLocationObjectStorageRequest.add_member(:access_key, Shapes::ShapeRef.new(shape: ObjectStorageAccessKey, location_name: "AccessKey"))
629
+ UpdateLocationObjectStorageRequest.add_member(:secret_key, Shapes::ShapeRef.new(shape: ObjectStorageSecretKey, location_name: "SecretKey"))
630
+ UpdateLocationObjectStorageRequest.add_member(:agent_arns, Shapes::ShapeRef.new(shape: AgentArnList, location_name: "AgentArns"))
631
+ UpdateLocationObjectStorageRequest.struct_class = Types::UpdateLocationObjectStorageRequest
632
+
633
+ UpdateLocationObjectStorageResponse.struct_class = Types::UpdateLocationObjectStorageResponse
634
+
635
+ UpdateLocationSmbRequest.add_member(:location_arn, Shapes::ShapeRef.new(shape: LocationArn, required: true, location_name: "LocationArn"))
636
+ UpdateLocationSmbRequest.add_member(:subdirectory, Shapes::ShapeRef.new(shape: SmbSubdirectory, location_name: "Subdirectory"))
637
+ UpdateLocationSmbRequest.add_member(:user, Shapes::ShapeRef.new(shape: SmbUser, location_name: "User"))
638
+ UpdateLocationSmbRequest.add_member(:domain, Shapes::ShapeRef.new(shape: SmbDomain, location_name: "Domain"))
639
+ UpdateLocationSmbRequest.add_member(:password, Shapes::ShapeRef.new(shape: SmbPassword, location_name: "Password"))
640
+ UpdateLocationSmbRequest.add_member(:agent_arns, Shapes::ShapeRef.new(shape: AgentArnList, location_name: "AgentArns"))
641
+ UpdateLocationSmbRequest.add_member(:mount_options, Shapes::ShapeRef.new(shape: SmbMountOptions, location_name: "MountOptions"))
642
+ UpdateLocationSmbRequest.struct_class = Types::UpdateLocationSmbRequest
643
+
644
+ UpdateLocationSmbResponse.struct_class = Types::UpdateLocationSmbResponse
645
+
646
+ UpdateTaskExecutionRequest.add_member(:task_execution_arn, Shapes::ShapeRef.new(shape: TaskExecutionArn, required: true, location_name: "TaskExecutionArn"))
647
+ UpdateTaskExecutionRequest.add_member(:options, Shapes::ShapeRef.new(shape: Options, required: true, location_name: "Options"))
648
+ UpdateTaskExecutionRequest.struct_class = Types::UpdateTaskExecutionRequest
649
+
650
+ UpdateTaskExecutionResponse.struct_class = Types::UpdateTaskExecutionResponse
651
+
606
652
  UpdateTaskRequest.add_member(:task_arn, Shapes::ShapeRef.new(shape: TaskArn, required: true, location_name: "TaskArn"))
607
653
  UpdateTaskRequest.add_member(:options, Shapes::ShapeRef.new(shape: Options, location_name: "Options"))
608
654
  UpdateTaskRequest.add_member(:excludes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Excludes"))
@@ -963,6 +1009,36 @@ module Aws::DataSync
963
1009
  o.errors << Shapes::ShapeRef.new(shape: InternalException)
964
1010
  end)
965
1011
 
1012
+ api.add_operation(:update_location_nfs, Seahorse::Model::Operation.new.tap do |o|
1013
+ o.name = "UpdateLocationNfs"
1014
+ o.http_method = "POST"
1015
+ o.http_request_uri = "/"
1016
+ o.input = Shapes::ShapeRef.new(shape: UpdateLocationNfsRequest)
1017
+ o.output = Shapes::ShapeRef.new(shape: UpdateLocationNfsResponse)
1018
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1019
+ o.errors << Shapes::ShapeRef.new(shape: InternalException)
1020
+ end)
1021
+
1022
+ api.add_operation(:update_location_object_storage, Seahorse::Model::Operation.new.tap do |o|
1023
+ o.name = "UpdateLocationObjectStorage"
1024
+ o.http_method = "POST"
1025
+ o.http_request_uri = "/"
1026
+ o.input = Shapes::ShapeRef.new(shape: UpdateLocationObjectStorageRequest)
1027
+ o.output = Shapes::ShapeRef.new(shape: UpdateLocationObjectStorageResponse)
1028
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1029
+ o.errors << Shapes::ShapeRef.new(shape: InternalException)
1030
+ end)
1031
+
1032
+ api.add_operation(:update_location_smb, Seahorse::Model::Operation.new.tap do |o|
1033
+ o.name = "UpdateLocationSmb"
1034
+ o.http_method = "POST"
1035
+ o.http_request_uri = "/"
1036
+ o.input = Shapes::ShapeRef.new(shape: UpdateLocationSmbRequest)
1037
+ o.output = Shapes::ShapeRef.new(shape: UpdateLocationSmbResponse)
1038
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1039
+ o.errors << Shapes::ShapeRef.new(shape: InternalException)
1040
+ end)
1041
+
966
1042
  api.add_operation(:update_task, Seahorse::Model::Operation.new.tap do |o|
967
1043
  o.name = "UpdateTask"
968
1044
  o.http_method = "POST"
@@ -972,6 +1048,16 @@ module Aws::DataSync
972
1048
  o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
973
1049
  o.errors << Shapes::ShapeRef.new(shape: InternalException)
974
1050
  end)
1051
+
1052
+ api.add_operation(:update_task_execution, Seahorse::Model::Operation.new.tap do |o|
1053
+ o.name = "UpdateTaskExecution"
1054
+ o.http_method = "POST"
1055
+ o.http_request_uri = "/"
1056
+ o.input = Shapes::ShapeRef.new(shape: UpdateTaskExecutionRequest)
1057
+ o.output = Shapes::ShapeRef.new(shape: UpdateTaskExecutionResponse)
1058
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1059
+ o.errors << Shapes::ShapeRef.new(shape: InternalException)
1060
+ end)
975
1061
  end
976
1062
 
977
1063
  end
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -287,18 +287,19 @@ module Aws::DataSync
287
287
  #
288
288
  # @!attribute [rw] subdirectory
289
289
  # A subdirectory in the location’s path. This subdirectory in the
290
- # Amazon FSx for Windows file system is used to read data from the
291
- # Amazon FSx for Windows source location or write data to the FSx for
292
- # Windows destination.
290
+ # Amazon FSx for Windows File Server file system is used to read data
291
+ # from the Amazon FSx for Windows File Server source location or write
292
+ # data to the FSx for Windows File Server destination.
293
293
  # @return [String]
294
294
  #
295
295
  # @!attribute [rw] fsx_filesystem_arn
296
- # The Amazon Resource Name (ARN) for the FSx for Windows file system.
296
+ # The Amazon Resource Name (ARN) for the FSx for Windows File Server
297
+ # file system.
297
298
  # @return [String]
298
299
  #
299
300
  # @!attribute [rw] security_group_arns
300
301
  # The Amazon Resource Names (ARNs) of the security groups that are to
301
- # use to configure the FSx for Windows file system.
302
+ # use to configure the FSx for Windows File Server file system.
302
303
  # @return [Array<String>]
303
304
  #
304
305
  # @!attribute [rw] tags
@@ -310,17 +311,17 @@ module Aws::DataSync
310
311
  #
311
312
  # @!attribute [rw] user
312
313
  # The user who has the permissions to access files and folders in the
313
- # FSx for Windows file system.
314
+ # FSx for Windows File Server file system.
314
315
  # @return [String]
315
316
  #
316
317
  # @!attribute [rw] domain
317
- # The name of the Windows domain that the FSx for Windows server
318
+ # The name of the Windows domain that the FSx for Windows File Server
318
319
  # belongs to.
319
320
  # @return [String]
320
321
  #
321
322
  # @!attribute [rw] password
322
323
  # The password of the user who has the permissions to access files and
323
- # folders in the FSx for Windows file system.
324
+ # folders in the FSx for Windows File Server file system.
324
325
  # @return [String]
325
326
  #
326
327
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxWindowsRequest AWS API Documentation
@@ -338,8 +339,8 @@ module Aws::DataSync
338
339
  end
339
340
 
340
341
  # @!attribute [rw] location_arn
341
- # The Amazon Resource Name (ARN) of the FSx for Windows file system
342
- # location that is created.
342
+ # The Amazon Resource Name (ARN) of the FSx for Windows File Server
343
+ # file system location that is created.
343
344
  # @return [String]
344
345
  #
345
346
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxWindowsResponse AWS API Documentation
@@ -379,7 +380,7 @@ module Aws::DataSync
379
380
  # a subdirectory of that path. The path should be such that it can be
380
381
  # mounted by other NFS clients in your network.
381
382
  #
382
- # To see all the paths exported by your NFS server. run "`showmount
383
+ # To see all the paths exported by your NFS server, run "`showmount
383
384
  # -e nfs-server-name`" from an NFS client that has access to your
384
385
  # server. You can specify any directory that appears in the results,
385
386
  # and any subdirectory of that directory. Ensure that the NFS export
@@ -526,12 +527,18 @@ module Aws::DataSync
526
527
  #
527
528
  # @!attribute [rw] access_key
528
529
  # Optional. The access key is used if credentials are required to
529
- # access the self-managed object storage server.
530
+ # access the self-managed object storage server. If your object
531
+ # storage requires a user name and password to authenticate, use
532
+ # `AccessKey` and `SecretKey` to provide the user name and password,
533
+ # respectively.
530
534
  # @return [String]
531
535
  #
532
536
  # @!attribute [rw] secret_key
533
537
  # Optional. The secret key is used if credentials are required to
534
- # access the self-managed object storage server.
538
+ # access the self-managed object storage server. If your object
539
+ # storage requires a user name and password to authenticate, use
540
+ # `AccessKey` and `SecretKey` to provide the user name and password,
541
+ # respectively.
535
542
  # @return [String]
536
543
  #
537
544
  # @!attribute [rw] agent_arns
@@ -584,10 +591,11 @@ module Aws::DataSync
584
591
  # {
585
592
  # subdirectory: "S3Subdirectory",
586
593
  # s3_bucket_arn: "S3BucketArn", # required
587
- # s3_storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
594
+ # s3_storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
588
595
  # s3_config: { # required
589
596
  # bucket_access_role_arn: "IamRoleArn", # required
590
597
  # },
598
+ # agent_arns: ["AgentArn"],
591
599
  # tags: [
592
600
  # {
593
601
  # key: "TagKey", # required
@@ -603,20 +611,24 @@ module Aws::DataSync
603
611
  # @return [String]
604
612
  #
605
613
  # @!attribute [rw] s3_bucket_arn
606
- # The Amazon Resource Name (ARN) of the Amazon S3 bucket.
614
+ # The ARN of the Amazon S3 bucket. If the bucket is on an AWS Outpost,
615
+ # this must be an access point ARN.
607
616
  # @return [String]
608
617
  #
609
618
  # @!attribute [rw] s3_storage_class
610
619
  # The Amazon S3 storage class that you want to store your files in
611
- # when this location is used as a task destination. For more
612
- # information about S3 storage classes, see [Amazon S3 Storage
613
- # Classes][1] in the *Amazon Simple Storage Service Developer Guide*.
614
- # Some storage classes have behaviors that can affect your S3 storage
615
- # cost. For detailed information, see using-storage-classes.
620
+ # when this location is used as a task destination. For buckets in AWS
621
+ # Regions, the storage class defaults to Standard. For buckets on AWS
622
+ # Outposts, the storage class defaults to AWS S3 Outposts.
623
+ #
624
+ # For more information about S3 storage classes, see [Amazon S3
625
+ # Storage Classes][1]. Some storage classes have behaviors that can
626
+ # affect your S3 storage cost. For detailed information, see
627
+ # using-storage-classes.
616
628
  #
617
629
  #
618
630
  #
619
- # [1]: https://aws.amazon.com/s3/storage-classes/
631
+ # [1]: http://aws.amazon.com/s3/storage-classes/
620
632
  # @return [String]
621
633
  #
622
634
  # @!attribute [rw] s3_config
@@ -627,6 +639,13 @@ module Aws::DataSync
627
639
  # Location for Amazon S3 in the *AWS DataSync User Guide*.
628
640
  # @return [Types::S3Config]
629
641
  #
642
+ # @!attribute [rw] agent_arns
643
+ # If you are using DataSync on an AWS Outpost, specify the Amazon
644
+ # Resource Names (ARNs) of the DataSync agents deployed on your
645
+ # Outpost. For more information about launching a DataSync agent on an
646
+ # AWS Outpost, see outposts-agent.
647
+ # @return [Array<String>]
648
+ #
630
649
  # @!attribute [rw] tags
631
650
  # The key-value pair that represents the tag that you want to add to
632
651
  # the location. The value can be an empty string. We recommend using
@@ -640,6 +659,7 @@ module Aws::DataSync
640
659
  :s3_bucket_arn,
641
660
  :s3_storage_class,
642
661
  :s3_config,
662
+ :agent_arns,
643
663
  :tags)
644
664
  SENSITIVE = []
645
665
  include Aws::Structure
@@ -854,7 +874,7 @@ module Aws::DataSync
854
874
  # A list of filter rules that determines which files to exclude from a
855
875
  # task. The list should contain a single filter string that consists
856
876
  # of the patterns to exclude. The patterns are delimited by "\|"
857
- # (that is, a pipe), for example, `"/folder1|/folder2"`
877
+ # (that is, a pipe), for example, `"/folder1|/folder2"`.
858
878
  # @return [Array<Types::FilterRule>]
859
879
  #
860
880
  # @!attribute [rw] schedule
@@ -1111,8 +1131,8 @@ module Aws::DataSync
1111
1131
  # }
1112
1132
  #
1113
1133
  # @!attribute [rw] location_arn
1114
- # The Amazon Resource Name (ARN) of the FSx for Windows location to
1115
- # describe.
1134
+ # The Amazon Resource Name (ARN) of the FSx for Windows File Server
1135
+ # location to describe.
1116
1136
  # @return [String]
1117
1137
  #
1118
1138
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxWindowsRequest AWS API Documentation
@@ -1124,30 +1144,31 @@ module Aws::DataSync
1124
1144
  end
1125
1145
 
1126
1146
  # @!attribute [rw] location_arn
1127
- # The Amazon Resource Name (ARN) of the FSx for Windows location that
1128
- # was described.
1147
+ # The Amazon Resource Name (ARN) of the FSx for Windows File Server
1148
+ # location that was described.
1129
1149
  # @return [String]
1130
1150
  #
1131
1151
  # @!attribute [rw] location_uri
1132
- # The URL of the FSx for Windows location that was described.
1152
+ # The URL of the FSx for Windows File Server location that was
1153
+ # described.
1133
1154
  # @return [String]
1134
1155
  #
1135
1156
  # @!attribute [rw] security_group_arns
1136
1157
  # The Amazon Resource Names (ARNs) of the security groups that are
1137
- # configured for the FSx for Windows file system.
1158
+ # configured for the FSx for Windows File Server file system.
1138
1159
  # @return [Array<String>]
1139
1160
  #
1140
1161
  # @!attribute [rw] creation_time
1141
- # The time that the FSx for Windows location was created.
1162
+ # The time that the FSx for Windows File Server location was created.
1142
1163
  # @return [Time]
1143
1164
  #
1144
1165
  # @!attribute [rw] user
1145
1166
  # The user who has the permissions to access files and folders in the
1146
- # FSx for Windows file system.
1167
+ # FSx for Windows File Server file system.
1147
1168
  # @return [String]
1148
1169
  #
1149
1170
  # @!attribute [rw] domain
1150
- # The name of the Windows domain that the FSx for Windows server
1171
+ # The name of the Windows domain that the FSx for Windows File Server
1151
1172
  # belongs to.
1152
1173
  # @return [String]
1153
1174
  #
@@ -1257,7 +1278,10 @@ module Aws::DataSync
1257
1278
  #
1258
1279
  # @!attribute [rw] access_key
1259
1280
  # Optional. The access key is used if credentials are required to
1260
- # access the self-managed object storage server.
1281
+ # access the self-managed object storage server. If your object
1282
+ # storage requires a user name and password to authenticate, use
1283
+ # `AccessKey` and `SecretKey` to provide the user name and password,
1284
+ # respectively.
1261
1285
  # @return [String]
1262
1286
  #
1263
1287
  # @!attribute [rw] server_port
@@ -1320,7 +1344,8 @@ module Aws::DataSync
1320
1344
  # DescribeLocationS3Response
1321
1345
  #
1322
1346
  # @!attribute [rw] location_arn
1323
- # The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
1347
+ # The Amazon Resource Name (ARN) of the Amazon S3 bucket or access
1348
+ # point.
1324
1349
  # @return [String]
1325
1350
  #
1326
1351
  # @!attribute [rw] location_uri
@@ -1331,13 +1356,13 @@ module Aws::DataSync
1331
1356
  # The Amazon S3 storage class that you chose to store your files in
1332
1357
  # when this location is used as a task destination. For more
1333
1358
  # information about S3 storage classes, see [Amazon S3 Storage
1334
- # Classes][1] in the *Amazon Simple Storage Service Developer Guide*.
1335
- # Some storage classes have behaviors that can affect your S3 storage
1336
- # cost. For detailed information, see using-storage-classes.
1359
+ # Classes][1]. Some storage classes have behaviors that can affect
1360
+ # your S3 storage cost. For detailed information, see
1361
+ # using-storage-classes.
1337
1362
  #
1338
1363
  #
1339
1364
  #
1340
- # [1]: https://aws.amazon.com/s3/storage-classes/
1365
+ # [1]: http://aws.amazon.com/s3/storage-classes/
1341
1366
  # @return [String]
1342
1367
  #
1343
1368
  # @!attribute [rw] s3_config
@@ -1348,6 +1373,13 @@ module Aws::DataSync
1348
1373
  # Location for Amazon S3 in the *AWS DataSync User Guide*.
1349
1374
  # @return [Types::S3Config]
1350
1375
  #
1376
+ # @!attribute [rw] agent_arns
1377
+ # If you are using DataSync on an AWS Outpost, the Amazon Resource
1378
+ # Name (ARNs) of the EC2 agents deployed on your Outpost. For more
1379
+ # information about launching a DataSync agent on an AWS Outpost, see
1380
+ # outposts-agent.
1381
+ # @return [Array<String>]
1382
+ #
1351
1383
  # @!attribute [rw] creation_time
1352
1384
  # The time that the Amazon S3 bucket location was created.
1353
1385
  # @return [Time]
@@ -1359,6 +1391,7 @@ module Aws::DataSync
1359
1391
  :location_uri,
1360
1392
  :s3_storage_class,
1361
1393
  :s3_config,
1394
+ :agent_arns,
1362
1395
  :creation_time)
1363
1396
  SENSITIVE = []
1364
1397
  include Aws::Structure
@@ -1596,7 +1629,7 @@ module Aws::DataSync
1596
1629
  # The status of the task that was described.
1597
1630
  #
1598
1631
  # For detailed information about task execution statuses, see
1599
- # Understanding Task Statuses in the *AWS DataSync User Guide.*
1632
+ # Understanding Task Statuses in the *AWS DataSync User Guide*.
1600
1633
  # @return [String]
1601
1634
  #
1602
1635
  # @!attribute [rw] name
@@ -1870,6 +1903,10 @@ module Aws::DataSync
1870
1903
  # @return [String]
1871
1904
  #
1872
1905
  # @!attribute [rw] filters
1906
+ # You can use API filters to narrow down the list of resources
1907
+ # returned by `ListLocations`. For example, to retrieve all tasks on a
1908
+ # specific source location, you can use `ListLocations` with filter
1909
+ # name `LocationType S3` and `Operator Equals`.
1873
1910
  # @return [Array<Types::LocationFilter>]
1874
1911
  #
1875
1912
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListLocationsRequest AWS API Documentation
@@ -2038,6 +2075,10 @@ module Aws::DataSync
2038
2075
  # @return [String]
2039
2076
  #
2040
2077
  # @!attribute [rw] filters
2078
+ # You can use API filters to narrow down the list of resources
2079
+ # returned by `ListTasks`. For example, to retrieve all tasks on a
2080
+ # specific source location, you can use `ListTasks` with filter name
2081
+ # `LocationId` and `Operator Equals` with the ARN for the location.
2041
2082
  # @return [Array<Types::TaskFilter>]
2042
2083
  #
2043
2084
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTasksRequest AWS API Documentation
@@ -2070,6 +2111,11 @@ module Aws::DataSync
2070
2111
  include Aws::Structure
2071
2112
  end
2072
2113
 
2114
+ # You can use API filters to narrow down the list of resources returned
2115
+ # by `ListLocations`. For example, to retrieve all your Amazon S3
2116
+ # locations, you can use `ListLocations` with filter name `LocationType
2117
+ # S3` and `Operator Equals`.
2118
+ #
2073
2119
  # @note When making an API call, you may pass LocationFilter
2074
2120
  # data as a hash:
2075
2121
  #
@@ -2080,12 +2126,20 @@ module Aws::DataSync
2080
2126
  # }
2081
2127
  #
2082
2128
  # @!attribute [rw] name
2129
+ # The name of the filter being used. Each API call supports a list of
2130
+ # filters that are available for it (for example, `LocationType` for
2131
+ # `ListLocations`).
2083
2132
  # @return [String]
2084
2133
  #
2085
2134
  # @!attribute [rw] values
2135
+ # The values that you want to filter for. For example, you might want
2136
+ # to display only Amazon S3 locations.
2086
2137
  # @return [Array<String>]
2087
2138
  #
2088
2139
  # @!attribute [rw] operator
2140
+ # The operator that is used to compare filter values (for example,
2141
+ # `Equals` or `Contains`). For more about API filtering operators, see
2142
+ # query-resources.
2089
2143
  # @return [String]
2090
2144
  #
2091
2145
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/LocationFilter AWS API Documentation
@@ -2192,7 +2246,7 @@ module Aws::DataSync
2192
2246
  # }
2193
2247
  #
2194
2248
  # @!attribute [rw] agent_arns
2195
- # ARNs)of the agents to use for an NFS location.
2249
+ # ARNs of the agents to use for an NFS location.
2196
2250
  # @return [Array<String>]
2197
2251
  #
2198
2252
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/OnPremConfig AWS API Documentation
@@ -2414,11 +2468,17 @@ module Aws::DataSync
2414
2468
  # @return [String]
2415
2469
  #
2416
2470
  # @!attribute [rw] transfer_mode
2417
- # TransferMode has two values: CHANGED and ALL. CHANGED performs an
2418
- # "incremental" or "delta sync", it compares file modification
2419
- # time between source and destination to determine which files need to
2420
- # be transferred. ALL skips destination inventory and transfers all
2421
- # files discovered on the source.
2471
+ # A value that determines whether DataSync transfers only the data and
2472
+ # metadata that differ between the source and the destination
2473
+ # location, or whether DataSync transfers all the content from the
2474
+ # source, without comparing to the destination location.
2475
+ #
2476
+ # CHANGED: DataSync copies only data or metadata that is new or
2477
+ # different content from the source location to the destination
2478
+ # location.
2479
+ #
2480
+ # ALL: DataSync copies all source location content to the destination,
2481
+ # without comparing to existing content on the destination.
2422
2482
  # @return [String]
2423
2483
  #
2424
2484
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Options AWS API Documentation
@@ -2724,7 +2784,7 @@ module Aws::DataSync
2724
2784
  # @return [Integer]
2725
2785
  #
2726
2786
  # @!attribute [rw] transfer_status
2727
- # The status of the TRANSFERRING Phase.
2787
+ # The status of the TRANSFERRING phase.
2728
2788
  # @return [String]
2729
2789
  #
2730
2790
  # @!attribute [rw] verify_duration
@@ -2733,7 +2793,7 @@ module Aws::DataSync
2733
2793
  # @return [Integer]
2734
2794
  #
2735
2795
  # @!attribute [rw] verify_status
2736
- # The status of the VERIFYING Phase.
2796
+ # The status of the VERIFYING phase.
2737
2797
  # @return [String]
2738
2798
  #
2739
2799
  # @!attribute [rw] error_code
@@ -2763,6 +2823,11 @@ module Aws::DataSync
2763
2823
  include Aws::Structure
2764
2824
  end
2765
2825
 
2826
+ # You can use API filters to narrow down the list of resources returned
2827
+ # by `ListTasks`. For example, to retrieve all tasks on a source
2828
+ # location, you can use `ListTasks` with filter name `LocationId` and
2829
+ # `Operator Equals` with the ARN for the location.
2830
+ #
2766
2831
  # @note When making an API call, you may pass TaskFilter
2767
2832
  # data as a hash:
2768
2833
  #
@@ -2773,12 +2838,20 @@ module Aws::DataSync
2773
2838
  # }
2774
2839
  #
2775
2840
  # @!attribute [rw] name
2841
+ # The name of the filter being used. Each API call supports a list of
2842
+ # filters that are available for it. For example, `LocationId` for
2843
+ # `ListTasks`.
2776
2844
  # @return [String]
2777
2845
  #
2778
2846
  # @!attribute [rw] values
2847
+ # The values that you want to filter for. For example, you might want
2848
+ # to display only tasks for a specific destination location.
2779
2849
  # @return [Array<String>]
2780
2850
  #
2781
2851
  # @!attribute [rw] operator
2852
+ # The operator that is used to compare filter values (for example,
2853
+ # `Equals` or `Contains`). For more about API filtering operators, see
2854
+ # query-resources.
2782
2855
  # @return [String]
2783
2856
  #
2784
2857
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskFilter AWS API Documentation
@@ -2909,6 +2982,298 @@ module Aws::DataSync
2909
2982
  #
2910
2983
  class UpdateAgentResponse < Aws::EmptyStructure; end
2911
2984
 
2985
+ # @note When making an API call, you may pass UpdateLocationNfsRequest
2986
+ # data as a hash:
2987
+ #
2988
+ # {
2989
+ # location_arn: "LocationArn", # required
2990
+ # subdirectory: "NfsSubdirectory",
2991
+ # on_prem_config: {
2992
+ # agent_arns: ["AgentArn"], # required
2993
+ # },
2994
+ # mount_options: {
2995
+ # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
2996
+ # },
2997
+ # }
2998
+ #
2999
+ # @!attribute [rw] location_arn
3000
+ # The Amazon Resource Name (ARN) of the NFS location to update.
3001
+ # @return [String]
3002
+ #
3003
+ # @!attribute [rw] subdirectory
3004
+ # The subdirectory in the NFS file system that is used to read data
3005
+ # from the NFS source location or write data to the NFS destination.
3006
+ # The NFS path should be a path that's exported by the NFS server, or
3007
+ # a subdirectory of that path. The path should be such that it can be
3008
+ # mounted by other NFS clients in your network.
3009
+ #
3010
+ # To see all the paths exported by your NFS server, run "`showmount
3011
+ # -e nfs-server-name`" from an NFS client that has access to your
3012
+ # server. You can specify any directory that appears in the results,
3013
+ # and any subdirectory of that directory. Ensure that the NFS export
3014
+ # is accessible without Kerberos authentication.
3015
+ #
3016
+ # To transfer all the data in the folder that you specified, DataSync
3017
+ # must have permissions to read all the data. To ensure this, either
3018
+ # configure the NFS export with `no_root_squash`, or ensure that the
3019
+ # files you want DataSync to access have permissions that allow read
3020
+ # access for all users. Doing either option enables the agent to read
3021
+ # the files. For the agent to access directories, you must
3022
+ # additionally enable all execute access.
3023
+ #
3024
+ # If you are copying data to or from your AWS Snowcone device, see
3025
+ # [NFS Server on AWS Snowcone][1] for more information.
3026
+ #
3027
+ # For information about NFS export configuration, see 18.7. The
3028
+ # /etc/exports Configuration File in the Red Hat Enterprise Linux
3029
+ # documentation.
3030
+ #
3031
+ #
3032
+ #
3033
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone
3034
+ # @return [String]
3035
+ #
3036
+ # @!attribute [rw] on_prem_config
3037
+ # A list of Amazon Resource Names (ARNs) of agents to use for a
3038
+ # Network File System (NFS) location.
3039
+ # @return [Types::OnPremConfig]
3040
+ #
3041
+ # @!attribute [rw] mount_options
3042
+ # Represents the mount options that are available for DataSync to
3043
+ # access an NFS location.
3044
+ # @return [Types::NfsMountOptions]
3045
+ #
3046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationNfsRequest AWS API Documentation
3047
+ #
3048
+ class UpdateLocationNfsRequest < Struct.new(
3049
+ :location_arn,
3050
+ :subdirectory,
3051
+ :on_prem_config,
3052
+ :mount_options)
3053
+ SENSITIVE = []
3054
+ include Aws::Structure
3055
+ end
3056
+
3057
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationNfsResponse AWS API Documentation
3058
+ #
3059
+ class UpdateLocationNfsResponse < Aws::EmptyStructure; end
3060
+
3061
+ # @note When making an API call, you may pass UpdateLocationObjectStorageRequest
3062
+ # data as a hash:
3063
+ #
3064
+ # {
3065
+ # location_arn: "LocationArn", # required
3066
+ # server_port: 1,
3067
+ # server_protocol: "HTTPS", # accepts HTTPS, HTTP
3068
+ # subdirectory: "S3Subdirectory",
3069
+ # access_key: "ObjectStorageAccessKey",
3070
+ # secret_key: "ObjectStorageSecretKey",
3071
+ # agent_arns: ["AgentArn"],
3072
+ # }
3073
+ #
3074
+ # @!attribute [rw] location_arn
3075
+ # The Amazon Resource Name (ARN) of the self-managed object storage
3076
+ # server location to be updated.
3077
+ # @return [String]
3078
+ #
3079
+ # @!attribute [rw] server_port
3080
+ # The port that your self-managed object storage server accepts
3081
+ # inbound network traffic on. The server port is set by default to TCP
3082
+ # 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your
3083
+ # self-managed object storage server requires one.
3084
+ # @return [Integer]
3085
+ #
3086
+ # @!attribute [rw] server_protocol
3087
+ # The protocol that the object storage server uses to communicate.
3088
+ # Valid values are `HTTP` or `HTTPS`.
3089
+ # @return [String]
3090
+ #
3091
+ # @!attribute [rw] subdirectory
3092
+ # The subdirectory in the self-managed object storage server that is
3093
+ # used to read data from.
3094
+ # @return [String]
3095
+ #
3096
+ # @!attribute [rw] access_key
3097
+ # Optional. The access key is used if credentials are required to
3098
+ # access the self-managed object storage server. If your object
3099
+ # storage requires a user name and password to authenticate, use
3100
+ # `AccessKey` and `SecretKey` to provide the user name and password,
3101
+ # respectively.
3102
+ # @return [String]
3103
+ #
3104
+ # @!attribute [rw] secret_key
3105
+ # Optional. The secret key is used if credentials are required to
3106
+ # access the self-managed object storage server. If your object
3107
+ # storage requires a user name and password to authenticate, use
3108
+ # `AccessKey` and `SecretKey` to provide the user name and password,
3109
+ # respectively.
3110
+ # @return [String]
3111
+ #
3112
+ # @!attribute [rw] agent_arns
3113
+ # The Amazon Resource Name (ARN) of the agents associated with the
3114
+ # self-managed object storage server location.
3115
+ # @return [Array<String>]
3116
+ #
3117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationObjectStorageRequest AWS API Documentation
3118
+ #
3119
+ class UpdateLocationObjectStorageRequest < Struct.new(
3120
+ :location_arn,
3121
+ :server_port,
3122
+ :server_protocol,
3123
+ :subdirectory,
3124
+ :access_key,
3125
+ :secret_key,
3126
+ :agent_arns)
3127
+ SENSITIVE = [:secret_key]
3128
+ include Aws::Structure
3129
+ end
3130
+
3131
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationObjectStorageResponse AWS API Documentation
3132
+ #
3133
+ class UpdateLocationObjectStorageResponse < Aws::EmptyStructure; end
3134
+
3135
+ # @note When making an API call, you may pass UpdateLocationSmbRequest
3136
+ # data as a hash:
3137
+ #
3138
+ # {
3139
+ # location_arn: "LocationArn", # required
3140
+ # subdirectory: "SmbSubdirectory",
3141
+ # user: "SmbUser",
3142
+ # domain: "SmbDomain",
3143
+ # password: "SmbPassword",
3144
+ # agent_arns: ["AgentArn"],
3145
+ # mount_options: {
3146
+ # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
3147
+ # },
3148
+ # }
3149
+ #
3150
+ # @!attribute [rw] location_arn
3151
+ # The Amazon Resource Name (ARN) of the SMB location to update.
3152
+ # @return [String]
3153
+ #
3154
+ # @!attribute [rw] subdirectory
3155
+ # The subdirectory in the SMB file system that is used to read data
3156
+ # from the SMB source location or write data to the SMB destination.
3157
+ # The SMB path should be a path that's exported by the SMB server, or
3158
+ # a subdirectory of that path. The path should be such that it can be
3159
+ # mounted by other SMB clients in your network.
3160
+ #
3161
+ # <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example,
3162
+ # `/path/to/folder`.
3163
+ #
3164
+ # </note>
3165
+ #
3166
+ # To transfer all the data in the folder that you specified, DataSync
3167
+ # must have permissions to mount the SMB share and to access all the
3168
+ # data in that share. To ensure this, do either of the following:
3169
+ #
3170
+ # * Ensure that the user/password specified belongs to the user who
3171
+ # can mount the share and who has the appropriate permissions for
3172
+ # all of the files and directories that you want DataSync to access.
3173
+ #
3174
+ # * Use credentials of a member of the Backup Operators group to mount
3175
+ # the share.
3176
+ #
3177
+ # Doing either of these options enables the agent to access the data.
3178
+ # For the agent to access directories, you must also enable all
3179
+ # execute access.
3180
+ # @return [String]
3181
+ #
3182
+ # @!attribute [rw] user
3183
+ # The user who can mount the share has the permissions to access files
3184
+ # and folders in the SMB share.
3185
+ # @return [String]
3186
+ #
3187
+ # @!attribute [rw] domain
3188
+ # The name of the Windows domain that the SMB server belongs to.
3189
+ # @return [String]
3190
+ #
3191
+ # @!attribute [rw] password
3192
+ # The password of the user who can mount the share has the permissions
3193
+ # to access files and folders in the SMB share.
3194
+ # @return [String]
3195
+ #
3196
+ # @!attribute [rw] agent_arns
3197
+ # The Amazon Resource Names (ARNs) of agents to use for a Simple
3198
+ # Message Block (SMB) location.
3199
+ # @return [Array<String>]
3200
+ #
3201
+ # @!attribute [rw] mount_options
3202
+ # Represents the mount options that are available for DataSync to
3203
+ # access an SMB location.
3204
+ # @return [Types::SmbMountOptions]
3205
+ #
3206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationSmbRequest AWS API Documentation
3207
+ #
3208
+ class UpdateLocationSmbRequest < Struct.new(
3209
+ :location_arn,
3210
+ :subdirectory,
3211
+ :user,
3212
+ :domain,
3213
+ :password,
3214
+ :agent_arns,
3215
+ :mount_options)
3216
+ SENSITIVE = [:password]
3217
+ include Aws::Structure
3218
+ end
3219
+
3220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationSmbResponse AWS API Documentation
3221
+ #
3222
+ class UpdateLocationSmbResponse < Aws::EmptyStructure; end
3223
+
3224
+ # @note When making an API call, you may pass UpdateTaskExecutionRequest
3225
+ # data as a hash:
3226
+ #
3227
+ # {
3228
+ # task_execution_arn: "TaskExecutionArn", # required
3229
+ # options: { # required
3230
+ # verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
3231
+ # overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
3232
+ # atime: "NONE", # accepts NONE, BEST_EFFORT
3233
+ # mtime: "NONE", # accepts NONE, PRESERVE
3234
+ # uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
3235
+ # gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
3236
+ # preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
3237
+ # preserve_devices: "NONE", # accepts NONE, PRESERVE
3238
+ # posix_permissions: "NONE", # accepts NONE, PRESERVE
3239
+ # bytes_per_second: 1,
3240
+ # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
3241
+ # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
3242
+ # transfer_mode: "CHANGED", # accepts CHANGED, ALL
3243
+ # },
3244
+ # }
3245
+ #
3246
+ # @!attribute [rw] task_execution_arn
3247
+ # The Amazon Resource Name (ARN) of the specific task execution that
3248
+ # is being updated.
3249
+ # @return [String]
3250
+ #
3251
+ # @!attribute [rw] options
3252
+ # Represents the options that are available to control the behavior of
3253
+ # a StartTaskExecution operation. Behavior includes preserving
3254
+ # metadata such as user ID (UID), group ID (GID), and file
3255
+ # permissions, and also overwriting files in the destination, data
3256
+ # integrity verification, and so on.
3257
+ #
3258
+ # A task has a set of default options associated with it. If you
3259
+ # don't specify an option in StartTaskExecution, the default value is
3260
+ # used. You can override the defaults options on each task execution
3261
+ # by specifying an overriding `Options` value to StartTaskExecution.
3262
+ # @return [Types::Options]
3263
+ #
3264
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
3265
+ #
3266
+ class UpdateTaskExecutionRequest < Struct.new(
3267
+ :task_execution_arn,
3268
+ :options)
3269
+ SENSITIVE = []
3270
+ include Aws::Structure
3271
+ end
3272
+
3273
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionResponse AWS API Documentation
3274
+ #
3275
+ class UpdateTaskExecutionResponse < Aws::EmptyStructure; end
3276
+
2912
3277
  # UpdateTaskResponse
2913
3278
  #
2914
3279
  # @note When making an API call, you may pass UpdateTaskRequest