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)

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

  • AgentName — (String)

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

  • Tags — (Array<map>)

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

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

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

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

  • SubnetArns — (Array<String>)

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

  • SecurityGroupArns — (Array<String>)

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

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 that you just activated. Use the ListAgents operation to return a list of agents in your Amazon Web Services account and Amazon Web Services Region.

Returns:

• (AWS.Request) —

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

var params = {
  AgentArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  AuthenticationType: SAS, /* required */
  ContainerUrl: 'STRING_VALUE', /* required */
  AccessTier: HOT | COOL | ARCHIVE,
  BlobType: BLOCK,
  SasConfiguration: {
    Token: 'STRING_VALUE' /* required */
  },
  Subdirectory: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datasync.createLocationAzureBlob(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: {}) —
  • ContainerUrl — (String)

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

  • AuthenticationType — (String)

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

    Possible values include:
    • "SAS"
  • SasConfiguration — (map)

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

    • Token — required — (String)

      Specifies a SAS token that provides permissions to access your Azure Blob Storage.

      The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:

      sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D

  • BlobType — (String)

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

    Possible values include:
    • "BLOCK"
  • AccessTier — (String)

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

    Possible values include:
    • "HOT"
    • "COOL"
    • "ARCHIVE"
  • Subdirectory — (String)

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

  • AgentArns — (Array<String>)

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

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

  • Tags — (Array<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 transfer 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 Azure Blob Storage transfer location that you created.

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.

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

      • 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 that can mount and access the files, folders, and metadata in your SVM.

        For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

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

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

      • 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 that can mount and access the files, folders, and metadata in your SVM.

        For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

  • 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 with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

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

  • Domain — (String)

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

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

  • Password — (String)

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

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)

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

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

  • ServerHostname — (String)

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

  • OnPremConfig — (map)

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

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

    • AgentArns — required — (Array<String>)

      The Amazon Resource Names (ARNs) of the agents connecting to a transfer location.

  • MountOptions — (map)

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

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

    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 transfer location that you created for your NFS file server.

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 chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

    The certificate chain might include:

    • The object storage system's certificate

    • All intermediate certificates (if there are any)

    • The root certificate of the signing CA

    You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

    cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

    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)

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

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

    • /photos
    • photos//2006/January
    • photos/./2006/February
    • photos/../2006/March
  • S3BucketArn — (String)

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

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

  • S3StorageClass — (String)

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

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

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

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

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

    For more information, see Accessing S3 buckets.

    • BucketAccessRoleArn — required — (String)

      Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.

  • AgentArns — (Array<String>)

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

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

  • Tags — (Array<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 transfer 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 S3 location that you 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 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 that can mount and access the files, folders, and file metadata in your SMB file server.

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

  • Domain — (String)

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

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

  • Password — (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 */
  ],
  ManifestConfig: {
    Action: TRANSFER,
    Format: CSV,
    Source: {
      S3: { /* required */
        BucketAccessRoleArn: 'STRING_VALUE', /* required */
        ManifestObjectPath: 'STRING_VALUE', /* required */
        S3BucketArn: 'STRING_VALUE', /* required */
        ManifestObjectVersionId: 'STRING_VALUE'
      }
    }
  },
  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 */
    Status: ENABLED | DISABLED
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TaskReportConfig: {
    Destination: {
      S3: {
        BucketAccessRoleArn: 'STRING_VALUE', /* required */
        S3BucketArn: 'STRING_VALUE', /* required */
        Subdirectory: 'STRING_VALUE'
      }
    },
    ObjectVersionIds: INCLUDE | NONE,
    OutputType: SUMMARY_ONLY | STANDARD,
    Overrides: {
      Deleted: {
        ReportLevel: ERRORS_ONLY | SUCCESSES_AND_ERRORS
      },
      Skipped: {
        ReportLevel: ERRORS_ONLY | SUCCESSES_AND_ERRORS
      },
      Transferred: {
        ReportLevel: ERRORS_ONLY | SUCCESSES_AND_ERRORS
      },
      Verified: {
        ReportLevel: ERRORS_ONLY | SUCCESSES_AND_ERRORS
      }
    },
    ReportLevel: ERRORS_ONLY | SUCCESSES_AND_ERRORS
  }
};
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)

    Specifies the ARN of your transfer's source location.

  • DestinationLocationArn — (String)

    Specifies the ARN of your transfer's destination location.

  • CloudWatchLogGroupArn — (String)

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

  • Name — (String)

    Specifies the name of your task.

  • Options — (map)

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

    • VerifyMode — (String)

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

      • 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 (default) - At the end of the transfer, DataSync scans the entire source and destination to verify that both locations are fully synchronized.

        If you use a manifest, DataSync only scans and verifies what's listed in the manifest.

        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 DataSync should modify or preserve data at the destination location.

      • ALWAYS (default) - DataSync modifies data in the destination location when source data (including metadata) has changed.

        If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.

      • NEVER - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.

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

      Specifies whether to preserve metadata indicating the last time a file was read or written to.

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

      • BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase of the task execution). This option is recommended.

      • NONE - Ignores 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.

      • PRESERVE (default) - Preserves original Mtime, which is recommended.

      • NONE - Ignores 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.

      • INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended.

      • NONE - Ignores UID and GID.

      For more information, see Metadata copied by DataSync.

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

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

      • INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.

      • NONE - Ignores UID and GID.

      For more information, see Metadata copied by DataSync.

      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.

      • PRESERVE (default) - Ignores such destination files, which is recommended.

      • REMOVE - Deletes 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.

      • NONE (default) - Ignores special devices (recommended).

      • PRESERVE - Preserves 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.

      • PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.

      • NONE - Ignores POSIX-style 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 your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This is ENABLED by default.

      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.

      • BASIC - Publishes logs with only basic information (such as transfer errors).

      • TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.

      • OFF - No logs are published.

      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 (default) - DataSync copies only data or metadata that is new or different content from the source location to the destination location.

      • ALL - DataSync copies everything in the source to the destination without comparing differences between the locations.

      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.

      • OWNER_DACL (default) - 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 with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer).

      • 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 you want DataSync to PRESERVE object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

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

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

    • 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 for when you want your task to run. For more information, see Scheduling your task.

    • ScheduleExpression — required — (String)

      Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the Amazon EventBridge User Guide .

    • Status — (String)

      Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

      DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
  • Tags — (Array<map>)

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

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

    • 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 include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

    • 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

  • ManifestConfig — (map)

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

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

    • Action — (String)

      Specifies what DataSync uses the manifest for.

      Possible values include:
      • "TRANSFER"
    • Format — (String)

      Specifies the file format of your manifest. For more information, see Creating a manifest.

      Possible values include:
      • "CSV"
    • Source — (map)

      Specifies the manifest that you want DataSync to use and where it's hosted.

      Note: You must specify this parameter if you're configuring a new manifest on or after February 7, 2024. If you don't, you'll get a 400 status code and ValidationException error stating that you're missing the IAM role for DataSync to access the S3 bucket where you're hosting your manifest. For more information, see Providing DataSync access to your manifest.
      • S3 — required — (map)

        Specifies the S3 bucket where you're hosting your manifest.

        • ManifestObjectPath — required — (String)

          Specifies the Amazon S3 object key of your manifest. This can include a prefix (for example, prefix/my-manifest.csv).

        • BucketAccessRoleArn — required — (String)

          Specifies the Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see Providing DataSync access to your manifest.

        • S3BucketArn — required — (String)

          Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.

        • ManifestObjectVersionId — (String)

          Specifies the object version ID of the manifest that you want DataSync to use. If you don't set this, DataSync uses the latest version of the object.

  • TaskReportConfig — (map)

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

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

    • Destination — (map)

      Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

      • S3 — (map)

        Specifies the Amazon S3 bucket where DataSync uploads your task report.

        • Subdirectory — (String)

          Specifies a bucket prefix for your report.

        • S3BucketArn — required — (String)

          Specifies the ARN of the S3 bucket where DataSync uploads your report.

        • BucketAccessRoleArn — required — (String)

          Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket.

    • OutputType — (String)

      Specifies the type of task report that you want:

      • SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

      • STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

      Possible values include:
      • "SUMMARY_ONLY"
      • "STANDARD"
    • ReportLevel — (String)

      Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

      • ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

      • SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

      Possible values include:
      • "ERRORS_ONLY"
      • "SUCCESSES_AND_ERRORS"
    • ObjectVersionIds — (String)

      Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

      Possible values include:
      • "INCLUDE"
      • "NONE"
    • Overrides — (map)

      Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

      • Transferred — (map)

        Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer.

        • ReportLevel — (String)

          Specifies whether your task report includes errors only or successes and errors.

          For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).

          Possible values include:
          • "ERRORS_ONLY"
          • "SUCCESSES_AND_ERRORS"
      • Verified — (map)

        Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer.

        • ReportLevel — (String)

          Specifies whether your task report includes errors only or successes and errors.

          For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).

          Possible values include:
          • "ERRORS_ONLY"
          • "SUCCESSES_AND_ERRORS"
      • Deleted — (map)

        Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.

        • ReportLevel — (String)

          Specifies whether your task report includes errors only or successes and errors.

          For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).

          Possible values include:
          • "ERRORS_ONLY"
          • "SUCCESSES_AND_ERRORS"
      • Skipped — (map)

        Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer.

        • ReportLevel — (String)

          Specifies whether your task report includes errors only or successes and errors.

          For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).

          Possible values include:
          • "ERRORS_ONLY"
          • "SUCCESSES_AND_ERRORS"

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

    • 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, the agent is configured properly and ready to use.

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

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

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

    • CreationTime — (Date)

      The time that the agent was activated.

    • EndpointType — (String)

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

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

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

      • VpcEndpointId — (String)

        Specifies the ID of the VPC endpoint that your agent connects to.

      • PrivateLinkEndpoint — (String)

        Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that your agent connects to.

      • SubnetArns — (Array<String>)

        Specifies the ARN of the subnet where your VPC endpoint is located. You can only specify one ARN.

      • SecurityGroupArns — (Array<String>)

        Specifies the Amazon Resource Names (ARN) of the security group that provides DataSync access to your VPC endpoint. You can only specify one ARN.

    • Platform — (map)

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

      • Version — (String)

        The version of the DataSync agent.

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.describeLocationAzureBlob(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 your Azure Blob Storage transfer location.

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 your Azure Blob Storage transfer location.

    • LocationUri — (String)

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

    • AuthenticationType — (String)

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

      Possible values include:
      • "SAS"
    • BlobType — (String)

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

      Possible values include:
      • "BLOCK"
    • AccessTier — (String)

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

      Possible values include:
      • "HOT"
      • "COOL"
      • "ARCHIVE"
    • AgentArns — (Array<String>)

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

    • CreationTime — (Date)

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

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.

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

        • 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 that can mount and access the files, folders, and metadata in your SVM.

          For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

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

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

        • 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 that can mount and access the files, folders, and metadata in your SVM.

          For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

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

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

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

    • LocationUri — (String)

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

    • SecurityGroupArns — (Array<String>)

      The 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 with the permissions to mount and access the FSx for Windows File Server file system.

    • Domain — (String)

      The name of the Microsoft Active Directory domain that the FSx for Windows File Server file system 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)

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

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

    • LocationUri — (String)

      The URI of the HDFS location.

    • NameNodes — (Array<map>)

      The NameNode that manages 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, which specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the 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 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 DataSync agents that can connect with your 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)

    Specifies the Amazon Resource Name (ARN) of the NFS 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 NFS location.

    • LocationUri — (String)

      The URI of the NFS location.

    • OnPremConfig — (map)

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

      • AgentArns — required — (Array<String>)

        The Amazon Resource Names (ARNs) of the agents connecting to a transfer location.

    • MountOptions — (map)

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

      • 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 when 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)

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

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 URI 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 connect with your object storage system.

    • CreationTime — (Date)

      The time that the location was created.

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

      The certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).

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)

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

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 S3 location.

    • LocationUri — (String)

      The URL of the Amazon S3 location that was described.

    • S3StorageClass — (String)

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

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

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

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

      For more information, see Accessing S3 buckets.

      • BucketAccessRoleArn — required — (String)

        Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.

    • AgentArns — (Array<String>)

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

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

    • CreationTime — (Date)

      The time that the Amazon S3 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)

    Specifies the Amazon Resource Name (ARN) of the SMB 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 SMB location.

    • LocationUri — (String)

      The URI of the SMB location.

    • AgentArns — (Array<String>)

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

    • User — (String)

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

    • Domain — (String)

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

    • MountOptions — (map)

      The protocol that DataSync use to access your SMB file.

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

        • ClusterCloudStorageUsed — (Integer)

          The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).

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

        • LunCount — (Integer)

          The number of LUNs (logical unit numbers) in the SVM.

      • 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"
        • LunCount — (Integer)

          The number of LUNs (logical unit numbers) in the volume.

      • 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"
        • LunCount — (Integer)

          The number of LUNs (logical unit numbers) in the cluster.

        • ClusterCloudStorageUsed — (Integer)

          The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).

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

    Specifies the Amazon Resource Name (ARN) of the transfer task 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:

    • TaskArn — (String)

      The ARN of your task.

    • Status — (String)

      The status of your task. For information about what each status means, see Task statuses.

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

      The name of your task.

    • CurrentTaskExecutionArn — (String)

      The ARN of the most recent task execution.

    • SourceLocationArn — (String)

      The ARN of your transfer's source location.

    • DestinationLocationArn — (String)

      The ARN of your transfer's destination location.

    • CloudWatchLogGroupArn — (String)

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

      For more information, see Monitoring DataSync with Amazon CloudWatch.

    • SourceNetworkInterfaceArns — (Array<String>)

      The ARNs of the network interfaces that DataSync created for your source location.

    • DestinationNetworkInterfaceArns — (Array<String>)

      The ARNs of the network interfaces that DataSync created for your destination location.

    • Options — (map)

      The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.

      • VerifyMode — (String)

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

        • 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 (default) - At the end of the transfer, DataSync scans the entire source and destination to verify that both locations are fully synchronized.

          If you use a manifest, DataSync only scans and verifies what's listed in the manifest.

          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 DataSync should modify or preserve data at the destination location.

        • ALWAYS (default) - DataSync modifies data in the destination location when source data (including metadata) has changed.

          If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.

        • NEVER - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.

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

        Specifies whether to preserve metadata indicating the last time a file was read or written to.

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

        • BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase of the task execution). This option is recommended.

        • NONE - Ignores 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.

        • PRESERVE (default) - Preserves original Mtime, which is recommended.

        • NONE - Ignores 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.

        • INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended.

        • NONE - Ignores UID and GID.

        For more information, see Metadata copied by DataSync.

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

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

        • INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.

        • NONE - Ignores UID and GID.

        For more information, see Metadata copied by DataSync.

        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.

        • PRESERVE (default) - Ignores such destination files, which is recommended.

        • REMOVE - Deletes 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.

        • NONE (default) - Ignores special devices (recommended).

        • PRESERVE - Preserves 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.

        • PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.

        • NONE - Ignores POSIX-style 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 your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This is ENABLED by default.

        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.

        • BASIC - Publishes logs with only basic information (such as transfer errors).

        • TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.

        • OFF - No logs are published.

        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 (default) - DataSync copies only data or metadata that is new or different content from the source location to the destination location.

        • ALL - DataSync copies everything in the source to the destination without comparing differences between the locations.

        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.

        • OWNER_DACL (default) - 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 with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer).

        • 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 you want DataSync to PRESERVE object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

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

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

      • 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 for when you want your task to run. For more information, see Scheduling your task.

      • ScheduleExpression — required — (String)

        Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the Amazon EventBridge User Guide .

      • Status — (String)

        Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

        DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.

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

      If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

    • ErrorDetail — (String)

      If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

    • CreationTime — (Date)

      The time that the task was created.

    • Includes — (Array<map>)

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

      • 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

    • ManifestConfig — (map)

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

      • Action — (String)

        Specifies what DataSync uses the manifest for.

        Possible values include:
        • "TRANSFER"
      • Format — (String)

        Specifies the file format of your manifest. For more information, see Creating a manifest.

        Possible values include:
        • "CSV"
      • Source — (map)

        Specifies the manifest that you want DataSync to use and where it's hosted.

        Note: You must specify this parameter if you're configuring a new manifest on or after February 7, 2024. If you don't, you'll get a 400 status code and ValidationException error stating that you're missing the IAM role for DataSync to access the S3 bucket where you're hosting your manifest. For more information, see Providing DataSync access to your manifest.
        • S3 — required — (map)

          Specifies the S3 bucket where you're hosting your manifest.

          • ManifestObjectPath — required — (String)

            Specifies the Amazon S3 object key of your manifest. This can include a prefix (for example, prefix/my-manifest.csv).

          • BucketAccessRoleArn — required — (String)

            Specifies the Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see Providing DataSync access to your manifest.

          • S3BucketArn — required — (String)

            Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.

          • ManifestObjectVersionId — (String)

            Specifies the object version ID of the manifest that you want DataSync to use. If you don't set this, DataSync uses the latest version of the object.

    • TaskReportConfig — (map)

      The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

      • Destination — (map)

        Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

        • S3 — (map)

          Specifies the Amazon S3 bucket where DataSync uploads your task report.

          • Subdirectory — (String)

            Specifies a bucket prefix for your report.

          • S3BucketArn — required — (String)

            Specifies the ARN of the S3 bucket where DataSync uploads your report.

          • BucketAccessRoleArn — required — (String)

            Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket.

      • OutputType — (String)

        Specifies the type of task report that you want:

        • SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

        • STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

        Possible values include:
        • "SUMMARY_ONLY"
        • "STANDARD"
      • ReportLevel — (String)

        Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

        • ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

        • SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

        Possible values include:
        • "ERRORS_ONLY"
        • "SUCCESSES_AND_ERRORS"
      • ObjectVersionIds — (String)

        Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

        Possible values include:
        • "INCLUDE"
        • "NONE"
      • Overrides — (map)

        Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

        • Transferred — (map)

          Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer.

          • ReportLevel — (String)

            Specifies whether your task report includes errors only or successes and errors.

            For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).

            Possible values include:
            • "ERRORS_ONLY"
            • "SUCCESSES_AND_ERRORS"
        • Verified — (map)

          Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer.

          • ReportLevel — (String)

            Specifies whether your task report includes errors only or successes and errors.

            For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).

            Possible values include:
            • "ERRORS_ONLY"
            • "SUCCESSES_AND_ERRORS"
        • Deleted — (map)

          Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.

          • ReportLevel — (String)

            Specifies whether your task report includes errors only or successes and errors.

            For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).

            Possible values include:
            • "ERRORS_ONLY"
            • "SUCCESSES_AND_ERRORS"
        • Skipped — (map)

          Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer.

          • ReportLevel — (String)

            Specifies whether your task report includes errors only or successes and errors.

            For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).

            Possible values include:
            • "ERRORS_ONLY"
            • "SUCCESSES_AND_ERRORS"
    • ScheduleDetails — (map)

      The details about your task schedule.

      • StatusUpdateTime — (Date)

        Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see when the schedule was disabled.

      • DisabledReason — (String)

        Provides a reason if the task schedule is disabled.

        If your schedule is disabled by USER, you see a Manually disabled by user. message.

        If your schedule is disabled by SERVICE, you see an error message to help you understand why the task keeps failing. For information on resolving DataSync errors, see Troubleshooting issues with DataSync transfers.

      • DisabledBy — (String)

        Indicates how your task schedule was disabled.

        • USER - Your schedule was manually disabled by using the UpdateTask operation or DataSync console.

        • SERVICE - Your schedule was automatically disabled by DataSync because the task failed repeatedly with the same error.

        Possible values include:
        • "USER"
        • "SERVICE"