aws-sdk-datasync 1.21.1 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ef6ca6f933929246e4fb6d7bba0488a698165c21ff04036f0a1ed57c9d1be34
-  data.tar.gz: 87c8e56a62db4463ceada76e91f9c2351f154708eb425b8cb038bc4d1a21e238
+  metadata.gz: 6df012c3054935f1a7383c858e7d705aedb11e98af086f47ff45db56d9b60507
+  data.tar.gz: 88ff308a72fe61f2913010bfa581685a8cc0a216bf94c39b8d397744dfaea6fb
 SHA512:
-  metadata.gz: a5f7f09977dc6e456f034e9ff056db95ff62e04094b3719a3ebfbb3e4e04fb1e868858328f61b5a46a95d4b1acb03228f4b69267b105cd95563f16418889e3c3
-  data.tar.gz: 19887cd0b97993f0d082897792bb0b728f59badb20c29d32db208f5520a00fe649c3ac469f675f73df1a1e49818af40d28c546723cab6a07c86e400c9379d09d
+  metadata.gz: 78eb1ad4c9ef06757818c7786ac19961b8902cceec6c61fb6a1a4a2eb04a8d64204246c6b670400aae9d981d0a1e0f766fd9f29dc55c8134073149683710539c
+  data.tar.gz: ad82c81f96476395ecd635be17f1a626d9c98bf977509cd8a79e6d74384f7ae55eea5a7dfe3960df8b84646959fa9aa048bb8836aacacdfec2195c06df815201

data/lib/aws-sdk-datasync.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -5,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -42,9 +45,9 @@ require_relative 'aws-sdk-datasync/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::DataSync
 
-  GEM_VERSION = '1.21.1'
+  GEM_VERSION = '1.26.0'
 
 end

data/lib/aws-sdk-datasync/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -83,13 +85,28 @@ module Aws::DataSync
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -99,10 +116,10 @@ module Aws::DataSync
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -322,7 +339,7 @@ module Aws::DataSync
 
     # Cancels execution of a task.
     #
-    # When you cancel a task execution, the transfer of some files are
+    # When you cancel a task execution, the transfer of some files is
     # abruptly interrupted. The contents of files that are transferred to
     # the destination might be incomplete or inconsistent with the source
     # files. However, if you start a new task execution on the same task and
@@ -359,7 +376,7 @@ module Aws::DataSync
     # AWS Region where your target locations (in Amazon S3 or Amazon EFS)
     # reside. Your tasks are created in this AWS Region.
     #
-    # You can activate the agent in a VPC (Virtual private Cloud) or provide
+    # You can activate the agent in a VPC (virtual private cloud) or provide
     # the agent access to a VPC endpoint so you can run tasks without going
     # over the public Internet.
     #
@@ -402,11 +419,11 @@ module Aws::DataSync
     #    </note>
     #
     # @option params [String] :vpc_endpoint_id
-    #   The ID of the VPC (Virtual Private Cloud) endpoint that the agent has
+    #   The ID of the VPC (virtual private cloud) endpoint that the agent has
     #   access to. This is the client-side VPC endpoint, also called a
     #   PrivateLink. If you don't have a PrivateLink VPC endpoint, see
-    #   [Creating a VPC Endpoint Service Configuration][1] in the AWS VPC User
-    #   Guide.
+    #   [Creating a VPC Endpoint Service Configuration][1] in the Amazon VPC
+    #   User Guide.
     #
     #   VPC endpoint ID looks like this: `vpce-01234d5aff67890e1`.
     #
@@ -469,7 +486,7 @@ module Aws::DataSync
     #   data to the EFS destination. By default, AWS DataSync uses the root
     #   directory.
     #
-    #   <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example
+    #   <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example,
     #   `/path/to/folder`.
     #
     #    </note>
@@ -608,7 +625,7 @@ module Aws::DataSync
     end
 
     # Defines a file system on a Network File System (NFS) server that can
-    # be read from or written to
+    # be read from or written to.
     #
     # @option params [required, String] :subdirectory
     #   The subdirectory in the NFS file system that is used to read data from
@@ -631,24 +648,45 @@ module Aws::DataSync
     #   files. For the agent to access directories, you must additionally
     #   enable all execute access.
     #
+    #   If you are copying data to or from your AWS Snowcone device, see [NFS
+    #   Server on AWS Snowcone][1] for more information.
+    #
     #   For information about NFS export configuration, see 18.7. The
     #   /etc/exports Configuration File in the Red Hat Enterprise Linux
     #   documentation.
     #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone
