CancelTaskExecution

$result = $client->cancelTaskExecution([/* ... */]);
$promise = $client->cancelTaskExecutionAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->cancelTaskExecution([
    'TaskExecutionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateAgent

$result = $client->createAgent([/* ... */]);
$promise = $client->createAgentAsync([/* ... */]);

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

If you haven't deployed an agent yet, see Do I need a DataSync agent?

Parameter Syntax

$result = $client->createAgent([
    'ActivationKey' => '<string>', // REQUIRED
    'AgentName' => '<string>',
    'SecurityGroupArns' => ['<string>', ...],
    'SubnetArns' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcEndpointId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AgentArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationAzureBlob

$result = $client->createLocationAzureBlob([/* ... */]);
$promise = $client->createLocationAzureBlobAsync([/* ... */]);

Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination. You can make transfers with or without a DataSync agent that connects to your container.

Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types.

Parameter Syntax

$result = $client->createLocationAzureBlob([
    'AccessTier' => 'HOT|COOL|ARCHIVE',
    'AgentArns' => ['<string>', ...],
    'AuthenticationType' => 'SAS|NONE', // REQUIRED
    'BlobType' => 'BLOCK',
    'CmkSecretConfig' => [
        'KmsKeyArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'ContainerUrl' => '<string>', // REQUIRED
    'CustomSecretConfig' => [
        'SecretAccessRoleArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'SasConfiguration' => [
        'Token' => '<string>', // REQUIRED
    ],
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationEfs

$result = $client->createLocationEfs([/* ... */]);
$promise = $client->createLocationEfsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createLocationEfs([
    'AccessPointArn' => '<string>',
    'Ec2Config' => [ // REQUIRED
        'SecurityGroupArns' => ['<string>', ...], // REQUIRED
        'SubnetArn' => '<string>', // REQUIRED
    ],
    'EfsFilesystemArn' => '<string>', // REQUIRED
    'FileSystemAccessRoleArn' => '<string>',
    'InTransitEncryption' => 'NONE|TLS1_2',
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationFsxLustre

$result = $client->createLocationFsxLustre([/* ... */]);
$promise = $client->createLocationFsxLustreAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createLocationFsxLustre([
    'FsxFilesystemArn' => '<string>', // REQUIRED
    'SecurityGroupArns' => ['<string>', ...], // REQUIRED
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationFsxOntap

$result = $client->createLocationFsxOntap([/* ... */]);
$promise = $client->createLocationFsxOntapAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createLocationFsxOntap([
    'Protocol' => [ // REQUIRED
        'NFS' => [
            'MountOptions' => [
                'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
            ],
        ],
        'SMB' => [
            'Domain' => '<string>',
            'MountOptions' => [
                'Version' => 'AUTOMATIC|SMB2|SMB3|SMB1|SMB2_0',
            ],
            'Password' => '<string>', // REQUIRED
            'User' => '<string>', // REQUIRED
        ],
    ],
    'SecurityGroupArns' => ['<string>', ...], // REQUIRED
    'StorageVirtualMachineArn' => '<string>', // REQUIRED
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationFsxOpenZfs

$result = $client->createLocationFsxOpenZfs([/* ... */]);
$promise = $client->createLocationFsxOpenZfsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createLocationFsxOpenZfs([
    'FsxFilesystemArn' => '<string>', // REQUIRED
    'Protocol' => [ // REQUIRED
        'NFS' => [
            'MountOptions' => [
                'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
            ],
        ],
        'SMB' => [
            'Domain' => '<string>',
            'MountOptions' => [
                'Version' => 'AUTOMATIC|SMB2|SMB3|SMB1|SMB2_0',
            ],
            'Password' => '<string>', // REQUIRED
            'User' => '<string>', // REQUIRED
        ],
    ],
    'SecurityGroupArns' => ['<string>', ...], // REQUIRED
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationFsxWindows

$result = $client->createLocationFsxWindows([/* ... */]);
$promise = $client->createLocationFsxWindowsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createLocationFsxWindows([
    'Domain' => '<string>',
    'FsxFilesystemArn' => '<string>', // REQUIRED
    'Password' => '<string>', // REQUIRED
    'SecurityGroupArns' => ['<string>', ...], // REQUIRED
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'User' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationHdfs

$result = $client->createLocationHdfs([/* ... */]);
$promise = $client->createLocationHdfsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createLocationHdfs([
    'AgentArns' => ['<string>', ...], // REQUIRED
    'AuthenticationType' => 'SIMPLE|KERBEROS', // REQUIRED
    'BlockSize' => <integer>,
    'KerberosKeytab' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KerberosKrb5Conf' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KerberosPrincipal' => '<string>',
    'KmsKeyProviderUri' => '<string>',
    'NameNodes' => [ // REQUIRED
        [
            'Hostname' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'QopConfiguration' => [
        'DataTransferProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY',
        'RpcProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY',
    ],
    'ReplicationFactor' => <integer>,
    'SimpleUser' => '<string>',
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationNfs

$result = $client->createLocationNfs([/* ... */]);
$promise = $client->createLocationNfsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createLocationNfs([
    'MountOptions' => [
        'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
    ],
    'OnPremConfig' => [ // REQUIRED
        'AgentArns' => ['<string>', ...], // REQUIRED
    ],
    'ServerHostname' => '<string>', // REQUIRED
    'Subdirectory' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationObjectStorage

$result = $client->createLocationObjectStorage([/* ... */]);
$promise = $client->createLocationObjectStorageAsync([/* ... */]);

Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data. You can make transfers with or without a DataSync agent.

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

Parameter Syntax

$result = $client->createLocationObjectStorage([
    'AccessKey' => '<string>',
    'AgentArns' => ['<string>', ...],
    'BucketName' => '<string>', // REQUIRED
    'CmkSecretConfig' => [
        'KmsKeyArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'CustomSecretConfig' => [
        'SecretAccessRoleArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'SecretKey' => '<string>',
    'ServerCertificate' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ServerHostname' => '<string>', // REQUIRED
    'ServerPort' => <integer>,
    'ServerProtocol' => 'HTTPS|HTTP',
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationS3

$result = $client->createLocationS3([/* ... */]);
$promise = $client->createLocationS3Async([/* ... */]);

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

For more information, see Configuring transfers with Amazon S3.

Parameter Syntax

$result = $client->createLocationS3([
    'AgentArns' => ['<string>', ...],
    'S3BucketArn' => '<string>', // REQUIRED
    'S3Config' => [ // REQUIRED
        'BucketAccessRoleArn' => '<string>', // REQUIRED
    ],
    'S3StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_INSTANT_RETRIEVAL',
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateLocationSmb

$result = $client->createLocationSmb([/* ... */]);
$promise = $client->createLocationSmbAsync([/* ... */]);

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

Before you begin, make sure that you understand how DataSync accesses SMB file servers. For more information, see Providing DataSync access to SMB file servers.

Parameter Syntax

$result = $client->createLocationSmb([
    'AgentArns' => ['<string>', ...], // REQUIRED
    'AuthenticationType' => 'NTLM|KERBEROS',
    'DnsIpAddresses' => ['<string>', ...],
    'Domain' => '<string>',
    'KerberosKeytab' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KerberosKrb5Conf' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KerberosPrincipal' => '<string>',
    'MountOptions' => [
        'Version' => 'AUTOMATIC|SMB2|SMB3|SMB1|SMB2_0',
    ],
    'Password' => '<string>',
    'ServerHostname' => '<string>', // REQUIRED
    'Subdirectory' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'User' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

CreateTask

$result = $client->createTask([/* ... */]);
$promise = $client->createTaskAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createTask([
    'CloudWatchLogGroupArn' => '<string>',
    'DestinationLocationArn' => '<string>', // REQUIRED
    'Excludes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Includes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ManifestConfig' => [
        'Action' => 'TRANSFER',
        'Format' => 'CSV',
        'Source' => [
            'S3' => [ // REQUIRED
                'BucketAccessRoleArn' => '<string>', // REQUIRED
                'ManifestObjectPath' => '<string>', // REQUIRED
                'ManifestObjectVersionId' => '<string>',
                'S3BucketArn' => '<string>', // REQUIRED
            ],
        ],
    ],
    'Name' => '<string>',
    'Options' => [
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        '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>', // REQUIRED
        'Status' => 'ENABLED|DISABLED',
    ],
    'SourceLocationArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'TaskMode' => 'BASIC|ENHANCED',
    'TaskReportConfig' => [
        'Destination' => [
            'S3' => [
                'BucketAccessRoleArn' => '<string>', // REQUIRED
                'S3BucketArn' => '<string>', // REQUIRED
                'Subdirectory' => '<string>',
            ],
        ],
        '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',
    ],
]);

Parameter Details

Result Syntax

[
    'TaskArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DeleteAgent

$result = $client->deleteAgent([/* ... */]);
$promise = $client->deleteAgentAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->deleteAgent([
    'AgentArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DeleteLocation

$result = $client->deleteLocation([/* ... */]);
$promise = $client->deleteLocationAsync([/* ... */]);

Deletes a transfer location resource from DataSync.

Parameter Syntax

$result = $client->deleteLocation([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DeleteTask

$result = $client->deleteTask([/* ... */]);
$promise = $client->deleteTaskAsync([/* ... */]);

Deletes a transfer task resource from DataSync.

Parameter Syntax

$result = $client->deleteTask([
    'TaskArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeAgent

$result = $client->describeAgent([/* ... */]);
$promise = $client->describeAgentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeAgent([
    'AgentArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AgentArn' => '<string>',
    'CreationTime' => <DateTime>,
    'EndpointType' => 'PUBLIC|PRIVATE_LINK|FIPS',
    'LastConnectionTime' => <DateTime>,
    'Name' => '<string>',
    'Platform' => [
        'Version' => '<string>',
    ],
    'PrivateLinkConfig' => [
        'PrivateLinkEndpoint' => '<string>',
        'SecurityGroupArns' => ['<string>', ...],
        'SubnetArns' => ['<string>', ...],
        'VpcEndpointId' => '<string>',
    ],
    'Status' => 'ONLINE|OFFLINE',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationAzureBlob

$result = $client->describeLocationAzureBlob([/* ... */]);
$promise = $client->describeLocationAzureBlobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationAzureBlob([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccessTier' => 'HOT|COOL|ARCHIVE',
    'AgentArns' => ['<string>', ...],
    'AuthenticationType' => 'SAS|NONE',
    'BlobType' => 'BLOCK',
    'CmkSecretConfig' => [
        'KmsKeyArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'CreationTime' => <DateTime>,
    'CustomSecretConfig' => [
        'SecretAccessRoleArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'ManagedSecretConfig' => [
        'SecretArn' => '<string>',
    ],
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationEfs

$result = $client->describeLocationEfs([/* ... */]);
$promise = $client->describeLocationEfsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationEfs([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccessPointArn' => '<string>',
    'CreationTime' => <DateTime>,
    'Ec2Config' => [
        'SecurityGroupArns' => ['<string>', ...],
        'SubnetArn' => '<string>',
    ],
    'FileSystemAccessRoleArn' => '<string>',
    'InTransitEncryption' => 'NONE|TLS1_2',
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationFsxLustre

$result = $client->describeLocationFsxLustre([/* ... */]);
$promise = $client->describeLocationFsxLustreAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationFsxLustre([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'SecurityGroupArns' => ['<string>', ...],
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationFsxOntap

$result = $client->describeLocationFsxOntap([/* ... */]);
$promise = $client->describeLocationFsxOntapAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationFsxOntap([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'FsxFilesystemArn' => '<string>',
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'Protocol' => [
        'NFS' => [
            'MountOptions' => [
                'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
            ],
        ],
        'SMB' => [
            'Domain' => '<string>',
            'MountOptions' => [
                'Version' => 'AUTOMATIC|SMB2|SMB3|SMB1|SMB2_0',
            ],
            'Password' => '<string>',
            'User' => '<string>',
        ],
    ],
    'SecurityGroupArns' => ['<string>', ...],
    'StorageVirtualMachineArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationFsxOpenZfs

$result = $client->describeLocationFsxOpenZfs([/* ... */]);
$promise = $client->describeLocationFsxOpenZfsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationFsxOpenZfs([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'Protocol' => [
        'NFS' => [
            'MountOptions' => [
                'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
            ],
        ],
        'SMB' => [
            'Domain' => '<string>',
            'MountOptions' => [
                'Version' => 'AUTOMATIC|SMB2|SMB3|SMB1|SMB2_0',
            ],
            'Password' => '<string>',
            'User' => '<string>',
        ],
    ],
    'SecurityGroupArns' => ['<string>', ...],
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationFsxWindows

$result = $client->describeLocationFsxWindows([/* ... */]);
$promise = $client->describeLocationFsxWindowsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationFsxWindows([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'Domain' => '<string>',
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'SecurityGroupArns' => ['<string>', ...],
    'User' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationHdfs

$result = $client->describeLocationHdfs([/* ... */]);
$promise = $client->describeLocationHdfsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationHdfs([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AgentArns' => ['<string>', ...],
    'AuthenticationType' => 'SIMPLE|KERBEROS',
    'BlockSize' => <integer>,
    'CreationTime' => <DateTime>,
    'KerberosPrincipal' => '<string>',
    'KmsKeyProviderUri' => '<string>',
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'NameNodes' => [
        [
            'Hostname' => '<string>',
            'Port' => <integer>,
        ],
        // ...
    ],
    'QopConfiguration' => [
        'DataTransferProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY',
        'RpcProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY',
    ],
    'ReplicationFactor' => <integer>,
    'SimpleUser' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationNfs

$result = $client->describeLocationNfs([/* ... */]);
$promise = $client->describeLocationNfsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationNfs([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'MountOptions' => [
        'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
    ],
    'OnPremConfig' => [
        'AgentArns' => ['<string>', ...],
    ],
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationObjectStorage

$result = $client->describeLocationObjectStorage([/* ... */]);
$promise = $client->describeLocationObjectStorageAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationObjectStorage([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccessKey' => '<string>',
    'AgentArns' => ['<string>', ...],
    'CmkSecretConfig' => [
        'KmsKeyArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'CreationTime' => <DateTime>,
    'CustomSecretConfig' => [
        'SecretAccessRoleArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'ManagedSecretConfig' => [
        'SecretArn' => '<string>',
    ],
    'ServerCertificate' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ServerPort' => <integer>,
    'ServerProtocol' => 'HTTPS|HTTP',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationS3

$result = $client->describeLocationS3([/* ... */]);
$promise = $client->describeLocationS3Async([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationS3([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AgentArns' => ['<string>', ...],
    'CreationTime' => <DateTime>,
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'S3Config' => [
        'BucketAccessRoleArn' => '<string>',
    ],
    'S3StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_INSTANT_RETRIEVAL',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeLocationSmb

$result = $client->describeLocationSmb([/* ... */]);
$promise = $client->describeLocationSmbAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationSmb([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AgentArns' => ['<string>', ...],
    'AuthenticationType' => 'NTLM|KERBEROS',
    'CreationTime' => <DateTime>,
    'DnsIpAddresses' => ['<string>', ...],
    'Domain' => '<string>',
    'KerberosPrincipal' => '<string>',
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'MountOptions' => [
        'Version' => 'AUTOMATIC|SMB2|SMB3|SMB1|SMB2_0',
    ],
    'User' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeTask

$result = $client->describeTask([/* ... */]);
$promise = $client->describeTaskAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeTask([
    'TaskArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CloudWatchLogGroupArn' => '<string>',
    'CreationTime' => <DateTime>,
    'CurrentTaskExecutionArn' => '<string>',
    'DestinationLocationArn' => '<string>',
    'DestinationNetworkInterfaceArns' => ['<string>', ...],
    'ErrorCode' => '<string>',
    'ErrorDetail' => '<string>',
    'Excludes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Includes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ManifestConfig' => [
        'Action' => 'TRANSFER',
        'Format' => 'CSV',
        'Source' => [
            'S3' => [
                'BucketAccessRoleArn' => '<string>',
                'ManifestObjectPath' => '<string>',
                'ManifestObjectVersionId' => '<string>',
                'S3BucketArn' => '<string>',
            ],
        ],
    ],
    'Name' => '<string>',
    'Options' => [
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        '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>',
        'Status' => 'ENABLED|DISABLED',
    ],
    'ScheduleDetails' => [
        'DisabledBy' => 'USER|SERVICE',
        'DisabledReason' => '<string>',
        'StatusUpdateTime' => <DateTime>,
    ],
    'SourceLocationArn' => '<string>',
    'SourceNetworkInterfaceArns' => ['<string>', ...],
    'Status' => 'AVAILABLE|CREATING|QUEUED|RUNNING|UNAVAILABLE',
    'TaskArn' => '<string>',
    'TaskMode' => 'BASIC|ENHANCED',
    'TaskReportConfig' => [
        'Destination' => [
            'S3' => [
                'BucketAccessRoleArn' => '<string>',
                'S3BucketArn' => '<string>',
                'Subdirectory' => '<string>',
            ],
        ],
        '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',
    ],
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

DescribeTaskExecution

$result = $client->describeTaskExecution([/* ... */]);
$promise = $client->describeTaskExecutionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeTaskExecution([
    'TaskExecutionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BytesCompressed' => <integer>,
    'BytesTransferred' => <integer>,
    'BytesWritten' => <integer>,
    'EndTime' => <DateTime>,
    'EstimatedBytesToTransfer' => <integer>,
    'EstimatedFilesToDelete' => <integer>,
    'EstimatedFilesToTransfer' => <integer>,
    'Excludes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'FilesDeleted' => <integer>,
    'FilesFailed' => [
        'Delete' => <integer>,
        'Prepare' => <integer>,
        'Transfer' => <integer>,
        'Verify' => <integer>,
    ],
    'FilesListed' => [
        'AtDestinationForDelete' => <integer>,
        'AtSource' => <integer>,
    ],
    'FilesPrepared' => <integer>,
    'FilesSkipped' => <integer>,
    'FilesTransferred' => <integer>,
    'FilesVerified' => <integer>,
    'Includes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'LaunchTime' => <DateTime>,
    'ManifestConfig' => [
        'Action' => 'TRANSFER',
        'Format' => 'CSV',
        'Source' => [
            'S3' => [
                'BucketAccessRoleArn' => '<string>',
                'ManifestObjectPath' => '<string>',
                'ManifestObjectVersionId' => '<string>',
                'S3BucketArn' => '<string>',
            ],
        ],
    ],
    'Options' => [
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        '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',
    ],
    'ReportResult' => [
        'ErrorCode' => '<string>',
        'ErrorDetail' => '<string>',
        'Status' => 'PENDING|SUCCESS|ERROR',
    ],
    'Result' => [
        'ErrorCode' => '<string>',
        'ErrorDetail' => '<string>',
        'PrepareDuration' => <integer>,
        'PrepareStatus' => 'PENDING|SUCCESS|ERROR',
        'TotalDuration' => <integer>,
        'TransferDuration' => <integer>,
        'TransferStatus' => 'PENDING|SUCCESS|ERROR',
        'VerifyDuration' => <integer>,
        'VerifyStatus' => 'PENDING|SUCCESS|ERROR',
    ],
    'StartTime' => <DateTime>,
    'Status' => 'QUEUED|CANCELLING|LAUNCHING|PREPARING|TRANSFERRING|VERIFYING|SUCCESS|ERROR',
    'TaskExecutionArn' => '<string>',
    'TaskMode' => 'BASIC|ENHANCED',
    'TaskReportConfig' => [
        'Destination' => [
            'S3' => [
                'BucketAccessRoleArn' => '<string>',
                'S3BucketArn' => '<string>',
                'Subdirectory' => '<string>',
            ],
        ],
        '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',
    ],
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

ListAgents

$result = $client->listAgents([/* ... */]);
$promise = $client->listAgentsAsync([/* ... */]);

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

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

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

Parameter Syntax

$result = $client->listAgents([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Agents' => [
        [
            'AgentArn' => '<string>',
            'Name' => '<string>',
            'Platform' => [
                'Version' => '<string>',
            ],
            'Status' => 'ONLINE|OFFLINE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

ListLocations

$result = $client->listLocations([/* ... */]);
$promise = $client->listLocationsAsync([/* ... */]);

Returns a list of source and destination locations.

If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.

Parameter Syntax

$result = $client->listLocations([
    'Filters' => [
        [
            'Name' => 'LocationUri|LocationType|CreationTime', // REQUIRED
            'Operator' => 'Equals|NotEquals|In|LessThanOrEqual|LessThan|GreaterThanOrEqual|GreaterThan|Contains|NotContains|BeginsWith', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Locations' => [
        [
            'LocationArn' => '<string>',
            'LocationUri' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

ListTaskExecutions

$result = $client->listTaskExecutions([/* ... */]);
$promise = $client->listTaskExecutionsAsync([/* ... */]);

Returns a list of executions for an DataSync transfer task.

Parameter Syntax

$result = $client->listTaskExecutions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TaskArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TaskExecutions' => [
        [
            'Status' => 'QUEUED|CANCELLING|LAUNCHING|PREPARING|TRANSFERRING|VERIFYING|SUCCESS|ERROR',
            'TaskExecutionArn' => '<string>',
            'TaskMode' => 'BASIC|ENHANCED',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

ListTasks

$result = $client->listTasks([/* ... */]);
$promise = $client->listTasksAsync([/* ... */]);

Returns a list of the DataSync tasks you created.

Parameter Syntax

$result = $client->listTasks([
    'Filters' => [
        [
            'Name' => 'LocationId|CreationTime', // REQUIRED
            'Operator' => 'Equals|NotEquals|In|LessThanOrEqual|LessThan|GreaterThanOrEqual|GreaterThan|Contains|NotContains|BeginsWith', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tasks' => [
        [
            'Name' => '<string>',
            'Status' => 'AVAILABLE|CREATING|QUEUED|RUNNING|UNAVAILABLE',
            'TaskArn' => '<string>',
            'TaskMode' => 'BASIC|ENHANCED',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

StartTaskExecution

$result = $client->startTaskExecution([/* ... */]);
$promise = $client->startTaskExecutionAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->startTaskExecution([
    'Excludes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Includes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ManifestConfig' => [
        'Action' => 'TRANSFER',
        'Format' => 'CSV',
        'Source' => [
            'S3' => [ // REQUIRED
                'BucketAccessRoleArn' => '<string>', // REQUIRED
                'ManifestObjectPath' => '<string>', // REQUIRED
                'ManifestObjectVersionId' => '<string>',
                'S3BucketArn' => '<string>', // REQUIRED
            ],
        ],
    ],
    'OverrideOptions' => [
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        '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',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'TaskArn' => '<string>', // REQUIRED
    'TaskReportConfig' => [
        'Destination' => [
            'S3' => [
                'BucketAccessRoleArn' => '<string>', // REQUIRED
                'S3BucketArn' => '<string>', // REQUIRED
                'Subdirectory' => '<string>',
            ],
        ],
        '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',
    ],
]);

Parameter Details

Result Syntax

[
    'TaskExecutionArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from an Amazon Web Services resource.

Parameter Syntax

$result = $client->untagResource([
    'Keys' => ['<string>', ...], // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateAgent

$result = $client->updateAgent([/* ... */]);
$promise = $client->updateAgentAsync([/* ... */]);

Updates the name of an DataSync agent.

Parameter Syntax

$result = $client->updateAgent([
    'AgentArn' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationAzureBlob

$result = $client->updateLocationAzureBlob([/* ... */]);
$promise = $client->updateLocationAzureBlobAsync([/* ... */]);

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

For more information, see Configuring DataSync transfers with Azure Blob Storage.

Parameter Syntax

$result = $client->updateLocationAzureBlob([
    'AccessTier' => 'HOT|COOL|ARCHIVE',
    'AgentArns' => ['<string>', ...],
    'AuthenticationType' => 'SAS|NONE',
    'BlobType' => 'BLOCK',
    'CmkSecretConfig' => [
        'KmsKeyArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'CustomSecretConfig' => [
        'SecretAccessRoleArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'LocationArn' => '<string>', // REQUIRED
    'SasConfiguration' => [
        'Token' => '<string>', // REQUIRED
    ],
    'Subdirectory' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationEfs

$result = $client->updateLocationEfs([/* ... */]);
$promise = $client->updateLocationEfsAsync([/* ... */]);

Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with Amazon EFS.

Parameter Syntax

$result = $client->updateLocationEfs([
    'AccessPointArn' => '<string>',
    'FileSystemAccessRoleArn' => '<string>',
    'InTransitEncryption' => 'NONE|TLS1_2',
    'LocationArn' => '<string>', // REQUIRED
    'Subdirectory' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationFsxLustre

$result = $client->updateLocationFsxLustre([/* ... */]);
$promise = $client->updateLocationFsxLustreAsync([/* ... */]);

Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for Lustre.

Parameter Syntax

$result = $client->updateLocationFsxLustre([
    'LocationArn' => '<string>', // REQUIRED
    'Subdirectory' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationFsxOntap

$result = $client->updateLocationFsxOntap([/* ... */]);
$promise = $client->updateLocationFsxOntapAsync([/* ... */]);

Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for ONTAP.

Parameter Syntax

$result = $client->updateLocationFsxOntap([
    'LocationArn' => '<string>', // REQUIRED
    'Protocol' => [
        'NFS' => [
            'MountOptions' => [
                'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
            ],
        ],
        'SMB' => [
            'Domain' => '<string>',
            'MountOptions' => [
                'Version' => 'AUTOMATIC|SMB2|SMB3|SMB1|SMB2_0',
            ],
            'Password' => '<string>',
            'User' => '<string>',
        ],
    ],
    'Subdirectory' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationFsxOpenZfs

$result = $client->updateLocationFsxOpenZfs([/* ... */]);
$promise = $client->updateLocationFsxOpenZfsAsync([/* ... */]);

Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for OpenZFS.

Parameter Syntax

$result = $client->updateLocationFsxOpenZfs([
    'LocationArn' => '<string>', // REQUIRED
    'Protocol' => [
        'NFS' => [
            'MountOptions' => [
                'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
            ],
        ],
        'SMB' => [
            'Domain' => '<string>',
            'MountOptions' => [
                'Version' => 'AUTOMATIC|SMB2|SMB3|SMB1|SMB2_0',
            ],
            'Password' => '<string>', // REQUIRED
            'User' => '<string>', // REQUIRED
        ],
    ],
    'Subdirectory' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationFsxWindows

$result = $client->updateLocationFsxWindows([/* ... */]);
$promise = $client->updateLocationFsxWindowsAsync([/* ... */]);

Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for Windows File Server.

Parameter Syntax

$result = $client->updateLocationFsxWindows([
    'Domain' => '<string>',
    'LocationArn' => '<string>', // REQUIRED
    'Password' => '<string>',
    'Subdirectory' => '<string>',
    'User' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationHdfs

$result = $client->updateLocationHdfs([/* ... */]);
$promise = $client->updateLocationHdfsAsync([/* ... */]);

Modifies the following configuration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with an HDFS cluster.

Parameter Syntax

$result = $client->updateLocationHdfs([
    'AgentArns' => ['<string>', ...],
    'AuthenticationType' => 'SIMPLE|KERBEROS',
    'BlockSize' => <integer>,
    'KerberosKeytab' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KerberosKrb5Conf' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KerberosPrincipal' => '<string>',
    'KmsKeyProviderUri' => '<string>',
    'LocationArn' => '<string>', // REQUIRED
    'NameNodes' => [
        [
            'Hostname' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'QopConfiguration' => [
        'DataTransferProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY',
        'RpcProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY',
    ],
    'ReplicationFactor' => <integer>,
    'SimpleUser' => '<string>',
    'Subdirectory' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationNfs

$result = $client->updateLocationNfs([/* ... */]);
$promise = $client->updateLocationNfsAsync([/* ... */]);

Modifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync.

For more information, see Configuring transfers with an NFS file server.

Parameter Syntax

$result = $client->updateLocationNfs([
    'LocationArn' => '<string>', // REQUIRED
    'MountOptions' => [
        'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
    ],
    'OnPremConfig' => [
        'AgentArns' => ['<string>', ...], // REQUIRED
    ],
    'ServerHostname' => '<string>',
    'Subdirectory' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationObjectStorage

$result = $client->updateLocationObjectStorage([/* ... */]);
$promise = $client->updateLocationObjectStorageAsync([/* ... */]);

Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with an object storage system.

Parameter Syntax

$result = $client->updateLocationObjectStorage([
    'AccessKey' => '<string>',
    'AgentArns' => ['<string>', ...],
    'CmkSecretConfig' => [
        'KmsKeyArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'CustomSecretConfig' => [
        'SecretAccessRoleArn' => '<string>',
        'SecretArn' => '<string>',
    ],
    'LocationArn' => '<string>', // REQUIRED
    'SecretKey' => '<string>',
    'ServerCertificate' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ServerHostname' => '<string>',
    'ServerPort' => <integer>,
    'ServerProtocol' => 'HTTPS|HTTP',
    'Subdirectory' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationS3

$result = $client->updateLocationS3([/* ... */]);
$promise = $client->updateLocationS3Async([/* ... */]);

Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync.

Parameter Syntax

$result = $client->updateLocationS3([
    'LocationArn' => '<string>', // REQUIRED
    'S3Config' => [
        'BucketAccessRoleArn' => '<string>', // REQUIRED
    ],
    'S3StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_INSTANT_RETRIEVAL',
    'Subdirectory' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateLocationSmb

$result = $client->updateLocationSmb([/* ... */]);
$promise = $client->updateLocationSmbAsync([/* ... */]);

Modifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with an SMB file server.

Parameter Syntax

$result = $client->updateLocationSmb([
    'AgentArns' => ['<string>', ...],
    'AuthenticationType' => 'NTLM|KERBEROS',
    'DnsIpAddresses' => ['<string>', ...],
    'Domain' => '<string>',
    'KerberosKeytab' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KerberosKrb5Conf' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KerberosPrincipal' => '<string>',
    'LocationArn' => '<string>', // REQUIRED
    'MountOptions' => [
        'Version' => 'AUTOMATIC|SMB2|SMB3|SMB1|SMB2_0',
    ],
    'Password' => '<string>',
    'ServerHostname' => '<string>',
    'Subdirectory' => '<string>',
    'User' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateTask

$result = $client->updateTask([/* ... */]);
$promise = $client->updateTaskAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateTask([
    'CloudWatchLogGroupArn' => '<string>',
    'Excludes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Includes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ManifestConfig' => [
        'Action' => 'TRANSFER',
        'Format' => 'CSV',
        'Source' => [
            'S3' => [ // REQUIRED
                'BucketAccessRoleArn' => '<string>', // REQUIRED
                'ManifestObjectPath' => '<string>', // REQUIRED
                'ManifestObjectVersionId' => '<string>',
                'S3BucketArn' => '<string>', // REQUIRED
            ],
        ],
    ],
    'Name' => '<string>',
    'Options' => [
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        '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>', // REQUIRED
        'Status' => 'ENABLED|DISABLED',
    ],
    'TaskArn' => '<string>', // REQUIRED
    'TaskReportConfig' => [
        'Destination' => [
            'S3' => [
                'BucketAccessRoleArn' => '<string>', // REQUIRED
                'S3BucketArn' => '<string>', // REQUIRED
                'Subdirectory' => '<string>',
            ],
        ],
        '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',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.

UpdateTaskExecution

$result = $client->updateTaskExecution([/* ... */]);
$promise = $client->updateTaskExecutionAsync([/* ... */]);

Updates the configuration of a running DataSync task execution.

Parameter Syntax

$result = $client->updateTaskExecution([
    'Options' => [ // REQUIRED
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        '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',
    ],
    'TaskExecutionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

This exception is thrown when the client submits a malformed request.

InternalException:

This exception is thrown when an error occurs in the DataSync service.