Class: Aws::DataSync::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb

Overview

An API client for DataSync. To construct a client, you need to configure a :region and :credentials.

client = Aws::DataSync::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • 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::ECSCredentials - Used for loading credentials from instances running in ECS.

    • 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:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • 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. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See Aws::DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::DataSync::EndpointProvider) —

    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

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



419
420
421
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 419

def initialize(*args)
  super
end

Instance Method Details

#add_storage_system(params = {}) ⇒ Types::AddStorageSystemResponse

Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.

Examples:

Request syntax with placeholder values


resp = client.add_storage_system({
  server_configuration: { # required
    server_hostname: "DiscoveryServerHostname", # required
    server_port: 1,
  },
  system_type: "NetAppONTAP", # required, accepts NetAppONTAP
  agent_arns: ["AgentArn"], # required
  cloud_watch_log_group_arn: "LogGroupArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  name: "Name",
  client_token: "PtolemyUUID", # required
  credentials: { # required
    username: "PtolemyUsername", # required
    password: "PtolemyPassword", # required
  },
})

Response structure


resp.storage_system_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_configuration (required, Types::DiscoveryServerConfiguration) —

    Specifies the server name and network port required to connect with the management interface of your on-premises storage system.

  • :system_type (required, String) —

    Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.

    DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.

  • :agent_arns (required, Array<String>) —

    Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface. You can only specify one ARN.

  • :cloud_watch_log_group_arn (String) —

    Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.

  • :tags (Array<Types::TagListEntry>) —

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your on-premises storage system.

  • :name (String) —

    Specifies a familiar name for your on-premises storage system.

  • :client_token (required, String) —

    Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :credentials (required, Types::Credentials) —

    Specifies the user name and password for accessing your on-premises storage system's management interface.

Returns:

See Also:



506
507
508
509
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 506

def add_storage_system(params = {}, options = {})
  req = build_request(:add_storage_system, params)
  req.send_request(options)
end

#cancel_task_execution(params = {}) ⇒ Struct

Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files.

However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.

Examples:

Request syntax with placeholder values