+    #
     # @option params [required, String] :server_hostname
     #   The name of the NFS server. This value is the IP address or Domain
     #   Name Service (DNS) name of the NFS server. An agent that is installed
     #   on-premises uses this host name to mount the NFS server in a network.
     #
+    #   If you are copying data to or from your AWS Snowcone device, see [NFS
+    #   Server on AWS Snowcone][1] for more information.
+    #
     #   <note markdown="1"> This name must either be DNS-compliant or must be an IP version 4
     #   (IPv4) address.
     #
     #    </note>
     #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone
+    #
     # @option params [required, Types::OnPremConfig] :on_prem_config
     #   Contains a list of Amazon Resource Names (ARNs) of agents that are
     #   used to connect to an NFS server.
     #
+    #   If you are copying data to or from your AWS Snowcone device, see [NFS
+    #   Server on AWS Snowcone][1] for more information.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone
+    #
     # @option params [Types::NfsMountOptions] :mount_options
     #   The NFS mount options that DataSync can use to mount your NFS share.
     #
@@ -693,6 +731,85 @@ module Aws::DataSync
       req.send_request(options)
     end
 
+    # Creates an endpoint for a self-managed object storage bucket.
+    #
+    # @option params [required, String] :server_hostname
+    #   The name of the self-managed object storage server. This value is the
+    #   IP address or Domain Name Service (DNS) name of the object storage
+    #   server. An agent uses this host name to mount the object storage
+    #   server in a network.
+    #
+    # @option params [Integer] :server_port
+    #   The port that your self-managed object storage server accepts inbound
+    #   network traffic on. The server port is set by default to TCP 80 (HTTP)
+    #   or TCP 443 (HTTPS). You can specify a custom port if your self-managed
+    #   object storage server requires one.
+    #
+    # @option params [String] :server_protocol
+    #   The protocol that the object storage server uses to communicate. Valid
+    #   values are HTTP or HTTPS.
+    #
+    # @option params [String] :subdirectory
+    #   The subdirectory in the self-managed object storage server that is
+    #   used to read data from.
+    #
+    # @option params [required, String] :bucket_name
+    #   The bucket on the self-managed object storage server that is used to
+    #   read data from.
+    #
+    # @option params [String] :access_key
+    #   Optional. The access key is used if credentials are required to access
+    #   the self-managed object storage server.
+    #
+    # @option params [String] :secret_key
+    #   Optional. The secret key is used if credentials are required to access
+    #   the self-managed object storage server.
+    #
+    # @option params [required, Array<String>] :agent_arns
+    #   The Amazon Resource Name (ARN) of the agents associated with the
+    #   self-managed object storage server location.
+    #
+    # @option params [Array<Types::TagListEntry>] :tags
+    #   The key-value pair that represents the tag that you want to add to the
+    #   location. The value can be an empty string. We recommend using tags to
+    #   name your resources.
+    #
+    # @return [Types::CreateLocationObjectStorageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateLocationObjectStorageResponse#location_arn #location_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_location_object_storage({
+    #     server_hostname: "ServerHostname", # required
+    #     server_port: 1,
+    #     server_protocol: "HTTPS", # accepts HTTPS, HTTP
+    #     subdirectory: "S3Subdirectory",
+    #     bucket_name: "ObjectStorageBucketName", # required
+    #     access_key: "ObjectStorageAccessKey",
+    #     secret_key: "ObjectStorageSecretKey",
+    #     agent_arns: ["AgentArn"], # required
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue",
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.location_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationObjectStorage AWS API Documentation
+    #
+    # @overload create_location_object_storage(params = {})
+    # @param [Hash] params ({})
+    def create_location_object_storage(params = {}, options = {})
+      req = build_request(:create_location_object_storage, params)
+      req.send_request(options)
+    end
+
     # Creates an endpoint for an Amazon S3 bucket.
     #
     # For AWS DataSync to access a destination S3 bucket, it needs an AWS
@@ -772,7 +889,7 @@ module Aws::DataSync
       req.send_request(options)
     end
 
-    # Defines a file system on an Server Message Block (SMB) server that can
+    # Defines a file system on a Server Message Block (SMB) server that can
     # be read from or written to.
     #
     # @option params [required, String] :subdirectory
