Struct aws_sdk_datasync::Client

pub struct Client { /* private fields */ }

Client for AWS DataSync

Client for invoking operations on AWS DataSync. Each operation on AWS DataSync is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_datasync::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_datasync::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AddStorageSystem operation has a Client::add_storage_system, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.add_storage_system()
    .system_type("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn add_storage_system(&self) -> AddStorageSystemFluentBuilder

Constructs a fluent builder for the AddStorageSystem operation.

• The fluent builder is configurable:
  • server_configuration(DiscoveryServerConfiguration) / set_server_configuration(Option<DiscoveryServerConfiguration>):
    required: true
    

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

    
    
  • system_type(DiscoverySystemType) / set_system_type(Option<DiscoverySystemType>):
    required: true
    

    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(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: true
    

    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(impl Into<String>) / set_cloud_watch_log_group_arn(Option<String>):
    required: false
    

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

    
    
  • tags(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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(impl Into<String>) / set_name(Option<String>):
    required: false
    

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

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    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.

    
    
  • credentials(Credentials) / set_credentials(Option<Credentials>):
    required: true
    

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

    
    
• On success, responds with AddStorageSystemOutput with field(s):
  • storage_system_arn(String):

    The ARN of the on-premises storage system that you can use with DataSync Discovery.

• On failure, responds with SdkError<AddStorageSystemError>

impl Client

pub fn cancel_task_execution(&self) -> CancelTaskExecutionFluentBuilder

Constructs a fluent builder for the CancelTaskExecution operation.

• The fluent builder is configurable:
  • task_execution_arn(impl Into<String>) / set_task_execution_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with CancelTaskExecutionOutput
• On failure, responds with SdkError<CancelTaskExecutionError>

impl Client

pub fn create_agent(&self) -> CreateAgentFluentBuilder

Constructs a fluent builder for the CreateAgent operation.

• The fluent builder is configurable:
  • activation_key(impl Into<String>) / set_activation_key(Option<String>):
    required: true
    

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

    
    
  • agent_name(impl Into<String>) / set_agent_name(Option<String>):
    required: false
    

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

    
    
  • tags(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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(impl Into<String>) / set_vpc_endpoint_id(Option<String>):
    required: false
    

    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(impl Into<String>) / set_subnet_arns(Option<Vec::<String>>):
    required: false
    

    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(impl Into<String>) / set_security_group_arns(Option<Vec::<String>>):
    required: false
    

    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.

    
    
• On success, responds with CreateAgentOutput with field(s):
  • agent_arn(Option<String>):

    The ARN of the agent that you just activated. Use the ListAgents operation to return a list of agents in your Amazon Web Services account and Amazon Web Services Region.

• On failure, responds with SdkError<CreateAgentError>

impl Client

pub fn create_location_azure_blob(&self) -> CreateLocationAzureBlobFluentBuilder

Constructs a fluent builder for the CreateLocationAzureBlob operation.

• The fluent builder is configurable:
  • container_url(impl Into<String>) / set_container_url(Option<String>):
    required: true
    

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

    
    
  • authentication_type(AzureBlobAuthenticationType) / set_authentication_type(Option<AzureBlobAuthenticationType>):
    required: true
    

    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(AzureBlobSasConfiguration) / set_sas_configuration(Option<AzureBlobSasConfiguration>):
    required: false
    

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

    
    
  • blob_type(AzureBlobType) / set_blob_type(Option<AzureBlobType>):
    required: false
    

    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(AzureAccessTier) / set_access_tier(Option<AzureAccessTier>):
    required: false
    

    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(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

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

    
    
  • agent_arns(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: true
    

    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(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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.

    
    
• On success, responds with CreateLocationAzureBlobOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the Azure Blob Storage transfer location that you created.

• On failure, responds with SdkError<CreateLocationAzureBlobError>

impl Client

pub fn create_location_efs(&self) -> CreateLocationEfsFluentBuilder

Constructs a fluent builder for the CreateLocationEfs operation.

• The fluent builder is configurable:
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(impl Into<String>) / set_efs_filesystem_arn(Option<String>):
    required: true
    

    Specifies the ARN for the Amazon EFS file system.

    
    
  • ec2_config(Ec2Config) / set_ec2_config(Option<Ec2Config>):
    required: true
    

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

    
    
  • tags(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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(impl Into<String>) / set_access_point_arn(Option<String>):
    required: false
    

    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(impl Into<String>) / set_file_system_access_role_arn(Option<String>):
    required: false
    

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

    
    
  • in_transit_encryption(EfsInTransitEncryption) / set_in_transit_encryption(Option<EfsInTransitEncryption>):
    required: false
    

    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.

    
    
• On success, responds with CreateLocationEfsOutput with field(s):
  • location_arn(Option<String>):

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

• On failure, responds with SdkError<CreateLocationEfsError>

impl Client

pub fn create_location_fsx_lustre(&self) -> CreateLocationFsxLustreFluentBuilder

Constructs a fluent builder for the CreateLocationFsxLustre operation.

• The fluent builder is configurable:
  • fsx_filesystem_arn(impl Into<String>) / set_fsx_filesystem_arn(Option<String>):
    required: true
    

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

    
    
  • security_group_arns(impl Into<String>) / set_security_group_arns(Option<Vec::<String>>):
    required: true
    

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

    
    
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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.

    
    
• On success, responds with CreateLocationFsxLustreOutput with field(s):
  • location_arn(Option<String>):

    The Amazon Resource Name (ARN) of the FSx for Lustre file system location that’s created.

• On failure, responds with SdkError<CreateLocationFsxLustreError>

impl Client

pub fn create_location_fsx_ontap(&self) -> CreateLocationFsxOntapFluentBuilder

Constructs a fluent builder for the CreateLocationFsxOntap operation.

• The fluent builder is configurable:
  • protocol(FsxProtocol) / set_protocol(Option<FsxProtocol>):
    required: true
    

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

    
    
  • security_group_arns(impl Into<String>) / set_security_group_arns(Option<Vec::<String>>):
    required: true
    

    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(impl Into<String>) / set_storage_virtual_machine_arn(Option<String>):
    required: true
    

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

    
    
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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.

    
    
• On success, responds with CreateLocationFsxOntapOutput with field(s):
  • location_arn(Option<String>):

    Specifies the ARN of the FSx for ONTAP file system location that you create.

• On failure, responds with SdkError<CreateLocationFsxOntapError>

impl Client

pub fn create_location_fsx_open_zfs( &self ) -> CreateLocationFsxOpenZfsFluentBuilder

Constructs a fluent builder for the CreateLocationFsxOpenZfs operation.

• The fluent builder is configurable:
  • fsx_filesystem_arn(impl Into<String>) / set_fsx_filesystem_arn(Option<String>):
    required: true
    

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

    
    
  • protocol(FsxProtocol) / set_protocol(Option<FsxProtocol>):
    required: true
    

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

    
    
  • security_group_arns(impl Into<String>) / set_security_group_arns(Option<Vec::<String>>):
    required: true
    

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

    
    
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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.

    
    
• On success, responds with CreateLocationFsxOpenZfsOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the FSx for OpenZFS file system location that you created.

• On failure, responds with SdkError<CreateLocationFsxOpenZfsError>

impl Client

pub fn create_location_fsx_windows( &self ) -> CreateLocationFsxWindowsFluentBuilder

Constructs a fluent builder for the CreateLocationFsxWindows operation.

• The fluent builder is configurable:
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(impl Into<String>) / set_fsx_filesystem_arn(Option<String>):
    required: true
    

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

    
    
  • security_group_arns(impl Into<String>) / set_security_group_arns(Option<Vec::<String>>):
    required: true
    

    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(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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(impl Into<String>) / set_user(Option<String>):
    required: true
    

    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(impl Into<String>) / set_domain(Option<String>):
    required: false
    

    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(impl Into<String>) / set_password(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CreateLocationFsxWindowsOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the FSx for Windows File Server file system location you created.

• On failure, responds with SdkError<CreateLocationFsxWindowsError>

impl Client

pub fn create_location_hdfs(&self) -> CreateLocationHdfsFluentBuilder

Constructs a fluent builder for the CreateLocationHdfs operation.

• The fluent builder is configurable:
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(HdfsNameNode) / set_name_nodes(Option<Vec::<HdfsNameNode>>):
    required: true
    

    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(i32) / set_block_size(Option<i32>):
    required: false
    

    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(i32) / set_replication_factor(Option<i32>):
    required: false
    

    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(impl Into<String>) / set_kms_key_provider_uri(Option<String>):
    required: false
    

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

    
    
  • qop_configuration(QopConfiguration) / set_qop_configuration(Option<QopConfiguration>):
    required: false
    

    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(HdfsAuthenticationType) / set_authentication_type(Option<HdfsAuthenticationType>):
    required: true
    

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

    
    
  • simple_user(impl Into<String>) / set_simple_user(Option<String>):
    required: false
    

    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(impl Into<String>) / set_kerberos_principal(Option<String>):
    required: false
    

    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(Blob) / set_kerberos_keytab(Option<Blob>):
    required: false
    

    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_krb5_conf(Blob) / set_kerberos_krb5_conf(Option<Blob>):
    required: false
    

    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(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: true
    

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

    
    
  • tags(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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.

    
    
• On success, responds with CreateLocationHdfsOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the source HDFS cluster location that’s created.

• On failure, responds with SdkError<CreateLocationHdfsError>

impl Client

pub fn create_location_nfs(&self) -> CreateLocationNfsFluentBuilder

Constructs a fluent builder for the CreateLocationNfs operation.

• The fluent builder is configurable:
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: true
    

    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(impl Into<String>) / set_server_hostname(Option<String>):
    required: true
    

    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(OnPremConfig) / set_on_prem_config(Option<OnPremConfig>):
    required: true
    

    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(NfsMountOptions) / set_mount_options(Option<NfsMountOptions>):
    required: false
    

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

    
    
  • tags(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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.

    
    
• On success, responds with CreateLocationNfsOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the transfer location that you created for your NFS file server.

• On failure, responds with SdkError<CreateLocationNfsError>

impl Client

pub fn create_location_object_storage( &self ) -> CreateLocationObjectStorageFluentBuilder

Constructs a fluent builder for the CreateLocationObjectStorage operation.

• The fluent builder is configurable:
  • server_hostname(impl Into<String>) / set_server_hostname(Option<String>):
    required: true
    

    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(i32) / set_server_port(Option<i32>):
    required: false
    

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

    
    
  • server_protocol(ObjectStorageServerProtocol) / set_server_protocol(Option<ObjectStorageServerProtocol>):
    required: false
    

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

    
    
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(impl Into<String>) / set_bucket_name(Option<String>):
    required: true
    

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

    
    
  • access_key(impl Into<String>) / set_access_key(Option<String>):
    required: false
    

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

    
    
  • secret_key(impl Into<String>) / set_secret_key(Option<String>):
    required: false
    

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

    
    
  • agent_arns(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: true
    

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

    
    
  • tags(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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(Blob) / set_server_certificate(Option<Blob>):
    required: false
    

    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.

    
    
• On success, responds with CreateLocationObjectStorageOutput with field(s):
  • location_arn(Option<String>):

    Specifies the ARN of the object storage system location that you create.

• On failure, responds with SdkError<CreateLocationObjectStorageError>

impl Client

pub fn create_location_s3(&self) -> CreateLocationS3FluentBuilder

Constructs a fluent builder for the CreateLocationS3 operation.

• The fluent builder is configurable:
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(impl Into<String>) / set_s3_bucket_arn(Option<String>):
    required: true
    

    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(S3StorageClass) / set_s3_storage_class(Option<S3StorageClass>):
    required: false
    

    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(S3Config) / set_s3_config(Option<S3Config>):
    required: true
    

    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(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: false
    

    (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(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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.

    
    
• On success, responds with CreateLocationS3Output with field(s):
  • location_arn(Option<String>):

    The ARN of the S3 location that you created.

• On failure, responds with SdkError<CreateLocationS3Error>

impl Client

pub fn create_location_smb(&self) -> CreateLocationSmbFluentBuilder

Constructs a fluent builder for the CreateLocationSmb operation.

• The fluent builder is configurable:
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: true
    

    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(impl Into<String>) / set_server_hostname(Option<String>):
    required: true
    

    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(impl Into<String>) / set_user(Option<String>):
    required: true
    

    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(impl Into<String>) / set_domain(Option<String>):
    required: false
    

    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(impl Into<String>) / set_password(Option<String>):
    required: true
    

    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(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: true
    

    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(SmbMountOptions) / set_mount_options(Option<SmbMountOptions>):
    required: false
    

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

    
    
  • tags(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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.

    
    
• On success, responds with CreateLocationSmbOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the SMB location that you created.

• On failure, responds with SdkError<CreateLocationSmbError>

impl Client

pub fn create_task(&self) -> CreateTaskFluentBuilder

Constructs a fluent builder for the CreateTask operation.

• The fluent builder is configurable:
  • source_location_arn(impl Into<String>) / set_source_location_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the source location for the task.

    
    
  • destination_location_arn(impl Into<String>) / set_destination_location_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of an Amazon Web Services storage resource’s location.

    
    
  • cloud_watch_log_group_arn(impl Into<String>) / set_cloud_watch_log_group_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of a task. This value is a text reference that is used to identify the task in the console.

    
    
  • options(Options) / set_options(Option<Options>):
    required: false
    

    Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

    You can also override these options before starting an individual run of a task (also known as a task execution). For more information, see StartTaskExecution.

    
    
  • excludes(FilterRule) / set_excludes(Option<Vec::<FilterRule>>):
    required: false
    

    Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

    
    
  • schedule(TaskSchedule) / set_schedule(Option<TaskSchedule>):
    required: false
    

    Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

    
    
  • tags(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

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

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

    
    
  • includes(FilterRule) / set_includes(Option<Vec::<FilterRule>>):
    required: false
    

    Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

    
    
  • manifest_config(ManifestConfig) / set_manifest_config(Option<ManifestConfig>):
    required: false
    

    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(TaskReportConfig) / set_task_report_config(Option<TaskReportConfig>):
    required: false
    

    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.

    
    
• On success, responds with CreateTaskOutput with field(s):
  • task_arn(Option<String>):

    The Amazon Resource Name (ARN) of the task.

• On failure, responds with SdkError<CreateTaskError>

impl Client

pub fn delete_agent(&self) -> DeleteAgentFluentBuilder

Constructs a fluent builder for the DeleteAgent operation.

• The fluent builder is configurable:
  • agent_arn(impl Into<String>) / set_agent_arn(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteAgentOutput
• On failure, responds with SdkError<DeleteAgentError>

impl Client

pub fn delete_location(&self) -> DeleteLocationFluentBuilder

Constructs a fluent builder for the DeleteLocation operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeleteLocationOutput
• On failure, responds with SdkError<DeleteLocationError>

impl Client

pub fn delete_task(&self) -> DeleteTaskFluentBuilder

Constructs a fluent builder for the DeleteTask operation.

• The fluent builder is configurable:
  • task_arn(impl Into<String>) / set_task_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeleteTaskOutput
• On failure, responds with SdkError<DeleteTaskError>

impl Client

pub fn describe_agent(&self) -> DescribeAgentFluentBuilder

Constructs a fluent builder for the DescribeAgent operation.

• The fluent builder is configurable:
  • agent_arn(impl Into<String>) / set_agent_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeAgentOutput with field(s):
  • agent_arn(Option<String>):

    The ARN of the agent.

  • name(Option<String>):

    The name of the agent.

  • status(Option<AgentStatus>):

    The status of the agent.

    • If the status is ONLINE, the agent is configured properly and ready to use.

    • If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?

  • last_connection_time(Option<DateTime>):

    The last time that the agent was communicating with the DataSync service.

  • creation_time(Option<DateTime>):

    The time that the agent was activated.

  • endpoint_type(Option<EndpointType>):

    The type of service endpoint that your agent is connected to.

  • private_link_config(Option<PrivateLinkConfig>):

    The network configuration that the agent uses when connecting to a VPC service endpoint.

  • platform(Option<Platform>):

    The platform-related details about the agent, such as the version number.

• On failure, responds with SdkError<DescribeAgentError>

impl Client

pub fn describe_discovery_job(&self) -> DescribeDiscoveryJobFluentBuilder

Constructs a fluent builder for the DescribeDiscoveryJob operation.

• The fluent builder is configurable:
  • discovery_job_arn(impl Into<String>) / set_discovery_job_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeDiscoveryJobOutput with field(s):
  • storage_system_arn(Option<String>):

    The ARN of the on-premises storage system you’re running the discovery job on.

  • discovery_job_arn(Option<String>):

    The ARN of the discovery job.

  • collection_duration_minutes(Option<i32>):

    The number of minutes that the discovery job runs.

  • status(Option<DiscoveryJobStatus>):

    Indicates the status of a discovery job. For more information, see Discovery job statuses.

  • job_start_time(Option<DateTime>):

    The time when the discovery job started.

  • job_end_time(Option<DateTime>):

    The time when the discovery job ended.

• On failure, responds with SdkError<DescribeDiscoveryJobError>

impl Client

pub fn describe_location_azure_blob( &self ) -> DescribeLocationAzureBlobFluentBuilder

Constructs a fluent builder for the DescribeLocationAzureBlob operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationAzureBlobOutput with field(s):
  • location_arn(Option<String>):

    The ARN of your Azure Blob Storage transfer location.

  • location_uri(Option<String>):

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

  • authentication_type(Option<AzureBlobAuthenticationType>):

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

  • blob_type(Option<AzureBlobType>):

    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(Option<AzureAccessTier>):

    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(Option<Vec::<String>>):

    The ARNs of the DataSync agents that can connect with your Azure Blob Storage container.

  • creation_time(Option<DateTime>):

    The time that your Azure Blob Storage transfer location was created.

• On failure, responds with SdkError<DescribeLocationAzureBlobError>

impl Client

pub fn describe_location_efs(&self) -> DescribeLocationEfsFluentBuilder

Constructs a fluent builder for the DescribeLocationEfs operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationEfsOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the Amazon EFS file system location.

  • location_uri(Option<String>):

    The URL of the Amazon EFS file system location.

  • ec2_config(Option<Ec2Config>):

    The subnet and security groups that DataSync uses to access your Amazon EFS file system.

  • creation_time(Option<DateTime>):

    The time that the location was created.

  • access_point_arn(Option<String>):

    The ARN of the access point that DataSync uses to access the Amazon EFS file system.

  • file_system_access_role_arn(Option<String>):

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

  • in_transit_encryption(Option<EfsInTransitEncryption>):

    Describes whether DataSync uses Transport Layer Security (TLS) encryption when copying data to or from the Amazon EFS file system.

• On failure, responds with SdkError<DescribeLocationEfsError>

impl Client

pub fn describe_location_fsx_lustre( &self ) -> DescribeLocationFsxLustreFluentBuilder

Constructs a fluent builder for the DescribeLocationFsxLustre operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationFsxLustreOutput with field(s):
  • location_arn(Option<String>):

    The Amazon Resource Name (ARN) of the FSx for Lustre location that was described.

  • location_uri(Option<String>):

    The URI of the FSx for Lustre location that was described.

  • security_group_arns(Option<Vec::<String>>):

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

  • creation_time(Option<DateTime>):

    The time that the FSx for Lustre location was created.

• On failure, responds with SdkError<DescribeLocationFsxLustreError>

impl Client

pub fn describe_location_fsx_ontap( &self ) -> DescribeLocationFsxOntapFluentBuilder

Constructs a fluent builder for the DescribeLocationFsxOntap operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationFsxOntapOutput with field(s):
  • creation_time(Option<DateTime>):

    The time that the location was created.

  • location_arn(Option<String>):

    The ARN of the FSx for ONTAP file system location.

  • location_uri(Option<String>):

    The uniform resource identifier (URI) of the FSx for ONTAP file system location.

  • protocol(Option<FsxProtocol>):

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

  • security_group_arns(Option<Vec::<String>>):

    The security groups that DataSync uses to access your FSx for ONTAP file system.

  • storage_virtual_machine_arn(Option<String>):

    The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you’re copying data to or from.

  • fsx_filesystem_arn(Option<String>):

    The ARN of the FSx for ONTAP file system.

• On failure, responds with SdkError<DescribeLocationFsxOntapError>

impl Client

pub fn describe_location_fsx_open_zfs( &self ) -> DescribeLocationFsxOpenZfsFluentBuilder

Constructs a fluent builder for the DescribeLocationFsxOpenZfs operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationFsxOpenZfsOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the FSx for OpenZFS location that was described.

  • location_uri(Option<String>):

    The uniform resource identifier (URI) of the FSx for OpenZFS location that was described.

    Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder

  • security_group_arns(Option<Vec::<String>>):

    The ARNs of the security groups that are configured for the FSx for OpenZFS file system.

  • protocol(Option<FsxProtocol>):

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

  • creation_time(Option<DateTime>):

    The time that the FSx for OpenZFS location was created.

• On failure, responds with SdkError<DescribeLocationFsxOpenZfsError>

impl Client

pub fn describe_location_fsx_windows( &self ) -> DescribeLocationFsxWindowsFluentBuilder

Constructs a fluent builder for the DescribeLocationFsxWindows operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationFsxWindowsOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the FSx for Windows File Server location.

  • location_uri(Option<String>):

    The uniform resource identifier (URI) of the FSx for Windows File Server location.

  • security_group_arns(Option<Vec::<String>>):

    The ARNs of the security groups that are configured for the FSx for Windows File Server file system.

  • creation_time(Option<DateTime>):

    The time that the FSx for Windows File Server location was created.

  • user(Option<String>):

    The user with the permissions to mount and access the FSx for Windows File Server file system.

  • domain(Option<String>):

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

• On failure, responds with SdkError<DescribeLocationFsxWindowsError>

impl Client

pub fn describe_location_hdfs(&self) -> DescribeLocationHdfsFluentBuilder

Constructs a fluent builder for the DescribeLocationHdfs operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationHdfsOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the HDFS location.

  • location_uri(Option<String>):

    The URI of the HDFS location.

  • name_nodes(Option<Vec::<HdfsNameNode>>):

    The NameNode that manages the HDFS namespace.

  • block_size(Option<i32>):

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

  • replication_factor(Option<i32>):

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

  • kms_key_provider_uri(Option<String>):

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

  • qop_configuration(Option<QopConfiguration>):

    The Quality of Protection (QOP) configuration, which specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the HDFS cluster.

  • authentication_type(Option<HdfsAuthenticationType>):

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

  • simple_user(Option<String>):

    The user name to identify the client on the host operating system. This parameter is used if the AuthenticationType is defined as SIMPLE.

  • kerberos_principal(Option<String>):

    The Kerberos principal with access to the files and folders on the HDFS cluster. This parameter is used if the AuthenticationType is defined as KERBEROS.

  • agent_arns(Option<Vec::<String>>):

    The ARNs of the DataSync agents that can connect with your HDFS cluster.

  • creation_time(Option<DateTime>):

    The time that the HDFS location was created.

• On failure, responds with SdkError<DescribeLocationHdfsError>

impl Client

pub fn describe_location_nfs(&self) -> DescribeLocationNfsFluentBuilder

Constructs a fluent builder for the DescribeLocationNfs operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationNfsOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the NFS location.

  • location_uri(Option<String>):

    The URI of the NFS location.

  • on_prem_config(Option<OnPremConfig>):

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

  • mount_options(Option<NfsMountOptions>):

    The mount options that DataSync uses to mount your NFS file server.

  • creation_time(Option<DateTime>):

    The time when the NFS location was created.

• On failure, responds with SdkError<DescribeLocationNfsError>

impl Client

pub fn describe_location_object_storage( &self ) -> DescribeLocationObjectStorageFluentBuilder

Constructs a fluent builder for the DescribeLocationObjectStorage operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationObjectStorageOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the object storage system location.

  • location_uri(Option<String>):

    The URI of the object storage system location.

  • access_key(Option<String>):

    The access key (for example, a user name) required to authenticate with the object storage system.

  • server_port(Option<i32>):

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

  • server_protocol(Option<ObjectStorageServerProtocol>):

    The protocol that your object storage system uses to communicate.

  • agent_arns(Option<Vec::<String>>):

    The ARNs of the DataSync agents that can connect with your object storage system.

  • creation_time(Option<DateTime>):

    The time that the location was created.

  • server_certificate(Option<Blob>):

    The self-signed certificate that DataSync uses to securely authenticate with your object storage system.

• On failure, responds with SdkError<DescribeLocationObjectStorageError>

impl Client

pub fn describe_location_s3(&self) -> DescribeLocationS3FluentBuilder

Constructs a fluent builder for the DescribeLocationS3 operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationS3Output with field(s):
  • location_arn(Option<String>):

    The ARN of the Amazon S3 location.

  • location_uri(Option<String>):

    The URL of the Amazon S3 location that was described.

  • s3_storage_class(Option<S3StorageClass>):

    When Amazon S3 is a destination location, this is the storage class that you chose for your objects.

    Some storage classes have behaviors that can affect your Amazon S3 storage costs. For more information, see Storage class considerations with Amazon S3 transfers.

  • s3_config(Option<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(Option<Vec::<String>>):

    The ARNs of the DataSync agents deployed on your Outpost when using working with Amazon S3 on Outposts.

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

  • creation_time(Option<DateTime>):

    The time that the Amazon S3 location was created.

• On failure, responds with SdkError<DescribeLocationS3Error>

impl Client

pub fn describe_location_smb(&self) -> DescribeLocationSmbFluentBuilder

Constructs a fluent builder for the DescribeLocationSmb operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeLocationSmbOutput with field(s):
  • location_arn(Option<String>):

    The ARN of the SMB location.

  • location_uri(Option<String>):

    The URI of the SMB location.

  • agent_arns(Option<Vec::<String>>):

    The ARNs of the DataSync agents that can connect with your SMB file server.

  • user(Option<String>):

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

  • domain(Option<String>):

    The name of the Microsoft Active Directory domain that the SMB file server belongs to.

  • mount_options(Option<SmbMountOptions>):

    The protocol that DataSync use to access your SMB file.

  • creation_time(Option<DateTime>):

    The time that the SMB location was created.

• On failure, responds with SdkError<DescribeLocationSmbError>

impl Client

pub fn describe_storage_system(&self) -> DescribeStorageSystemFluentBuilder

Constructs a fluent builder for the DescribeStorageSystem operation.

• The fluent builder is configurable:
  • storage_system_arn(impl Into<String>) / set_storage_system_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeStorageSystemOutput with field(s):
  • storage_system_arn(Option<String>):

    The ARN of the on-premises storage system that the discovery job looked at.

  • server_configuration(Option<DiscoveryServerConfiguration>):

    The server name and network port required to connect with your on-premises storage system’s management interface.

  • system_type(Option<DiscoverySystemType>):

    The type of on-premises storage system.

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

  • agent_arns(Option<Vec::<String>>):

    The ARN of the DataSync agent that connects to and reads from your on-premises storage system.

  • name(Option<String>):

    The name that you gave your on-premises storage system when adding it to DataSync Discovery.

  • error_message(Option<String>):

    Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.

  • connectivity_status(Option<StorageSystemConnectivityStatus>):

    Indicates whether your DataSync agent can connect to your on-premises storage system.

  • cloud_watch_log_group_arn(Option<String>):

    The ARN of the Amazon CloudWatch log group that’s used to monitor and log discovery job events.

  • creation_time(Option<DateTime>):

    The time when you added the on-premises storage system to DataSync Discovery.

  • secrets_manager_arn(Option<String>):

    The ARN of the secret that stores your on-premises storage system’s credentials. DataSync Discovery stores these credentials in Secrets Manager.

• On failure, responds with SdkError<DescribeStorageSystemError>

impl Client

pub fn describe_storage_system_resource_metrics( &self ) -> DescribeStorageSystemResourceMetricsFluentBuilder

Constructs a fluent builder for the DescribeStorageSystemResourceMetrics operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • discovery_job_arn(impl Into<String>) / set_discovery_job_arn(Option<String>):
    required: true
    

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

    
    
  • resource_type(DiscoveryResourceType) / set_resource_type(Option<DiscoveryResourceType>):
    required: true
    

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

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

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

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    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(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies how many results that you want in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with DescribeStorageSystemResourceMetricsOutput with field(s):
  • metrics(Option<Vec::<ResourceMetrics>>):

    The details that your discovery job collected about your storage system resource.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<DescribeStorageSystemResourceMetricsError>

impl Client

pub fn describe_storage_system_resources( &self ) -> DescribeStorageSystemResourcesFluentBuilder

Constructs a fluent builder for the DescribeStorageSystemResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • discovery_job_arn(impl Into<String>) / set_discovery_job_arn(Option<String>):
    required: true
    

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

    
    
  • resource_type(DiscoveryResourceType) / set_resource_type(Option<DiscoveryResourceType>):
    required: true
    

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

    
    
  • resource_ids(impl Into<String>) / set_resource_ids(Option<Vec::<String>>):
    required: false
    

    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(DiscoveryResourceFilter, Vec::<String>) / set_filter(Option<HashMap::<DiscoveryResourceFilter, Vec::<String>>>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with DescribeStorageSystemResourcesOutput with field(s):
  • resource_details(Option<ResourceDetails>):

    The information collected about your storage system’s resources. A response can also include Amazon Web Services storage service recommendations.

    For more information, see storage resource information collected by and recommendations provided by DataSync Discovery.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<DescribeStorageSystemResourcesError>

impl Client

pub fn describe_task(&self) -> DescribeTaskFluentBuilder

Constructs a fluent builder for the DescribeTask operation.

• The fluent builder is configurable:
  • task_arn(impl Into<String>) / set_task_arn(Option<String>):
    required: true
    

    Specifies the Amazon Resource Name (ARN) of the transfer task.

    
    
• On success, responds with DescribeTaskOutput with field(s):
  • task_arn(Option<String>):

    The Amazon Resource Name (ARN) of the task that was described.

  • status(Option<TaskStatus>):

    The status of the task that was described.

    For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

  • name(Option<String>):

    The name of the task that was described.

  • current_task_execution_arn(Option<String>):

    The Amazon Resource Name (ARN) of the task execution that is transferring files.

  • source_location_arn(Option<String>):

    The Amazon Resource Name (ARN) of the source file system’s location.

  • destination_location_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon Web Services storage resource’s location.

  • cloud_watch_log_group_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.

    For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

  • source_network_interface_arns(Option<Vec::<String>>):

    The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

  • destination_network_interface_arns(Option<Vec::<String>>):

    The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

  • options(Option<Options>):

    The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.

    You can override these options for each task execution. For more information, see StartTaskExecution.

  • excludes(Option<Vec::<FilterRule>>):

    A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

  • schedule(Option<TaskSchedule>):

    The schedule used to periodically transfer files from a source to a destination location.

  • error_code(Option<String>):

    Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

  • error_detail(Option<String>):

    Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

  • creation_time(Option<DateTime>):

    The time that the task was created.

  • includes(Option<Vec::<FilterRule>>):

    A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

  • manifest_config(Option<ManifestConfig>):

    The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

  • task_report_config(Option<TaskReportConfig>):

    The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

• On failure, responds with SdkError<DescribeTaskError>

impl Client

pub fn describe_task_execution(&self) -> DescribeTaskExecutionFluentBuilder

Constructs a fluent builder for the DescribeTaskExecution operation.

• The fluent builder is configurable:
  • task_execution_arn(impl Into<String>) / set_task_execution_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeTaskExecutionOutput with field(s):
  • task_execution_arn(Option<String>):

    The ARN of the task execution that you wanted information about. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

    For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

  • status(Option<TaskExecutionStatus>):

    The status of the task execution.

  • options(Option<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 of these options before starting your task.

  • excludes(Option<Vec::<FilterRule>>):

    A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

  • includes(Option<Vec::<FilterRule>>):

    A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

  • manifest_config(Option<ManifestConfig>):

    The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

  • start_time(Option<DateTime>):

    The time when the task execution started.

  • estimated_files_to_transfer(i64):

    The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution’s PREPARING phase before the TRANSFERRING phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred.

  • estimated_bytes_to_transfer(i64):

    The estimated physical number of bytes that will transfer over the network.

  • files_transferred(i64):

    The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution’s TRANSFERRING phase when something is read from the source and sent over the network.

    If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-specific for some location types, so don’t use it as an exact indication of what transferred or to monitor your task execution.

  • bytes_written(i64):

    The number of logical bytes written to the destination location.

  • bytes_transferred(i64):

    The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed.

  • bytes_compressed(i64):

    The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than BytesTransferred unless the data isn’t compressible.

  • result(Option<TaskExecutionResultDetail>):

    The result of the task execution.

  • task_report_config(Option<TaskReportConfig>):

    The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

  • files_deleted(i64):

    The number of files, objects, and directories that DataSync deleted in your destination location. If you don’t configure your task to delete data in the destination that isn’t in the source, the value is always 0.

  • files_skipped(i64):

    The number of files, objects, and directories that DataSync skipped during your transfer.

  • files_verified(i64):

    The number of files, objects, and directories that DataSync verified during your transfer.

    When you configure your task to verify only the data that’s transferred, DataSync doesn’t verify directories in some situations or files that fail to transfer.

  • report_result(Option<ReportResult>):

    Indicates whether DataSync generated a complete task report for your transfer.

  • estimated_files_to_delete(i64):

    The expected number of files, objects, and directories that DataSync will delete in your destination location. If you don’t configure your task to delete data in the destination that isn’t in the source, the value is always 0.

• On failure, responds with SdkError<DescribeTaskExecutionError>

impl Client

pub fn generate_recommendations(&self) -> GenerateRecommendationsFluentBuilder

Constructs a fluent builder for the GenerateRecommendations operation.

• The fluent builder is configurable:
  • discovery_job_arn(impl Into<String>) / set_discovery_job_arn(Option<String>):
    required: true
    

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

    
    
  • resource_ids(impl Into<String>) / set_resource_ids(Option<Vec::<String>>):
    required: true
    

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

    
    
  • resource_type(DiscoveryResourceType) / set_resource_type(Option<DiscoveryResourceType>):
    required: true
    

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

    
    
• On success, responds with GenerateRecommendationsOutput
• On failure, responds with SdkError<GenerateRecommendationsError>

impl Client

pub fn list_agents(&self) -> ListAgentsFluentBuilder

Constructs a fluent builder for the ListAgents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListAgentsOutput with field(s):
  • agents(Option<Vec::<AgentListEntry>>):

    A list of DataSync agents in your Amazon Web Services account in the Amazon Web Services Region specified in the request. The list is ordered by the agents’ Amazon Resource Names (ARNs).

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListAgentsError>

impl Client

pub fn list_discovery_jobs(&self) -> ListDiscoveryJobsFluentBuilder

Constructs a fluent builder for the ListDiscoveryJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • storage_system_arn(impl Into<String>) / set_storage_system_arn(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies how many results you want in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListDiscoveryJobsOutput with field(s):
  • discovery_jobs(Option<Vec::<DiscoveryJobListEntry>>):

    The discovery jobs that you’ve run.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListDiscoveryJobsError>

impl Client

pub fn list_locations(&self) -> ListLocationsFluentBuilder

Constructs a fluent builder for the ListLocations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of locations to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • filters(LocationFilter) / set_filters(Option<Vec::<LocationFilter>>):
    required: false
    

    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.

    
    
• On success, responds with ListLocationsOutput with field(s):
  • locations(Option<Vec::<LocationListEntry>>):

    An array that contains a list of locations.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListLocationsError>

impl Client

pub fn list_storage_systems(&self) -> ListStorageSystemsFluentBuilder

Constructs a fluent builder for the ListStorageSystems operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies how many results you want in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListStorageSystemsOutput with field(s):
  • storage_systems(Option<Vec::<StorageSystemListEntry>>):

    The Amazon Resource Names ARNs) of the on-premises storage systems that you’re using with DataSync Discovery.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListStorageSystemsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies how many results that you want in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<TagListEntry>>):

    An array of tags applied to the specified resource.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_task_executions(&self) -> ListTaskExecutionsFluentBuilder

Constructs a fluent builder for the ListTaskExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • task_arn(impl Into<String>) / set_task_arn(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies how many results you want in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListTaskExecutionsOutput with field(s):
  • task_executions(Option<Vec::<TaskExecutionListEntry>>):

    A list of the task’s executions.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListTaskExecutionsError>

impl Client

pub fn list_tasks(&self) -> ListTasksFluentBuilder

Constructs a fluent builder for the ListTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of tasks to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • filters(TaskFilter) / set_filters(Option<Vec::<TaskFilter>>):
    required: false
    

    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.

    
    
• On success, responds with ListTasksOutput with field(s):
  • tasks(Option<Vec::<TaskListEntry>>):

    A list of all the tasks that are returned.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListTasksError>

impl Client

pub fn remove_storage_system(&self) -> RemoveStorageSystemFluentBuilder

Constructs a fluent builder for the RemoveStorageSystem operation.

• The fluent builder is configurable:
  • storage_system_arn(impl Into<String>) / set_storage_system_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with RemoveStorageSystemOutput
• On failure, responds with SdkError<RemoveStorageSystemError>

impl Client

pub fn start_discovery_job(&self) -> StartDiscoveryJobFluentBuilder

Constructs a fluent builder for the StartDiscoveryJob operation.

• The fluent builder is configurable:
  • storage_system_arn(impl Into<String>) / set_storage_system_arn(Option<String>):
    required: true
    

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

    
    
  • collection_duration_minutes(i32) / set_collection_duration_minutes(Option<i32>):
    required: true
    

    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(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    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.

    
    
  • tags(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

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

    
    
• On success, responds with StartDiscoveryJobOutput with field(s):
  • discovery_job_arn(Option<String>):

    The ARN of the discovery job that you started.

• On failure, responds with SdkError<StartDiscoveryJobError>

impl Client

pub fn start_task_execution(&self) -> StartTaskExecutionFluentBuilder

Constructs a fluent builder for the StartTaskExecution operation.

• The fluent builder is configurable:
  • task_arn(impl Into<String>) / set_task_arn(Option<String>):
    required: true
    

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

    
    
  • override_options(Options) / set_override_options(Option<Options>):
    required: false
    

    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 of these options before starting your task.

    
    
  • includes(FilterRule) / set_includes(Option<Vec::<FilterRule>>):
    required: false
    

    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(FilterRule) / set_excludes(Option<Vec::<FilterRule>>):
    required: false
    

    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(ManifestConfig) / set_manifest_config(Option<ManifestConfig>):
    required: false
    

    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(TaskReportConfig) / set_task_report_config(Option<TaskReportConfig>):
    required: false
    

    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(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: false
    

    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.

    
    
• On success, responds with StartTaskExecutionOutput with field(s):
  • task_execution_arn(Option<String>):

    The ARN of the running task execution.

• On failure, responds with SdkError<StartTaskExecutionError>

impl Client

pub fn stop_discovery_job(&self) -> StopDiscoveryJobFluentBuilder

Constructs a fluent builder for the StopDiscoveryJob operation.

• The fluent builder is configurable:
  • discovery_job_arn(impl Into<String>) / set_discovery_job_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with StopDiscoveryJobOutput
• On failure, responds with SdkError<StopDiscoveryJobError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
  • tags(TagListEntry) / set_tags(Option<Vec::<TagListEntry>>):
    required: true
    

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

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
  • keys(impl Into<String>) / set_keys(Option<Vec::<String>>):
    required: true
    

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

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_agent(&self) -> UpdateAgentFluentBuilder

Constructs a fluent builder for the UpdateAgent operation.

• The fluent builder is configurable:
  • agent_arn(impl Into<String>) / set_agent_arn(Option<String>):
    required: true
    

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

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

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

    
    
• On success, responds with UpdateAgentOutput
• On failure, responds with SdkError<UpdateAgentError>

impl Client

pub fn update_discovery_job(&self) -> UpdateDiscoveryJobFluentBuilder

Constructs a fluent builder for the UpdateDiscoveryJob operation.

• The fluent builder is configurable:
  • discovery_job_arn(impl Into<String>) / set_discovery_job_arn(Option<String>):
    required: true
    

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

    
    
  • collection_duration_minutes(i32) / set_collection_duration_minutes(Option<i32>):
    required: true
    

    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.)

    
    
• On success, responds with UpdateDiscoveryJobOutput
• On failure, responds with SdkError<UpdateDiscoveryJobError>

impl Client

pub fn update_location_azure_blob(&self) -> UpdateLocationAzureBlobFluentBuilder

Constructs a fluent builder for the UpdateLocationAzureBlob operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

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

    
    
  • authentication_type(AzureBlobAuthenticationType) / set_authentication_type(Option<AzureBlobAuthenticationType>):
    required: false
    

    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(AzureBlobSasConfiguration) / set_sas_configuration(Option<AzureBlobSasConfiguration>):
    required: false
    

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

    
    
  • blob_type(AzureBlobType) / set_blob_type(Option<AzureBlobType>):
    required: false
    

    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(AzureAccessTier) / set_access_tier(Option<AzureAccessTier>):
    required: false
    

    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(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: false
    

    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.

    
    
• On success, responds with UpdateLocationAzureBlobOutput
• On failure, responds with SdkError<UpdateLocationAzureBlobError>

impl Client

pub fn update_location_hdfs(&self) -> UpdateLocationHdfsFluentBuilder

Constructs a fluent builder for the UpdateLocationHdfs operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

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

    
    
  • name_nodes(HdfsNameNode) / set_name_nodes(Option<Vec::<HdfsNameNode>>):
    required: false
    

    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(i32) / set_block_size(Option<i32>):
    required: false
    

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

    
    
  • replication_factor(i32) / set_replication_factor(Option<i32>):
    required: false
    

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

    
    
  • kms_key_provider_uri(impl Into<String>) / set_kms_key_provider_uri(Option<String>):
    required: false
    

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

    
    
  • qop_configuration(QopConfiguration) / set_qop_configuration(Option<QopConfiguration>):
    required: false
    

    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(HdfsAuthenticationType) / set_authentication_type(Option<HdfsAuthenticationType>):
    required: false
    

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

    
    
  • simple_user(impl Into<String>) / set_simple_user(Option<String>):
    required: false
    

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

    
    
  • kerberos_principal(impl Into<String>) / set_kerberos_principal(Option<String>):
    required: false
    

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

    
    
  • kerberos_keytab(Blob) / set_kerberos_keytab(Option<Blob>):
    required: false
    

    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_krb5_conf(Blob) / set_kerberos_krb5_conf(Option<Blob>):
    required: false
    

    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(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: false
    

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

    
    
• On success, responds with UpdateLocationHdfsOutput
• On failure, responds with SdkError<UpdateLocationHdfsError>

impl Client

pub fn update_location_nfs(&self) -> UpdateLocationNfsFluentBuilder

Constructs a fluent builder for the UpdateLocationNfs operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(OnPremConfig) / set_on_prem_config(Option<OnPremConfig>):
    required: false
    

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

    
    
  • mount_options(NfsMountOptions) / set_mount_options(Option<NfsMountOptions>):
    required: false
    

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

    
    
• On success, responds with UpdateLocationNfsOutput
• On failure, responds with SdkError<UpdateLocationNfsError>

impl Client

pub fn update_location_object_storage( &self ) -> UpdateLocationObjectStorageFluentBuilder

Constructs a fluent builder for the UpdateLocationObjectStorage operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
  • server_port(i32) / set_server_port(Option<i32>):
    required: false
    

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

    
    
  • server_protocol(ObjectStorageServerProtocol) / set_server_protocol(Option<ObjectStorageServerProtocol>):
    required: false
    

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

    
    
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(impl Into<String>) / set_access_key(Option<String>):
    required: false
    

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

    
    
  • secret_key(impl Into<String>) / set_secret_key(Option<String>):
    required: false
    

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

    
    
  • agent_arns(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: false
    

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

    
    
  • server_certificate(Blob) / set_server_certificate(Option<Blob>):
    required: false
    

    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.

    
    
• On success, responds with UpdateLocationObjectStorageOutput
• On failure, responds with SdkError<UpdateLocationObjectStorageError>

impl Client

pub fn update_location_smb(&self) -> UpdateLocationSmbFluentBuilder

Constructs a fluent builder for the UpdateLocationSmb operation.

• The fluent builder is configurable:
  • location_arn(impl Into<String>) / set_location_arn(Option<String>):
    required: true
    

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

    
    
  • subdirectory(impl Into<String>) / set_subdirectory(Option<String>):
    required: false
    

    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(impl Into<String>) / set_user(Option<String>):
    required: false
    

    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(impl Into<String>) / set_domain(Option<String>):
    required: false
    

    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(impl Into<String>) / set_password(Option<String>):
    required: false
    

    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(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: false
    

    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(SmbMountOptions) / set_mount_options(Option<SmbMountOptions>):
    required: false
    

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

    
    
• On success, responds with UpdateLocationSmbOutput
• On failure, responds with SdkError<UpdateLocationSmbError>

impl Client

pub fn update_storage_system(&self) -> UpdateStorageSystemFluentBuilder

Constructs a fluent builder for the UpdateStorageSystem operation.

• The fluent builder is configurable:
  • storage_system_arn(impl Into<String>) / set_storage_system_arn(Option<String>):
    required: true
    

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

    
    
  • server_configuration(DiscoveryServerConfiguration) / set_server_configuration(Option<DiscoveryServerConfiguration>):
    required: false
    

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

    
    
  • agent_arns(impl Into<String>) / set_agent_arns(Option<Vec::<String>>):
    required: false
    

    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(impl Into<String>) / set_name(Option<String>):
    required: false
    

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

    
    
  • cloud_watch_log_group_arn(impl Into<String>) / set_cloud_watch_log_group_arn(Option<String>):
    required: false
    

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

    
    
  • credentials(Credentials) / set_credentials(Option<Credentials>):
    required: false
    

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

    
    
• On success, responds with UpdateStorageSystemOutput
• On failure, responds with SdkError<UpdateStorageSystemError>

impl Client

pub fn update_task(&self) -> UpdateTaskFluentBuilder

Constructs a fluent builder for the UpdateTask operation.

• The fluent builder is configurable:
  • task_arn(impl Into<String>) / set_task_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource name of the task to update.

    
    
  • options(Options) / set_options(Option<Options>):
    required: false
    

    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 of these options before starting your task.

    
    
  • excludes(FilterRule) / set_excludes(Option<Vec::<FilterRule>>):
    required: false
    

    Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

    
    
  • schedule(TaskSchedule) / set_schedule(Option<TaskSchedule>):
    required: false
    

    Specifies a schedule used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is UTC time. For more information, see Scheduling your task.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the task to update.

    
    
  • cloud_watch_log_group_arn(impl Into<String>) / set_cloud_watch_log_group_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.

    
    
  • includes(FilterRule) / set_includes(Option<Vec::<FilterRule>>):
    required: false
    

    Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

    
    
  • manifest_config(ManifestConfig) / set_manifest_config(Option<ManifestConfig>):
    required: false
    

    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(TaskReportConfig) / set_task_report_config(Option<TaskReportConfig>):
    required: false
    

    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.

    
    
• On success, responds with UpdateTaskOutput
• On failure, responds with SdkError<UpdateTaskError>

impl Client

pub fn update_task_execution(&self) -> UpdateTaskExecutionFluentBuilder

Constructs a fluent builder for the UpdateTaskExecution operation.

• The fluent builder is configurable:
  • task_execution_arn(impl Into<String>) / set_task_execution_arn(Option<String>):
    required: true
    

    Specifies the Amazon Resource Name (ARN) of the task execution that you’re updating.

    
    
  • options(Options) / set_options(Option<Options>):
    required: true
    

    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 of these options before starting your task.

    
    
• On success, responds with UpdateTaskExecutionOutput
• On failure, responds with SdkError<UpdateTaskExecutionError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.