aws-sdk-datasync 1.73.0 → 1.75.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-datasync/client.rb +145 -101
- data/lib/aws-sdk-datasync/client_api.rb +11 -0
- data/lib/aws-sdk-datasync/types.rb +232 -120
- data/lib/aws-sdk-datasync.rb +1 -1
- data/sig/client.rbs +5 -2
- data/sig/types.rbs +9 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8f1af93138fc57bcd8f3feed5932b5bf6a6c232efd9f340b9e96b4a1701349a1
|
4
|
+
data.tar.gz: 93418ae1d4f38b2430d8d435f842f85b76eec526c91b485a98ac9ebfd976add2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bc0bfab8858668110ee1bdb3eb01c4cb4e66a721289398af28fba9f6e3382193d0371f17e05f2ea75b0495c0ce9697e8a7b70495bb9936b986e0a6c56559e96d
|
7
|
+
data.tar.gz: 43e24c4f8e74a94c2058362e3466aa3f3f90a7a925dc438b5d7afe3a967439aa578188b0e98958297445f1b08664216e16e7f5150ef9fc088cb9b8090e75dcd7
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.75.0 (2024-04-25)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.74.0 (2024-04-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This change allows users to disable and enable the schedules associated with their tasks.
|
13
|
+
|
4
14
|
1.73.0 (2024-02-07)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.75.0
|
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
|
22
22
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
23
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
24
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id.rb'
|
25
26
|
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
27
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
28
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
@@ -72,6 +73,7 @@ module Aws::DataSync
|
|
72
73
|
add_plugin(Aws::Plugins::ResponsePaging)
|
73
74
|
add_plugin(Aws::Plugins::StubResponses)
|
74
75
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
76
|
+
add_plugin(Aws::Plugins::InvocationId)
|
75
77
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
76
78
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
77
79
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
@@ -196,10 +198,17 @@ module Aws::DataSync
|
|
196
198
|
# When set to 'true' the request body will not be compressed
|
197
199
|
# for supported operations.
|
198
200
|
#
|
199
|
-
# @option options [String] :endpoint
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
201
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
202
|
+
# Normally you should not configure the `:endpoint` option
|
203
|
+
# directly. This is normally constructed from the `:region`
|
204
|
+
# option. Configuring `:endpoint` is normally reserved for
|
205
|
+
# connecting to test or custom endpoints. The endpoint should
|
206
|
+
# be a URI formatted like:
|
207
|
+
#
|
208
|
+
# 'http://example.com'
|
209
|
+
# 'https://example.com'
|
210
|
+
# 'http://example.com:123'
|
211
|
+
#
|
203
212
|
#
|
204
213
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
205
214
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -347,50 +356,65 @@ module Aws::DataSync
|
|
347
356
|
# @option options [Aws::DataSync::EndpointProvider] :endpoint_provider
|
348
357
|
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::DataSync::EndpointParameters`
|
349
358
|
#
|
350
|
-
# @option options [
|
351
|
-
#
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
#
|
360
|
-
#
|
361
|
-
# @option options [Float] :
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
#
|
366
|
-
#
|
367
|
-
#
|
368
|
-
#
|
369
|
-
#
|
370
|
-
#
|
371
|
-
#
|
372
|
-
#
|
373
|
-
#
|
374
|
-
#
|
359
|
+
# @option options [Float] :http_continue_timeout (1)
|
360
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
361
|
+
# request body. This option has no effect unless the request has "Expect"
|
362
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
363
|
+
# behaviour. This value can safely be set per request on the session.
|
364
|
+
#
|
365
|
+
# @option options [Float] :http_idle_timeout (5)
|
366
|
+
# The number of seconds a connection is allowed to sit idle before it
|
367
|
+
# is considered stale. Stale connections are closed and removed from the
|
368
|
+
# pool before making a request.
|
369
|
+
#
|
370
|
+
# @option options [Float] :http_open_timeout (15)
|
371
|
+
# The default number of seconds to wait for response data.
|
372
|
+
# This value can safely be set per-request on the session.
|
373
|
+
#
|
374
|
+
# @option options [URI::HTTP,String] :http_proxy
|
375
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
376
|
+
#
|
377
|
+
# @option options [Float] :http_read_timeout (60)
|
378
|
+
# The default number of seconds to wait for response data.
|
379
|
+
# This value can safely be set per-request on the session.
|
380
|
+
#
|
381
|
+
# @option options [Boolean] :http_wire_trace (false)
|
382
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
383
|
+
#
|
384
|
+
# @option options [Proc] :on_chunk_received
|
385
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
386
|
+
# of the response body is received. It provides three arguments: the chunk,
|
387
|
+
# the number of bytes received, and the total number of
|
388
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
389
|
+
#
|
390
|
+
# @option options [Proc] :on_chunk_sent
|
391
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
392
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
393
|
+
# the number of bytes read from the body, and the total number of
|
394
|
+
# bytes in the body.
|
395
|
+
#
|
396
|
+
# @option options [Boolean] :raise_response_errors (true)
|
397
|
+
# When `true`, response errors are raised.
|
398
|
+
#
|
399
|
+
# @option options [String] :ssl_ca_bundle
|
400
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
401
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
402
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
403
|
+
#
|
404
|
+
# @option options [String] :ssl_ca_directory
|
405
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
406
|
+
# authority files for verifying peer certificates. If you do
|
407
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
408
|
+
# default will be used if available.
|
375
409
|
#
|
376
|
-
# @option options [
|
377
|
-
#
|
410
|
+
# @option options [String] :ssl_ca_store
|
411
|
+
# Sets the X509::Store to verify peer certificate.
|
378
412
|
#
|
379
|
-
# @option options [
|
380
|
-
#
|
381
|
-
# connection.
|
413
|
+
# @option options [Float] :ssl_timeout
|
414
|
+
# Sets the SSL timeout in seconds
|
382
415
|
#
|
383
|
-
# @option options [
|
384
|
-
#
|
385
|
-
# verifying peer certificates. If you do not pass
|
386
|
-
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
387
|
-
# will be used if available.
|
388
|
-
#
|
389
|
-
# @option options [String] :ssl_ca_directory Full path of the
|
390
|
-
# directory that contains the unbundled SSL certificate
|
391
|
-
# authority files for verifying peer certificates. If you do
|
392
|
-
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
393
|
-
# system default will be used if available.
|
416
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
417
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
394
418
|
#
|
395
419
|
def initialize(*args)
|
396
420
|
super
|
@@ -1732,12 +1756,11 @@ module Aws::DataSync
|
|
1732
1756
|
req.send_request(options)
|
1733
1757
|
end
|
1734
1758
|
|
1735
|
-
# Configures a
|
1759
|
+
# Configures a *task*, which defines where and how DataSync transfers
|
1736
1760
|
# your data.
|
1737
1761
|
#
|
1738
|
-
# A task includes a source location, destination location, and
|
1739
|
-
# options
|
1740
|
-
# bandwidth limits, scheduling, among other options).
|
1762
|
+
# A task includes a source location, destination location, and transfer
|
1763
|
+
# options (such as bandwidth limits, scheduling, and more).
|
1741
1764
|
#
|
1742
1765
|
# If you're planning to transfer data to or from an Amazon S3 location,
|
1743
1766
|
# review [how DataSync can affect your S3 request charges][1] and the
|
@@ -1749,61 +1772,51 @@ module Aws::DataSync
|
|
1749
1772
|
# [2]: http://aws.amazon.com/datasync/pricing/
|
1750
1773
|
#
|
1751
1774
|
# @option params [required, String] :source_location_arn
|
1752
|
-
#
|
1775
|
+
# Specifies the ARN of your transfer's source location.
|
1753
1776
|
#
|
1754
1777
|
# @option params [required, String] :destination_location_arn
|
1755
|
-
#
|
1756
|
-
# resource's location.
|
1778
|
+
# Specifies the ARN of your transfer's destination location.
|
1757
1779
|
#
|
1758
1780
|
# @option params [String] :cloud_watch_log_group_arn
|
1759
|
-
#
|
1760
|
-
#
|
1781
|
+
# Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
|
1782
|
+
# group for monitoring your task.
|
1761
1783
|
#
|
1762
1784
|
# @option params [String] :name
|
1763
|
-
#
|
1764
|
-
# identify the task in the console.
|
1785
|
+
# Specifies the name of your task.
|
1765
1786
|
#
|
1766
1787
|
# @option params [Types::Options] :options
|
1767
|
-
# Specifies
|
1768
|
-
#
|
1769
|
-
#
|
1770
|
-
# You can also override these options before starting an individual run
|
1771
|
-
# of a task (also known as a *task execution*). For more information,
|
1772
|
-
# see [StartTaskExecution][1].
|
1773
|
-
#
|
1774
|
-
#
|
1775
|
-
#
|
1776
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
1788
|
+
# Specifies your task's settings, such as preserving file metadata,
|
1789
|
+
# verifying data integrity, among other options.
|
1777
1790
|
#
|
1778
1791
|
# @option params [Array<Types::FilterRule>] :excludes
|
1779
|
-
# Specifies
|
1780
|
-
# your
|
1781
|
-
#
|
1792
|
+
# Specifies exclude filters that define the files, objects, and folders
|
1793
|
+
# in your source location that you don't want DataSync to transfer. For
|
1794
|
+
# more information and examples, see [Specifying what DataSync transfers
|
1795
|
+
# by using filters][1].
|
1782
1796
|
#
|
1783
1797
|
#
|
1784
1798
|
#
|
1785
1799
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
1786
1800
|
#
|
1787
1801
|
# @option params [Types::TaskSchedule] :schedule
|
1788
|
-
# Specifies a schedule
|
1789
|
-
#
|
1790
|
-
# time. For more information, see [Scheduling your task][1].
|
1802
|
+
# Specifies a schedule for when you want your task to run. For more
|
1803
|
+
# information, see [Scheduling your task][1].
|
1791
1804
|
#
|
1792
1805
|
#
|
1793
1806
|
#
|
1794
1807
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
1795
1808
|
#
|
1796
1809
|
# @option params [Array<Types::TagListEntry>] :tags
|
1797
|
-
# Specifies the tags that you want to apply to
|
1798
|
-
# (ARN) representing the task.
|
1810
|
+
# Specifies the tags that you want to apply to your task.
|
1799
1811
|
#
|
1800
1812
|
# *Tags* are key-value pairs that help you manage, filter, and search
|
1801
1813
|
# for your DataSync resources.
|
1802
1814
|
#
|
1803
1815
|
# @option params [Array<Types::FilterRule>] :includes
|
1804
|
-
# Specifies
|
1805
|
-
# your
|
1806
|
-
#
|
1816
|
+
# Specifies include filters define the files, objects, and folders in
|
1817
|
+
# your source location that you want DataSync to transfer. For more
|
1818
|
+
# information and examples, see [Specifying what DataSync transfers by
|
1819
|
+
# using filters][1].
|
1807
1820
|
#
|
1808
1821
|
#
|
1809
1822
|
#
|
@@ -1875,6 +1888,7 @@ module Aws::DataSync
|
|
1875
1888
|
# ],
|
1876
1889
|
# schedule: {
|
1877
1890
|
# schedule_expression: "ScheduleExpressionCron", # required
|
1891
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
1878
1892
|
# },
|
1879
1893
|
# tags: [
|
1880
1894
|
# {
|
@@ -2879,10 +2893,12 @@ module Aws::DataSync
|
|
2879
2893
|
req.send_request(options)
|
2880
2894
|
end
|
2881
2895
|
|
2882
|
-
# Provides information about
|
2896
|
+
# Provides information about a *task*, which defines where and how
|
2897
|
+
# DataSync transfers your data.
|
2883
2898
|
#
|
2884
2899
|
# @option params [required, String] :task_arn
|
2885
|
-
# Specifies the Amazon Resource Name (ARN) of the transfer task
|
2900
|
+
# Specifies the Amazon Resource Name (ARN) of the transfer task that you
|
2901
|
+
# want information about.
|
2886
2902
|
#
|
2887
2903
|
# @return [Types::DescribeTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2888
2904
|
#
|
@@ -2904,6 +2920,7 @@ module Aws::DataSync
|
|
2904
2920
|
# * {Types::DescribeTaskResponse#includes #includes} => Array<Types::FilterRule>
|
2905
2921
|
# * {Types::DescribeTaskResponse#manifest_config #manifest_config} => Types::ManifestConfig
|
2906
2922
|
# * {Types::DescribeTaskResponse#task_report_config #task_report_config} => Types::TaskReportConfig
|
2923
|
+
# * {Types::DescribeTaskResponse#schedule_details #schedule_details} => Types::TaskScheduleDetails
|
2907
2924
|
#
|
2908
2925
|
# @example Request syntax with placeholder values
|
2909
2926
|
#
|
@@ -2943,6 +2960,7 @@ module Aws::DataSync
|
|
2943
2960
|
# resp.excludes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
|
2944
2961
|
# resp.excludes[0].value #=> String
|
2945
2962
|
# resp.schedule.schedule_expression #=> String
|
2963
|
+
# resp.schedule.status #=> String, one of "ENABLED", "DISABLED"
|
2946
2964
|
# resp.error_code #=> String
|
2947
2965
|
# resp.error_detail #=> String
|
2948
2966
|
# resp.creation_time #=> Time
|
@@ -2965,6 +2983,9 @@ module Aws::DataSync
|
|
2965
2983
|
# resp.task_report_config.overrides.verified.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2966
2984
|
# resp.task_report_config.overrides.deleted.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2967
2985
|
# resp.task_report_config.overrides.skipped.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2986
|
+
# resp.schedule_details.status_update_time #=> Time
|
2987
|
+
# resp.schedule_details.disabled_reason #=> String
|
2988
|
+
# resp.schedule_details.disabled_by #=> String, one of "USER", "SERVICE"
|
2968
2989
|
#
|
2969
2990
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTask AWS API Documentation
|
2970
2991
|
#
|
@@ -3595,7 +3616,15 @@ module Aws::DataSync
|
|
3595
3616
|
# integrity, set bandwidth limits for your task, among other options.
|
3596
3617
|
#
|
3597
3618
|
# Each option has a default value. Unless you need to, you don't have
|
3598
|
-
# to configure any
|
3619
|
+
# to configure any option before calling [StartTaskExecution][1].
|
3620
|
+
#
|
3621
|
+
# You also can override your task options for each task execution. For
|
3622
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
3623
|
+
# execution.
|
3624
|
+
#
|
3625
|
+
#
|
3626
|
+
#
|
3627
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
3599
3628
|
#
|
3600
3629
|
# @option params [Array<Types::FilterRule>] :includes
|
3601
3630
|
# Specifies a list of filter rules that determines which files to
|
@@ -4347,11 +4376,11 @@ module Aws::DataSync
|
|
4347
4376
|
req.send_request(options)
|
4348
4377
|
end
|
4349
4378
|
|
4350
|
-
# Updates the configuration of
|
4379
|
+
# Updates the configuration of a *task*, which defines where and how
|
4380
|
+
# DataSync transfers your data.
|
4351
4381
|
#
|
4352
4382
|
# @option params [required, String] :task_arn
|
4353
|
-
#
|
4354
|
-
# update.
|
4383
|
+
# Specifies the ARN of the task that you want to update.
|
4355
4384
|
#
|
4356
4385
|
# @option params [Types::Options] :options
|
4357
4386
|
# Indicates how your transfer task is configured. These options include
|
@@ -4360,40 +4389,46 @@ module Aws::DataSync
|
|
4360
4389
|
# integrity, set bandwidth limits for your task, among other options.
|
4361
4390
|
#
|
4362
4391
|
# Each option has a default value. Unless you need to, you don't have
|
4363
|
-
# to configure any
|
4392
|
+
# to configure any option before calling [StartTaskExecution][1].
|
4393
|
+
#
|
4394
|
+
# You also can override your task options for each task execution. For
|
4395
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
4396
|
+
# execution.
|
4397
|
+
#
|
4398
|
+
#
|
4399
|
+
#
|
4400
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
4364
4401
|
#
|
4365
4402
|
# @option params [Array<Types::FilterRule>] :excludes
|
4366
|
-
# Specifies
|
4367
|
-
# your
|
4368
|
-
#
|
4403
|
+
# Specifies exclude filters that define the files, objects, and folders
|
4404
|
+
# in your source location that you don't want DataSync to transfer. For
|
4405
|
+
# more information and examples, see [Specifying what DataSync transfers
|
4406
|
+
# by using filters][1].
|
4369
4407
|
#
|
4370
4408
|
#
|
4371
4409
|
#
|
4372
4410
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
4373
4411
|
#
|
4374
4412
|
# @option params [Types::TaskSchedule] :schedule
|
4375
|
-
# Specifies a schedule
|
4376
|
-
#
|
4377
|
-
# hourly, daily, weekly or on specific days of the week. You control
|
4378
|
-
# when in the day or hour you want the task to execute. The time you
|
4379
|
-
# specify is UTC time. For more information, see [Scheduling your
|
4380
|
-
# task][1].
|
4413
|
+
# Specifies a schedule for when you want your task to run. For more
|
4414
|
+
# information, see [Scheduling your task][1].
|
4381
4415
|
#
|
4382
4416
|
#
|
4383
4417
|
#
|
4384
4418
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
4385
4419
|
#
|
4386
4420
|
# @option params [String] :name
|
4387
|
-
#
|
4421
|
+
# Specifies the name of your task.
|
4388
4422
|
#
|
4389
4423
|
# @option params [String] :cloud_watch_log_group_arn
|
4390
|
-
#
|
4391
|
-
#
|
4424
|
+
# Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
|
4425
|
+
# group for monitoring your task.
|
4392
4426
|
#
|
4393
4427
|
# @option params [Array<Types::FilterRule>] :includes
|
4394
|
-
# Specifies
|
4395
|
-
# your
|
4396
|
-
#
|
4428
|
+
# Specifies include filters define the files, objects, and folders in
|
4429
|
+
# your source location that you want DataSync to transfer. For more
|
4430
|
+
# information and examples, see [Specifying what DataSync transfers by
|
4431
|
+
# using filters][1].
|
4397
4432
|
#
|
4398
4433
|
#
|
4399
4434
|
#
|
@@ -4465,6 +4500,7 @@ module Aws::DataSync
|
|
4465
4500
|
# ],
|
4466
4501
|
# schedule: {
|
4467
4502
|
# schedule_expression: "ScheduleExpressionCron", # required
|
4503
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
4468
4504
|
# },
|
4469
4505
|
# name: "TagValue",
|
4470
4506
|
# cloud_watch_log_group_arn: "LogGroupArn",
|
@@ -4542,7 +4578,15 @@ module Aws::DataSync
|
|
4542
4578
|
# integrity, set bandwidth limits for your task, among other options.
|
4543
4579
|
#
|
4544
4580
|
# Each option has a default value. Unless you need to, you don't have
|
4545
|
-
# to configure any
|
4581
|
+
# to configure any option before calling [StartTaskExecution][1].
|
4582
|
+
#
|
4583
|
+
# You also can override your task options for each task execution. For
|
4584
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
4585
|
+
# execution.
|
4586
|
+
#
|
4587
|
+
#
|
4588
|
+
#
|
4589
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
4546
4590
|
#
|
4547
4591
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4548
4592
|
#
|
@@ -4591,7 +4635,7 @@ module Aws::DataSync
|
|
4591
4635
|
params: params,
|
4592
4636
|
config: config)
|
4593
4637
|
context[:gem_name] = 'aws-sdk-datasync'
|
4594
|
-
context[:gem_version] = '1.
|
4638
|
+
context[:gem_version] = '1.75.0'
|
4595
4639
|
Seahorse::Client::Request.new(handlers, context)
|
4596
4640
|
end
|
4597
4641
|
|
@@ -267,7 +267,10 @@ module Aws::DataSync
|
|
267
267
|
S3ObjectVersionId = Shapes::StringShape.new(name: 'S3ObjectVersionId')
|
268
268
|
S3StorageClass = Shapes::StringShape.new(name: 'S3StorageClass')
|
269
269
|
S3Subdirectory = Shapes::StringShape.new(name: 'S3Subdirectory')
|
270
|
+
ScheduleDisabledBy = Shapes::StringShape.new(name: 'ScheduleDisabledBy')
|
271
|
+
ScheduleDisabledReason = Shapes::StringShape.new(name: 'ScheduleDisabledReason')
|
270
272
|
ScheduleExpressionCron = Shapes::StringShape.new(name: 'ScheduleExpressionCron')
|
273
|
+
ScheduleStatus = Shapes::StringShape.new(name: 'ScheduleStatus')
|
271
274
|
SecretsManagerArn = Shapes::StringShape.new(name: 'SecretsManagerArn')
|
272
275
|
ServerHostname = Shapes::StringShape.new(name: 'ServerHostname')
|
273
276
|
SmbDomain = Shapes::StringShape.new(name: 'SmbDomain')
|
@@ -311,6 +314,7 @@ module Aws::DataSync
|
|
311
314
|
TaskQueueing = Shapes::StringShape.new(name: 'TaskQueueing')
|
312
315
|
TaskReportConfig = Shapes::StructureShape.new(name: 'TaskReportConfig')
|
313
316
|
TaskSchedule = Shapes::StructureShape.new(name: 'TaskSchedule')
|
317
|
+
TaskScheduleDetails = Shapes::StructureShape.new(name: 'TaskScheduleDetails')
|
314
318
|
TaskStatus = Shapes::StringShape.new(name: 'TaskStatus')
|
315
319
|
Throughput = Shapes::StructureShape.new(name: 'Throughput')
|
316
320
|
Time = Shapes::TimestampShape.new(name: 'Time')
|
@@ -799,6 +803,7 @@ module Aws::DataSync
|
|
799
803
|
DescribeTaskResponse.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes"))
|
800
804
|
DescribeTaskResponse.add_member(:manifest_config, Shapes::ShapeRef.new(shape: ManifestConfig, location_name: "ManifestConfig"))
|
801
805
|
DescribeTaskResponse.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig"))
|
806
|
+
DescribeTaskResponse.add_member(:schedule_details, Shapes::ShapeRef.new(shape: TaskScheduleDetails, location_name: "ScheduleDetails"))
|
802
807
|
DescribeTaskResponse.struct_class = Types::DescribeTaskResponse
|
803
808
|
|
804
809
|
DestinationNetworkInterfaceArns.member = Shapes::ShapeRef.new(shape: NetworkInterfaceArn)
|
@@ -1229,8 +1234,14 @@ module Aws::DataSync
|
|
1229
1234
|
TaskReportConfig.struct_class = Types::TaskReportConfig
|
1230
1235
|
|
1231
1236
|
TaskSchedule.add_member(:schedule_expression, Shapes::ShapeRef.new(shape: ScheduleExpressionCron, required: true, location_name: "ScheduleExpression"))
|
1237
|
+
TaskSchedule.add_member(:status, Shapes::ShapeRef.new(shape: ScheduleStatus, location_name: "Status"))
|
1232
1238
|
TaskSchedule.struct_class = Types::TaskSchedule
|
1233
1239
|
|
1240
|
+
TaskScheduleDetails.add_member(:status_update_time, Shapes::ShapeRef.new(shape: Time, location_name: "StatusUpdateTime"))
|
1241
|
+
TaskScheduleDetails.add_member(:disabled_reason, Shapes::ShapeRef.new(shape: ScheduleDisabledReason, location_name: "DisabledReason"))
|
1242
|
+
TaskScheduleDetails.add_member(:disabled_by, Shapes::ShapeRef.new(shape: ScheduleDisabledBy, location_name: "DisabledBy"))
|
1243
|
+
TaskScheduleDetails.struct_class = Types::TaskScheduleDetails
|
1244
|
+
|
1234
1245
|
Throughput.add_member(:read, Shapes::ShapeRef.new(shape: NonNegativeDouble, location_name: "Read"))
|
1235
1246
|
Throughput.add_member(:write, Shapes::ShapeRef.new(shape: NonNegativeDouble, location_name: "Write"))
|
1236
1247
|
Throughput.add_member(:other, Shapes::ShapeRef.new(shape: NonNegativeDouble, location_name: "Other"))
|
@@ -1252,41 +1252,32 @@ module Aws::DataSync
|
|
1252
1252
|
# CreateTaskRequest
|
1253
1253
|
#
|
1254
1254
|
# @!attribute [rw] source_location_arn
|
1255
|
-
#
|
1255
|
+
# Specifies the ARN of your transfer's source location.
|
1256
1256
|
# @return [String]
|
1257
1257
|
#
|
1258
1258
|
# @!attribute [rw] destination_location_arn
|
1259
|
-
#
|
1260
|
-
# resource's location.
|
1259
|
+
# Specifies the ARN of your transfer's destination location.
|
1261
1260
|
# @return [String]
|
1262
1261
|
#
|
1263
1262
|
# @!attribute [rw] cloud_watch_log_group_arn
|
1264
|
-
#
|
1265
|
-
#
|
1263
|
+
# Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
|
1264
|
+
# group for monitoring your task.
|
1266
1265
|
# @return [String]
|
1267
1266
|
#
|
1268
1267
|
# @!attribute [rw] name
|
1269
|
-
#
|
1270
|
-
# identify the task in the console.
|
1268
|
+
# Specifies the name of your task.
|
1271
1269
|
# @return [String]
|
1272
1270
|
#
|
1273
1271
|
# @!attribute [rw] options
|
1274
|
-
# Specifies
|
1275
|
-
#
|
1276
|
-
#
|
1277
|
-
# You can also override these options before starting an individual
|
1278
|
-
# run of a task (also known as a *task execution*). For more
|
1279
|
-
# information, see [StartTaskExecution][1].
|
1280
|
-
#
|
1281
|
-
#
|
1282
|
-
#
|
1283
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
1272
|
+
# Specifies your task's settings, such as preserving file metadata,
|
1273
|
+
# verifying data integrity, among other options.
|
1284
1274
|
# @return [Types::Options]
|
1285
1275
|
#
|
1286
1276
|
# @!attribute [rw] excludes
|
1287
|
-
# Specifies
|
1288
|
-
# your
|
1289
|
-
#
|
1277
|
+
# Specifies exclude filters that define the files, objects, and
|
1278
|
+
# folders in your source location that you don't want DataSync to
|
1279
|
+
# transfer. For more information and examples, see [Specifying what
|
1280
|
+
# DataSync transfers by using filters][1].
|
1290
1281
|
#
|
1291
1282
|
#
|
1292
1283
|
#
|
@@ -1294,9 +1285,8 @@ module Aws::DataSync
|
|
1294
1285
|
# @return [Array<Types::FilterRule>]
|
1295
1286
|
#
|
1296
1287
|
# @!attribute [rw] schedule
|
1297
|
-
# Specifies a schedule
|
1298
|
-
#
|
1299
|
-
# in UTC time. For more information, see [Scheduling your task][1].
|
1288
|
+
# Specifies a schedule for when you want your task to run. For more
|
1289
|
+
# information, see [Scheduling your task][1].
|
1300
1290
|
#
|
1301
1291
|
#
|
1302
1292
|
#
|
@@ -1304,17 +1294,17 @@ module Aws::DataSync
|
|
1304
1294
|
# @return [Types::TaskSchedule]
|
1305
1295
|
#
|
1306
1296
|
# @!attribute [rw] tags
|
1307
|
-
# Specifies the tags that you want to apply to
|
1308
|
-
# Name (ARN) representing the task.
|
1297
|
+
# Specifies the tags that you want to apply to your task.
|
1309
1298
|
#
|
1310
1299
|
# *Tags* are key-value pairs that help you manage, filter, and search
|
1311
1300
|
# for your DataSync resources.
|
1312
1301
|
# @return [Array<Types::TagListEntry>]
|
1313
1302
|
#
|
1314
1303
|
# @!attribute [rw] includes
|
1315
|
-
# Specifies
|
1316
|
-
# your
|
1317
|
-
#
|
1304
|
+
# Specifies include filters define the files, objects, and folders in
|
1305
|
+
# your source location that you want DataSync to transfer. For more
|
1306
|
+
# information and examples, see [Specifying what DataSync transfers by
|
1307
|
+
# using filters][1].
|
1318
1308
|
#
|
1319
1309
|
#
|
1320
1310
|
#
|
@@ -2580,7 +2570,15 @@ module Aws::DataSync
|
|
2580
2570
|
# options.
|
2581
2571
|
#
|
2582
2572
|
# Each option has a default value. Unless you need to, you don't have
|
2583
|
-
# to configure any
|
2573
|
+
# to configure any option before calling [StartTaskExecution][1].
|
2574
|
+
#
|
2575
|
+
# You also can override your task options for each task execution. For
|
2576
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
2577
|
+
# execution.
|
2578
|
+
#
|
2579
|
+
#
|
2580
|
+
#
|
2581
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
2584
2582
|
# @return [Types::Options]
|
2585
2583
|
#
|
2586
2584
|
# @!attribute [rw] excludes
|
@@ -2755,7 +2753,8 @@ module Aws::DataSync
|
|
2755
2753
|
# DescribeTaskRequest
|
2756
2754
|
#
|
2757
2755
|
# @!attribute [rw] task_arn
|
2758
|
-
# Specifies the Amazon Resource Name (ARN) of the transfer task
|
2756
|
+
# Specifies the Amazon Resource Name (ARN) of the transfer task that
|
2757
|
+
# you want information about.
|
2759
2758
|
# @return [String]
|
2760
2759
|
#
|
2761
2760
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskRequest AWS API Documentation
|
@@ -2769,47 +2768,49 @@ module Aws::DataSync
|
|
2769
2768
|
# DescribeTaskResponse
|
2770
2769
|
#
|
2771
2770
|
# @!attribute [rw] task_arn
|
2772
|
-
# The
|
2771
|
+
# The ARN of your task.
|
2773
2772
|
# @return [String]
|
2774
2773
|
#
|
2775
2774
|
# @!attribute [rw] status
|
2776
|
-
# The status of
|
2775
|
+
# The status of your task. For information about what each status
|
2776
|
+
# means, see [Task statuses][1].
|
2777
|
+
#
|
2777
2778
|
#
|
2778
|
-
#
|
2779
|
-
#
|
2779
|
+
#
|
2780
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-creation-statuses
|
2780
2781
|
# @return [String]
|
2781
2782
|
#
|
2782
2783
|
# @!attribute [rw] name
|
2783
|
-
# The name of
|
2784
|
+
# The name of your task.
|
2784
2785
|
# @return [String]
|
2785
2786
|
#
|
2786
2787
|
# @!attribute [rw] current_task_execution_arn
|
2787
|
-
# The
|
2788
|
-
# transferring files.
|
2788
|
+
# The ARN of the most recent task execution.
|
2789
2789
|
# @return [String]
|
2790
2790
|
#
|
2791
2791
|
# @!attribute [rw] source_location_arn
|
2792
|
-
# The
|
2793
|
-
# location.
|
2792
|
+
# The ARN of your transfer's source location.
|
2794
2793
|
# @return [String]
|
2795
2794
|
#
|
2796
2795
|
# @!attribute [rw] destination_location_arn
|
2797
|
-
# The
|
2798
|
-
# resource's location.
|
2796
|
+
# The ARN of your transfer's destination location.
|
2799
2797
|
# @return [String]
|
2800
2798
|
#
|
2801
2799
|
# @!attribute [rw] cloud_watch_log_group_arn
|
2802
|
-
# The Amazon Resource Name (ARN) of
|
2803
|
-
#
|
2800
|
+
# The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for
|
2801
|
+
# monitoring your task.
|
2804
2802
|
#
|
2805
|
-
# For more information
|
2806
|
-
#
|
2803
|
+
# For more information, see [Monitoring DataSync with Amazon
|
2804
|
+
# CloudWatch][1].
|
2805
|
+
#
|
2806
|
+
#
|
2807
|
+
#
|
2808
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html
|
2807
2809
|
# @return [String]
|
2808
2810
|
#
|
2809
2811
|
# @!attribute [rw] source_network_interface_arns
|
2810
|
-
# The
|
2811
|
-
#
|
2812
|
-
# interface requirements][1].
|
2812
|
+
# The ARNs of the [network interfaces][1] that DataSync created for
|
2813
|
+
# your source location.
|
2813
2814
|
#
|
2814
2815
|
#
|
2815
2816
|
#
|
@@ -2817,9 +2818,8 @@ module Aws::DataSync
|
|
2817
2818
|
# @return [Array<String>]
|
2818
2819
|
#
|
2819
2820
|
# @!attribute [rw] destination_network_interface_arns
|
2820
|
-
# The
|
2821
|
-
#
|
2822
|
-
# interface requirements][1].
|
2821
|
+
# The ARNs of the [network interfaces][1] that DataSync created for
|
2822
|
+
# your destination location.
|
2823
2823
|
#
|
2824
2824
|
#
|
2825
2825
|
#
|
@@ -2827,22 +2827,16 @@ module Aws::DataSync
|
|
2827
2827
|
# @return [Array<String>]
|
2828
2828
|
#
|
2829
2829
|
# @!attribute [rw] options
|
2830
|
-
# The
|
2831
|
-
#
|
2832
|
-
#
|
2833
|
-
#
|
2834
|
-
# You can override these options for each task execution. For more
|
2835
|
-
# information, see [StartTaskExecution][1].
|
2836
|
-
#
|
2837
|
-
#
|
2838
|
-
#
|
2839
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
2830
|
+
# The task's settings. For example, what file metadata gets
|
2831
|
+
# preserved, how data integrity gets verified at the end of your
|
2832
|
+
# transfer, bandwidth limits, among other options.
|
2840
2833
|
# @return [Types::Options]
|
2841
2834
|
#
|
2842
2835
|
# @!attribute [rw] excludes
|
2843
|
-
#
|
2844
|
-
#
|
2845
|
-
#
|
2836
|
+
# The exclude filters that define the files, objects, and folders in
|
2837
|
+
# your source location that you don't want DataSync to transfer. For
|
2838
|
+
# more information and examples, see [Specifying what DataSync
|
2839
|
+
# transfers by using filters][1].
|
2846
2840
|
#
|
2847
2841
|
#
|
2848
2842
|
#
|
@@ -2850,19 +2844,32 @@ module Aws::DataSync
|
|
2850
2844
|
# @return [Array<Types::FilterRule>]
|
2851
2845
|
#
|
2852
2846
|
# @!attribute [rw] schedule
|
2853
|
-
# The schedule
|
2854
|
-
#
|
2847
|
+
# The schedule for when you want your task to run. For more
|
2848
|
+
# information, see [Scheduling your task][1].
|
2849
|
+
#
|
2850
|
+
#
|
2851
|
+
#
|
2852
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
2855
2853
|
# @return [Types::TaskSchedule]
|
2856
2854
|
#
|
2857
2855
|
# @!attribute [rw] error_code
|
2858
|
-
#
|
2859
|
-
#
|
2856
|
+
# If there's an issue with your task, you can use the error code to
|
2857
|
+
# help you troubleshoot the problem. For more information, see
|
2858
|
+
# [Troubleshooting issues with DataSync transfers][1].
|
2859
|
+
#
|
2860
|
+
#
|
2861
|
+
#
|
2862
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html
|
2860
2863
|
# @return [String]
|
2861
2864
|
#
|
2862
2865
|
# @!attribute [rw] error_detail
|
2863
|
-
#
|
2864
|
-
#
|
2865
|
-
# issues.
|
2866
|
+
# If there's an issue with your task, you can use the error details
|
2867
|
+
# to help you troubleshoot the problem. For more information, see
|
2868
|
+
# [Troubleshooting issues with DataSync transfers][1].
|
2869
|
+
#
|
2870
|
+
#
|
2871
|
+
#
|
2872
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html
|
2866
2873
|
# @return [String]
|
2867
2874
|
#
|
2868
2875
|
# @!attribute [rw] creation_time
|
@@ -2870,9 +2877,10 @@ module Aws::DataSync
|
|
2870
2877
|
# @return [Time]
|
2871
2878
|
#
|
2872
2879
|
# @!attribute [rw] includes
|
2873
|
-
#
|
2874
|
-
#
|
2875
|
-
#
|
2880
|
+
# The include filters that define the files, objects, and folders in
|
2881
|
+
# your source location that you want DataSync to transfer. For more
|
2882
|
+
# information and examples, see [Specifying what DataSync transfers by
|
2883
|
+
# using filters][1].
|
2876
2884
|
#
|
2877
2885
|
#
|
2878
2886
|
#
|
@@ -2880,9 +2888,9 @@ module Aws::DataSync
|
|
2880
2888
|
# @return [Array<Types::FilterRule>]
|
2881
2889
|
#
|
2882
2890
|
# @!attribute [rw] manifest_config
|
2883
|
-
# The configuration of the manifest that lists the files or objects
|
2884
|
-
# transfer. For more information, see
|
2885
|
-
# transfers by using a manifest][1].
|
2891
|
+
# The configuration of the manifest that lists the files or objects
|
2892
|
+
# that you want DataSync to transfer. For more information, see
|
2893
|
+
# [Specifying what DataSync transfers by using a manifest][1].
|
2886
2894
|
#
|
2887
2895
|
#
|
2888
2896
|
#
|
@@ -2891,14 +2899,22 @@ module Aws::DataSync
|
|
2891
2899
|
#
|
2892
2900
|
# @!attribute [rw] task_report_config
|
2893
2901
|
# The configuration of your task report, which provides detailed
|
2894
|
-
# information about
|
2895
|
-
#
|
2902
|
+
# information about your DataSync transfer. For more information, see
|
2903
|
+
# [Monitoring your DataSync transfers with task reports][1].
|
2896
2904
|
#
|
2897
2905
|
#
|
2898
2906
|
#
|
2899
2907
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
|
2900
2908
|
# @return [Types::TaskReportConfig]
|
2901
2909
|
#
|
2910
|
+
# @!attribute [rw] schedule_details
|
2911
|
+
# The details about your [task schedule][1].
|
2912
|
+
#
|
2913
|
+
#
|
2914
|
+
#
|
2915
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
2916
|
+
# @return [Types::TaskScheduleDetails]
|
2917
|
+
#
|
2902
2918
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskResponse AWS API Documentation
|
2903
2919
|
#
|
2904
2920
|
class DescribeTaskResponse < Struct.new(
|
@@ -2919,7 +2935,8 @@ module Aws::DataSync
|
|
2919
2935
|
:creation_time,
|
2920
2936
|
:includes,
|
2921
2937
|
:manifest_config,
|
2922
|
-
:task_report_config
|
2938
|
+
:task_report_config,
|
2939
|
+
:schedule_details)
|
2923
2940
|
SENSITIVE = []
|
2924
2941
|
include Aws::Structure
|
2925
2942
|
end
|
@@ -4126,7 +4143,15 @@ module Aws::DataSync
|
|
4126
4143
|
# integrity, set bandwidth limits for your task, among other options.
|
4127
4144
|
#
|
4128
4145
|
# Each option has a default value. Unless you need to, you don't have
|
4129
|
-
# to configure any
|
4146
|
+
# to configure any option before calling [StartTaskExecution][1].
|
4147
|
+
#
|
4148
|
+
# You also can override your task options for each task execution. For
|
4149
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
4150
|
+
# execution.
|
4151
|
+
#
|
4152
|
+
#
|
4153
|
+
#
|
4154
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
4130
4155
|
#
|
4131
4156
|
# @!attribute [rw] verify_mode
|
4132
4157
|
# Specifies how and when DataSync checks the integrity of your data
|
@@ -4146,6 +4171,9 @@ module Aws::DataSync
|
|
4146
4171
|
# DataSync scans the entire source and destination to verify that
|
4147
4172
|
# both locations are fully synchronized.
|
4148
4173
|
#
|
4174
|
+
# If you use a [manifest][2], DataSync only scans and verifies
|
4175
|
+
# what's listed in the manifest.
|
4176
|
+
#
|
4149
4177
|
# You can't use this option when transferring to S3 Glacier
|
4150
4178
|
# Flexible Retrieval or S3 Glacier Deep Archive storage classes. For
|
4151
4179
|
# more information, see [Storage class considerations with Amazon S3
|
@@ -4158,6 +4186,7 @@ module Aws::DataSync
|
|
4158
4186
|
#
|
4159
4187
|
#
|
4160
4188
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
|
4189
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
|
4161
4190
|
# @return [String]
|
4162
4191
|
#
|
4163
4192
|
# @!attribute [rw] overwrite_mode
|
@@ -4481,18 +4510,6 @@ module Aws::DataSync
|
|
4481
4510
|
#
|
4482
4511
|
# @!attribute [rw] version
|
4483
4512
|
# The version of the DataSync agent.
|
4484
|
-
#
|
4485
|
-
# On December 7, 2023, we discontinued version 1 DataSync agents.
|
4486
|
-
# Check the DataSync console to see if you have affected agents. If
|
4487
|
-
# you do, [replace][1] those agents or [delete][2] them if they
|
4488
|
-
# aren't in use. If you need more help, contact [Amazon Web Services
|
4489
|
-
# Support][3].
|
4490
|
-
#
|
4491
|
-
#
|
4492
|
-
#
|
4493
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html
|
4494
|
-
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/deleting-agent.html
|
4495
|
-
# [3]: https://aws.amazon.com/contact-us/
|
4496
4513
|
# @return [String]
|
4497
4514
|
#
|
4498
4515
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Platform AWS API Documentation
|
@@ -5060,7 +5077,15 @@ module Aws::DataSync
|
|
5060
5077
|
# options.
|
5061
5078
|
#
|
5062
5079
|
# Each option has a default value. Unless you need to, you don't have
|
5063
|
-
# to configure any
|
5080
|
+
# to configure any option before calling [StartTaskExecution][1].
|
5081
|
+
#
|
5082
|
+
# You also can override your task options for each task execution. For
|
5083
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
5084
|
+
# execution.
|
5085
|
+
#
|
5086
|
+
#
|
5087
|
+
#
|
5088
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
5064
5089
|
# @return [Types::Options]
|
5065
5090
|
#
|
5066
5091
|
# @!attribute [rw] includes
|
@@ -5470,23 +5495,97 @@ module Aws::DataSync
|
|
5470
5495
|
include Aws::Structure
|
5471
5496
|
end
|
5472
5497
|
|
5473
|
-
#
|
5474
|
-
#
|
5475
|
-
# Rules][1].
|
5498
|
+
# Configures your DataSync task to run on a [schedule][1] (at a minimum
|
5499
|
+
# interval of 1 hour).
|
5476
5500
|
#
|
5477
5501
|
#
|
5478
5502
|
#
|
5479
|
-
# [1]: https://docs.aws.amazon.com/
|
5503
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
5480
5504
|
#
|
5481
5505
|
# @!attribute [rw] schedule_expression
|
5482
|
-
#
|
5483
|
-
#
|
5506
|
+
# Specifies your task schedule by using a cron expression in UTC time.
|
5507
|
+
# For information about cron expression syntax, see the [ *Amazon
|
5508
|
+
# EventBridge User Guide* ][1].
|
5509
|
+
#
|
5510
|
+
#
|
5511
|
+
#
|
5512
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html
|
5513
|
+
# @return [String]
|
5514
|
+
#
|
5515
|
+
# @!attribute [rw] status
|
5516
|
+
# Specifies whether to enable or disable your task schedule. Your
|
5517
|
+
# schedule is enabled by default, but there can be situations where
|
5518
|
+
# you need to disable it. For example, you might need to pause a
|
5519
|
+
# recurring transfer or fix an issue with your task or perform
|
5520
|
+
# maintenance on your storage system.
|
5521
|
+
#
|
5522
|
+
# DataSync might disable your schedule automatically if your task
|
5523
|
+
# fails repeatedly with the same error. For more information, see
|
5524
|
+
# [TaskScheduleDetails][1].
|
5525
|
+
#
|
5526
|
+
#
|
5527
|
+
#
|
5528
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html
|
5484
5529
|
# @return [String]
|
5485
5530
|
#
|
5486
5531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskSchedule AWS API Documentation
|
5487
5532
|
#
|
5488
5533
|
class TaskSchedule < Struct.new(
|
5489
|
-
:schedule_expression
|
5534
|
+
:schedule_expression,
|
5535
|
+
:status)
|
5536
|
+
SENSITIVE = []
|
5537
|
+
include Aws::Structure
|
5538
|
+
end
|
5539
|
+
|
5540
|
+
# Provides information about your DataSync [task schedule][1].
|
5541
|
+
#
|
5542
|
+
#
|
5543
|
+
#
|
5544
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
5545
|
+
#
|
5546
|
+
# @!attribute [rw] status_update_time
|
5547
|
+
# Indicates the last time the status of your task schedule changed.
|
5548
|
+
# For example, if DataSync automatically disables your schedule
|
5549
|
+
# because of a repeated error, you can see when the schedule was
|
5550
|
+
# disabled.
|
5551
|
+
# @return [Time]
|
5552
|
+
#
|
5553
|
+
# @!attribute [rw] disabled_reason
|
5554
|
+
# Provides a reason if the task schedule is disabled.
|
5555
|
+
#
|
5556
|
+
# If your schedule is disabled by `USER`, you see a `Manually disabled
|
5557
|
+
# by user.` message.
|
5558
|
+
#
|
5559
|
+
# If your schedule is disabled by `SERVICE`, you see an error message
|
5560
|
+
# to help you understand why the task keeps failing. For information
|
5561
|
+
# on resolving DataSync errors, see [Troubleshooting issues with
|
5562
|
+
# DataSync transfers][1].
|
5563
|
+
#
|
5564
|
+
#
|
5565
|
+
#
|
5566
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html
|
5567
|
+
# @return [String]
|
5568
|
+
#
|
5569
|
+
# @!attribute [rw] disabled_by
|
5570
|
+
# Indicates how your task schedule was disabled.
|
5571
|
+
#
|
5572
|
+
# * `USER` - Your schedule was manually disabled by using the
|
5573
|
+
# [UpdateTask][1] operation or DataSync console.
|
5574
|
+
#
|
5575
|
+
# * `SERVICE` - Your schedule was automatically disabled by DataSync
|
5576
|
+
# because the task failed repeatedly with the same error.
|
5577
|
+
#
|
5578
|
+
#
|
5579
|
+
#
|
5580
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html
|
5581
|
+
# @return [String]
|
5582
|
+
#
|
5583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskScheduleDetails AWS API Documentation
|
5584
|
+
#
|
5585
|
+
class TaskScheduleDetails < Struct.new(
|
5586
|
+
:status_update_time,
|
5587
|
+
:disabled_reason,
|
5588
|
+
:disabled_by)
|
5490
5589
|
SENSITIVE = []
|
5491
5590
|
include Aws::Structure
|
5492
5591
|
end
|
@@ -6021,7 +6120,15 @@ module Aws::DataSync
|
|
6021
6120
|
# options.
|
6022
6121
|
#
|
6023
6122
|
# Each option has a default value. Unless you need to, you don't have
|
6024
|
-
# to configure any
|
6123
|
+
# to configure any option before calling [StartTaskExecution][1].
|
6124
|
+
#
|
6125
|
+
# You also can override your task options for each task execution. For
|
6126
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
6127
|
+
# execution.
|
6128
|
+
#
|
6129
|
+
#
|
6130
|
+
#
|
6131
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
6025
6132
|
# @return [Types::Options]
|
6026
6133
|
#
|
6027
6134
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
|
@@ -6040,8 +6147,7 @@ module Aws::DataSync
|
|
6040
6147
|
# UpdateTaskResponse
|
6041
6148
|
#
|
6042
6149
|
# @!attribute [rw] task_arn
|
6043
|
-
#
|
6044
|
-
# update.
|
6150
|
+
# Specifies the ARN of the task that you want to update.
|
6045
6151
|
# @return [String]
|
6046
6152
|
#
|
6047
6153
|
# @!attribute [rw] options
|
@@ -6052,13 +6158,22 @@ module Aws::DataSync
|
|
6052
6158
|
# options.
|
6053
6159
|
#
|
6054
6160
|
# Each option has a default value. Unless you need to, you don't have
|
6055
|
-
# to configure any
|
6161
|
+
# to configure any option before calling [StartTaskExecution][1].
|
6162
|
+
#
|
6163
|
+
# You also can override your task options for each task execution. For
|
6164
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
6165
|
+
# execution.
|
6166
|
+
#
|
6167
|
+
#
|
6168
|
+
#
|
6169
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
6056
6170
|
# @return [Types::Options]
|
6057
6171
|
#
|
6058
6172
|
# @!attribute [rw] excludes
|
6059
|
-
# Specifies
|
6060
|
-
# your
|
6061
|
-
#
|
6173
|
+
# Specifies exclude filters that define the files, objects, and
|
6174
|
+
# folders in your source location that you don't want DataSync to
|
6175
|
+
# transfer. For more information and examples, see [Specifying what
|
6176
|
+
# DataSync transfers by using filters][1].
|
6062
6177
|
#
|
6063
6178
|
#
|
6064
6179
|
#
|
@@ -6066,12 +6181,8 @@ module Aws::DataSync
|
|
6066
6181
|
# @return [Array<Types::FilterRule>]
|
6067
6182
|
#
|
6068
6183
|
# @!attribute [rw] schedule
|
6069
|
-
# Specifies a schedule
|
6070
|
-
#
|
6071
|
-
# execute hourly, daily, weekly or on specific days of the week. You
|
6072
|
-
# control when in the day or hour you want the task to execute. The
|
6073
|
-
# time you specify is UTC time. For more information, see [Scheduling
|
6074
|
-
# your task][1].
|
6184
|
+
# Specifies a schedule for when you want your task to run. For more
|
6185
|
+
# information, see [Scheduling your task][1].
|
6075
6186
|
#
|
6076
6187
|
#
|
6077
6188
|
#
|
@@ -6079,18 +6190,19 @@ module Aws::DataSync
|
|
6079
6190
|
# @return [Types::TaskSchedule]
|
6080
6191
|
#
|
6081
6192
|
# @!attribute [rw] name
|
6082
|
-
#
|
6193
|
+
# Specifies the name of your task.
|
6083
6194
|
# @return [String]
|
6084
6195
|
#
|
6085
6196
|
# @!attribute [rw] cloud_watch_log_group_arn
|
6086
|
-
#
|
6087
|
-
#
|
6197
|
+
# Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
|
6198
|
+
# group for monitoring your task.
|
6088
6199
|
# @return [String]
|
6089
6200
|
#
|
6090
6201
|
# @!attribute [rw] includes
|
6091
|
-
# Specifies
|
6092
|
-
# your
|
6093
|
-
#
|
6202
|
+
# Specifies include filters define the files, objects, and folders in
|
6203
|
+
# your source location that you want DataSync to transfer. For more
|
6204
|
+
# information and examples, see [Specifying what DataSync transfers by
|
6205
|
+
# using filters][1].
|
6094
6206
|
#
|
6095
6207
|
#
|
6096
6208
|
#
|
data/lib/aws-sdk-datasync.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -445,7 +445,8 @@ module Aws
|
|
445
445
|
},
|
446
446
|
],
|
447
447
|
?schedule: {
|
448
|
-
schedule_expression: ::String
|
448
|
+
schedule_expression: ::String,
|
449
|
+
status: ("ENABLED" | "DISABLED")?
|
449
450
|
},
|
450
451
|
?tags: Array[
|
451
452
|
{
|
@@ -804,6 +805,7 @@ module Aws
|
|
804
805
|
def includes: () -> ::Array[Types::FilterRule]
|
805
806
|
def manifest_config: () -> Types::ManifestConfig
|
806
807
|
def task_report_config: () -> Types::TaskReportConfig
|
808
|
+
def schedule_details: () -> Types::TaskScheduleDetails
|
807
809
|
end
|
808
810
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataSync/Client.html#describe_task-instance_method
|
809
811
|
def describe_task: (
|
@@ -1261,7 +1263,8 @@ module Aws
|
|
1261
1263
|
},
|
1262
1264
|
],
|
1263
1265
|
?schedule: {
|
1264
|
-
schedule_expression: ::String
|
1266
|
+
schedule_expression: ::String,
|
1267
|
+
status: ("ENABLED" | "DISABLED")?
|
1265
1268
|
},
|
1266
1269
|
?name: ::String,
|
1267
1270
|
?cloud_watch_log_group_arn: ::String,
|
data/sig/types.rbs
CHANGED
@@ -606,6 +606,7 @@ module Aws::DataSync
|
|
606
606
|
attr_accessor includes: ::Array[Types::FilterRule]
|
607
607
|
attr_accessor manifest_config: Types::ManifestConfig
|
608
608
|
attr_accessor task_report_config: Types::TaskReportConfig
|
609
|
+
attr_accessor schedule_details: Types::TaskScheduleDetails
|
609
610
|
SENSITIVE: []
|
610
611
|
end
|
611
612
|
|
@@ -1116,6 +1117,14 @@ module Aws::DataSync
|
|
1116
1117
|
|
1117
1118
|
class TaskSchedule
|
1118
1119
|
attr_accessor schedule_expression: ::String
|
1120
|
+
attr_accessor status: ("ENABLED" | "DISABLED")
|
1121
|
+
SENSITIVE: []
|
1122
|
+
end
|
1123
|
+
|
1124
|
+
class TaskScheduleDetails
|
1125
|
+
attr_accessor status_update_time: ::Time
|
1126
|
+
attr_accessor disabled_reason: ::String
|
1127
|
+
attr_accessor disabled_by: ("USER" | "SERVICE")
|
1119
1128
|
SENSITIVE: []
|
1120
1129
|
end
|
1121
1130
|
|
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.
|
4
|
+
version: 1.75.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: 2024-
|
11
|
+
date: 2024-04-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.193.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.193.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|