@@ -782,7 +899,7 @@ module Aws::DataSync
     #   subdirectory of that path. The path should be such that it can be
     #   mounted by other SMB clients in your network.
     #
-    #   <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example
+    #   <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example,
     #   `/path/to/folder`.
     #
     #    </note>
@@ -896,12 +1013,6 @@ module Aws::DataSync
     #   The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
     #   is used to monitor and log events in the task.
     #
-    #   For more information on these groups, see Working with Log Groups and
-    #   Log Streams in the *Amazon CloudWatch User Guide.*
-    #
-    #   For more information about how to use CloudWatch Logs with DataSync,
-    #   see Monitoring Your Task in the *AWS DataSync User Guide.*
-    #
     # @option params [String] :name
     #   The name of a task. This value is a text reference that is used to
     #   identify the task in the console.
@@ -914,7 +1025,7 @@ module Aws::DataSync
     #   verification, and so on.
     #
     #   For each individual task execution, you can override these options by
-    #   specifying the `OverrideOptions` before starting a the task execution.
+    #   specifying the `OverrideOptions` before starting the task execution.
     #   For more information, see the operation.
     #
     # @option params [Array<Types::FilterRule>] :excludes
@@ -956,6 +1067,7 @@ module Aws::DataSync
     #       bytes_per_second: 1,
     #       task_queueing: "ENABLED", # accepts ENABLED, DISABLED
     #       log_level: "OFF", # accepts OFF, BASIC, TRANSFER
+    #       transfer_mode: "CHANGED", # accepts CHANGED, ALL
     #     },
     #     excludes: [
     #       {
@@ -1185,10 +1297,10 @@ module Aws::DataSync
       req.send_request(options)
     end
 
-    # Returns metadata, such as the path information, about a NFS location.
+    # Returns metadata, such as the path information, about an NFS location.
     #
     # @option params [required, String] :location_arn
-    #   The Amazon resource Name (ARN) of the NFS location to describe.
+    #   The Amazon Resource Name (ARN) of the NFS location to describe.
     #
     # @return [Types::DescribeLocationNfsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1222,6 +1334,48 @@ module Aws::DataSync
       req.send_request(options)
     end
 
