Class: AWS.DataSync

var params = {
  TaskExecutionArn: 'STRING_VALUE' /* required */
};
datasync.cancelTaskExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TaskExecutionArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ActivationKey: 'STRING_VALUE', /* required */
  AgentName: 'STRING_VALUE',
  SecurityGroupArns: [
    'STRING_VALUE',
    /* more items */
  ],
  SubnetArns: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcEndpointId: 'STRING_VALUE'
};
datasync.createAgent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ActivationKey — (String)

    Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.

    The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.

    For more information, see Activating an Agent in the DataSync User Guide.

  • AgentName — (String)

    The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.

  • Tags — (Array<map>)

    The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.

    Note: Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.
    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

  • VpcEndpointId — (String)

    The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

    VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

  • SubnetArns — (Array<String>)

    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.

  • SecurityGroupArns — (Array<String>)

    The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AgentArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Ec2Config: { /* required */
    SecurityGroupArns: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SubnetArn: 'STRING_VALUE' /* required */
  },
  EfsFilesystemArn: 'STRING_VALUE', /* required */
  AccessPointArn: 'STRING_VALUE',
  FileSystemAccessRoleArn: 'STRING_VALUE',
  InTransitEncryption: NONE | TLS1_2,
  Subdirectory: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationEfs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Subdirectory — (String)

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

    Note: You must specify a value with forward slashes (for example, /path/to/folder).
  • EfsFilesystemArn — (String)

    Specifies the ARN for the Amazon EFS file system.

  • Ec2Config — (map)

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

    • SubnetArn — required — (String)

      Specifies the ARN of a subnet where DataSync creates the network interfaces for managing traffic during your transfer.

      The subnet must be located:

      • In the same virtual private cloud (VPC) as the Amazon EFS file system.

      • In the same Availability Zone as at least one mount target for the Amazon EFS file system.

      Note: You don't need to specify a subnet that includes a file system mount target.
    • SecurityGroupArns — required — (Array<String>)

      Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.

  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

  • AccessPointArn — (String)

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

  • FileSystemAccessRoleArn — (String)

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

  • InTransitEncryption — (String)

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

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

    Possible values include:
    • "NONE"
    • "TLS1_2"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  FsxFilesystemArn: 'STRING_VALUE', /* required */
  SecurityGroupArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Subdirectory: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationFsxLustre(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • FsxFilesystemArn — (String)

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

  • SecurityGroupArns — (Array<String>)

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

  • Subdirectory — (String)

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

  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Protocol: { /* required */
    NFS: {
      MountOptions: {
        Version: AUTOMATIC | NFS3 | NFS4_0 | NFS4_1
      }
    },
    SMB: {
      Password: 'STRING_VALUE', /* required */
      User: 'STRING_VALUE', /* required */
      Domain: 'STRING_VALUE',
      MountOptions: {
        Version: AUTOMATIC | SMB2 | SMB3 | SMB1 | SMB2_0
      }
    }
  },
  SecurityGroupArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  StorageVirtualMachineArn: 'STRING_VALUE', /* required */
  Subdirectory: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationFsxOntap(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Protocol — (map)

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

    • NFS — (map)

      Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).

      • MountOptions — (map)

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

        • Version — (String)

          Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

          You can specify the following options:

          • AUTOMATIC (default): DataSync chooses NFS version 4.1.

          • NFS3: Stateless protocol version that allows for asynchronous writes on the server.

          • NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

          • NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

          Note: DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
          Possible values include:
          • "AUTOMATIC"
          • "NFS3"
          • "NFS4_0"
          • "NFS4_1"
    • SMB — (map)

      Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.

      • Domain — (String)

        Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

      • MountOptions — (map)

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

        • Version — (String)

          By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

          These are the following options for configuring the SMB version:

          • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

            This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

          • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

          • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

          • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

          • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

            Note: The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.
          Possible values include:
          • "AUTOMATIC"
          • "SMB2"
          • "SMB3"
          • "SMB1"
          • "SMB2_0"
      • Password — required — (String)

        Specifies the password of a user who has permission to access your SVM.

      • User — required — (String)

        Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.

        If you provide a user in your Active Directory, note the following:

        • If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.

        • If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.

        Make sure that the user has the permissions it needs to copy the data you want:

        • SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).

        • SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.

  • SecurityGroupArns — (Array<String>)

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

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

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

    • Server Message Block (SMB): TCP port 445

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

  • StorageVirtualMachineArn — (String)

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

  • Subdirectory — (String)

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

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

    Note: Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  FsxFilesystemArn: 'STRING_VALUE', /* required */
  Protocol: { /* required */
    NFS: {
      MountOptions: {
        Version: AUTOMATIC | NFS3 | NFS4_0 | NFS4_1
      }
    },
    SMB: {
      Password: 'STRING_VALUE', /* required */
      User: 'STRING_VALUE', /* required */
      Domain: 'STRING_VALUE',
      MountOptions: {
        Version: AUTOMATIC | SMB2 | SMB3 | SMB1 | SMB2_0
      }
    }
  },
  SecurityGroupArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Subdirectory: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationFsxOpenZfs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • FsxFilesystemArn — (String)

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

  • Protocol — (map)

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

    • NFS — (map)

      Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).

      • MountOptions — (map)

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

        • Version — (String)

          Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

          You can specify the following options:

          • AUTOMATIC (default): DataSync chooses NFS version 4.1.

          • NFS3: Stateless protocol version that allows for asynchronous writes on the server.

          • NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

          • NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

          Note: DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
          Possible values include:
          • "AUTOMATIC"
          • "NFS3"
          • "NFS4_0"
          • "NFS4_1"
    • SMB — (map)

      Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.

      • Domain — (String)

        Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

      • MountOptions — (map)

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

        • Version — (String)

          By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

          These are the following options for configuring the SMB version:

          • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

            This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

          • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

          • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

          • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

          • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

            Note: The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.
          Possible values include:
          • "AUTOMATIC"
          • "SMB2"
          • "SMB3"
          • "SMB1"
          • "SMB2_0"
      • Password — required — (String)

        Specifies the password of a user who has permission to access your SVM.

      • User — required — (String)

        Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.

        If you provide a user in your Active Directory, note the following:

        • If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.

        • If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.

        Make sure that the user has the permissions it needs to copy the data you want:

        • SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).

        • SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.

  • SecurityGroupArns — (Array<String>)

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

  • Subdirectory — (String)

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

  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  FsxFilesystemArn: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  SecurityGroupArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  User: 'STRING_VALUE', /* required */
  Domain: 'STRING_VALUE',
  Subdirectory: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationFsxWindows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Subdirectory — (String)

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

  • FsxFilesystemArn — (String)

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

  • SecurityGroupArns — (Array<String>)

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

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

    • Configure the security group to allow it to communicate within itself.
    • Choose a different security group that can communicate with the mount target's security group.
  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

  • User — (String)

    Specifies the user who has the permissions to access files and folders in the file system.

    For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

  • Domain — (String)

    Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.

  • Password — (String)

    Specifies the password of the user who has the permissions to access files and folders in the file system.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AgentArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  AuthenticationType: SIMPLE | KERBEROS, /* required */
  NameNodes: [ /* required */
    {
      Hostname: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ],
  BlockSize: 'NUMBER_VALUE',
  KerberosKeytab: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  KerberosKrb5Conf: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  KerberosPrincipal: 'STRING_VALUE',
  KmsKeyProviderUri: 'STRING_VALUE',
  QopConfiguration: {
    DataTransferProtection: DISABLED | AUTHENTICATION | INTEGRITY | PRIVACY,
    RpcProtection: DISABLED | AUTHENTICATION | INTEGRITY | PRIVACY
  },
  ReplicationFactor: 'NUMBER_VALUE',
  SimpleUser: 'STRING_VALUE',
  Subdirectory: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationHdfs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Subdirectory — (String)

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

  • NameNodes — (Array<map>)

    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.

    • Hostname — required — (String)

      The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.

    • Port — required — (Integer)

      The port that the NameNode uses to listen to client requests.

  • BlockSize — (Integer)

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

  • ReplicationFactor — (Integer)

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

  • KmsKeyProviderUri — (String)

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

  • QopConfiguration — (map)

    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.

    • RpcProtection — (String)

      The RPC protection setting configured on the HDFS cluster. This setting corresponds to your hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster.

      Possible values include:
      • "DISABLED"
      • "AUTHENTICATION"
      • "INTEGRITY"
      • "PRIVACY"
    • DataTransferProtection — (String)

      The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster.

      Possible values include:
      • "DISABLED"
      • "AUTHENTICATION"
      • "INTEGRITY"
      • "PRIVACY"
  • AuthenticationType — (String)

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

    Possible values include:
    • "SIMPLE"
    • "KERBEROS"
  • SimpleUser — (String)

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

    Note: If SIMPLE is specified for AuthenticationType, this parameter is required.
  • KerberosPrincipal — (String)

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

    Note: If KERBEROS is specified for AuthenticationType, this parameter is required.
  • KerberosKeytab — (Buffer, Typed Array, Blob, String)

    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.

    Note: If KERBEROS is specified for AuthenticationType, this parameter is required.
  • KerberosKrb5Conf — (Buffer, Typed Array, Blob, String)

    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.

    Note: If KERBEROS is specified for AuthenticationType, this parameter is required.
  • AgentArns — (Array<String>)

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

  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OnPremConfig: { /* required */
    AgentArns: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  ServerHostname: 'STRING_VALUE', /* required */
  Subdirectory: 'STRING_VALUE', /* required */
  MountOptions: {
    Version: AUTOMATIC | NFS3 | NFS4_0 | NFS4_1
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationNfs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Subdirectory — (String)

    The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

    To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

    To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

    If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

    For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

  • ServerHostname — (String)

    The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this hostname to mount the NFS server in a network.

    If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

    Note: This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
  • OnPremConfig — (map)

    Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

    If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

    • AgentArns — required — (Array<String>)

      ARNs of the agents to use for an NFS location.

  • MountOptions — (map)

    The NFS mount options that DataSync can use to mount your NFS share.

    • Version — (String)

      Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

      You can specify the following options:

      • AUTOMATIC (default): DataSync chooses NFS version 4.1.

      • NFS3: Stateless protocol version that allows for asynchronous writes on the server.

      • NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

      • NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

      Note: DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
      Possible values include:
      • "AUTOMATIC"
      • "NFS3"
      • "NFS4_0"
      • "NFS4_1"
  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

      The Amazon Resource Name (ARN) of the source NFS file system location that is created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AgentArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  BucketName: 'STRING_VALUE', /* required */
  ServerHostname: 'STRING_VALUE', /* required */
  AccessKey: 'STRING_VALUE',
  SecretKey: 'STRING_VALUE',
  ServerCertificate: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  ServerPort: 'NUMBER_VALUE',
  ServerProtocol: HTTPS | HTTP,
  Subdirectory: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationObjectStorage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ServerHostname — (String)

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

  • ServerPort — (Integer)

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

  • ServerProtocol — (String)

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

    Possible values include:
    • "HTTPS"
    • "HTTP"
  • Subdirectory — (String)

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

  • BucketName — (String)

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

  • AccessKey — (String)

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

  • SecretKey — (String)

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

  • AgentArns — (Array<String>)

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

  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

  • ServerCertificate — (Buffer, Typed Array, Blob, String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  S3BucketArn: 'STRING_VALUE', /* required */
  S3Config: { /* required */
    BucketAccessRoleArn: 'STRING_VALUE' /* required */
  },
  AgentArns: [
    'STRING_VALUE',
    /* more items */
  ],
  S3StorageClass: STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL,
  Subdirectory: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationS3(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Subdirectory — (String)

    A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

  • S3BucketArn — (String)

    The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

  • S3StorageClass — (String)

    The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

    For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

    Possible values include:
    • "STANDARD"
    • "STANDARD_IA"
    • "ONEZONE_IA"
    • "INTELLIGENT_TIERING"
    • "GLACIER"
    • "DEEP_ARCHIVE"
    • "OUTPOSTS"
    • "GLACIER_INSTANT_RETRIEVAL"
  • S3Config — (map)

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access an Amazon S3 bucket.

    For detailed information about using such a role, see Creating a Location for Amazon S3 in the DataSync User Guide.

    • BucketAccessRoleArn — required — (String)

      The ARN of the IAM role for accessing the S3 bucket.

  • AgentArns — (Array<String>)

    If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

      The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AgentArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Password: 'STRING_VALUE', /* required */
  ServerHostname: 'STRING_VALUE', /* required */
  Subdirectory: 'STRING_VALUE', /* required */
  User: 'STRING_VALUE', /* required */
  Domain: 'STRING_VALUE',
  MountOptions: {
    Version: AUTOMATIC | SMB2 | SMB3 | SMB1 | SMB2_0
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationSmb(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Subdirectory — (String)

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

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

  • ServerHostname — (String)

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

    Note: You can't specify an IP version 6 (IPv6) address.
  • User — (String)

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

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

  • Domain — (String)

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

    For more information, see required permissions for SMB locations.

  • Password — (String)

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

    For more information, see required permissions for SMB locations.

  • AgentArns — (Array<String>)

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

  • MountOptions — (map)

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

    • Version — (String)

      By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

      These are the following options for configuring the SMB version:

      • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

        This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

      • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

      • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

      • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

      • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

        Note: The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.
      Possible values include:
      • "AUTOMATIC"
      • "SMB2"
      • "SMB3"
      • "SMB1"
      • "SMB2_0"
  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

      The ARN of the SMB location that you created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DestinationLocationArn: 'STRING_VALUE', /* required */
  SourceLocationArn: 'STRING_VALUE', /* required */
  CloudWatchLogGroupArn: 'STRING_VALUE',
  Excludes: [
    {
      FilterType: SIMPLE_PATTERN,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  Includes: [
    {
      FilterType: SIMPLE_PATTERN,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  Name: 'STRING_VALUE',
  Options: {
    Atime: NONE | BEST_EFFORT,
    BytesPerSecond: 'NUMBER_VALUE',
    Gid: NONE | INT_VALUE | NAME | BOTH,
    LogLevel: OFF | BASIC | TRANSFER,
    Mtime: NONE | PRESERVE,
    ObjectTags: PRESERVE | NONE,
    OverwriteMode: ALWAYS | NEVER,
    PosixPermissions: NONE | PRESERVE,
    PreserveDeletedFiles: PRESERVE | REMOVE,
    PreserveDevices: NONE | PRESERVE,
    SecurityDescriptorCopyFlags: NONE | OWNER_DACL | OWNER_DACL_SACL,
    TaskQueueing: ENABLED | DISABLED,
    TransferMode: CHANGED | ALL,
    Uid: NONE | INT_VALUE | NAME | BOTH,
    VerifyMode: POINT_IN_TIME_CONSISTENT | ONLY_FILES_TRANSFERRED | NONE
  },
  Schedule: {
    ScheduleExpression: 'STRING_VALUE' /* required */
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SourceLocationArn — (String)

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

  • DestinationLocationArn — (String)

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

  • CloudWatchLogGroupArn — (String)

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

  • Name — (String)

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

  • Options — (map)

    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.

    • VerifyMode — (String)

      Specifies how and when DataSync checks the integrity of your data during a transfer.

      Default value: POINT_IN_TIME_CONSISTENT

      ONLY_FILES_TRANSFERRED (recommended): DataSync calculates the checksum of transferred files and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on those files at the destination.

      We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.

      POINT_IN_TIME_CONSISTENT: At the end of the transfer, DataSync scans the entire source and destination to verify that both locations are fully synchronized.

      You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.

      NONE: DataSync doesn't run additional verification at the end of the transfer. All data transmissions are still integrity-checked with checksum verification during the transfer.

      Possible values include:
      • "POINT_IN_TIME_CONSISTENT"
      • "ONLY_FILES_TRANSFERRED"
      • "NONE"
    • OverwriteMode — (String)

      Specifies whether data at the destination location should be overwritten or preserved. If set to NEVER, a destination file for example will not be replaced by a source file (even if the destination file differs from the source file). If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

      Some storage classes have specific behaviors that can affect your Amazon S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.

      Possible values include:
      • "ALWAYS"
      • "NEVER"
    • Atime — (String)

      Specifies whether to preserve metadata indicating the last time a file was read or written to. If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase of the task execution).

      Note: The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

      Default value: BEST_EFFORT

      BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

      NONE: Ignore Atime.

      Note: If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE.
      Possible values include:
      • "NONE"
      • "BEST_EFFORT"
    • Mtime — (String)

      Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING phase of your task execution. This option is required when you need to run the a task more than once.

      Default Value: PRESERVE

      PRESERVE: Preserve original Mtime (recommended)

      NONE: Ignore Mtime.

      Note: If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT. If Mtime is set to NONE, Atime must also be set to NONE.
      Possible values include:
      • "NONE"
      • "PRESERVE"
    • Uid — (String)

      Specifies the POSIX user ID (UID) of the file's owner.

      For more information, see Metadata copied by DataSync.

      Default value: INT_VALUE. This preserves the integer value of the ID.

      INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

      NONE: Ignore UID and GID.

      Possible values include:
      • "NONE"
      • "INT_VALUE"
      • "NAME"
      • "BOTH"
    • Gid — (String)

      Specifies the POSIX group ID (GID) of the file's owners.

      For more information, see Metadata copied by DataSync.

      Default value: INT_VALUE. This preserves the integer value of the ID.

      INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

      NONE: Ignore UID and GID.

      Possible values include:
      • "NONE"
      • "INT_VALUE"
      • "NAME"
      • "BOTH"
    • PreserveDeletedFiles — (String)

      Specifies whether files in the destination location that don't exist in the source should be preserved. This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.

      Default value: PRESERVE

      PRESERVE: Ignore such destination files (recommended).

      REMOVE: Delete destination files that aren’t present in the source.

      Note: If you set this parameter to REMOVE, you can't set TransferMode to ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.
      Possible values include:
      • "PRESERVE"
      • "REMOVE"
    • PreserveDevices — (String)

      Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices.

      Note: DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-file (EOF) marker.

      Default value: NONE

      NONE: Ignore special devices (recommended).

      PRESERVE: Preserve character and block device metadata. This option currently isn't supported for Amazon EFS.

      Possible values include:
      • "NONE"
      • "PRESERVE"
    • PosixPermissions — (String)

      Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

      For more information, see Metadata copied by DataSync.

      Default value: PRESERVE

      PRESERVE: Preserve POSIX-style permissions (recommended).

      NONE: Ignore permissions.

      Note: DataSync can preserve extant permissions of a source location.
      Possible values include:
      • "NONE"
      • "PRESERVE"
    • BytesPerSecond — (Integer)

      Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

    • TaskQueueing — (String)

      Specifies whether tasks should be queued before executing the tasks. The default is ENABLED, which means the tasks will be queued.

      If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • LogLevel — (String)

      Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn.

      If you set LogLevel to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred. TRANSFER publishes logs for every file or object that is transferred and integrity checked.

      Possible values include:
      • "OFF"
      • "BASIC"
      • "TRANSFER"
    • TransferMode — (String)

      Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's in the destination).

      CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

      ALL: DataSync copies all source location content to the destination (without comparing what's in the destination).

      Possible values include:
      • "CHANGED"
      • "ALL"
    • SecurityDescriptorCopyFlags — (String)

      Specifies which components of the SMB security descriptor are copied from source to destination objects.

      This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata.

      Default value: OWNER_DACL

      OWNER_DACL: For each copied object, DataSync copies the following metadata:

      • The object owner.

      • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

        DataSync won't copy NTFS system access control lists (SACLs) with this option.

      OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:

      • The object owner.

      • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

      • SACLs, which are used by administrators to log attempts to access a secured object.

        Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.

      NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.

      Possible values include:
      • "NONE"
      • "OWNER_DACL"
      • "OWNER_DACL_SACL"
    • ObjectTags — (String)

      Specifies whether object tags are preserved when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

      Default Value: PRESERVE

      Possible values include:
      • "PRESERVE"
      • "NONE"
  • Excludes — (Array<map>)

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

    • FilterType — (String)

      The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

      Possible values include:
      • "SIMPLE_PATTERN"
    • Value — (String)

      A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

  • Schedule — (map)

    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.

    • ScheduleExpression — required — (String)

      A cron expression that specifies when DataSync initiates a scheduled transfer from a source to a destination location.

  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      The key for an Amazon Web Services resource tag.

    • Value — (String)

      The value for an Amazon Web Services resource tag.

  • Includes — (Array<map>)

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

    • FilterType — (String)

      The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

      Possible values include:
      • "SIMPLE_PATTERN"
    • Value — (String)

      A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TaskArn — (String)

      The Amazon Resource Name (ARN) of the task.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AgentArn: 'STRING_VALUE' /* required */
};
datasync.deleteAgent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AgentArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.deleteLocation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TaskArn: 'STRING_VALUE' /* required */
};
datasync.deleteTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TaskArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AgentArn: 'STRING_VALUE' /* required */
};
datasync.describeAgent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AgentArn — (String)

    Specifies the Amazon Resource Name (ARN) of the DataSync agent to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AgentArn — (String)

      The ARN of the agent.

    • Name — (String)

      The name of the agent.

    • Status — (String)

      The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.

      Possible values include:
      • "ONLINE"
      • "OFFLINE"
    • LastConnectionTime — (Date)

      The time that the agent last connected to DataSync.

    • CreationTime — (Date)

      The time that the agent was activated (that is, created in your account).

    • EndpointType — (String)

      The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.

      Possible values include:
      • "PUBLIC"
      • "PRIVATE_LINK"
      • "FIPS"
    • PrivateLinkConfig — (map)

      The subnet and the security group that DataSync used to access a VPC endpoint.

      • VpcEndpointId — (String)

        The ID of the VPC endpoint that is configured for an agent. An agent that is configured with a VPC endpoint will not be accessible over the public internet.

      • PrivateLinkEndpoint — (String)

        The private endpoint that is configured for an agent that has access to IP addresses in a PrivateLink. An agent that is configured with this endpoint will not be accessible over the public internet.

      • SubnetArns — (Array<String>)

        The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated in a VPC or an agent that has access to a VPC endpoint.

      • SecurityGroupArns — (Array<String>)

        The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2 resource that hosts an agent activated in a VPC or an agent that has access to a VPC endpoint.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DiscoveryJobArn: 'STRING_VALUE' /* required */
};
datasync.describeDiscoveryJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DiscoveryJobArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • StorageSystemArn — (String)

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

    • DiscoveryJobArn — (String)

      The ARN of the discovery job.

    • CollectionDurationMinutes — (Integer)

      The number of minutes that the discovery job runs.

    • Status — (String)

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

      Possible values include:
      • "RUNNING"
      • "WARNING"
      • "TERMINATED"
      • "FAILED"
      • "STOPPED"
      • "COMPLETED"
      • "COMPLETED_WITH_ISSUES"
    • JobStartTime — (Date)

      The time when the discovery job started.

    • JobEndTime — (Date)

      The time when the discovery job ended.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.describeLocationEfs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

      The ARN of the Amazon EFS file system location.

    • LocationUri — (String)

      The URL of the Amazon EFS file system location.

    • Ec2Config — (map)

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

      • SubnetArn — required — (String)

        Specifies the ARN of a subnet where DataSync creates the network interfaces for managing traffic during your transfer.

        The subnet must be located:

        • In the same virtual private cloud (VPC) as the Amazon EFS file system.

        • In the same Availability Zone as at least one mount target for the Amazon EFS file system.

        Note: You don't need to specify a subnet that includes a file system mount target.
      • SecurityGroupArns — required — (Array<String>)

        Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.

    • CreationTime — (Date)

      The time that the location was created.

    • AccessPointArn — (String)

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

    • FileSystemAccessRoleArn — (String)

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

    • InTransitEncryption — (String)

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

      Possible values include:
      • "NONE"
      • "TLS1_2"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.describeLocationFsxLustre(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

    • LocationUri — (String)

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

    • SecurityGroupArns — (Array<String>)

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

    • CreationTime — (Date)

      The time that the FSx for Lustre location was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.describeLocationFsxOntap(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CreationTime — (Date)

      The time that the location was created.

    • LocationArn — (String)

      The ARN of the FSx for ONTAP file system location.

    • LocationUri — (String)

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

    • Protocol — (map)

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

      • NFS — (map)

        Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).

        • MountOptions — (map)

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

          • Version — (String)

            Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

            You can specify the following options:

            • AUTOMATIC (default): DataSync chooses NFS version 4.1.

            • NFS3: Stateless protocol version that allows for asynchronous writes on the server.

            • NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

            • NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

            Note: DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
            Possible values include:
            • "AUTOMATIC"
            • "NFS3"
            • "NFS4_0"
            • "NFS4_1"
      • SMB — (map)

        Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.

        • Domain — (String)

          Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

        • MountOptions — (map)

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

          • Version — (String)

            By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

            These are the following options for configuring the SMB version:

            • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

              This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

            • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

            • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

            • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

            • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

              Note: The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.
            Possible values include:
            • "AUTOMATIC"
            • "SMB2"
            • "SMB3"
            • "SMB1"
            • "SMB2_0"
        • Password — required — (String)

          Specifies the password of a user who has permission to access your SVM.

        • User — required — (String)

          Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.

          If you provide a user in your Active Directory, note the following:

          • If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.

          • If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.

          Make sure that the user has the permissions it needs to copy the data you want:

          • SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).

          • SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.

    • SecurityGroupArns — (Array<String>)

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

    • StorageVirtualMachineArn — (String)

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

    • FsxFilesystemArn — (String)

      The ARN of the FSx for ONTAP file system.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.describeLocationFsxOpenZfs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

    • LocationUri — (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

    • SecurityGroupArns — (Array<String>)

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

    • Protocol — (map)

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

      • NFS — (map)

        Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).

        • MountOptions — (map)

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

          • Version — (String)

            Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

            You can specify the following options:

            • AUTOMATIC (default): DataSync chooses NFS version 4.1.

            • NFS3: Stateless protocol version that allows for asynchronous writes on the server.

            • NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

            • NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

            Note: DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
            Possible values include:
            • "AUTOMATIC"
            • "NFS3"
            • "NFS4_0"
            • "NFS4_1"
      • SMB — (map)

        Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.

        • Domain — (String)

          Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

        • MountOptions — (map)

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

          • Version — (String)

            By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

            These are the following options for configuring the SMB version:

            • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

              This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

            • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

            • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

            • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

            • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

              Note: The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.
            Possible values include:
            • "AUTOMATIC"
            • "SMB2"
            • "SMB3"
            • "SMB1"
            • "SMB2_0"
        • Password — required — (String)

          Specifies the password of a user who has permission to access your SVM.

        • User — required — (String)

          Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.

          If you provide a user in your Active Directory, note the following:

          • If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.

          • If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.

          Make sure that the user has the permissions it needs to copy the data you want:

          • SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).

          • SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.

    • CreationTime — (Date)

      The time that the FSx for OpenZFS location was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.describeLocationFsxWindows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

    The Amazon Resource Name (ARN) of the FSx for Windows File Server location to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

    • LocationUri — (String)

      The URL of the FSx for Windows File Server location that was described.

    • SecurityGroupArns — (Array<String>)

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

    • CreationTime — (Date)

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

    • User — (String)

      The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

    • Domain — (String)

      The name of the Windows domain that the FSx for Windows File Server belongs to.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.describeLocationHdfs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

      The ARN of the HDFS cluster location.

    • LocationUri — (String)

      The URI of the HDFS cluster location.

    • NameNodes — (Array<map>)

      The NameNode that manage the HDFS namespace.

      • Hostname — required — (String)

        The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.

      • Port — required — (Integer)

        The port that the NameNode uses to listen to client requests.

    • BlockSize — (Integer)

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

    • ReplicationFactor — (Integer)

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

    • KmsKeyProviderUri — (String)

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

    • QopConfiguration — (map)

      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.

      • RpcProtection — (String)

        The RPC protection setting configured on the HDFS cluster. This setting corresponds to your hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster.

        Possible values include:
        • "DISABLED"
        • "AUTHENTICATION"
        • "INTEGRITY"
        • "PRIVACY"
      • DataTransferProtection — (String)

        The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster.

        Possible values include:
        • "DISABLED"
        • "AUTHENTICATION"
        • "INTEGRITY"
        • "PRIVACY"
    • AuthenticationType — (String)

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

      Possible values include:
      • "SIMPLE"
      • "KERBEROS"
    • SimpleUser — (String)

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

    • KerberosPrincipal — (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.

    • AgentArns — (Array<String>)

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

    • CreationTime — (Date)

      The time that the HDFS location was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.describeLocationNfs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

    • LocationUri — (String)

      The URL of the source NFS location that was described.

    • OnPremConfig — (map)

      A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.

      • AgentArns — required — (Array<String>)

        ARNs of the agents to use for an NFS location.

    • MountOptions — (map)

      The NFS mount options that DataSync used to mount your NFS share.

      • Version — (String)

        Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

        You can specify the following options:

        • AUTOMATIC (default): DataSync chooses NFS version 4.1.

        • NFS3: Stateless protocol version that allows for asynchronous writes on the server.

        • NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

        • NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

        Note: DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
        Possible values include:
        • "AUTOMATIC"
        • "NFS3"
        • "NFS4_0"
        • "NFS4_1"
    • CreationTime — (Date)

      The time that the NFS location was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.describeLocationObjectStorage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

      The ARN of the object storage system location.

    • LocationUri — (String)

      The URL of the object storage system location.

    • AccessKey — (String)

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

    • ServerPort — (Integer)

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

    • ServerProtocol — (String)

      The protocol that your object storage system uses to communicate.

      Possible values include:
      • "HTTPS"
      • "HTTP"
    • AgentArns — (Array<String>)

      The ARNs of the DataSync agents that can securely connect with your location.

    • CreationTime — (Date)

      The time that the location was created.

    • ServerCertificate — (Buffer(Node.js), Typed Array(Browser))

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.describeLocationS3(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

    The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

      The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.

    • LocationUri — (String)

      The URL of the Amazon S3 location that was described.

    • S3StorageClass — (String)

      The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

      Possible values include:
      • "STANDARD"
      • "STANDARD_IA"
      • "ONEZONE_IA"
      • "INTELLIGENT_TIERING"
      • "GLACIER"
      • "DEEP_ARCHIVE"
      • "OUTPOSTS"
      • "GLACIER_INSTANT_RETRIEVAL"
    • S3Config — (map)

      The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access an Amazon S3 bucket.

      For detailed information about using such a role, see Creating a Location for Amazon S3 in the DataSync User Guide.

      • BucketAccessRoleArn — required — (String)

        The ARN of the IAM role for accessing the S3 bucket.

    • AgentArns — (Array<String>)

      If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

    • CreationTime — (Date)

      The time that the Amazon S3 bucket location was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LocationArn: 'STRING_VALUE' /* required */
};
datasync.describeLocationSmb(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LocationArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LocationArn — (String)

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

    • LocationUri — (String)

      The URL of the source SMB location that was described.

    • AgentArns — (Array<String>)

      The Amazon Resource Name (ARN) of the source SMB file system location that is created.

    • User — (String)

      The user who can mount the share, has the permissions to access files and folders in the SMB share.

    • Domain — (String)

      The name of the Windows domain that the SMB server belongs to.

    • MountOptions — (map)

      The mount options that are available for DataSync to use to access an SMB location.

      • Version — (String)

        By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

        These are the following options for configuring the SMB version:

        • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

          This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

        • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

        • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

        • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

        • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

          Note: The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.
        Possible values include:
        • "AUTOMATIC"
        • "SMB2"
        • "SMB3"
        • "SMB1"
        • "SMB2_0"
    • CreationTime — (Date)

      The time that the SMB location was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  StorageSystemArn: 'STRING_VALUE' /* required */
};
datasync.describeStorageSystem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StorageSystemArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • StorageSystemArn — (String)

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

    • ServerConfiguration — (map)

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

      • ServerHostname — required — (String)

        The domain name or IP address of your storage system's management interface.

      • ServerPort — (Integer)

        The network port for accessing the storage system's management interface.

    • SystemType — (String)

      The type of on-premises storage system.

      Note: DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
      Possible values include:
      • "NetAppONTAP"
    • AgentArns — (Array<String>)

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

    • Name — (String)

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

    • ErrorMessage — (String)

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

    • ConnectivityStatus — (String)

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

      Possible values include:
      • "PASS"
      • "FAIL"
      • "UNKNOWN"
    • CloudWatchLogGroupArn — (String)

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

    • CreationTime — (Date)

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

    • SecretsManagerArn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DiscoveryJobArn: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: SVM | VOLUME | CLUSTER, /* required */
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
datasync.describeStorageSystemResourceMetrics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DiscoveryJobArn — (String)

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

  • ResourceType — (String)

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

    Possible values include:
    • "SVM"
    • "VOLUME"
    • "CLUSTER"
  • ResourceId — (String)

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

  • StartTime — (Date)

    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.

  • EndTime — (Date)

    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.

  • MaxResults — (Integer)

    Specifies how many results that you want in the response.

  • NextToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Metrics — (Array<map>)

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

      • Timestamp — (Date)

        The time when DataSync Discovery collected this information from the resource.

      • P95Metrics — (map)

        The types of performance data that DataSync Discovery collects about the on-premises storage system resource.

        • IOPS — (map)

          The IOPS peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.

          • Read — (Float)

            Peak IOPS related to read operations.

          • Write — (Float)

            Peak IOPS related to write operations.

          • Other — (Float)

            Peak IOPS unrelated to read and write operations.

          • Total — (Float)

            Peak total IOPS on your on-premises storage system resource.

        • Throughput — (map)

          The throughput peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.

          • Read — (Float)

            Peak throughput related to read operations.

          • Write — (Float)

            Peak throughput related to write operations.

          • Other — (Float)

            Peak throughput unrelated to read and write operations.

          • Total — (Float)

            Peak total throughput on your on-premises storage system resource.

        • Latency — (map)

          The latency peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.

          • Read — (Float)

            Peak latency for read operations.

          • Write — (Float)

            Peak latency for write operations.

          • Other — (Float)

            Peak latency for operations unrelated to read and write operations.

      • Capacity — (map)

        The storage capacity of the on-premises storage system resource.

        • Used — (Integer)

          The amount of space that's being used in a storage system resource.

        • Provisioned — (Integer)

          The total amount of space available in a storage system resource.

        • LogicalUsed — (Integer)

          The amount of space that's being used in a storage system resource without accounting for compression or deduplication.

      • ResourceId — (String)

        The universally unique identifier (UUID) of the on-premises storage system resource.

      • ResourceType — (String)

        The type of on-premises storage system resource.

        Possible values include:
        • "SVM"
        • "VOLUME"
        • "CLUSTER"
    • NextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DiscoveryJobArn: 'STRING_VALUE', /* required */
  ResourceType: SVM | VOLUME | CLUSTER, /* required */
  Filter: {
    '<DiscoveryResourceFilter>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<DiscoveryResourceFilter>': ... */
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
datasync.describeStorageSystemResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DiscoveryJobArn — (String)

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

  • ResourceType — (String)

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

    Possible values include:
    • "SVM"
    • "VOLUME"
    • "CLUSTER"
  • ResourceIds — (Array<String>)

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

  • Filter — (map<Array<String>>)

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

  • MaxResults — (Integer)

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

  • NextToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ResourceDetails — (map)

      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.

      • NetAppONTAPSVMs — (Array<map>)

        The information that DataSync Discovery collects about storage virtual machines (SVMs) in your on-premises storage system.

        • ClusterUuid — (String)

          The universally unique identifier (UUID) of the cluster associated with the SVM.

        • ResourceId — (String)

          The UUID of the SVM.

        • SvmName — (String)

          The name of the SVM

        • CifsShareCount — (Integer)

          The number of CIFS shares in the SVM.

        • EnabledProtocols — (Array<String>)

          The data transfer protocols (such as NFS) configured for the SVM.

        • TotalCapacityUsed — (Integer)

          The storage space that's being used in the SVM.

        • TotalCapacityProvisioned — (Integer)

          The total storage space that's available in the SVM.

        • TotalLogicalCapacityUsed — (Integer)

          The storage space that's being used in the SVM without accounting for compression or deduplication.

        • MaxP95Performance — (map)

          The performance data that DataSync Discovery collects about the SVM.

          • IopsRead — (Float)

            Peak IOPS related to read operations.

          • IopsWrite — (Float)

            Peak IOPS related to write operations.

          • IopsOther — (Float)

            Peak IOPS unrelated to read and write operations.

          • IopsTotal — (Float)

            Peak total IOPS on your on-premises storage system resource.

          • ThroughputRead — (Float)

            Peak throughput related to read operations.

          • ThroughputWrite — (Float)

            Peak throughput related to write operations.

          • ThroughputOther — (Float)

            Peak throughput unrelated to read and write operations.

          • ThroughputTotal — (Float)

            Peak total throughput on your on-premises storage system resource.

          • LatencyRead — (Float)

            Peak latency for read operations.

          • LatencyWrite — (Float)

            Peak latency for write operations.

          • LatencyOther — (Float)

            Peak latency for operations unrelated to read and write operations.

        • Recommendations — (Array<map>)

          The Amazon Web Services storage services that DataSync Discovery recommends for the SVM. For more information, see Recommendations provided by DataSync Discovery.

          • StorageType — (String)

            A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.

          • StorageConfiguration — (map<String>)

            Information about how you can set up a recommended Amazon Web Services storage service.

          • EstimatedMonthlyStorageCost — (String)

            The estimated monthly cost of the recommended Amazon Web Services storage service.

        • NfsExportedVolumes — (Integer)

          The number of NFS volumes in the SVM.

        • RecommendationStatus — (String)

          Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or can't be determined.

          For more information, see Recommendation statuses.

          Possible values include:
          • "NONE"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
        • TotalSnapshotCapacityUsed — (Integer)

          The amount of storage in the SVM that's being used for snapshots.

      • NetAppONTAPVolumes — (Array<map>)

        The information that DataSync Discovery collects about volumes in your on-premises storage system.

        • VolumeName — (String)

          The name of the volume.

        • ResourceId — (String)

          The universally unique identifier (UUID) of the volume.

        • CifsShareCount — (Integer)

          The number of CIFS shares in the volume.

        • SecurityStyle — (String)

          The volume's security style (such as Unix or NTFS).

        • SvmUuid — (String)

          The UUID of the storage virtual machine (SVM) associated with the volume.

        • SvmName — (String)

          The name of the SVM associated with the volume.

        • CapacityUsed — (Integer)

          The storage space that's being used in the volume.

        • CapacityProvisioned — (Integer)

          The total storage space that's available in the volume.

        • LogicalCapacityUsed — (Integer)

          The storage space that's being used in the volume without accounting for compression or deduplication.

        • NfsExported — (Boolean)

          The number of NFS volumes in the volume.

        • SnapshotCapacityUsed — (Integer)

          The amount of storage in the volume that's being used for snapshots.

        • MaxP95Performance — (map)

          The performance data that DataSync Discovery collects about the volume.

          • IopsRead — (Float)

            Peak IOPS related to read operations.

          • IopsWrite — (Float)

            Peak IOPS related to write operations.

          • IopsOther — (Float)

            Peak IOPS unrelated to read and write operations.

          • IopsTotal — (Float)

            Peak total IOPS on your on-premises storage system resource.

          • ThroughputRead — (Float)

            Peak throughput related to read operations.

          • ThroughputWrite — (Float)

            Peak throughput related to write operations.

          • ThroughputOther — (Float)

            Peak throughput unrelated to read and write operations.

          • ThroughputTotal — (Float)

            Peak total throughput on your on-premises storage system resource.

          • LatencyRead — (Float)

            Peak latency for read operations.

          • LatencyWrite — (Float)

            Peak latency for write operations.

          • LatencyOther — (Float)

            Peak latency for operations unrelated to read and write operations.

        • Recommendations — (Array<map>)

          The Amazon Web Services storage services that DataSync Discovery recommends for the volume. For more information, see Recommendations provided by DataSync Discovery.

          • StorageType — (String)

            A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.

          • StorageConfiguration — (map<String>)

            Information about how you can set up a recommended Amazon Web Services storage service.

          • EstimatedMonthlyStorageCost — (String)

            The estimated monthly cost of the recommended Amazon Web Services storage service.

        • RecommendationStatus — (String)

          Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete, or can't be determined.

          For more information, see Recommendation statuses.

          Possible values include:
          • "NONE"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
      • NetAppONTAPClusters — (Array<map>)

        The information that DataSync Discovery collects about the cluster in your on-premises storage system.

        • CifsShareCount — (Integer)

          The number of CIFS shares in the cluster.

        • NfsExportedVolumes — (Integer)

          The number of NFS volumes in the cluster.

        • ResourceId — (String)

          The universally unique identifier (UUID) of the cluster.

        • ClusterName — (String)

          The name of the cluster.

        • MaxP95Performance — (map)

          The performance data that DataSync Discovery collects about the cluster.

          • IopsRead — (Float)

            Peak IOPS related to read operations.

          • IopsWrite — (Float)

            Peak IOPS related to write operations.

          • IopsOther — (Float)

            Peak IOPS unrelated to read and write operations.

          • IopsTotal — (Float)

            Peak total IOPS on your on-premises storage system resource.

          • ThroughputRead — (Float)

            Peak throughput related to read operations.

          • ThroughputWrite — (Float)

            Peak throughput related to write operations.

          • ThroughputOther — (Float)

            Peak throughput unrelated to read and write operations.

          • ThroughputTotal — (Float)

            Peak total throughput on your on-premises storage system resource.

          • LatencyRead — (Float)

            Peak latency for read operations.

          • LatencyWrite — (Float)

            Peak latency for write operations.

          • LatencyOther — (Float)

            Peak latency for operations unrelated to read and write operations.

        • ClusterBlockStorageSize — (Integer)

          The total storage space that's available in the cluster.

        • ClusterBlockStorageUsed — (Integer)

          The storage space that's being used in a cluster.

        • ClusterBlockStorageLogicalUsed — (Integer)

          The storage space that's being used in the cluster without accounting for compression or deduplication.

        • Recommendations — (Array<map>)

          The Amazon Web Services storage services that DataSync Discovery recommends for the cluster. For more information, see Recommendations provided by DataSync Discovery.

          • StorageType — (String)

            A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.

          • StorageConfiguration — (map<String>)

            Information about how you can set up a recommended Amazon Web Services storage service.

          • EstimatedMonthlyStorageCost — (String)

            The estimated monthly cost of the recommended Amazon Web Services storage service.

        • RecommendationStatus — (String)

          Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete, or can't be determined.

          For more information, see Recommendation statuses.

          Possible values include:
          • "NONE"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
    • NextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TaskArn: 'STRING_VALUE' /* required */
};
datasync.describeTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TaskArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TaskArn — (String)

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

    • Status — (String)

      The status of the task that was described.

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

      Possible values include:
      • "AVAILABLE"
      • "CREATING"
      • "QUEUED"
      • "RUNNING"
      • "UNAVAILABLE"
    • Name — (String)

      The name of the task that was described.

    • CurrentTaskExecutionArn — (String)

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

    • SourceLocationArn — (String)

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

    • DestinationLocationArn — (String)

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

    • CloudWatchLogGroupArn — (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.

    • SourceNetworkInterfaceArns — (Array<String>)

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

    • DestinationNetworkInterfaceArns — (Array<String>)

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

    • Options — (map)

      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.

      • VerifyMode — (String)

        Specifies how and when DataSync checks the integrity of your data during a transfer.

        Default value: POINT_IN_TIME_CONSISTENT

        ONLY_FILES_TRANSFERRED (recommended): DataSync calculates the checksum of transferred files and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on those files at the destination.

        We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.

        POINT_IN_TIME_CONSISTENT: At the end of the transfer, DataSync scans the entire source and destination to verify that both locations are fully synchronized.

        You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.

        NONE: DataSync doesn't run additional verification at the end of the transfer. All data transmissions are still integrity-checked with checksum verification during the transfer.

        Possible values include:
        • "POINT_IN_TIME_CONSISTENT"
        • "ONLY_FILES_TRANSFERRED"
        • "NONE"
      • OverwriteMode — (String)

        Specifies whether data at the destination location should be overwritten or preserved. If set to NEVER, a destination file for example will not be replaced by a source file (even if the destination file differs from the source file). If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

        Some storage classes have specific behaviors that can affect your Amazon S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.

        Possible values include:
        • "ALWAYS"
        • "NEVER"
      • Atime — (String)

        Specifies whether to preserve metadata indicating the last time a file was read or written to. If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase of the task execution).

        Note: The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

        Default value: BEST_EFFORT

        BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

        NONE: Ignore Atime.

        Note: If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE.
        Possible values include:
        • "NONE"
        • "BEST_EFFORT"
      • Mtime — (String)

        Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING phase of your task execution. This option is required when you need to run the a task more than once.

        Default Value: PRESERVE

        PRESERVE: Preserve original Mtime (recommended)

        NONE: Ignore Mtime.

        Note: If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT. If Mtime is set to NONE, Atime must also be set to NONE.
        Possible values include:
        • "NONE"
        • "PRESERVE"
      • Uid — (String)

        Specifies the POSIX user ID (UID) of the file's owner.

        For more information, see Metadata copied by DataSync.

        Default value: INT_VALUE. This preserves the integer value of the ID.

        INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

        NONE: Ignore UID and GID.

        Possible values include:
        • "NONE"
        • "INT_VALUE"
        • "NAME"
        • "BOTH"
      • Gid — (String)

        Specifies the POSIX group ID (GID) of the file's owners.

        For more information, see Metadata copied by DataSync.

        Default value: INT_VALUE. This preserves the integer value of the ID.

        INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

        NONE: Ignore UID and GID.

        Possible values include:
        • "NONE"
        • "INT_VALUE"
        • "NAME"
        • "BOTH"
      • PreserveDeletedFiles — (String)

        Specifies whether files in the destination location that don't exist in the source should be preserved. This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.

        Default value: PRESERVE

        PRESERVE: Ignore such destination files (recommended).

        REMOVE: Delete destination files that aren’t present in the source.

        Note: If you set this parameter to REMOVE, you can't set TransferMode to ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.
        Possible values include:
        • "PRESERVE"
        • "REMOVE"
      • PreserveDevices — (String)

        Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices.

        Note: DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-file (EOF) marker.

        Default value: NONE

        NONE: Ignore special devices (recommended).

        PRESERVE: Preserve character and block device metadata. This option currently isn't supported for Amazon EFS.

        Possible values include:
        • "NONE"
        • "PRESERVE"
      • PosixPermissions — (String)

        Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

        For more information, see Metadata copied by DataSync.

        Default value: PRESERVE

        PRESERVE: Preserve POSIX-style permissions (recommended).

        NONE: Ignore permissions.

        Note: DataSync can preserve extant permissions of a source location.
        Possible values include:
        • "NONE"
        • "PRESERVE"
      • BytesPerSecond — (Integer)

        Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

      • TaskQueueing — (String)

        Specifies whether tasks should be queued before executing the tasks. The default is ENABLED, which means the tasks will be queued.

        If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • LogLevel — (String)

        Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn.

        If you set LogLevel to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred. TRANSFER publishes logs for every file or object that is transferred and integrity checked.

        Possible values include:
        • "OFF"
        • "BASIC"
        • "TRANSFER"
      • TransferMode — (String)

        Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's in the destination).

        CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

        ALL: DataSync copies all source location content to the destination (without comparing what's in the destination).

        Possible values include:
        • "CHANGED"
        • "ALL"
      • SecurityDescriptorCopyFlags — (String)

        Specifies which components of the SMB security descriptor are copied from source to destination objects.

        This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata.

        Default value: OWNER_DACL

        OWNER_DACL: For each copied object, DataSync copies the following metadata:

        • The object owner.

        • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

          DataSync won't copy NTFS system access control lists (SACLs) with this option.

        OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:

        • The object owner.

        • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

        • SACLs, which are used by administrators to log attempts to access a secured object.

          Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.

        NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.

        Possible values include:
        • "NONE"
        • "OWNER_DACL"
        • "OWNER_DACL_SACL"
      • ObjectTags — (String)

        Specifies whether object tags are preserved when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

        Default Value: PRESERVE

        Possible values include:
        • "PRESERVE"
        • "NONE"
    • Excludes — (Array<map>)

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

      • FilterType — (String)

        The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

        Possible values include:
        • "SIMPLE_PATTERN"
      • Value — (String)

        A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

    • Schedule — (map)

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

      • ScheduleExpression — required — (String)

        A cron expression that specifies when DataSync initiates a scheduled transfer from a source to a destination location.

    • ErrorCode — (String)

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

    • ErrorDetail — (String)

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

    • CreationTime — (Date)

      The time that the task was created.

    • Includes — (Array<map>)

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

      • FilterType — (String)

        The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

        Possible values include:
        • "SIMPLE_PATTERN"
      • Value — (String)

        A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TaskExecutionArn: 'STRING_VALUE' /* required */
};
datasync.describeTaskExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TaskExecutionArn — (String)

    The Amazon Resource Name (ARN) of the task that is being executed.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TaskExecutionArn — (String)

      The Amazon Resource Name (ARN) of the task execution that was described. 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 — (String)

      The status of the task execution.

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

      Possible values include:
      • "QUEUED"
      • "LAUNCHING"
      • "PREPARING"
      • "TRANSFERRING"
      • "VERIFYING"
      • "SUCCESS"
      • "ERROR"
    • Options — (map)

      Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how DataSync verifies data integrity, set bandwidth limits for your task, among other options.

      Each task setting has a default value. Unless you need to, you don't have to configure any of these Options before starting your task.

      • VerifyMode — (String)

        Specifies how and when DataSync checks the integrity of your data during a transfer.

        Default value: POINT_IN_TIME_CONSISTENT

        ONLY_FILES_TRANSFERRED (recommended): DataSync calculates the checksum of transferred files and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on those files at the destination.

        We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.

        POINT_IN_TIME_CONSISTENT: At the end of the transfer, DataSync scans the entire source and destination to verify that both locations are fully synchronized.

        You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.

        NONE: DataSync doesn't run additional verification at the end of the transfer. All data transmissions are still integrity-checked with checksum verification during the transfer.

        Possible values include:
        • "POINT_IN_TIME_CONSISTENT"
        • "ONLY_FILES_TRANSFERRED"
        • "NONE"
      • OverwriteMode — (String)

        Specifies whether data at the destination location should be overwritten or preserved. If set to NEVER, a destination file for example will not be replaced by a source file (even if the destination file differs from the source file). If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

        Some storage classes have specific behaviors that can affect your Amazon S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.

        Possible values include:
        • "ALWAYS"
        • "NEVER"
      • Atime — (String)

        Specifies whether to preserve metadata indicating the last time a file was read or written to. If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase of the task execution).

        Note: The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

        Default value: BEST_EFFORT

        BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

        NONE: Ignore Atime.

        Note: If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE.
        Possible values include:
        • "NONE"
        • "BEST_EFFORT"
      • Mtime — (String)

        Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING phase of your task execution. This option is required when you need to run the a task more than once.

        Default Value: PRESERVE

        PRESERVE: Preserve original Mtime (recommended)

        NONE: Ignore Mtime.

        Note: If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT. If Mtime is set to NONE, Atime must also be set to NONE.
        Possible values include:
        • "NONE"
        • "PRESERVE"
      • Uid — (String)

        Specifies the POSIX user ID (UID) of the file's owner.

        For more information, see Metadata copied by DataSync.

        Default value: INT_VALUE. This preserves the integer value of the ID.

        INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

        NONE: Ignore UID and GID.

        Possible values include:
        • "NONE"
        • "INT_VALUE"
        • "NAME"
        • "BOTH"
      • Gid — (String)

        Specifies the POSIX group ID (GID) of the file's owners.

        For more information, see Metadata copied by DataSync.

        Default value: INT_VALUE. This preserves the integer value of the ID.

        INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

        NONE: Ignore UID and GID.

        Possible values include:
        • "NONE"
        • "INT_VALUE"
        • "NAME"
        • "BOTH"
      • PreserveDeletedFiles — (String)

        Specifies whether files in the destination location that don't exist in the source should be preserved. This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.

        Default value: PRESERVE

        PRESERVE: Ignore such destination files (recommended).

        REMOVE: Delete destination files that aren’t present in the source.

        Note: If you set this parameter to REMOVE, you can't set TransferMode to ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.
        Possible values include:
        • "PRESERVE"
        • "REMOVE"
      • PreserveDevices — (String)

        Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices.

        Note: DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-file (EOF) marker.

        Default value: NONE

        NONE: Ignore special devices (recommended).

        PRESERVE: Preserve character and block device metadata. This option currently isn't supported for Amazon EFS.

        Possible values include:
        • "NONE"
        • "PRESERVE"
      • PosixPermissions — (String)

        Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

        For more information, see Metadata copied by DataSync.

        Default value: PRESERVE

        PRESERVE: Preserve POSIX-style permissions (recommended).

        NONE: Ignore permissions.

        Note: DataSync can preserve extant permissions of a source location.
        Possible values include:
        • "NONE"
        • "PRESERVE"
      • BytesPerSecond — (Integer)

        Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

      • TaskQueueing — (String)

        Specifies whether tasks should be queued before executing the tasks. The default is ENABLED, which means the tasks will be queued.

        If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • LogLevel — (String)

        Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn.

        If you set LogLevel to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred. TRANSFER publishes logs for every file or object that is transferred and integrity checked.

        Possible values include:
        • "OFF"
        • "BASIC"
        • "TRANSFER"
      • TransferMode — (String)

        Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's in the destination).

        CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

        ALL: DataSync copies all source location content to the destination (without comparing what's in the destination).

        Possible values include:
        • "CHANGED"
        • "ALL"
      • SecurityDescriptorCopyFlags — (String)

        Specifies which components of the SMB security descriptor are copied from source to destination objects.

        This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata.

        Default value: OWNER_DACL

        OWNER_DACL: For each copied object, DataSync copies the following metadata:

        • The object owner.

        • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

          DataSync won't copy NTFS system access control lists (SACLs) with this option.

        OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:

        • The object owner.

        • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

        • SACLs, which are used by administrators to log attempts to access a secured object.

          Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.

        NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.

        Possible values include:
        • "NONE"
        • "OWNER_DACL"
        • "OWNER_DACL_SACL"
      • ObjectTags — (String)

        Specifies whether object tags are preserved when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

        Default Value: PRESERVE

        Possible values include:
        • "PRESERVE"
        • "NONE"
    • Excludes — (Array<map>)

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

      • FilterType — (String)

        The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

        Possible values include:
        • "SIMPLE_PATTERN"
      • Value — (String)

        A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

    • Includes — (Array<map>)

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

      • FilterType — (String)

        The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

        Possible values include:
        • "SIMPLE_PATTERN"
      • Value — (String)

        A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

    • StartTime — (Date)

      The time that the task execution was started.

    • EstimatedFilesToTransfer — (Integer)

      The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase before the TRANSFERRING phase of the task execution. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.

    • EstimatedBytesToTransfer — (Integer)

      The estimated physical number of bytes that is to be transferred over the network.

    • FilesTransferred — (Integer)

      The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase of the task execution. It's updated periodically when each file is read from the source and sent over the network.

      If failures occur during a transfer, 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 indicator for a correct file number or to monitor your task execution.

    • BytesWritten — (Integer)

      The number of logical bytes written to the destination Amazon Web Services storage resource.

    • BytesTransferred — (Integer)

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

    • Result — (map)

      The result of the task execution.

      • PrepareDuration — (Integer)

        The total time in milliseconds that DataSync spent in the PREPARING phase.

      • PrepareStatus — (String)

        The status of the PREPARING phase.

        Possible values include:
        • "PENDING"
        • "SUCCESS"
        • "ERROR"
      • TotalDuration — (Integer)

        The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.

      • TransferDuration — (Integer)

        The total time in milliseconds that DataSync spent in the TRANSFERRING phase.

      • TransferStatus — (String)

        The status of the TRANSFERRING phase.

        Possible values include:
        • "PENDING"
        • "SUCCESS"
        • "ERROR"
      • VerifyDuration — (Integer)

        The total time in milliseconds that DataSync spent in the VERIFYING phase.

      • VerifyStatus — (String)

        The status of the VERIFYING phase.

        Possible values include:
        • "PENDING"
        • "SUCCESS"
        • "ERROR"
      • ErrorCode — (String)

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

      • ErrorDetail — (String)

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

    • BytesCompressed — (Integer)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DiscoveryJobArn: 'STRING_VALUE', /* required */
  ResourceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ResourceType: SVM | VOLUME | CLUSTER /* required */
};
datasync.generateRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DiscoveryJobArn — (String)

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

  • ResourceIds — (Array<String>)

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

  • ResourceType — (String)

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

    Possible values include:
    • "SVM"
    • "VOLUME"
    • "CLUSTER"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
datasync.listAgents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

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

  • NextToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Agents — (Array<map>)

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

      • AgentArn — (String)

        The Amazon Resource Name (ARN) of a DataSync agent.

      • Name — (String)

        The name of an agent.

      • Status — (String)

        The status of an agent. For more information, see DataSync agent statuses.

        Possible values include:
        • "ONLINE"
        • "OFFLINE"
    • NextToken — (String)

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