DataSync

Table of Contents

Client

class DataSync.Client

A low-level client representing AWS DataSync:

client = session.create_client('datasync')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_task_execution(**kwargs)

Cancels execution of a task.

When you cancel a task execution, the transfer of some files are abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution.

See also: AWS API Documentation

Request Syntax

response = client.cancel_task_execution(
    TaskExecutionArn='string'
)
Parameters
TaskExecutionArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
create_agent(**kwargs)

Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region.

You can activate the agent in a VPC (Virtual private Cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public Internet.

You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.

Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.

See also: AWS API Documentation

Request Syntax

response = client.create_agent(
    ActivationKey='string',
    AgentName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    VpcEndpointId='string',
    SubnetArns=[
        'string',
    ],
    SecurityGroupArns=[
        'string',
    ]
)
Parameters
  • ActivationKey (string) --

    [REQUIRED]

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

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

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

  • AgentName (string) -- The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.
  • Tags (list) --

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

    Note

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

    • (dict) --

      Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

      • Key (string) -- [REQUIRED]

        The key for an AWS resource tag.

      • Value (string) --

        The value for an AWS resource tag.

  • VpcEndpointId (string) --

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

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

  • SubnetArns (list) --

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

    • (string) --
  • SecurityGroupArns (list) --

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

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'AgentArn': 'string'
}

Response Structure

  • (dict) --

    CreateAgentResponse

    • AgentArn (string) --

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

create_location_efs(**kwargs)

Creates an endpoint for an Amazon EFS file system.

See also: AWS API Documentation

Request Syntax