+    # Returns metadata about a self-managed object storage server location.
+    #
+    # @option params [required, String] :location_arn
+    #   The Amazon Resource Name (ARN) of the self-managed object storage
+    #   server location that was described.
+    #
+    # @return [Types::DescribeLocationObjectStorageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeLocationObjectStorageResponse#location_arn #location_arn} => String
+    #   * {Types::DescribeLocationObjectStorageResponse#location_uri #location_uri} => String
+    #   * {Types::DescribeLocationObjectStorageResponse#access_key #access_key} => String
+    #   * {Types::DescribeLocationObjectStorageResponse#server_port #server_port} => Integer
+    #   * {Types::DescribeLocationObjectStorageResponse#server_protocol #server_protocol} => String
+    #   * {Types::DescribeLocationObjectStorageResponse#agent_arns #agent_arns} => Array&lt;String&gt;
+    #   * {Types::DescribeLocationObjectStorageResponse#creation_time #creation_time} => Time
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_location_object_storage({
+    #     location_arn: "LocationArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.location_arn #=> String
+    #   resp.location_uri #=> String
+    #   resp.access_key #=> String
+    #   resp.server_port #=> Integer
+    #   resp.server_protocol #=> String, one of "HTTPS", "HTTP"
+    #   resp.agent_arns #=> Array
+    #   resp.agent_arns[0] #=> String
+    #   resp.creation_time #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationObjectStorage AWS API Documentation
+    #
+    # @overload describe_location_object_storage(params = {})
+    # @param [Hash] params ({})
+    def describe_location_object_storage(params = {}, options = {})
+      req = build_request(:describe_location_object_storage, params)
+      req.send_request(options)
+    end
+
     # Returns metadata, such as bucket name, about an Amazon S3 bucket
     # location.
     #
@@ -1260,11 +1414,11 @@ module Aws::DataSync
       req.send_request(options)
     end
 
-    # Returns metadata, such as the path and user information about a SMB
+    # Returns metadata, such as the path and user information about an SMB
     # location.
     #
     # @option params [required, String] :location_arn
-    #   The Amazon resource Name (ARN) of the SMB location to describe.
+    #   The Amazon Resource Name (ARN) of the SMB location to describe.
     #
     # @return [Types::DescribeLocationSmbResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1356,6 +1510,7 @@ module Aws::DataSync
     #   resp.options.bytes_per_second #=> Integer
     #   resp.options.task_queueing #=> String, one of "ENABLED", "DISABLED"
     #   resp.options.log_level #=> String, one of "OFF", "BASIC", "TRANSFER"
+    #   resp.options.transfer_mode #=> String, one of "CHANGED", "ALL"
     #   resp.excludes #=> Array
     #   resp.excludes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
     #   resp.excludes[0].value #=> String
@@ -1415,6 +1570,7 @@ module Aws::DataSync
     #   resp.options.bytes_per_second #=> Integer
     #   resp.options.task_queueing #=> String, one of "ENABLED", "DISABLED"
     #   resp.options.log_level #=> String, one of "OFF", "BASIC", "TRANSFER"
+    #   resp.options.transfer_mode #=> String, one of "CHANGED", "ALL"
     #   resp.excludes #=> Array
     #   resp.excludes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
     #   resp.excludes[0].value #=> String
@@ -1497,7 +1653,7 @@ module Aws::DataSync
       req.send_request(options)
     end
 
-    # Returns a lists of source and destination locations.
+    # Returns a list of source and destination locations.
     #
     # If you have more locations than are returned in a response (that is,
     # the response returns only a truncated list of your agents), the
@@ -1511,6 +1667,8 @@ module Aws::DataSync
     #   An opaque string that indicates the position at which to begin the
     #   next list of locations.
     #
+    # @option params [Array<Types::LocationFilter>] :filters
+    #
     # @return [Types::ListLocationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListLocationsResponse#locations #locations} => Array&lt;Types::LocationListEntry&gt;
@@ -1523,6 +1681,13 @@ module Aws::DataSync
     #   resp = client.list_locations({
     #     max_results: 1,
     #     next_token: "NextToken",
+    #     filters: [
+    #       {
+    #         name: "LocationUri", # required, accepts LocationUri, LocationType, CreationTime
+    #         values: ["FilterAttributeValue"], # required
+    #         operator: "Equals", # required, accepts Equals, NotEquals, In, LessThanOrEqual, LessThan, GreaterThanOrEqual, GreaterThan, Contains, NotContains, BeginsWith
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -1541,7 +1706,7 @@ module Aws::DataSync
       req.send_request(options)
     end
 
-    # Returns all the tags associated with a specified resources.
+    # Returns all the tags associated with a specified resource.
     #
     # @option params [required, String] :resource_arn
     #   The Amazon Resource Name (ARN) of the resource whose tags to list.
@@ -1637,6 +1802,8 @@ module Aws::DataSync
     #   An opaque string that indicates the position at which to begin the
     #   next list of tasks.
     #
+    # @option params [Array<Types::TaskFilter>] :filters
+    #
     # @return [Types::ListTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListTasksResponse#tasks #tasks} => Array&lt;Types::TaskListEntry&gt;
@@ -1649,6 +1816,13 @@ module Aws::DataSync
     #   resp = client.list_tasks({
     #     max_results: 1,
     #     next_token: "NextToken",
+    #     filters: [
+    #       {
+    #         name: "LocationId", # required, accepts LocationId, CreationTime
+    #         values: ["FilterAttributeValue"], # required
+    #         operator: "Equals", # required, accepts Equals, NotEquals, In, LessThanOrEqual, LessThan, GreaterThanOrEqual, GreaterThan, Contains, NotContains, BeginsWith
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -1720,6 +1894,7 @@ module Aws::DataSync
     #       bytes_per_second: 1,
     #       task_queueing: "ENABLED", # accepts ENABLED, DISABLED
     #       log_level: "OFF", # accepts OFF, BASIC, TRANSFER
+    #       transfer_mode: "CHANGED", # accepts CHANGED, ALL
     #     },
     #     includes: [
     #       {
@@ -1882,6 +2057,7 @@ module Aws::DataSync
     #       bytes_per_second: 1,
     #       task_queueing: "ENABLED", # accepts ENABLED, DISABLED
     #       log_level: "OFF", # accepts OFF, BASIC, TRANSFER
+    #       transfer_mode: "CHANGED", # accepts CHANGED, ALL
     #     },
     #     excludes: [
     #       {
@@ -1918,7 +2094,7 @@ module Aws::DataSync
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-datasync'
-      context[:gem_version] = '1.21.1'
+      context[:gem_version] = '1.26.0'
       Seahorse::Client::Request.new(handlers, context)
     end