resp = client.cancel_task_execution({
  task_execution_arn: "TaskExecutionArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_execution_arn (required, String) —

    The Amazon Resource Name (ARN) of the task execution to stop.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



538
539
540
541
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 538

def cancel_task_execution(params = {}, options = {})
  req = build_request(:cancel_task_execution, params)
  req.send_request(options)
end

#create_agent(params = {}) ⇒ Types::CreateAgentResponse

Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.

If you haven't deployed an agent yet, see the following topics to learn more:

If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.

Examples:

Request syntax with placeholder values


resp = client.create_agent({
  activation_key: "ActivationKey", # required
  agent_name: "TagValue",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  vpc_endpoint_id: "VpcEndpointId",
  subnet_arns: ["Ec2SubnetArn"],
  security_group_arns: ["Ec2SecurityGroupArn"],
})

Response structure


resp.agent_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :activation_key (required, String) —

    Specifies your DataSync agent's activation key. If you don't have an activation key, see Activate your agent.

  • :agent_name (String) —

    Specifies a name for your agent. You can see this name in the DataSync console.

  • :tags (Array<Types::TagListEntry>) —

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

  • :vpc_endpoint_id (String) —

    Specifies the ID of the VPC endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

    The VPC endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

  • :subnet_arns (Array<String>) —

    Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

  • :security_group_arns (Array<String>) —

    Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

Returns:

See Also:



637
638
639
640
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 637

def create_agent(params = {}, options = {})
  req = build_request(:create_agent, params)
  req.send_request(options)
end

#create_location_azure_blob(params = {}) ⇒ Types::CreateLocationAzureBlobResponse

Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination.

Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.

Examples:

Request syntax with placeholder values


resp = client.create_location_azure_blob({
  container_url: "AzureBlobContainerUrl", # required
  authentication_type: "SAS", # required, accepts SAS
  sas_configuration: {
    token: "AzureBlobSasToken", # required
  },
  blob_type: "BLOCK", # accepts BLOCK
  access_tier: "HOT", # accepts HOT, COOL, ARCHIVE
  subdirectory: "AzureBlobSubdirectory",
  agent_arns: ["AgentArn"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :container_url (required, String) —

    Specifies the URL of the Azure Blob Storage container involved in your transfer.

  • :authentication_type (required, String) —

    Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).

  • :sas_configuration (Types::AzureBlobSasConfiguration) —

    Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

  • :blob_type (String) —

    Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation.

  • :access_tier (String) —

    Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.

  • :subdirectory (String) —

    Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images).

  • :agent_arns (required, Array<String>) —

    Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

    You can specify more than one agent. For more information, see Using multiple agents for your transfer.

  • :tags (Array<Types::TagListEntry>) —

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

Returns:

See Also:



742
743
744
745
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 742

def create_location_azure_blob(params = {}, options = {})
  req = build_request(:create_location_azure_blob, params)
  req.send_request(options)
end

#create_location_efs(params = {}) ⇒ Types::CreateLocationEfsResponse

Creates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems.

Examples:

Request syntax with placeholder values


resp = client.create_location_efs({
  subdirectory: "EfsSubdirectory",
  efs_filesystem_arn: "EfsFilesystemArn", # required
  ec2_config: { # required
    subnet_arn: "Ec2SubnetArn", # required
    security_group_arns: ["Ec2SecurityGroupArn"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  access_point_arn: "EfsAccessPointArn",
  file_system_access_role_arn: "IamRoleArn",
  in_transit_encryption: "NONE", # accepts NONE, TLS1_2
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subdirectory (String) —

    Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.

    You must specify a value with forward slashes (for example, /path/to/folder).

  • :efs_filesystem_arn (required, String) —

    Specifies the ARN for the Amazon EFS file system.

  • :ec2_config (required, Types::Ec2Config) —

    Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

  • :tags (Array<Types::TagListEntry>) —

    Specifies the key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

  • :access_point_arn (String) —

    Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.

  • :file_system_access_role_arn (String) —

    Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

  • :in_transit_encryption (String) —

    Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.

    If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

Returns:

See Also:



831
832
833
834
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 831

def create_location_efs(params = {}, options = {})
  req = build_request(:create_location_efs, params)
  req.send_request(options)
end

#create_location_fsx_lustre(params = {}) ⇒ Types::CreateLocationFsxLustreResponse

Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems.

Examples:

Request syntax with placeholder values


resp = client.create_location_fsx_lustre({
  fsx_filesystem_arn: "FsxFilesystemArn", # required
  security_group_arns: ["Ec2SecurityGroupArn"], # required
  subdirectory: "FsxLustreSubdirectory",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :fsx_filesystem_arn (required, String) —

    The Amazon Resource Name (ARN) for the FSx for Lustre file system.

  • :security_group_arns (required, Array<String>) —

    The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Lustre file system.

  • :subdirectory (String) —

    A subdirectory in the location's path. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.

  • :tags (Array<Types::TagListEntry>) —

    The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

Returns:

See Also:



891
892
893
894
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 891

def create_location_fsx_lustre(params = {}, options = {})
  req = build_request(:create_location_fsx_lustre, params)
  req.send_request(options)
end

#create_location_fsx_ontap(params = {}) ⇒ Types::CreateLocationFsxOntapResponse

Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems.

Examples:

Request syntax with placeholder values


resp = client.create_location_fsx_ontap({
  protocol: { # required
    nfs: {
      mount_options: {
        version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
      },
    },
    smb: {
      domain: "SmbDomain",
      mount_options: {
        version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3, SMB1, SMB2_0
      },
      password: "SmbPassword", # required
      user: "SmbUser", # required
    },
  },
  security_group_arns: ["Ec2SecurityGroupArn"], # required
  storage_virtual_machine_arn: "StorageVirtualMachineArn", # required
  subdirectory: "FsxOntapSubdirectory",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :protocol (required, Types::FsxProtocol) —

    Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

  • :security_group_arns (required, Array<String>) —

    Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.

    The security groups must allow outbound traffic on the following ports (depending on the protocol you use):

    • Network File System (NFS): TCP ports 111, 635, and 2049

    • Server Message Block (SMB): TCP port 445

    Your file system's security groups must also allow inbound traffic on the same ports.

  • :storage_virtual_machine_arn (required, String) —

    Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.

  • :subdirectory (String) —

    Specifies a path to the file share in the SVM where you'll copy your data.

    You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1.

    Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.

  • :tags (Array<Types::TagListEntry>) —

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

Returns:

See Also:



994
995
996
997
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 994

def create_location_fsx_ontap(params = {}, options = {})
  req = build_request(:create_location_fsx_ontap, params)
  req.send_request(options)
end

#create_location_fsx_open_zfs(params = {}) ⇒ Types::CreateLocationFsxOpenZfsResponse

Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems.

Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.

Examples:

Request syntax with placeholder values


resp = client.create_location_fsx_open_zfs({
  fsx_filesystem_arn: "FsxFilesystemArn", # required
  protocol: { # required
    nfs: {
      mount_options: {
        version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
      },
    },
    smb: {
      domain: "SmbDomain",
      mount_options: {
        version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3, SMB1, SMB2_0
      },
      password: "SmbPassword", # required
      user: "SmbUser", # required
    },
  },
  security_group_arns: ["Ec2SecurityGroupArn"], # required
  subdirectory: "FsxOpenZfsSubdirectory",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :fsx_filesystem_arn (required, String) —

    The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.

  • :protocol (required, Types::FsxProtocol) —

    The type of protocol that DataSync uses to access your file system.

  • :security_group_arns (required, Array<String>) —

    The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.

  • :subdirectory (String) —

    A subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).

  • :tags (Array<Types::TagListEntry>) —

    The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

Returns:

See Also:



1077
1078
1079
1080
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1077

def create_location_fsx_open_zfs(params = {}, options = {})
  req = build_request(:create_location_fsx_open_zfs, params)
  req.send_request(options)
end

#create_location_fsx_windows(params = {}) ⇒ Types::CreateLocationFsxWindowsResponse

Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.

Examples:

Request syntax with placeholder values


resp = client.create_location_fsx_windows({
  subdirectory: "FsxWindowsSubdirectory",
  fsx_filesystem_arn: "FsxFilesystemArn", # required
  security_group_arns: ["Ec2SecurityGroupArn"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  user: "SmbUser", # required
  domain: "SmbDomain",
  password: "SmbPassword", # required
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subdirectory (String) —

    Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).

  • :fsx_filesystem_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

  • :security_group_arns (required, Array<String>) —

    Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.

    If you choose a security group that doesn't allow connections from within itself, do one of the following:

    • Configure the security group to allow it to communicate within itself.

    • Choose a different security group that can communicate with the mount target's security group.

  • :tags (Array<Types::TagListEntry>) —

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

  • :user (required, String) —

    Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

    For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.

  • :domain (String) —

    Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.

    If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.

  • :password (required, String) —

    Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

Returns:

See Also:



1177
1178
1179
1180
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1177

def create_location_fsx_windows(params = {}, options = {})
  req = build_request(:create_location_fsx_windows, params)
  req.send_request(options)
end

#create_location_hdfs(params = {}) ⇒ Types::CreateLocationHdfsResponse

Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses HDFS clusters.

Examples:

Request syntax with placeholder values


resp = client.create_location_hdfs({
  subdirectory: "HdfsSubdirectory",
  name_nodes: [ # required
    {
      hostname: "HdfsServerHostname", # required
      port: 1, # required
    },
  ],
  block_size: 1,
  replication_factor: 1,
  kms_key_provider_uri: "KmsKeyProviderUri",
  qop_configuration: {
    rpc_protection: "DISABLED", # accepts DISABLED, AUTHENTICATION, INTEGRITY, PRIVACY
    data_transfer_protection: "DISABLED", # accepts DISABLED, AUTHENTICATION, INTEGRITY, PRIVACY
  },
  authentication_type: "SIMPLE", # required, accepts SIMPLE, KERBEROS
  simple_user: "HdfsUser",
  kerberos_principal: "KerberosPrincipal",
  kerberos_keytab: "data",
  kerberos_krb_5_conf: "data",
  agent_arns: ["AgentArn"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subdirectory (String) —

    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.

  • :name_nodes (required, Array<Types::HdfsNameNode>) —

    The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.

  • :block_size (Integer) —

    The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).

  • :replication_factor (Integer) —

    The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.

  • :kms_key_provider_uri (String) —

    The URI of the HDFS cluster's Key Management Server (KMS).

  • :qop_configuration (Types::QopConfiguration) —

    The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster. If QopConfiguration isn't specified, RpcProtection and DataTransferProtection default to PRIVACY. If you set RpcProtection or DataTransferProtection, the other parameter assumes the same value.

  • :authentication_type (required, String) —

    The type of authentication used to determine the identity of the user.

  • :simple_user (String) —

    The user name used to identify the client on the host operating system.

    If SIMPLE is specified for AuthenticationType, this parameter is required.

  • :kerberos_principal (String) —

    The Kerberos principal with access to the files and folders on the HDFS cluster.

    If KERBEROS is specified for AuthenticationType, this parameter is required.

  • :kerberos_keytab (String, StringIO, File) —

    The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you're using the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.

    If KERBEROS is specified for AuthenticationType, this parameter is required.

  • :kerberos_krb_5_conf (String, StringIO, File) —

    The krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.

    If KERBEROS is specified for AuthenticationType, this parameter is required.

  • :agent_arns (required, Array<String>) —

    The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.

  • :tags (Array<Types::TagListEntry>) —

    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.

Returns:

See Also:



1321
1322
1323
1324
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1321

def create_location_hdfs(params = {}, options = {})
  req = build_request(:create_location_hdfs, params)
  req.send_request(options)
end

#create_location_nfs(params = {}) ⇒ Types::CreateLocationNfsResponse

Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses NFS file servers.

If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create your transfer location. For more information, see Configuring transfers with Snowcone.

Examples:

Request syntax with placeholder values


resp = client.create_location_nfs({
  subdirectory: "NfsSubdirectory", # required
  server_hostname: "ServerHostname", # required
  on_prem_config: { # required
    agent_arns: ["AgentArn"], # required
  },
  mount_options: {
    version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subdirectory (required, String) —

    Specifies the export path in your NFS file server that you want DataSync to mount.

    This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers.

  • :server_hostname (required, String) —

    Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS file server that your DataSync agent connects to.

  • :on_prem_config (required, Types::OnPremConfig) —

    Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to connect to your NFS file server.

    You can specify more than one agent. For more information, see Using multiple agents for transfers.

  • :mount_options (Types::NfsMountOptions) —

    Specifies the options that DataSync can use to mount your NFS file server.

  • :tags (Array<Types::TagListEntry>) —

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

Returns:

See Also:



1411
1412
1413
1414
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1411

def create_location_nfs(params = {}, options = {})
  req = build_request(:create_location_nfs, params)
  req.send_request(options)
end

#create_location_object_storage(params = {}) ⇒ Types::CreateLocationObjectStorageResponse

Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.

Examples:

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",
    },
  ],
  server_certificate: "data",
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_hostname (required, String) —

    Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.

  • :server_port (Integer) —

    Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

  • :server_protocol (String) —

    Specifies the protocol that your object storage server uses to communicate.

  • :subdirectory (String) —

    Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

  • :bucket_name (required, String) —

    Specifies the name of the object storage bucket involved in the transfer.

  • :access_key (String) —

    Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

  • :secret_key (String) —

    Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

  • :agent_arns (required, Array<String>) —

    Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

  • :tags (Array<Types::TagListEntry>) —

    Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

  • :server_certificate (String, StringIO, File) —

    Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The file you specify must include the following:

    • The certificate of the signing certificate authority (CA)

    • Any intermediate certificates

    • base64 encoding

    • A .pem extension

    The file can be up to 32768 bytes (before base64 encoding).

    To use this parameter, configure ServerProtocol to HTTPS.

Returns:

See Also:



1517
1518
1519
1520
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1517

def create_location_object_storage(params = {}, options = {})
  req = build_request(:create_location_object_storage, params)
  req.send_request(options)
end

#create_location_s3(params = {}) ⇒ Types::CreateLocationS3Response

Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you read the following topics:

For more information, see Configuring transfers with Amazon S3.

Examples:

Request syntax with placeholder values


resp = client.create_location_s3({
  subdirectory: "S3Subdirectory",
  s3_bucket_arn: "S3BucketArn", # required
  s3_storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_INSTANT_RETRIEVAL
  s3_config: { # required
    bucket_access_role_arn: "IamRoleArn", # required
  },
  agent_arns: ["AgentArn"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subdirectory (String) —

    Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).

    DataSync can't transfer objects with a prefix that begins with a slash (/) or includes //, /./, or /../ patterns. For example:

    • /photos

    • photos//2006/January

    • photos/./2006/February

    • photos/../2006/March

  • :s3_bucket_arn (required, String) —

    Specifies the ARN of the S3 bucket that you want to use as a location. (When creating your DataSync task later, you specify whether this location is a transfer source or destination.)

    If your S3 bucket is located on an Outposts resource, you must specify an Amazon S3 access point. For more information, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.

  • :s3_storage_class (String) —

    Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.

    For buckets in Amazon Web Services Regions, the storage class defaults to STANDARD. For buckets on Outposts, the storage class defaults to OUTPOSTS.

    For more information, see Storage class considerations with Amazon S3 transfers.

  • :s3_config (required, Types::S3Config) —

    Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.

    For more information, see Accessing S3 buckets.

  • :agent_arns (Array<String>) — default: Amazon S3 on Outposts only —

    Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.

    For more information, see Deploy your DataSync agent on Outposts.

  • :tags (Array<Types::TagListEntry>) —

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

Returns:

See Also:



1640
1641
1642
1643
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1640

def create_location_s3(params = {}, options = {})
  req = build_request(:create_location_s3, params)
  req.send_request(options)
end

#create_location_smb(params = {}) ⇒ Types::CreateLocationSmbResponse

Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses SMB file servers.

Examples:

Request syntax with placeholder values


resp = client.create_location_smb({
  subdirectory: "SmbSubdirectory", # required
  server_hostname: "ServerHostname", # required
  user: "SmbUser", # required
  domain: "SmbDomain",
  password: "SmbPassword", # required
  agent_arns: ["AgentArn"], # required
  mount_options: {
    version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3, SMB1, SMB2_0
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.location_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subdirectory (required, String) —

    Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

    To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see required permissions for SMB locations.

  • :server_hostname (required, String) —

    Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.

    You can't specify an IP version 6 (IPv6) address.

  • :user (required, String) —

    Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

    For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

  • :domain (String) —

    Specifies the name of the Active Directory domain that your SMB file server belongs to.

    If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

  • :password (required, String) —

    Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

    For more information, see required permissions for SMB locations.

  • :agent_arns (required, Array<String>) —

    Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

  • :mount_options (Types::SmbMountOptions) —

    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

  • :tags (Array<Types::TagListEntry>) —

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

Returns:

See Also:



1754
1755
1756
1757
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1754

def create_location_smb(params = {}, options = {})
  req = build_request(:create_location_smb, params)
  req.send_request(options)
end

#create_task(params = {}) ⇒ Types::CreateTaskResponse

Configures a task, which defines where and how DataSync transfers your data.

A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).

If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.

Examples:

Request syntax with placeholder values


resp = client.create_task({
  source_location_arn: "LocationArn", # required
  destination_location_arn: "LocationArn", # required
  cloud_watch_log_group_arn: "LogGroupArn",
  name: "TagValue",
  options: {
    verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
    overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
    atime: "NONE", # accepts NONE, BEST_EFFORT
    mtime: "NONE", # accepts NONE, PRESERVE
    uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
    gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
    preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
    preserve_devices: "NONE", # accepts NONE, PRESERVE
    posix_permissions: "NONE", # accepts NONE, PRESERVE
    bytes_per_second: 1,
    task_queueing: "ENABLED", # accepts ENABLED, DISABLED
    log_level: "OFF", # accepts OFF, BASIC, TRANSFER
    transfer_mode: "CHANGED", # accepts CHANGED, ALL
    security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
    object_tags: "PRESERVE", # accepts PRESERVE, NONE
  },
  excludes: [
    {
      filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
      value: "FilterValue",
    },
  ],
  schedule: {
    schedule_expression: "ScheduleExpressionCron", # required
    status: "ENABLED", # accepts ENABLED, DISABLED
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  includes: [
    {
      filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
      value: "FilterValue",
    },
  ],
  manifest_config: {
    action: "TRANSFER", # accepts TRANSFER
    format: "CSV", # accepts CSV
    source: {
      s3: { # required
        manifest_object_path: "S3Subdirectory", # required
        bucket_access_role_arn: "IamRoleArn", # required
        s3_bucket_arn: "S3BucketArn", # required
        manifest_object_version_id: "S3ObjectVersionId",
      },
    },
  },
  task_report_config: {
    destination: {
      s3: {
        subdirectory: "S3Subdirectory",
        s3_bucket_arn: "S3BucketArn", # required
        bucket_access_role_arn: "IamRoleArn", # required
      },
    },
    output_type: "SUMMARY_ONLY", # accepts SUMMARY_ONLY, STANDARD
    report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
    object_version_ids: "INCLUDE", # accepts INCLUDE, NONE
    overrides: {
      transferred: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
      verified: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
      deleted: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
      skipped: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
    },
  },
})

Response structure


resp.task_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_location_arn (required, String) —

    Specifies the ARN of your transfer's source location.

  • :destination_location_arn (required, String) —

    Specifies the ARN of your transfer's destination location.

  • :cloud_watch_log_group_arn (String) —

    Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

  • :name (String) —

    Specifies the name of your task.

  • :options (Types::Options) —

    Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

  • :excludes (Array<Types::FilterRule>) —

    Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

  • :schedule (Types::TaskSchedule) —

    Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

  • :tags (Array<Types::TagListEntry>) —

    Specifies the tags that you want to apply to your task.

    Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

  • :includes (Array<Types::FilterRule>) —

    Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

  • :manifest_config (Types::ManifestConfig) —

    Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

    When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

  • :task_report_config (Types::TaskReportConfig) —

    Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

    When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

Returns:

See Also:



1953
1954
1955
1956
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1953

def create_task(params = {}, options = {})
  req = build_request(:create_task, params)
  req.send_request(options)
end

#delete_agent(params = {}) ⇒ Struct

Removes an DataSync agent resource from your Amazon Web Services account.

Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.

Examples:

Request syntax with placeholder values


resp = client.delete_agent({
  agent_arn: "AgentArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_arn (required, String) —

    The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1988
1989
1990
1991
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1988

def delete_agent(params = {}, options = {})
  req = build_request(:delete_agent, params)
  req.send_request(options)
end

#delete_location(params = {}) ⇒ Struct

Deletes a transfer location resource from DataSync.

Examples:

Request syntax with placeholder values


resp = client.delete_location({
  location_arn: "LocationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    The Amazon Resource Name (ARN) of the location to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2010
2011
2012
2013
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2010

def delete_location(params = {}, options = {})
  req = build_request(:delete_location, params)
  req.send_request(options)
end

#delete_task(params = {}) ⇒ Struct

Deletes a transfer task resource from DataSync.

Examples:

Request syntax with placeholder values


resp = client.delete_task({
  task_arn: "TaskArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the task that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2033
2034
2035
2036
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2033

def delete_task(params = {}, options = {})
  req = build_request(:delete_task, params)
  req.send_request(options)
end

#describe_agent(params = {}) ⇒ Types::DescribeAgentResponse

Returns information about an DataSync agent, such as its name, service endpoint type, and status.

Examples:

Request syntax with placeholder values


resp = client.describe_agent({
  agent_arn: "AgentArn", # required
})

Response structure


resp.agent_arn #=> String
resp.name #=> String
resp.status #=> String, one of "ONLINE", "OFFLINE"
resp.last_connection_time #=> Time
resp.creation_time #=> Time
resp.endpoint_type #=> String, one of "PUBLIC", "PRIVATE_LINK", "FIPS"
resp.private_link_config.vpc_endpoint_id #=> String
resp.private_link_config.private_link_endpoint #=> String
resp.private_link_config.subnet_arns #=> Array
resp.private_link_config.subnet_arns[0] #=> String
resp.private_link_config.security_group_arns #=> Array
resp.private_link_config.security_group_arns[0] #=> String
resp.platform.version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the DataSync agent that you want information about.

Returns:

See Also:



2082
2083
2084
2085
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2082

def describe_agent(params = {}, options = {})
  req = build_request(:describe_agent, params)
  req.send_request(options)
end

#describe_discovery_job(params = {}) ⇒ Types::DescribeDiscoveryJobResponse

Returns information about a DataSync discovery job.

Examples:

Request syntax with placeholder values


resp = client.describe_discovery_job({
  discovery_job_arn: "DiscoveryJobArn", # required
})

Response structure


resp.storage_system_arn #=> String
resp.discovery_job_arn #=> String
resp.collection_duration_minutes #=> Integer
resp.status #=> String, one of "RUNNING", "WARNING", "TERMINATED", "FAILED", "STOPPED", "COMPLETED", "COMPLETED_WITH_ISSUES"
resp.job_start_time #=> Time
resp.job_end_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :discovery_job_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the discovery job that you want information about.

Returns:

See Also:



2121
2122
2123
2124
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2121

def describe_discovery_job(params = {}, options = {})
  req = build_request(:describe_discovery_job, params)
  req.send_request(options)
end

#describe_location_azure_blob(params = {}) ⇒ Types::DescribeLocationAzureBlobResponse

Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.

Examples:

Request syntax with placeholder values


resp = client.describe_location_azure_blob({
  location_arn: "LocationArn", # required
})

Response structure


resp.location_arn #=> String
resp.location_uri #=> String
resp.authentication_type #=> String, one of "SAS"
resp.blob_type #=> String, one of "BLOCK"
resp.access_tier #=> String, one of "HOT", "COOL", "ARCHIVE"
resp.agent_arns #=> Array
resp.agent_arns[0] #=> String
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage transfer location.

Returns:

See Also:



2164
2165
2166
2167
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2164

def describe_location_azure_blob(params = {}, options = {})
  req = build_request(:describe_location_azure_blob, params)
  req.send_request(options)
end

#describe_location_efs(params = {}) ⇒ Types::DescribeLocationEfsResponse

Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

Examples:

Request syntax with placeholder values


resp = client.describe_location_efs({
  location_arn: "LocationArn", # required
})

Response structure


resp.location_arn #=> String
resp.location_uri #=> String
resp.ec2_config.subnet_arn #=> String
resp.ec2_config.security_group_arns #=> Array
resp.ec2_config.security_group_arns[0] #=> String
resp.creation_time #=> Time
resp.access_point_arn #=> String
resp.file_system_access_role_arn #=> String
resp.in_transit_encryption #=> String, one of "NONE", "TLS1_2"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon EFS file system location that you want information about.

Returns:

See Also:



2208
2209
2210
2211
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2208

def describe_location_efs(params = {}, options = {})
  req = build_request(:describe_location_efs, params)
  req.send_request(options)
end

#describe_location_fsx_lustre(params = {}) ⇒ Types::DescribeLocationFsxLustreResponse

Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.

Examples:

Request syntax with placeholder values


resp = client.describe_location_fsx_lustre({
  location_arn: "LocationArn", # required
})

Response structure


resp.location_arn #=> String
resp.location_uri #=> String
resp.security_group_arns #=> Array
resp.security_group_arns[0] #=> String
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    The Amazon Resource Name (ARN) of the FSx for Lustre location to describe.

Returns:

See Also:



2245
2246
2247
2248
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2245

def describe_location_fsx_lustre(params = {}, options = {})
  req = build_request(:describe_location_fsx_lustre, params)
  req.send_request(options)
end

#describe_location_fsx_ontap(params = {}) ⇒ Types::DescribeLocationFsxOntapResponse

Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.

If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.

Examples:

Request syntax with placeholder values


resp = client.describe_location_fsx_ontap({
  location_arn: "LocationArn", # required
})

Response structure


resp.creation_time #=> Time
resp.location_arn #=> String
resp.location_uri #=> String
resp.protocol.nfs.mount_options.version #=> String, one of "AUTOMATIC", "NFS3", "NFS4_0", "NFS4_1"
resp.protocol.smb.domain #=> String
resp.protocol.smb.mount_options.version #=> String, one of "AUTOMATIC", "SMB2", "SMB3", "SMB1", "SMB2_0"
resp.protocol.smb.password #=> String
resp.protocol.smb.user #=> String
resp.security_group_arns #=> Array
resp.security_group_arns[0] #=> String
resp.storage_virtual_machine_arn #=> String
resp.fsx_filesystem_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.

Returns:

See Also:



2297
2298
2299
2300
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2297

def describe_location_fsx_ontap(params = {}, options = {})
  req = build_request(:describe_location_fsx_ontap, params)
  req.send_request(options)
end

#describe_location_fsx_open_zfs(params = {}) ⇒ Types::DescribeLocationFsxOpenZfsResponse

Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.

Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.

Examples:

Request syntax with placeholder values


resp = client.describe_location_fsx_open_zfs({
  location_arn: "LocationArn", # required
})

Response structure


resp.location_arn #=> String
resp.location_uri #=> String
resp.security_group_arns #=> Array
resp.security_group_arns[0] #=> String
resp.protocol.nfs.mount_options.version #=> String, one of "AUTOMATIC", "NFS3", "NFS4_0", "NFS4_1"
resp.protocol.smb.domain #=> String
resp.protocol.smb.mount_options.version #=> String, one of "AUTOMATIC", "SMB2", "SMB3", "SMB1", "SMB2_0"
resp.protocol.smb.password #=> String
resp.protocol.smb.user #=> String
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.

Returns:

See Also:



2345
2346
2347
2348
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2345

def describe_location_fsx_open_zfs(params = {}, options = {})
  req = build_request(:describe_location_fsx_open_zfs, params)
  req.send_request(options)
end

#describe_location_fsx_windows(params = {}) ⇒ Types::DescribeLocationFsxWindowsResponse

Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.

Examples:

Request syntax with placeholder values


resp = client.describe_location_fsx_windows({
  location_arn: "LocationArn", # required
})

Response structure


resp.location_arn #=> String
resp.location_uri #=> String
resp.security_group_arns #=> Array
resp.security_group_arns[0] #=> String
resp.creation_time #=> Time
resp.user #=> String
resp.domain #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server location.

Returns:

See Also:



2386
2387
2388
2389
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2386

def describe_location_fsx_windows(params = {}, options = {})
  req = build_request(:describe_location_fsx_windows, params)
  req.send_request(options)
end

#describe_location_hdfs(params = {}) ⇒ Types::DescribeLocationHdfsResponse

Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.

Examples:

Request syntax with placeholder values


resp = client.describe_location_hdfs({
  location_arn: "LocationArn", # required
})

Response structure


resp.location_arn #=> String
resp.location_uri #=> String
resp.name_nodes #=> Array
resp.name_nodes[0].hostname #=> String
resp.name_nodes[0].port #=> Integer
resp.block_size #=> Integer
resp.replication_factor #=> Integer
resp.kms_key_provider_uri #=> String
resp.qop_configuration.rpc_protection #=> String, one of "DISABLED", "AUTHENTICATION", "INTEGRITY", "PRIVACY"
resp.qop_configuration.data_transfer_protection #=> String, one of "DISABLED", "AUTHENTICATION", "INTEGRITY", "PRIVACY"
resp.authentication_type #=> String, one of "SIMPLE", "KERBEROS"
resp.simple_user #=> String
resp.kerberos_principal #=> String
resp.agent_arns #=> Array
resp.agent_arns[0] #=> String
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the HDFS location.

Returns:

See Also:



2441
2442
2443
2444
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2441

def describe_location_hdfs(params = {}, options = {})
  req = build_request(:describe_location_hdfs, params)
  req.send_request(options)
end

#describe_location_nfs(params = {}) ⇒ Types::DescribeLocationNfsResponse

Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.

Examples:

Request syntax with placeholder values


resp = client.describe_location_nfs({
  location_arn: "LocationArn", # required
})

Response structure


resp.location_arn #=> String
resp.location_uri #=> String
resp.on_prem_config.agent_arns #=> Array
resp.on_prem_config.agent_arns[0] #=> String
resp.mount_options.version #=> String, one of "AUTOMATIC", "NFS3", "NFS4_0", "NFS4_1"
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the NFS location that you want information about.

Returns:

See Also:



2480
2481
2482
2483
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2480

def describe_location_nfs(params = {}, options = {})
  req = build_request(:describe_location_nfs, params)
  req.send_request(options)
end

#describe_location_object_storage(params = {}) ⇒ Types::DescribeLocationObjectStorageResponse

Provides details about how an DataSync transfer location for an object storage system is configured.

Examples:

Request syntax with placeholder values


resp = client.describe_location_object_storage({
  location_arn: "LocationArn", # required
})

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
resp.server_certificate #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the object storage system location.

Returns:

See Also:



2525
2526
2527
2528
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2525

def describe_location_object_storage(params = {}, options = {})
  req = build_request(:describe_location_object_storage, params)
  req.send_request(options)
end

#describe_location_s3(params = {}) ⇒ Types::DescribeLocationS3Response

Provides details about how an DataSync transfer location for an S3 bucket is configured.

Examples:

Request syntax with placeholder values


resp = client.describe_location_s3({
  location_arn: "LocationArn", # required
})

Response structure


resp.location_arn #=> String
resp.location_uri #=> String
resp.s3_storage_class #=> String, one of "STANDARD", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_INSTANT_RETRIEVAL"
resp.s3_config.bucket_access_role_arn #=> String
resp.agent_arns #=> Array
resp.agent_arns[0] #=> String
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.

Returns:

See Also:



2565
2566
2567
2568
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2565

def describe_location_s3(params = {}, options = {})
  req = build_request(:describe_location_s3, params)
  req.send_request(options)
end

#describe_location_smb(params = {}) ⇒ Types::DescribeLocationSmbResponse

Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.

Examples:

Request syntax with placeholder values


resp = client.describe_location_smb({
  location_arn: "LocationArn", # required
})

Response structure


resp.location_arn #=> String
resp.location_uri #=> String
resp.agent_arns #=> Array
resp.agent_arns[0] #=> String
resp.user #=> String
resp.domain #=> String
resp.mount_options.version #=> String, one of "AUTOMATIC", "SMB2", "SMB3", "SMB1", "SMB2_0"
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the SMB location that you want information about.

Returns:

See Also:



2608
2609
2610
2611
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2608

def describe_location_smb(params = {}, options = {})
  req = build_request(:describe_location_smb, params)
  req.send_request(options)
end

#describe_storage_system(params = {}) ⇒ Types::DescribeStorageSystemResponse

Returns information about an on-premises storage system that you're using with DataSync Discovery.

Examples:

Request syntax with placeholder values


resp = client.describe_storage_system({
  storage_system_arn: "StorageSystemArn", # required
})

Response structure


resp.storage_system_arn #=> String
resp.server_configuration.server_hostname #=> String
resp.server_configuration.server_port #=> Integer
resp.system_type #=> String, one of "NetAppONTAP"
resp.agent_arns #=> Array
resp.agent_arns[0] #=> String
resp.name #=> String
resp.error_message #=> String
resp.connectivity_status #=> String, one of "PASS", "FAIL", "UNKNOWN"
resp.cloud_watch_log_group_arn #=> String
resp.creation_time #=> Time
resp.secrets_manager_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :storage_system_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're using with DataSync Discovery.

Returns:

See Also:



2658
2659
2660
2661
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2658

def describe_storage_system(params = {}, options = {})
  req = build_request(:describe_storage_system, params)
  req.send_request(options)
end

#describe_storage_system_resource_metrics(params = {}) ⇒ Types::DescribeStorageSystemResourceMetricsResponse

Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_storage_system_resource_metrics({
  discovery_job_arn: "DiscoveryJobArn", # required
  resource_type: "SVM", # required, accepts SVM, VOLUME, CLUSTER
  resource_id: "ResourceId", # required
  start_time: Time.now,
  end_time: Time.now,
  max_results: 1,
  next_token: "DiscoveryNextToken",
})

Response structure


resp.metrics #=> Array
resp.metrics[0].timestamp #=> Time
resp.metrics[0].p95_metrics.iops.read #=> Float
resp.metrics[0].p95_metrics.iops.write #=> Float
resp.metrics[0].p95_metrics.iops.other #=> Float
resp.metrics[0].p95_metrics.iops.total #=> Float
resp.metrics[0].p95_metrics.throughput.read #=> Float
resp.metrics[0].p95_metrics.throughput.write #=> Float
resp.metrics[0].p95_metrics.throughput.other #=> Float
resp.metrics[0].p95_metrics.throughput.total #=> Float
resp.metrics[0].p95_metrics.latency.read #=> Float
resp.metrics[0].p95_metrics.latency.write #=> Float
resp.metrics[0].p95_metrics.latency.other #=> Float
resp.metrics[0].capacity.used #=> Integer
resp.metrics[0].capacity.provisioned #=> Integer
resp.metrics[0].capacity.logical_used #=> Integer
resp.metrics[0].capacity.cluster_cloud_storage_used #=> Integer
resp.metrics[0].resource_id #=> String
resp.metrics[0].resource_type #=> String, one of "SVM", "VOLUME", "CLUSTER"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :discovery_job_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.

  • :resource_type (required, String) —

    Specifies the kind of storage system resource that you want information about.

  • :resource_id (required, String) —

    Specifies the universally unique identifier (UUID) of the storage system resource that you want information about.

  • :start_time (Time, DateTime, Date, Integer, String) —

    Specifies a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with EndTime.

  • :end_time (Time, DateTime, Date, Integer, String) —

    Specifies a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with StartTime.

  • :max_results (Integer) —

    Specifies how many results that you want in the response.

  • :next_token (String) —

    Specifies an opaque string that indicates the position to begin the next list of results in the response.

Returns:

See Also:



2742
2743
2744
2745
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2742

def describe_storage_system_resource_metrics(params = {}, options = {})
  req = build_request(:describe_storage_system_resource_metrics, params)
  req.send_request(options)
end

#describe_storage_system_resources(params = {}) ⇒ Types::DescribeStorageSystemResourcesResponse

Returns information that DataSync Discovery collects about resources in your on-premises storage system.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_storage_system_resources({
  discovery_job_arn: "DiscoveryJobArn", # required
  resource_type: "SVM", # required, accepts SVM, VOLUME, CLUSTER
  resource_ids: ["ResourceId"],
  filter: {
    "SVM" => ["PtolemyString"],
  },
  max_results: 1,
  next_token: "DiscoveryNextToken",
})

Response structure


resp.resource_details.net_app_ontapsv_ms #=> Array
resp.resource_details.net_app_ontapsv_ms[0].cluster_uuid #=> String
resp.resource_details.net_app_ontapsv_ms[0].resource_id #=> String
resp.resource_details.net_app_ontapsv_ms[0].svm_name #=> String
resp.resource_details.net_app_ontapsv_ms[0].cifs_share_count #=> Integer
resp.resource_details.net_app_ontapsv_ms[0].enabled_protocols #=> Array
resp.resource_details.net_app_ontapsv_ms[0].enabled_protocols[0] #=> String
resp.resource_details.net_app_ontapsv_ms[0].total_capacity_used #=> Integer
resp.resource_details.net_app_ontapsv_ms[0].total_capacity_provisioned #=> Integer
resp.resource_details.net_app_ontapsv_ms[0].total_logical_capacity_used #=> Integer
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.iops_read #=> Float
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.iops_write #=> Float
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.iops_other #=> Float
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.iops_total #=> Float
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.throughput_read #=> Float
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.throughput_write #=> Float
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.throughput_other #=> Float
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.throughput_total #=> Float
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.latency_read #=> Float
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.latency_write #=> Float
resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.latency_other #=> Float
resp.resource_details.net_app_ontapsv_ms[0].recommendations #=> Array
resp.resource_details.net_app_ontapsv_ms[0].recommendations[0].storage_type #=> String
resp.resource_details.net_app_ontapsv_ms[0].recommendations[0].storage_configuration #=> Hash
resp.resource_details.net_app_ontapsv_ms[0].recommendations[0].storage_configuration["PtolemyString"] #=> String
resp.resource_details.net_app_ontapsv_ms[0].recommendations[0].estimated_monthly_storage_cost #=> String
resp.resource_details.net_app_ontapsv_ms[0].nfs_exported_volumes #=> Integer
resp.resource_details.net_app_ontapsv_ms[0].recommendation_status #=> String, one of "NONE", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.resource_details.net_app_ontapsv_ms[0].total_snapshot_capacity_used #=> Integer
resp.resource_details.net_app_ontapsv_ms[0].lun_count #=> Integer
resp.resource_details.net_app_ontap_volumes #=> Array
resp.resource_details.net_app_ontap_volumes[0].volume_name #=> String
resp.resource_details.net_app_ontap_volumes[0].resource_id #=> String
resp.resource_details.net_app_ontap_volumes[0].cifs_share_count #=> Integer
resp.resource_details.net_app_ontap_volumes[0].security_style #=> String
resp.resource_details.net_app_ontap_volumes[0].svm_uuid #=> String
resp.resource_details.net_app_ontap_volumes[0].svm_name #=> String
resp.resource_details.net_app_ontap_volumes[0].capacity_used #=> Integer
resp.resource_details.net_app_ontap_volumes[0].capacity_provisioned #=> Integer
resp.resource_details.net_app_ontap_volumes[0].logical_capacity_used #=> Integer
resp.resource_details.net_app_ontap_volumes[0].nfs_exported #=> Boolean
resp.resource_details.net_app_ontap_volumes[0].snapshot_capacity_used #=> Integer
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.iops_read #=> Float
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.iops_write #=> Float
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.iops_other #=> Float
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.iops_total #=> Float
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.throughput_read #=> Float
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.throughput_write #=> Float
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.throughput_other #=> Float
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.throughput_total #=> Float
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.latency_read #=> Float
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.latency_write #=> Float
resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.latency_other #=> Float
resp.resource_details.net_app_ontap_volumes[0].recommendations #=> Array
resp.resource_details.net_app_ontap_volumes[0].recommendations[0].storage_type #=> String
resp.resource_details.net_app_ontap_volumes[0].recommendations[0].storage_configuration #=> Hash
resp.resource_details.net_app_ontap_volumes[0].recommendations[0].storage_configuration["PtolemyString"] #=> String
resp.resource_details.net_app_ontap_volumes[0].recommendations[0].estimated_monthly_storage_cost #=> String
resp.resource_details.net_app_ontap_volumes[0].recommendation_status #=> String, one of "NONE", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.resource_details.net_app_ontap_volumes[0].lun_count #=> Integer
resp.resource_details.net_app_ontap_clusters #=> Array
resp.resource_details.net_app_ontap_clusters[0].cifs_share_count #=> Integer
resp.resource_details.net_app_ontap_clusters[0].nfs_exported_volumes #=> Integer
resp.resource_details.net_app_ontap_clusters[0].resource_id #=> String
resp.resource_details.net_app_ontap_clusters[0].cluster_name #=> String
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.iops_read #=> Float
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.iops_write #=> Float
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.iops_other #=> Float
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.iops_total #=> Float
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.throughput_read #=> Float
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.throughput_write #=> Float
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.throughput_other #=> Float
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.throughput_total #=> Float
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.latency_read #=> Float
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.latency_write #=> Float
resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.latency_other #=> Float
resp.resource_details.net_app_ontap_clusters[0].cluster_block_storage_size #=> Integer
resp.resource_details.net_app_ontap_clusters[0].cluster_block_storage_used #=> Integer
resp.resource_details.net_app_ontap_clusters[0].cluster_block_storage_logical_used #=> Integer
resp.resource_details.net_app_ontap_clusters[0].recommendations #=> Array
resp.resource_details.net_app_ontap_clusters[0].recommendations[0].storage_type #=> String
resp.resource_details.net_app_ontap_clusters[0].recommendations[0].storage_configuration #=> Hash
resp.resource_details.net_app_ontap_clusters[0].recommendations[0].storage_configuration["PtolemyString"] #=> String
resp.resource_details.net_app_ontap_clusters[0].recommendations[0].estimated_monthly_storage_cost #=> String
resp.resource_details.net_app_ontap_clusters[0].recommendation_status #=> String, one of "NONE", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.resource_details.net_app_ontap_clusters[0].lun_count #=> Integer
resp.resource_details.net_app_ontap_clusters[0].cluster_cloud_storage_used #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :discovery_job_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.

  • :resource_type (required, String) —

    Specifies what kind of storage system resources that you want information about.

  • :resource_ids (Array<String>) —

    Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the Filter parameter.

  • :filter (Hash<String,Array>) —

    Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).

  • :max_results (Integer) —

    Specifies the maximum number of storage system resources that you want to list in a response.

  • :next_token (String) —

    Specifies an opaque string that indicates the position to begin the next list of results in the response.

Returns:

See Also:



2891
2892
2893
2894
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2891

def describe_storage_system_resources(params = {}, options = {})
  req = build_request(:describe_storage_system_resources, params)
  req.send_request(options)
end

#describe_task(params = {}) ⇒ Types::DescribeTaskResponse

Provides information about a task, which defines where and how DataSync transfers your data.

Examples:

Request syntax with placeholder values


resp = client.describe_task({
  task_arn: "TaskArn", # required
})

Response structure


resp.task_arn #=> String
resp.status #=> String, one of "AVAILABLE", "CREATING", "QUEUED", "RUNNING", "UNAVAILABLE"
resp.name #=> String
resp.current_task_execution_arn #=> String
resp.source_location_arn #=> String
resp.destination_location_arn #=> String
resp.cloud_watch_log_group_arn #=> String
resp.source_network_interface_arns #=> Array
resp.source_network_interface_arns[0] #=> String
resp.destination_network_interface_arns #=> Array
resp.destination_network_interface_arns[0] #=> String
resp.options.verify_mode #=> String, one of "POINT_IN_TIME_CONSISTENT", "ONLY_FILES_TRANSFERRED", "NONE"
resp.options.overwrite_mode #=> String, one of "ALWAYS", "NEVER"
resp.options.atime #=> String, one of "NONE", "BEST_EFFORT"
resp.options.mtime #=> String, one of "NONE", "PRESERVE"
resp.options.uid #=> String, one of "NONE", "INT_VALUE", "NAME", "BOTH"
resp.options.gid #=> String, one of "NONE", "INT_VALUE", "NAME", "BOTH"
resp.options.preserve_deleted_files #=> String, one of "PRESERVE", "REMOVE"
resp.options.preserve_devices #=> String, one of "NONE", "PRESERVE"
resp.options.posix_permissions #=> String, one of "NONE", "PRESERVE"
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.options.security_descriptor_copy_flags #=> String, one of "NONE", "OWNER_DACL", "OWNER_DACL_SACL"
resp.options.object_tags #=> String, one of "PRESERVE", "NONE"
resp.excludes #=> Array
resp.excludes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
resp.excludes[0].value #=> String
resp.schedule.schedule_expression #=> String
resp.schedule.status #=> String, one of "ENABLED", "DISABLED"
resp.error_code #=> String
resp.error_detail #=> String
resp.creation_time #=> Time
resp.includes #=> Array
resp.includes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
resp.includes[0].value #=> String
resp.manifest_config.action #=> String, one of "TRANSFER"
resp.manifest_config.format #=> String, one of "CSV"
resp.manifest_config.source.s3.manifest_object_path #=> String
resp.manifest_config.source.s3.bucket_access_role_arn #=> String
resp.manifest_config.source.s3.s3_bucket_arn #=> String
resp.manifest_config.source.s3.manifest_object_version_id #=> String
resp.task_report_config.destination.s3.subdirectory #=> String
resp.task_report_config.destination.s3.s3_bucket_arn #=> String
resp.task_report_config.destination.s3.bucket_access_role_arn #=> String
resp.task_report_config.output_type #=> String, one of "SUMMARY_ONLY", "STANDARD"
resp.task_report_config.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
resp.task_report_config.object_version_ids #=> String, one of "INCLUDE", "NONE"
resp.task_report_config.overrides.transferred.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
resp.task_report_config.overrides.verified.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
resp.task_report_config.overrides.deleted.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
resp.task_report_config.overrides.skipped.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
resp.schedule_details.status_update_time #=> Time
resp.schedule_details.disabled_reason #=> String
resp.schedule_details.disabled_by #=> String, one of "USER", "SERVICE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the transfer task that you want information about.

Returns:

See Also:



2994
2995
2996
2997
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2994

def describe_task(params = {}, options = {})
  req = build_request(:describe_task, params)
  req.send_request(options)
end

#describe_task_execution(params = {}) ⇒ Types::DescribeTaskExecutionResponse

Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing transfer or check the results of the transfer.

Examples:

Request syntax with placeholder values


resp = client.describe_task_execution({
  task_execution_arn: "TaskExecutionArn", # required
})

Response structure


resp.task_execution_arn #=> String
resp.status #=> String, one of "QUEUED", "LAUNCHING", "PREPARING", "TRANSFERRING", "VERIFYING", "SUCCESS", "ERROR"
resp.options.verify_mode #=> String, one of "POINT_IN_TIME_CONSISTENT", "ONLY_FILES_TRANSFERRED", "NONE"
resp.options.overwrite_mode #=> String, one of "ALWAYS", "NEVER"
resp.options.atime #=> String, one of "NONE", "BEST_EFFORT"
resp.options.mtime #=> String, one of "NONE", "PRESERVE"
resp.options.uid #=> String, one of "NONE", "INT_VALUE", "NAME", "BOTH"
resp.options.gid #=> String, one of "NONE", "INT_VALUE", "NAME", "BOTH"
resp.options.preserve_deleted_files #=> String, one of "PRESERVE", "REMOVE"
resp.options.preserve_devices #=> String, one of "NONE", "PRESERVE"
resp.options.posix_permissions #=> String, one of "NONE", "PRESERVE"
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.options.security_descriptor_copy_flags #=> String, one of "NONE", "OWNER_DACL", "OWNER_DACL_SACL"
resp.options.object_tags #=> String, one of "PRESERVE", "NONE"
resp.excludes #=> Array
resp.excludes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
resp.excludes[0].value #=> String
resp.includes #=> Array
resp.includes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
resp.includes[0].value #=> String
resp.manifest_config.action #=> String, one of "TRANSFER"
resp.manifest_config.format #=> String, one of "CSV"
resp.manifest_config.source.s3.manifest_object_path #=> String
resp.manifest_config.source.s3.bucket_access_role_arn #=> String
resp.manifest_config.source.s3.s3_bucket_arn #=> String
resp.manifest_config.source.s3.manifest_object_version_id #=> String
resp.start_time #=> Time
resp.estimated_files_to_transfer #=> Integer
resp.estimated_bytes_to_transfer #=> Integer
resp.files_transferred #=> Integer
resp.bytes_written #=> Integer
resp.bytes_transferred #=> Integer
resp.bytes_compressed #=> Integer
resp.result.prepare_duration #=> Integer
resp.result.prepare_status #=> String, one of "PENDING", "SUCCESS", "ERROR"
resp.result.total_duration #=> Integer
resp.result.transfer_duration #=> Integer
resp.result.transfer_status #=> String, one of "PENDING", "SUCCESS", "ERROR"
resp.result.verify_duration #=> Integer
resp.result.verify_status #=> String, one of "PENDING", "SUCCESS", "ERROR"
resp.result.error_code #=> String
resp.result.error_detail #=> String
resp.task_report_config.destination.s3.subdirectory #=> String
resp.task_report_config.destination.s3.s3_bucket_arn #=> String
resp.task_report_config.destination.s3.bucket_access_role_arn #=> String
resp.task_report_config.output_type #=> String, one of "SUMMARY_ONLY", "STANDARD"
resp.task_report_config.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
resp.task_report_config.object_version_ids #=> String, one of "INCLUDE", "NONE"
resp.task_report_config.overrides.transferred.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
resp.task_report_config.overrides.verified.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
resp.task_report_config.overrides.deleted.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
resp.task_report_config.overrides.skipped.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
resp.files_deleted #=> Integer
resp.files_skipped #=> Integer
resp.files_verified #=> Integer
resp.report_result.status #=> String, one of "PENDING", "SUCCESS", "ERROR"
resp.report_result.error_code #=> String
resp.report_result.error_detail #=> String
resp.estimated_files_to_delete #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_execution_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the task execution that you want information about.

Returns:

See Also:



3105
3106
3107
3108
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3105

def describe_task_execution(params = {}, options = {})
  req = build_request(:describe_task_execution, params)
  req.send_request(options)
end

#generate_recommendations(params = {}) ⇒ Struct

Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery.

Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation.

Examples:

Request syntax with placeholder values


resp = client.generate_recommendations({
  discovery_job_arn: "DiscoveryJobArn", # required
  resource_ids: ["ResourceId"], # required
  resource_type: "SVM", # required, accepts SVM, VOLUME, CLUSTER
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :discovery_job_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.

  • :resource_ids (required, Array<String>) —

    Specifies the universally unique identifiers (UUIDs) of the resources in your storage system that you want recommendations on.

  • :resource_type (required, String) —

    Specifies the type of resource in your storage system that you want recommendations on.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3150
3151
3152
3153
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3150

def generate_recommendations(params = {}, options = {})
  req = build_request(:generate_recommendations, params)
  req.send_request(options)
end

#list_agents(params = {}) ⇒ Types::ListAgentsResponse

Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.

With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.

ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents, that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_agents({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.agents #=> Array
resp.agents[0].agent_arn #=> String
resp.agents[0].name #=> String
resp.agents[0].status #=> String, one of "ONLINE", "OFFLINE"
resp.agents[0].platform.version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Specifies the maximum number of DataSync agents to list in a response. By default, a response shows a maximum of 100 agents.

  • :next_token (String) —

    Specifies an opaque string that indicates the position to begin the next list of results in the response.

Returns:

See Also:



3212
3213
3214
3215
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3212

def list_agents(params = {}, options = {})
  req = build_request(:list_agents, params)
  req.send_request(options)
end

#list_discovery_jobs(params = {}) ⇒ Types::ListDiscoveryJobsResponse

Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_discovery_jobs({
  storage_system_arn: "StorageSystemArn",
  max_results: 1,
  next_token: "DiscoveryNextToken",
})

Response structure


resp.discovery_jobs #=> Array
resp.discovery_jobs[0].discovery_job_arn #=> String
resp.discovery_jobs[0].status #=> String, one of "RUNNING", "WARNING", "TERMINATED", "FAILED", "STOPPED", "COMPLETED", "COMPLETED_WITH_ISSUES"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :storage_system_arn (String) —

    Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use this parameter if you only want to list the discovery jobs that are associated with a specific storage system.

  • :max_results (Integer) —

    Specifies how many results you want in the response.

  • :next_token (String) —

    Specifies an opaque string that indicates the position to begin the next list of results in the response.

Returns:

See Also:



3259
3260
3261
3262
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3259

def list_discovery_jobs(params = {}, options = {})
  req = build_request(:list_discovery_jobs, params)
  req.send_request(options)
end

#list_locations(params = {}) ⇒ Types::ListLocationsResponse

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 response contains a token that you can specify in your next request to fetch the next page of locations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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
    },
  ],
})

Response structure


resp.locations #=> Array
resp.locations[0].location_arn #=> String
resp.locations[0].location_uri #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of locations to return.

  • :next_token (String) —

    An opaque string that indicates the position at which to begin the next list of locations.

  • :filters (Array<Types::LocationFilter>) —

    You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.

Returns:

See Also:



3316
3317
3318
3319
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3316

def list_locations(params = {}, options = {})
  req = build_request(:list_locations, params)
  req.send_request(options)
end

#list_storage_systems(params = {}) ⇒ Types::ListStorageSystemsResponse

Lists the on-premises storage systems that you're using with DataSync Discovery.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_storage_systems({
  max_results: 1,
  next_token: "DiscoveryNextToken",
})

Response structure


resp.storage_systems #=> Array
resp.storage_systems[0].storage_system_arn #=> String
resp.storage_systems[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Specifies how many results you want in the response.

  • :next_token (String) —

    Specifies an opaque string that indicates the position to begin the next list of results in the response.

Returns:

See Also:



3356
3357
3358
3359
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3356

def list_storage_systems(params = {}, options = {})
  req = build_request(:list_storage_systems, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns all the tags associated with an Amazon Web Services resource.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TaggableResourceArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the resource that you want tag information on.

  • :max_results (Integer) —

    Specifies how many results that you want in the response.

  • :next_token (String) —

    Specifies an opaque string that indicates the position to begin the next list of results in the response.

Returns:

See Also:



3400
3401
3402
3403
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3400

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_task_executions(params = {}) ⇒ Types::ListTaskExecutionsResponse

Returns a list of executions for an DataSync transfer task.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_task_executions({
  task_arn: "TaskArn",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.task_executions #=> Array
resp.task_executions[0].task_execution_arn #=> String
resp.task_executions[0].status #=> String, one of "QUEUED", "LAUNCHING", "PREPARING", "TRANSFERRING", "VERIFYING", "SUCCESS", "ERROR"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_arn (String) —

    Specifies the Amazon Resource Name (ARN) of the task that you want execution information about.

  • :max_results (Integer) —

    Specifies how many results you want in the response.

  • :next_token (String) —

    Specifies an opaque string that indicates the position at which to begin the next list of results in the response.

Returns:

See Also:



3444
3445
3446
3447
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3444

def list_task_executions(params = {}, options = {})
  req = build_request(:list_task_executions, params)
  req.send_request(options)
end

#list_tasks(params = {}) ⇒ Types::ListTasksResponse

Returns a list of the DataSync tasks you created.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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
    },
  ],
})

Response structure


resp.tasks #=> Array
resp.tasks[0].task_arn #=> String
resp.tasks[0].status #=> String, one of "AVAILABLE", "CREATING", "QUEUED", "RUNNING", "UNAVAILABLE"
resp.tasks[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of tasks to return.

  • :next_token (String) —

    An opaque string that indicates the position at which to begin the next list of tasks.

  • :filters (Array<Types::TaskFilter>) —

    You can use API filters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a specific source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location.

Returns:

See Also:



3497
3498
3499
3500
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3497

def list_tasks(params = {}, options = {})
  req = build_request(:list_tasks, params)
  req.send_request(options)
end

#remove_storage_system(params = {}) ⇒ Struct

Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.

Examples:

Request syntax with placeholder values


resp = client.remove_storage_system({
  storage_system_arn: "StorageSystemArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :storage_system_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the storage system that you want to permanently remove from DataSync Discovery.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3522
3523
3524
3525
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3522

def remove_storage_system(params = {}, options = {})
  req = build_request(:remove_storage_system, params)
  req.send_request(options)
end

#start_discovery_job(params = {}) ⇒ Types::StartDiscoveryJobResponse

Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystem operation.

Examples:

Request syntax with placeholder values


resp = client.start_discovery_job({
  storage_system_arn: "StorageSystemArn", # required
  collection_duration_minutes: 1, # required
  client_token: "PtolemyUUID", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.discovery_job_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :storage_system_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on.

  • :collection_duration_minutes (required, Integer) —

    Specifies in minutes how long you want the discovery job to run.

    For more accurate recommendations, we recommend a duration of at least 14 days. Longer durations allow time to collect a sufficient number of data points and provide a realistic representation of storage performance and utilization.

  • :client_token (required, String) —

    Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Array<Types::TagListEntry>) —

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.

Returns:

See Also:



3587
3588
3589
3590
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3587

def start_discovery_job(params = {}, options = {})
  req = build_request(:start_discovery_job, params)
  req.send_request(options)
end

#start_task_execution(params = {}) ⇒ Types::StartTaskExecutionResponse

Starts an DataSync transfer task. For each task, you can only run one task execution at a time.

There are several phases to a task execution. For more information, see Task execution statuses.

If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.

Examples:

Request syntax with placeholder values


resp = client.start_task_execution({
  task_arn: "TaskArn", # required
  override_options: {
    verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
    overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
    atime: "NONE", # accepts NONE, BEST_EFFORT
    mtime: "NONE", # accepts NONE, PRESERVE
    uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
    gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
    preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
    preserve_devices: "NONE", # accepts NONE, PRESERVE
    posix_permissions: "NONE", # accepts NONE, PRESERVE
    bytes_per_second: 1,
    task_queueing: "ENABLED", # accepts ENABLED, DISABLED
    log_level: "OFF", # accepts OFF, BASIC, TRANSFER
    transfer_mode: "CHANGED", # accepts CHANGED, ALL
    security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
    object_tags: "PRESERVE", # accepts PRESERVE, NONE
  },
  includes: [
    {
      filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
      value: "FilterValue",
    },
  ],
  excludes: [
    {
      filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
      value: "FilterValue",
    },
  ],
  manifest_config: {
    action: "TRANSFER", # accepts TRANSFER
    format: "CSV", # accepts CSV
    source: {
      s3: { # required
        manifest_object_path: "S3Subdirectory", # required
        bucket_access_role_arn: "IamRoleArn", # required
        s3_bucket_arn: "S3BucketArn", # required
        manifest_object_version_id: "S3ObjectVersionId",
      },
    },
  },
  task_report_config: {
    destination: {
      s3: {
        subdirectory: "S3Subdirectory",
        s3_bucket_arn: "S3BucketArn", # required
        bucket_access_role_arn: "IamRoleArn", # required
      },
    },
    output_type: "SUMMARY_ONLY", # accepts SUMMARY_ONLY, STANDARD
    report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
    object_version_ids: "INCLUDE", # accepts INCLUDE, NONE
    overrides: {
      transferred: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
      verified: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
      deleted: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
      skipped: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.task_execution_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the task that you want to start.

  • :override_options (Types::Options) —

    Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

    Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.

    You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.

  • :includes (Array<Types::FilterRule>) —

    Specifies a list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

  • :excludes (Array<Types::FilterRule>) —

    Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

  • :manifest_config (Types::ManifestConfig) —

    Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

    When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

    To remove a manifest configuration, specify this parameter with an empty value.

  • :task_report_config (Types::TaskReportConfig) —

    Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

    When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

    To remove a task report configuration, specify this parameter as empty.

  • :tags (Array<Types::TagListEntry>) —

    Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.

    Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

Returns:

See Also:



3776
3777
3778
3779
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3776

def start_task_execution(params = {}, options = {})
  req = build_request(:start_task_execution, params)
  req.send_request(options)
end

#stop_discovery_job(params = {}) ⇒ Struct

Stops a running DataSync discovery job.

You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendations operation.

Examples:

Request syntax with placeholder values


resp = client.stop_discovery_job({
  discovery_job_arn: "DiscoveryJobArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :discovery_job_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the discovery job that you want to stop.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3809
3810
3811
3812
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3809

def stop_discovery_job(params = {}, options = {})
  req = build_request(:stop_discovery_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.

These include DataSync resources, such as locations, tasks, and task executions.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TaggableResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the resource to apply the tag to.

  • :tags (required, Array<Types::TagListEntry>) —

    Specifies the tags that you want to apply to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3845
3846
3847
3848
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3845

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from an Amazon Web Services resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TaggableResourceArn", # required
  keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the resource to remove the tags from.

  • :keys (required, Array<String>) —

    Specifies the keys in the tags that you want to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3872
3873
3874
3875
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3872

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_agent(params = {}) ⇒ Struct

Updates the name of an DataSync agent.

Examples:

Request syntax with placeholder values


resp = client.update_agent({
  agent_arn: "AgentArn", # required
  name: "TagValue",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_arn (required, String) —

    The Amazon Resource Name (ARN) of the agent to update.

  • :name (String) —

    The name that you want to use to configure the agent.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3898
3899
3900
3901
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3898

def update_agent(params = {}, options = {})
  req = build_request(:update_agent, params)
  req.send_request(options)
end

#update_discovery_job(params = {}) ⇒ Struct

Edits a DataSync discovery job configuration.

Examples:

Request syntax with placeholder values


resp = client.update_discovery_job({
  discovery_job_arn: "DiscoveryJobArn", # required
  collection_duration_minutes: 1, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :discovery_job_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the discovery job that you want to update.

  • :collection_duration_minutes (required, Integer) —

    Specifies in minutes how long that you want the discovery job to run. (You can't set this parameter to less than the number of minutes that the job has already run for.)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3927
3928
3929
3930
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3927

def update_discovery_job(params = {}, options = {})
  req = build_request(:update_discovery_job, params)
  req.send_request(options)
end

#update_location_azure_blob(params = {}) ⇒ Struct

Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.

Examples:

Request syntax with placeholder values


resp = client.update_location_azure_blob({
  location_arn: "LocationArn", # required
  subdirectory: "AzureBlobSubdirectory",
  authentication_type: "SAS", # accepts SAS
  sas_configuration: {
    token: "AzureBlobSasToken", # required
  },
  blob_type: "BLOCK", # accepts BLOCK
  access_tier: "HOT", # accepts HOT, COOL, ARCHIVE
  agent_arns: ["AgentArn"],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the ARN of the Azure Blob Storage transfer location that you're updating.

  • :subdirectory (String) —

    Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images).

  • :authentication_type (String) —

    Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).

  • :sas_configuration (Types::AzureBlobSasConfiguration) —

    Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

  • :blob_type (String) —

    Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation.

  • :access_tier (String) —

    Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.

  • :agent_arns (Array<String>) —

    Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

    You can specify more than one agent. For more information, see Using multiple agents for your transfer.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4003
4004
4005
4006
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4003

def update_location_azure_blob(params = {}, options = {})
  req = build_request(:update_location_azure_blob, params)
  req.send_request(options)
end

#update_location_hdfs(params = {}) ⇒ Struct

Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.

Examples:

Request syntax with placeholder values


resp = client.update_location_hdfs({
  location_arn: "LocationArn", # required
  subdirectory: "HdfsSubdirectory",
  name_nodes: [
    {
      hostname: "HdfsServerHostname", # required
      port: 1, # required
    },
  ],
  block_size: 1,
  replication_factor: 1,
  kms_key_provider_uri: "KmsKeyProviderUri",
  qop_configuration: {
    rpc_protection: "DISABLED", # accepts DISABLED, AUTHENTICATION, INTEGRITY, PRIVACY
    data_transfer_protection: "DISABLED", # accepts DISABLED, AUTHENTICATION, INTEGRITY, PRIVACY
  },
  authentication_type: "SIMPLE", # accepts SIMPLE, KERBEROS
  simple_user: "HdfsUser",
  kerberos_principal: "KerberosPrincipal",
  kerberos_keytab: "data",
  kerberos_krb_5_conf: "data",
  agent_arns: ["AgentArn"],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    The Amazon Resource Name (ARN) of the source HDFS cluster location.

  • :subdirectory (String) —

    A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.

  • :name_nodes (Array<Types::HdfsNameNode>) —

    The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.

  • :block_size (Integer) —

    The size of the data blocks to write into the HDFS cluster.

  • :replication_factor (Integer) —

    The number of DataNodes to replicate the data to when writing to the HDFS cluster.

  • :kms_key_provider_uri (String) —

    The URI of the HDFS cluster's Key Management Server (KMS).

  • :qop_configuration (Types::QopConfiguration) —

    The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.

  • :authentication_type (String) —

    The type of authentication used to determine the identity of the user.

  • :simple_user (String) —

    The user name used to identify the client on the host operating system.

  • :kerberos_principal (String) —

    The Kerberos principal with access to the files and folders on the HDFS cluster.

  • :kerberos_keytab (String, StringIO, File) —

    The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you use the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.

  • :kerberos_krb_5_conf (String, StringIO, File) —

    The krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.

  • :agent_arns (Array<String>) —

    The ARNs of the agents that are used to connect to the HDFS cluster.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4098
4099
4100
4101
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4098

def update_location_hdfs(params = {}, options = {})
  req = build_request(:update_location_hdfs, params)
  req.send_request(options)
end

#update_location_nfs(params = {}) ⇒ Struct

Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.

For more information, see Configuring transfers to or from an NFS file server.

Examples:

Request syntax with placeholder values


resp = client.update_location_nfs({
  location_arn: "LocationArn", # required
  subdirectory: "NfsSubdirectory",
  on_prem_config: {
    agent_arns: ["AgentArn"], # required
  },
  mount_options: {
    version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the NFS transfer location that you want to update.

  • :subdirectory (String) —

    Specifies the export path in your NFS file server that you want DataSync to mount.

    This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers.

  • :on_prem_config (Types::OnPremConfig) —

    The DataSync agents that are connecting to a Network File System (NFS) location.

  • :mount_options (Types::NfsMountOptions) —

    Specifies how DataSync can access a location using the NFS protocol.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4155
4156
4157
4158
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4155

def update_location_nfs(params = {}, options = {})
  req = build_request(:update_location_nfs, params)
  req.send_request(options)
end

#update_location_object_storage(params = {}) ⇒ Struct

Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.

Examples:

Request syntax with placeholder values


resp = client.update_location_object_storage({
  location_arn: "LocationArn", # required
  server_port: 1,
  server_protocol: "HTTPS", # accepts HTTPS, HTTP
  subdirectory: "S3Subdirectory",
  access_key: "ObjectStorageAccessKey",
  secret_key: "ObjectStorageSecretKey",
  agent_arns: ["AgentArn"],
  server_certificate: "data",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the ARN of the object storage system location that you're updating.

  • :server_port (Integer) —

    Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

  • :server_protocol (String) —

    Specifies the protocol that your object storage server uses to communicate.

  • :subdirectory (String) —

    Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

  • :access_key (String) —

    Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

  • :secret_key (String) —

    Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

  • :agent_arns (Array<String>) —

    Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

  • :server_certificate (String, StringIO, File) —

    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up to 32768 bytes (before Base64 encoding).

    To use this parameter, configure ServerProtocol to HTTPS.

    Updating the certificate doesn't interfere with tasks that you have in progress.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4230
4231
4232
4233
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4230

def update_location_object_storage(params = {}, options = {})
  req = build_request(:update_location_object_storage, params)
  req.send_request(options)
end

#update_location_smb(params = {}) ⇒ Struct

Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.

Examples:

Request syntax with placeholder values


resp = client.update_location_smb({
  location_arn: "LocationArn", # required
  subdirectory: "SmbSubdirectory",
  user: "SmbUser",
  domain: "SmbDomain",
  password: "SmbPassword",
  agent_arns: ["AgentArn"],
  mount_options: {
    version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3, SMB1, SMB2_0
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :location_arn (required, String) —

    Specifies the ARN of the SMB location that you want to update.

  • :subdirectory (String) —

    Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

    To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see required permissions for SMB locations.

  • :user (String) —

    Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.

    For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

  • :domain (String) —

    Specifies the Windows domain name that your SMB file server belongs to.

    If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

    For more information, see required permissions for SMB locations.

  • :password (String) —

    Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

    For more information, see required permissions for SMB locations.

  • :agent_arns (Array<String>) —

    Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

  • :mount_options (Types::SmbMountOptions) —

    Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4319
4320
4321
4322
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4319

def update_location_smb(params = {}, options = {})
  req = build_request(:update_location_smb, params)
  req.send_request(options)
end

#update_storage_system(params = {}) ⇒ Struct

Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.

Examples:

Request syntax with placeholder values


resp = client.update_storage_system({
  storage_system_arn: "StorageSystemArn", # required
  server_configuration: {
    server_hostname: "DiscoveryServerHostname", # required
    server_port: 1,
  },
  agent_arns: ["AgentArn"],
  name: "Name",
  cloud_watch_log_group_arn: "LogGroupArn",
  credentials: {
    username: "PtolemyUsername", # required
    password: "PtolemyPassword", # required
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :storage_system_arn (required, String) —

    Specifies the ARN of the on-premises storage system that you want reconfigure.

  • :server_configuration (Types::DiscoveryServerConfiguration) —

    Specifies the server name and network port required to connect with your on-premises storage system's management interface.

  • :agent_arns (Array<String>) —

    Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads your on-premises storage system. You can only specify one ARN.

  • :name (String) —

    Specifies a familiar name for your on-premises storage system.

  • :cloud_watch_log_group_arn (String) —

    Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.

  • :credentials (Types::Credentials) —

    Specifies the user name and password for accessing your on-premises storage system's management interface.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4374
4375
4376
4377
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4374

def update_storage_system(params = {}, options = {})
  req = build_request(:update_storage_system, params)
  req.send_request(options)
end

#update_task(params = {}) ⇒ Struct

Updates the configuration of a task, which defines where and how DataSync transfers your data.

Examples:

Request syntax with placeholder values


resp = client.update_task({
  task_arn: "TaskArn", # required
  options: {
    verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
    overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
    atime: "NONE", # accepts NONE, BEST_EFFORT
    mtime: "NONE", # accepts NONE, PRESERVE
    uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
    gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
    preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
    preserve_devices: "NONE", # accepts NONE, PRESERVE
    posix_permissions: "NONE", # accepts NONE, PRESERVE
    bytes_per_second: 1,
    task_queueing: "ENABLED", # accepts ENABLED, DISABLED
    log_level: "OFF", # accepts OFF, BASIC, TRANSFER
    transfer_mode: "CHANGED", # accepts CHANGED, ALL
    security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
    object_tags: "PRESERVE", # accepts PRESERVE, NONE
  },
  excludes: [
    {
      filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
      value: "FilterValue",
    },
  ],
  schedule: {
    schedule_expression: "ScheduleExpressionCron", # required
    status: "ENABLED", # accepts ENABLED, DISABLED
  },
  name: "TagValue",
  cloud_watch_log_group_arn: "LogGroupArn",
  includes: [
    {
      filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
      value: "FilterValue",
    },
  ],
  manifest_config: {
    action: "TRANSFER", # accepts TRANSFER
    format: "CSV", # accepts CSV
    source: {
      s3: { # required
        manifest_object_path: "S3Subdirectory", # required
        bucket_access_role_arn: "IamRoleArn", # required
        s3_bucket_arn: "S3BucketArn", # required
        manifest_object_version_id: "S3ObjectVersionId",
      },
    },
  },
  task_report_config: {
    destination: {
      s3: {
        subdirectory: "S3Subdirectory",
        s3_bucket_arn: "S3BucketArn", # required
        bucket_access_role_arn: "IamRoleArn", # required
      },
    },
    output_type: "SUMMARY_ONLY", # accepts SUMMARY_ONLY, STANDARD
    report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
    object_version_ids: "INCLUDE", # accepts INCLUDE, NONE
    overrides: {
      transferred: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
      verified: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
      deleted: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
      skipped: {
        report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
      },
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_arn (required, String) —

    Specifies the ARN of the task that you want to update.

  • :options (Types::Options) —

    Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

    Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.

    You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.

  • :excludes (Array<Types::FilterRule>) —

    Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

  • :schedule (Types::TaskSchedule) —

    Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

  • :name (String) —

    Specifies the name of your task.

  • :cloud_watch_log_group_arn (String) —

    Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

  • :includes (Array<Types::FilterRule>) —

    Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

  • :manifest_config (Types::ManifestConfig) —

    Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

    When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

    To remove a manifest configuration, specify this parameter as empty.

  • :task_report_config (Types::TaskReportConfig) —

    Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

    When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

    To remove a task report configuration, specify this parameter as empty.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4557
4558
4559
4560
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4557

def update_task(params = {}, options = {})
  req = build_request(:update_task, params)
  req.send_request(options)
end

#update_task_execution(params = {}) ⇒ Struct

Updates the configuration of a running DataSync task execution.

Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond, which throttles bandwidth for a running or queued task execution.

Examples:

Request syntax with placeholder values


resp = client.update_task_execution({
  task_execution_arn: "TaskExecutionArn", # required
  options: { # required
    verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
    overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
    atime: "NONE", # accepts NONE, BEST_EFFORT
    mtime: "NONE", # accepts NONE, PRESERVE
    uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
    gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
    preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
    preserve_devices: "NONE", # accepts NONE, PRESERVE
    posix_permissions: "NONE", # accepts NONE, PRESERVE
    bytes_per_second: 1,
    task_queueing: "ENABLED", # accepts ENABLED, DISABLED
    log_level: "OFF", # accepts OFF, BASIC, TRANSFER
    transfer_mode: "CHANGED", # accepts CHANGED, ALL
    security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
    object_tags: "PRESERVE", # accepts PRESERVE, NONE
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_execution_arn (required, String) —

    Specifies the Amazon Resource Name (ARN) of the task execution that you're updating.

  • :options (required, Types::Options) —

    Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

    Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.

    You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4620
4621
4622
4623
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4620

def update_task_execution(params = {}, options = {})
  req = build_request(:update_task_execution, params)
  req.send_request(options)
end