response = client.create_location_efs(
    Subdirectory='string',
    EfsFilesystemArn='string',
    Ec2Config={
        'SubnetArn': 'string',
        'SecurityGroupArns': [
            'string',
        ]
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Subdirectory (string) -- A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, AWS DataSync uses the root directory.
  • EfsFilesystemArn (string) --

    [REQUIRED]

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

  • Ec2Config (dict) --

    [REQUIRED]

    The subnet and security group that the Amazon EFS file system uses. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

    The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows:

    • Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group.
    • Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group. For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User Guide.
    • SubnetArn (string) -- [REQUIRED]

      The ARN of the subnet and the security group that DataSync uses to access the target EFS file system.

    • SecurityGroupArns (list) -- [REQUIRED]

      The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.

      • (string) --
  • Tags (list) --

    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.

    • (dict) --

      Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

      • Key (string) -- [REQUIRED]

        The key for an AWS resource tag.

      • Value (string) --

        The value for an AWS resource tag.

Return type

dict

Returns

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

  • (dict) --

    CreateLocationEfs

    • LocationArn (string) --

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

create_location_nfs(**kwargs)

Creates an endpoint for a Network File System (NFS) file system.

See also: AWS API Documentation

Request Syntax

response = client.create_location_nfs(
    Subdirectory='string',
    ServerHostname='string',
    OnPremConfig={
        'AgentArns': [
            'string',
        ]
    },
    MountOptions={
        'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Subdirectory (string) --

    [REQUIRED]

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

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

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

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

  • ServerHostname (string) --

    [REQUIRED]

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

    Note

    This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

  • OnPremConfig (dict) --

    [REQUIRED]

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

    • AgentArns (list) -- [REQUIRED]

      ARNs)of the agents to use for an NFS location.

      • (string) --
  • MountOptions (dict) --

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

    • Version (string) --

      The specific NFS version that you want DataSync to use to mount your NFS share. If you don't specify a version, DataSync defaults to AUTOMATIC . That is, DataSync automatically selects a version based on negotiation with the NFS server.

  • Tags (list) --

    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.

    • (dict) --

      Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

      • Key (string) -- [REQUIRED]

        The key for an AWS resource tag.

      • Value (string) --

        The value for an AWS resource tag.

Return type

dict

Returns

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

  • (dict) --

    CreateLocationNfsResponse

    • LocationArn (string) --

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

create_location_s3(**kwargs)

Creates an endpoint for an Amazon S3 bucket.

For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.

For more information, see Configuring Amazon S3 Location Settings in the AWS DataSync User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_location_s3(
    Subdirectory='string',
    S3BucketArn='string',
    S3Config={
        'BucketAccessRoleArn': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Subdirectory (string) -- A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
  • S3BucketArn (string) --

    [REQUIRED]

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

  • S3Config (dict) --

    [REQUIRED]

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

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

    • BucketAccessRoleArn (string) -- [REQUIRED]

      The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.

  • Tags (list) --

    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.

    • (dict) --

      Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

      • Key (string) -- [REQUIRED]

        The key for an AWS resource tag.

      • Value (string) --

        The value for an AWS resource tag.

Return type

dict

Returns

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

  • (dict) --

    CreateLocationS3Response

    • LocationArn (string) --

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

create_location_smb(**kwargs)

Creates an endpoint for a Server Message Block (SMB) file system.

See also: AWS API Documentation

Request Syntax

response = client.create_location_smb(
    Subdirectory='string',
    ServerHostname='string',
    User='string',
    Domain='string',
    Password='string',
    AgentArns=[
        'string',
    ],
    MountOptions={
        'Version': 'AUTOMATIC'|'SMB2'|'SMB3'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Subdirectory (string) --

    [REQUIRED]

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

    To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

  • ServerHostname (string) --

    [REQUIRED]

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

    Note

    This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

  • User (string) --

    [REQUIRED]

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

  • Domain (string) -- The name of the domain that the SMB server belongs to.
  • Password (string) --

    [REQUIRED]

    The password of the user who has permission to access the SMB server.

  • AgentArns (list) --

    [REQUIRED]

    The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

    • (string) --
  • MountOptions (dict) --

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

    • Version (string) --

      The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC . That is, DataSync automatically selects a version based on negotiation with the SMB Server server.

  • Tags (list) --

    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.

    • (dict) --

      Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

      • Key (string) -- [REQUIRED]

        The key for an AWS resource tag.

      • Value (string) --

        The value for an AWS resource tag.

Return type

dict

Returns

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

  • (dict) --

    CreateLocationSmbResponse

    • LocationArn (string) --

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

create_task(**kwargs)

Creates a task. A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.

When you create a task, it first enters the CREATING state. During CREATING AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If required, AWS DataSync mounts the AWS location before each task execution.

If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name.

See also: AWS API Documentation

Request Syntax

response = client.create_task(
    SourceLocationArn='string',
    DestinationLocationArn='string',
    CloudWatchLogGroupArn='string',
    Name='string',
    Options={
        'VerifyMode': 'POINT_IN_TIME_CONSISTENT'|'NONE',
        'Atime': 'NONE'|'BEST_EFFORT',
        'Mtime': 'NONE'|'PRESERVE',
        'Uid': 'NONE'|'INT_VALUE'|'NAME'|'BOTH',
        'Gid': 'NONE'|'INT_VALUE'|'NAME'|'BOTH',
        'PreserveDeletedFiles': 'PRESERVE'|'REMOVE',
        'PreserveDevices': 'NONE'|'PRESERVE',
        'PosixPermissions': 'NONE'|'BEST_EFFORT'|'PRESERVE',
        'BytesPerSecond': 123
    },
    Excludes=[
        {
            'FilterType': 'SIMPLE_PATTERN',
            'Value': 'string'
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • SourceLocationArn (string) --

    [REQUIRED]

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

  • DestinationLocationArn (string) --

    [REQUIRED]

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

  • CloudWatchLogGroupArn (string) --

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

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

    For more information about how to use CloudWatch Logs with DataSync, see Monitoring Your Task in the AWS DataSync User Guide.

  • Name (string) -- The name of a task. This value is a text reference that is used to identify the task in the console.
  • Options (dict) --

    The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution . You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

    For each individual task execution, you can override these options by specifying the OverrideOptions before starting a the task execution. For more information, see the operation.

    • VerifyMode (string) --

      A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

      Default value: POINT_IN_TIME_CONSISTENT.

      POINT_IN_TIME_CONSISTENT: Perform verification (recommended).

      NONE: Skip verification.

    • Atime (string) --

      A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime 's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

      Default value: BEST_EFFORT.

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

      NONE: Ignore Atime .

      Note

      If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

      If Atime is set to NONE, Mtime must also be NONE.

    • Mtime (string) --

      A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

      Default value: PRESERVE.

      PRESERVE: Preserve original Mtime (recommended)

      NONE: Ignore Mtime .

      Note

      If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

      If Mtime is set to NONE, Atime must also be set to NONE.

    • Uid (string) --

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

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

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

      NONE: Ignore UID and GID.

    • Gid (string) --

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

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

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

      NONE: Ignore UID and GID.

    • PreserveDeletedFiles (string) --

      A value that specifies whether files in the destination that don't exist in the source file system should be preserved.

      Default value: PRESERVE.

      PRESERVE: Ignore such destination files (recommended).

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

    • PreserveDevices (string) --

      A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

      Note

      AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

      Default value: NONE.

      NONE: Ignore special devices (recommended).

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

    • PosixPermissions (string) --

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

      Default value: PRESERVE.

      PRESERVE: Preserve POSIX-style permissions (recommended).

      NONE: Ignore permissions.

      Note

      AWS DataSync can preserve extant permissions of a source location.

    • BytesPerSecond (integer) --

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

  • Excludes (list) --

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

    • (dict) --

      Specifies which files, folders and objects to include or exclude when transferring files from source to destination.

      • FilterType (string) --

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

      • 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

  • Tags (list) --

    The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

    • (dict) --

      Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

      • Key (string) -- [REQUIRED]

        The key for an AWS resource tag.

      • Value (string) --

        The value for an AWS resource tag.

Return type

dict

Returns

Response Syntax

{
    'TaskArn': 'string'
}

Response Structure

  • (dict) --

    CreateTaskResponse

    • TaskArn (string) --

      The Amazon Resource Name (ARN) of the task.

delete_agent(**kwargs)

Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.

See also: AWS API Documentation

Request Syntax

response = client.delete_agent(
    AgentArn='string'
)
Parameters
AgentArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_location(**kwargs)

Deletes the configuration of a location used by AWS DataSync.

See also: AWS API Documentation

Request Syntax

response = client.delete_location(
    LocationArn='string'
)
Parameters
LocationArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_task(**kwargs)

Deletes a task.

See also: AWS API Documentation

Request Syntax

response = client.delete_task(
    TaskArn='string'
)
Parameters
TaskArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
describe_agent(**kwargs)

Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.

See also: AWS API Documentation

Request Syntax

response = client.describe_agent(
    AgentArn='string'
)
Parameters
AgentArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'AgentArn': 'string',
    'Name': 'string',
    'Status': 'ONLINE'|'OFFLINE',
    'LastConnectionTime': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'EndpointType': 'PUBLIC'|'PRIVATE_LINK',
    'PrivateLinkConfig': {
        'VpcEndpointId': 'string',
        'PrivateLinkEndpoint': 'string',
        'SubnetArns': [
            'string',
        ],
        'SecurityGroupArns': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    DescribeAgentResponse

    • AgentArn (string) --

      The Amazon Resource Name (ARN) of the agent.

    • Name (string) --

      The name of the agent.

    • Status (string) --

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

    • LastConnectionTime (datetime) --

      The time that the agent last connected to DataSyc.

    • CreationTime (datetime) --

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

    • EndpointType (string) --

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

    • PrivateLinkConfig (dict) --

      The VPC endpoint, subnet and security group that an agent uses to access IP addresses in a VPC (Virtual Private Cloud).

      • VpcEndpointId (string) --

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

      • PrivateLinkEndpoint (string) --

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

      • SubnetArns (list) --

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

        • (string) --
      • SecurityGroupArns (list) --

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

        • (string) --
describe_location_efs(**kwargs)

Returns metadata, such as the path information about an Amazon EFS location.

See also: AWS API Documentation

Request Syntax

response = client.describe_location_efs(
    LocationArn='string'
)
Parameters
LocationArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'Ec2Config': {
        'SubnetArn': 'string',
        'SecurityGroupArns': [
            'string',
        ]
    },
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    DescribeLocationEfsResponse

    • LocationArn (string) --

      The Amazon resource Name (ARN) of the EFS location that was described.

    • LocationUri (string) --

      The URL of the EFS location that was described.

    • Ec2Config (dict) --

      The subnet and the security group that DataSync uses to access target EFS file system. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

      • SubnetArn (string) --

        The ARN of the subnet and the security group that DataSync uses to access the target EFS file system.

      • SecurityGroupArns (list) --

        The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.

        • (string) --
    • CreationTime (datetime) --

      The time that the EFS location was created.

describe_location_nfs(**kwargs)

Returns metadata, such as the path information, about a NFS location.

See also: AWS API Documentation

Request Syntax

response = client.describe_location_nfs(
    LocationArn='string'
)
Parameters
LocationArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'OnPremConfig': {
        'AgentArns': [
            'string',
        ]
    },
    'MountOptions': {
        'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
    },
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    DescribeLocationNfsResponse

    • LocationArn (string) --

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

    • LocationUri (string) --

      The URL of the source NFS location that was described.

    • OnPremConfig (dict) --

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

      • AgentArns (list) --

        ARNs)of the agents to use for an NFS location.

        • (string) --
    • MountOptions (dict) --

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

      • Version (string) --

        The specific NFS version that you want DataSync to use to mount your NFS share. If you don't specify a version, DataSync defaults to AUTOMATIC . That is, DataSync automatically selects a version based on negotiation with the NFS server.

    • CreationTime (datetime) --

      The time that the NFS location was created.

describe_location_s3(**kwargs)

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

See also: AWS API Documentation

Request Syntax

response = client.describe_location_s3(
    LocationArn='string'
)
Parameters
LocationArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'S3Config': {
        'BucketAccessRoleArn': 'string'
    },
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    DescribeLocationS3Response

    • LocationArn (string) --

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

    • LocationUri (string) --

      The URL of the Amazon S3 location that was described.

    • S3Config (dict) --

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

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

      • BucketAccessRoleArn (string) --

        The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.

    • CreationTime (datetime) --

      The time that the Amazon S3 bucket location was created.

describe_location_smb(**kwargs)

Returns metadata, such as the path and user information about a SMB location.

See also: AWS API Documentation

Request Syntax

response = client.describe_location_smb(
    LocationArn='string'
)
Parameters
LocationArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'AgentArns': [
        'string',
    ],
    'User': 'string',
    'Domain': 'string',
    'MountOptions': {
        'Version': 'AUTOMATIC'|'SMB2'|'SMB3'
    },
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    DescribeLocationSmbResponse

    • LocationArn (string) --

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

    • LocationUri (string) --

      The URL of the source SBM location that was described.

    • AgentArns (list) --

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

      • (string) --
    • User (string) --

      The user who is logged on the SMB server.

    • Domain (string) --

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

    • MountOptions (dict) --

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

      • Version (string) --

        The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC . That is, DataSync automatically selects a version based on negotiation with the SMB Server server.

    • CreationTime (datetime) --

      The time that the SMB location was created.

describe_task(**kwargs)

Returns metadata about a task.

See also: AWS API Documentation

Request Syntax

response = client.describe_task(
    TaskArn='string'
)
Parameters
TaskArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'TaskArn': 'string',
    'Status': 'AVAILABLE'|'CREATING'|'RUNNING'|'UNAVAILABLE',
    'Name': 'string',
    'CurrentTaskExecutionArn': 'string',
    'SourceLocationArn': 'string',
    'DestinationLocationArn': 'string',
    'CloudWatchLogGroupArn': 'string',
    'SourceNetworkInterfaceArns': [
        'string',
    ],
    'DestinationNetworkInterfaceArns': [
        'string',
    ],
    'Options': {
        'VerifyMode': 'POINT_IN_TIME_CONSISTENT'|'NONE',
        'Atime': 'NONE'|'BEST_EFFORT',
        'Mtime': 'NONE'|'PRESERVE',
        'Uid': 'NONE'|'INT_VALUE'|'NAME'|'BOTH',
        'Gid': 'NONE'|'INT_VALUE'|'NAME'|'BOTH',
        'PreserveDeletedFiles': 'PRESERVE'|'REMOVE',
        'PreserveDevices': 'NONE'|'PRESERVE',
        'PosixPermissions': 'NONE'|'BEST_EFFORT'|'PRESERVE',
        'BytesPerSecond': 123
    },
    'Excludes': [
        {
            'FilterType': 'SIMPLE_PATTERN',
            'Value': 'string'
        },
    ],
    'ErrorCode': 'string',
    'ErrorDetail': 'string',
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    DescribeTaskResponse

    • TaskArn (string) --

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

    • Status (string) --

      The status of the task that was described.

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

    • Name (string) --

      The name of the task that was described.

    • CurrentTaskExecutionArn (string) --

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

    • SourceLocationArn (string) --

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

    • DestinationLocationArn (string) --

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

    • CloudWatchLogGroupArn (string) --

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

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

    • SourceNetworkInterfaceArns (list) --

      The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.

      • (string) --
    • DestinationNetworkInterfaceArns (list) --

      The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your subnet.

      • (string) --
    • Options (dict) --

      The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution . You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.

      For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to operation.

      • VerifyMode (string) --

        A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

        Default value: POINT_IN_TIME_CONSISTENT.

        POINT_IN_TIME_CONSISTENT: Perform verification (recommended).

        NONE: Skip verification.

      • Atime (string) --

        A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime 's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

        Default value: BEST_EFFORT.

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

        NONE: Ignore Atime .

        Note

        If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

        If Atime is set to NONE, Mtime must also be NONE.

      • Mtime (string) --

        A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

        Default value: PRESERVE.

        PRESERVE: Preserve original Mtime (recommended)

        NONE: Ignore Mtime .

        Note

        If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

        If Mtime is set to NONE, Atime must also be set to NONE.

      • Uid (string) --

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

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

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

        NONE: Ignore UID and GID.

      • Gid (string) --

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

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

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

        NONE: Ignore UID and GID.

      • PreserveDeletedFiles (string) --

        A value that specifies whether files in the destination that don't exist in the source file system should be preserved.

        Default value: PRESERVE.

        PRESERVE: Ignore such destination files (recommended).

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

      • PreserveDevices (string) --

        A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

        Note

        AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

        Default value: NONE.

        NONE: Ignore special devices (recommended).

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

      • PosixPermissions (string) --

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

        Default value: PRESERVE.

        PRESERVE: Preserve POSIX-style permissions (recommended).

        NONE: Ignore permissions.

        Note

        AWS DataSync can preserve extant permissions of a source location.

      • BytesPerSecond (integer) --

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

    • Excludes (list) --

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

      • (dict) --

        Specifies which files, folders and objects to include or exclude when transferring files from source to destination.

        • FilterType (string) --

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

        • 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

    • ErrorCode (string) --

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

    • ErrorDetail (string) --

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

    • CreationTime (datetime) --

      The time that the task was created.

describe_task_execution(**kwargs)

Returns detailed metadata about a task that is being executed.

See also: AWS API Documentation

Request Syntax

response = client.describe_task_execution(
    TaskExecutionArn='string'
)
Parameters
TaskExecutionArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the task that is being executed.

Return type
dict
Returns
Response Syntax
{
    'TaskExecutionArn': 'string',
    'Status': 'LAUNCHING'|'PREPARING'|'TRANSFERRING'|'VERIFYING'|'SUCCESS'|'ERROR',
    'Options': {
        'VerifyMode': 'POINT_IN_TIME_CONSISTENT'|'NONE',
        'Atime': 'NONE'|'BEST_EFFORT',
        'Mtime': 'NONE'|'PRESERVE',
        'Uid': 'NONE'|'INT_VALUE'|'NAME'|'BOTH',
        'Gid': 'NONE'|'INT_VALUE'|'NAME'|'BOTH',
        'PreserveDeletedFiles': 'PRESERVE'|'REMOVE',
        'PreserveDevices': 'NONE'|'PRESERVE',
        'PosixPermissions': 'NONE'|'BEST_EFFORT'|'PRESERVE',
        'BytesPerSecond': 123
    },
    'Excludes': [
        {
            'FilterType': 'SIMPLE_PATTERN',
            'Value': 'string'
        },
    ],
    'Includes': [
        {
            'FilterType': 'SIMPLE_PATTERN',
            'Value': 'string'
        },
    ],
    'StartTime': datetime(2015, 1, 1),
    'EstimatedFilesToTransfer': 123,
    'EstimatedBytesToTransfer': 123,
    'FilesTransferred': 123,
    'BytesWritten': 123,
    'BytesTransferred': 123,
    'Result': {
        'PrepareDuration': 123,
        'PrepareStatus': 'PENDING'|'SUCCESS'|'ERROR',
        'TransferDuration': 123,
        'TransferStatus': 'PENDING'|'SUCCESS'|'ERROR',
        'VerifyDuration': 123,
        'VerifyStatus': 'PENDING'|'SUCCESS'|'ERROR',
        'ErrorCode': 'string',
        'ErrorDetail': 'string'
    }
}

Response Structure

  • (dict) --

    DescribeTaskExecutionResponse

    • TaskExecutionArn (string) --

      The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

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

    • Status (string) --

      The status of the task execution.

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

    • Options (dict) --

      Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

      A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution , the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution .

      • VerifyMode (string) --

        A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

        Default value: POINT_IN_TIME_CONSISTENT.

        POINT_IN_TIME_CONSISTENT: Perform verification (recommended).

        NONE: Skip verification.

      • Atime (string) --

        A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime 's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

        Default value: BEST_EFFORT.

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

        NONE: Ignore Atime .

        Note

        If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

        If Atime is set to NONE, Mtime must also be NONE.

      • Mtime (string) --

        A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

        Default value: PRESERVE.

        PRESERVE: Preserve original Mtime (recommended)

        NONE: Ignore Mtime .

        Note

        If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

        If Mtime is set to NONE, Atime must also be set to NONE.

      • Uid (string) --

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

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

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

        NONE: Ignore UID and GID.

      • Gid (string) --

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

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

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

        NONE: Ignore UID and GID.

      • PreserveDeletedFiles (string) --

        A value that specifies whether files in the destination that don't exist in the source file system should be preserved.

        Default value: PRESERVE.

        PRESERVE: Ignore such destination files (recommended).

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

      • PreserveDevices (string) --

        A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

        Note

        AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

        Default value: NONE.

        NONE: Ignore special devices (recommended).

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

      • PosixPermissions (string) --

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

        Default value: PRESERVE.

        PRESERVE: Preserve POSIX-style permissions (recommended).

        NONE: Ignore permissions.

        Note

        AWS DataSync can preserve extant permissions of a source location.

      • BytesPerSecond (integer) --

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

    • Excludes (list) --

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

      • (dict) --

        Specifies which files, folders and objects to include or exclude when transferring files from source to destination.

        • FilterType (string) --

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

        • Value (string) --

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

    • Includes (list) --

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

      • (dict) --

        Specifies which files, folders and objects to include or exclude when transferring files from source to destination.

        • FilterType (string) --

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

        • Value (string) --

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

    • StartTime (datetime) --

      The time that the task execution was started.

    • EstimatedFilesToTransfer (integer) --

      The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.

    • EstimatedBytesToTransfer (integer) --

      The estimated physical number of bytes that is to be transferred over the network.

    • FilesTransferred (integer) --

      The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network.

      If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer . This value can also be greater than EstimatedFilesTransferred in some cases. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.

    • BytesWritten (integer) --

      The number of logical bytes written to the destination AWS storage resource.

    • BytesTransferred (integer) --

      The physical number of bytes transferred over the network.

    • Result (dict) --

      The result of the task execution.

      • PrepareDuration (integer) --

        The total time in milliseconds that AWS DataSync spent in the PREPARING phase.

      • PrepareStatus (string) --

        The status of the PREPARING phase.

      • TransferDuration (integer) --

        The total time in milliseconds that AWS DataSync spent in the TRANSFERRING phase.

      • TransferStatus (string) --

        The status of the TRANSFERRING Phase.

      • VerifyDuration (integer) --

        The total time in milliseconds that AWS DataSync spent in the VERIFYING phase.

      • VerifyStatus (string) --

        The status of the VERIFYING Phase.

      • ErrorCode (string) --

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

      • ErrorDetail (string) --

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

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_agents(**kwargs)

Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).

By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.

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

See also: AWS API Documentation

Request Syntax

response = client.list_agents(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of agents to list.
  • NextToken (string) -- An opaque string that indicates the position at which to begin the next list of agents.
Return type

dict

Returns

Response Syntax

{
    'Agents': [
        {
            'AgentArn': 'string',
            'Name': 'string',
            'Status': 'ONLINE'|'OFFLINE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    ListAgentsResponse

    • Agents (list) --

      A list of agents in your account.

      • (dict) --

        Represents a single entry in a list of agents. AgentListEntry returns an array that contains a list of agents when the ListAgents operation is called.

        • AgentArn (string) --

          The Amazon Resource Name (ARN) of the agent.

        • Name (string) --

          The name of the agent.

        • Status (string) --

          The status of the agent.

    • NextToken (string) --

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

list_locations(**kwargs)

Returns a lists 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.

See also: AWS API Documentation

Request Syntax

response = client.list_locations(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of locations to return.
  • NextToken (string) -- An opaque string that indicates the position at which to begin the next list of locations.
Return type

dict

Returns

Response Syntax

{
    'Locations': [
        {
            'LocationArn': 'string',
            'LocationUri': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    ListLocationsResponse

    • Locations (list) --

      An array that contains a list of locations.

      • (dict) --

        Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called.

        • LocationArn (string) --

          The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location.

        • LocationUri (string) --

          Represents a list of URLs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called.

          Format: TYPE://GLOBAL_ID/SUBDIR .

          TYPE designates the type of location. Valid values: NFS | EFS | S3.

          GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234 . An example for Amazon S3 is the bucket name, such as myBucket . An example for NFS is a valid IPv4 address or a host name compliant with Domain Name Service (DNS).

          SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.

    • NextToken (string) --

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

list_tags_for_resource(**kwargs)

Returns all the tags associated with a specified resources.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource whose tags to list.

  • MaxResults (integer) -- The maximum number of locations to return.
  • NextToken (string) -- An opaque string that indicates the position at which to begin the next list of locations.
Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    ListTagsForResourceResponse

    • Tags (list) --

      Array of resource tags.

      • (dict) --

        Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

        • Key (string) --

          The key for an AWS resource tag.

        • Value (string) --

          The value for an AWS resource tag.

    • NextToken (string) --

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

list_task_executions(**kwargs)

Returns a list of executed tasks.

See also: AWS API Documentation

Request Syntax

response = client.list_task_executions(
    TaskArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • TaskArn (string) -- The Amazon Resource Name (ARN) of the task whose tasks you want to list.
  • MaxResults (integer) -- The maximum number of executed tasks to list.
  • NextToken (string) -- An opaque string that indicates the position at which to begin the next list of the executed tasks.
Return type

dict

Returns

Response Syntax

{
    'TaskExecutions': [
        {
            'TaskExecutionArn': 'string',
            'Status': 'LAUNCHING'|'PREPARING'|'TRANSFERRING'|'VERIFYING'|'SUCCESS'|'ERROR'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    ListTaskExecutionsResponse

    • TaskExecutions (list) --

      A list of executed tasks.

      • (dict) --

        Represents a single entry in a list of task executions. TaskExecutionListEntry returns an array that contains a list of specific invocations of a task when ListTaskExecutions operation is called.

        • TaskExecutionArn (string) --

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

        • Status (string) --

          The status of a task execution.

    • NextToken (string) --

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

list_tasks(**kwargs)

Returns a list of all the tasks.

See also: AWS API Documentation

Request Syntax

response = client.list_tasks(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of tasks to return.
  • NextToken (string) -- An opaque string that indicates the position at which to begin the next list of tasks.
Return type

dict

Returns

Response Syntax

{
    'Tasks': [
        {
            'TaskArn': 'string',
            'Status': 'AVAILABLE'|'CREATING'|'RUNNING'|'UNAVAILABLE',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    ListTasksResponse

    • Tasks (list) --

      A list of all the tasks that are returned.

      • (dict) --

        Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.

        • TaskArn (string) --

          The Amazon Resource Name (ARN) of the task.

        • Status (string) --

          The status of the task.

        • Name (string) --

          The name of the task.

    • NextToken (string) --

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

start_task_execution(**kwargs)

Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time.

TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.

For detailed information, see the Task Execution section in the Components and Terminology topic in the AWS DataSync User Guide .

See also: AWS API Documentation

Request Syntax

response = client.start_task_execution(
    TaskArn='string',
    OverrideOptions={
        'VerifyMode': 'POINT_IN_TIME_CONSISTENT'|'NONE',
        'Atime': 'NONE'|'BEST_EFFORT',
        'Mtime': 'NONE'|'PRESERVE',
        'Uid': 'NONE'|'INT_VALUE'|'NAME'|'BOTH',
        'Gid': 'NONE'|'INT_VALUE'|'NAME'|'BOTH',
        'PreserveDeletedFiles': 'PRESERVE'|'REMOVE',
        'PreserveDevices': 'NONE'|'PRESERVE',
        'PosixPermissions': 'NONE'|'BEST_EFFORT'|'PRESERVE',
        'BytesPerSecond': 123
    },
    Includes=[
        {
            'FilterType': 'SIMPLE_PATTERN',
            'Value': 'string'
        },
    ]
)
Parameters
  • TaskArn (string) --

    [REQUIRED]

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

  • OverrideOptions (dict) --

    Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

    A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution , the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution .

    • VerifyMode (string) --

      A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

      Default value: POINT_IN_TIME_CONSISTENT.

      POINT_IN_TIME_CONSISTENT: Perform verification (recommended).

      NONE: Skip verification.

    • Atime (string) --

      A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime 's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

      Default value: BEST_EFFORT.

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

      NONE: Ignore Atime .

      Note

      If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

      If Atime is set to NONE, Mtime must also be NONE.

    • Mtime (string) --

      A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

      Default value: PRESERVE.

      PRESERVE: Preserve original Mtime (recommended)

      NONE: Ignore Mtime .

      Note

      If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

      If Mtime is set to NONE, Atime must also be set to NONE.

    • Uid (string) --

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

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

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

      NONE: Ignore UID and GID.

    • Gid (string) --

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

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

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

      NONE: Ignore UID and GID.

    • PreserveDeletedFiles (string) --

      A value that specifies whether files in the destination that don't exist in the source file system should be preserved.

      Default value: PRESERVE.

      PRESERVE: Ignore such destination files (recommended).

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

    • PreserveDevices (string) --

      A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

      Note

      AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

      Default value: NONE.

      NONE: Ignore special devices (recommended).

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

    • PosixPermissions (string) --

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

      Default value: PRESERVE.

      PRESERVE: Preserve POSIX-style permissions (recommended).

      NONE: Ignore permissions.

      Note

      AWS DataSync can preserve extant permissions of a source location.

    • BytesPerSecond (integer) --

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

  • Includes (list) --

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

    • (dict) --

      Specifies which files, folders and objects to include or exclude when transferring files from source to destination.

      • FilterType (string) --

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

      • 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

Return type

dict

Returns

Response Syntax

{
    'TaskExecutionArn': 'string'
}

Response Structure

  • (dict) --

    StartTaskExecutionResponse

    • TaskExecutionArn (string) --

      The Amazon Resource Name (ARN) of the specific task execution that was started.

tag_resource(**kwargs)

Applies a key-value pair to an AWS resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

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

  • Tags (list) --

    [REQUIRED]

    The tags to apply.

    • (dict) --

      Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

      • Key (string) -- [REQUIRED]

        The key for an AWS resource tag.

      • Value (string) --

        The value for an AWS resource tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

untag_resource(**kwargs)

Removes a tag from an AWS resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    Keys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to remove the tag from.

  • Keys (list) --

    [REQUIRED]

    The keys in the key-value pair in the tag to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_agent(**kwargs)

Updates the name of an agent.

See also: AWS API Documentation

Request Syntax

response = client.update_agent(
    AgentArn='string',
    Name='string'
)
Parameters
  • AgentArn (string) --

    [REQUIRED]

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

  • Name (string) -- The name that you want to use to configure the agent.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_task(**kwargs)

Updates the metadata associated with a task.

See also: AWS API Documentation

Request Syntax

response = client.update_task(
    TaskArn='string',
    Options={
        'VerifyMode': 'POINT_IN_TIME_CONSISTENT'|'NONE',
        'Atime': 'NONE'|'BEST_EFFORT',
        'Mtime': 'NONE'|'PRESERVE',
        'Uid': 'NONE'|'INT_VALUE'|'NAME'|'BOTH',
        'Gid': 'NONE'|'INT_VALUE'|'NAME'|'BOTH',
        'PreserveDeletedFiles': 'PRESERVE'|'REMOVE',
        'PreserveDevices': 'NONE'|'PRESERVE',
        'PosixPermissions': 'NONE'|'BEST_EFFORT'|'PRESERVE',
        'BytesPerSecond': 123
    },
    Excludes=[
        {
            'FilterType': 'SIMPLE_PATTERN',
            'Value': 'string'
        },
    ],
    Name='string',
    CloudWatchLogGroupArn='string'
)
Parameters
  • TaskArn (string) --

    [REQUIRED]

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

  • Options (dict) --

    Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

    A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution , the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution .

    • VerifyMode (string) --

      A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

      Default value: POINT_IN_TIME_CONSISTENT.

      POINT_IN_TIME_CONSISTENT: Perform verification (recommended).

      NONE: Skip verification.

    • Atime (string) --

      A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime 's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

      Default value: BEST_EFFORT.

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

      NONE: Ignore Atime .

      Note

      If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

      If Atime is set to NONE, Mtime must also be NONE.

    • Mtime (string) --

      A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

      Default value: PRESERVE.

      PRESERVE: Preserve original Mtime (recommended)

      NONE: Ignore Mtime .

      Note

      If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

      If Mtime is set to NONE, Atime must also be set to NONE.

    • Uid (string) --

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

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

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

      NONE: Ignore UID and GID.

    • Gid (string) --

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

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

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

      NONE: Ignore UID and GID.

    • PreserveDeletedFiles (string) --

      A value that specifies whether files in the destination that don't exist in the source file system should be preserved.

      Default value: PRESERVE.

      PRESERVE: Ignore such destination files (recommended).

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

    • PreserveDevices (string) --

      A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

      Note

      AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

      Default value: NONE.

      NONE: Ignore special devices (recommended).

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

    • PosixPermissions (string) --

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

      Default value: PRESERVE.

      PRESERVE: Preserve POSIX-style permissions (recommended).

      NONE: Ignore permissions.

      Note

      AWS DataSync can preserve extant permissions of a source location.

    • BytesPerSecond (integer) --

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

  • Excludes (list) --

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

    • (dict) --

      Specifies which files, folders and objects to include or exclude when transferring files from source to destination.

      • FilterType (string) --

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

      • 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

  • Name (string) -- The name of the task to update.
  • CloudWatchLogGroupArn (string) -- The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Paginators

The available paginators are:

class DataSync.Paginator.ListAgents
paginator = client.get_paginator('list_agents')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DataSync.Client.list_agents().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Agents': [
        {
            'AgentArn': 'string',
            'Name': 'string',
            'Status': 'ONLINE'|'OFFLINE'
        },
    ],

}

Response Structure

  • (dict) --

    ListAgentsResponse

    • Agents (list) --

      A list of agents in your account.

      • (dict) --

        Represents a single entry in a list of agents. AgentListEntry returns an array that contains a list of agents when the ListAgents operation is called.

        • AgentArn (string) --

          The Amazon Resource Name (ARN) of the agent.

        • Name (string) --

          The name of the agent.

        • Status (string) --

          The status of the agent.

class DataSync.Paginator.ListLocations
paginator = client.get_paginator('list_locations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DataSync.Client.list_locations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Locations': [
        {
            'LocationArn': 'string',
            'LocationUri': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    ListLocationsResponse

    • Locations (list) --

      An array that contains a list of locations.

      • (dict) --

        Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called.

        • LocationArn (string) --

          The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location.

        • LocationUri (string) --

          Represents a list of URLs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called.

          Format: TYPE://GLOBAL_ID/SUBDIR .

          TYPE designates the type of location. Valid values: NFS | EFS | S3.

          GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234 . An example for Amazon S3 is the bucket name, such as myBucket . An example for NFS is a valid IPv4 address or a host name compliant with Domain Name Service (DNS).

          SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.

class DataSync.Paginator.ListTagsForResource
paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DataSync.Client.list_tags_for_resource().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource whose tags to list.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    ListTagsForResourceResponse

    • Tags (list) --

      Array of resource tags.

      • (dict) --

        Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

        • Key (string) --

          The key for an AWS resource tag.

        • Value (string) --

          The value for an AWS resource tag.

class DataSync.Paginator.ListTaskExecutions
paginator = client.get_paginator('list_task_executions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DataSync.Client.list_task_executions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TaskArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • TaskArn (string) -- The Amazon Resource Name (ARN) of the task whose tasks you want to list.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'TaskExecutions': [
        {
            'TaskExecutionArn': 'string',
            'Status': 'LAUNCHING'|'PREPARING'|'TRANSFERRING'|'VERIFYING'|'SUCCESS'|'ERROR'
        },
    ],

}

Response Structure

  • (dict) --

    ListTaskExecutionsResponse

    • TaskExecutions (list) --

      A list of executed tasks.

      • (dict) --

        Represents a single entry in a list of task executions. TaskExecutionListEntry returns an array that contains a list of specific invocations of a task when ListTaskExecutions operation is called.

        • TaskExecutionArn (string) --

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

        • Status (string) --

          The status of a task execution.

class DataSync.Paginator.ListTasks
paginator = client.get_paginator('list_tasks')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DataSync.Client.list_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Tasks': [
        {
            'TaskArn': 'string',
            'Status': 'AVAILABLE'|'CREATING'|'RUNNING'|'UNAVAILABLE',
            'Name': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    ListTasksResponse

    • Tasks (list) --

      A list of all the tasks that are returned.

      • (dict) --

        Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.

        • TaskArn (string) --

          The Amazon Resource Name (ARN) of the task.

        • Status (string) --

          The status of the task.

        • Name (string) --

          The name of the task.