AWS DataSync

Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.

See also: AWS API Documentation

Request Syntax

client.describe_location_fsx_open_zfs(
    LocationArn='string'
)

type LocationArn

string

param LocationArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'SecurityGroupArns': [
        'string',
    ],
    'Protocol': {
        'NFS': {
            'MountOptions': {
                'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
            }
        }
    },
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • LocationArn (string) --

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

  • LocationUri (string) --

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

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

  • SecurityGroupArns (list) --

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

    • (string) --

  • Protocol (dict) --

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

    • NFS (dict) --

      Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system.

      • MountOptions (dict) --

        Represents the mount options that are available for DataSync to access an NFS location.

        • Version (string) --

          The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. 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.

          You can specify the following NFS versions:

          • NFSv3 - stateless protocol version that allows for asynchronous writes on the server.

          • NFSv4.0 - stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

          • NFSv4.1 - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.

  • CreationTime (datetime) --

    The time that the FSx for OpenZFS location was created.

Creates an endpoint for an Amazon FSx for OpenZFS file system.

See also: AWS API Documentation

Request Syntax

client.create_location_fsx_open_zfs(
    FsxFilesystemArn='string',
    Protocol={
        'NFS': {
            'MountOptions': {
                'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
            }
        }
    },
    SecurityGroupArns=[
        'string',
    ],
    Subdirectory='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type FsxFilesystemArn

string

param FsxFilesystemArn

[REQUIRED]

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

type Protocol

dict

param Protocol

[REQUIRED]

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

• NFS (dict) --

  Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system.

  • MountOptions (dict) --

    Represents the mount options that are available for DataSync to access an NFS location.

    • Version (string) --

      The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. 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.

      You can specify the following NFS versions:

      • NFSv3 - stateless protocol version that allows for asynchronous writes on the server.

      • NFSv4.0 - stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

      • NFSv4.1 - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.

type SecurityGroupArns

list

param SecurityGroupArns

[REQUIRED]

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

• (string) --

type Subdirectory

string

param Subdirectory

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

type Tags

list

param Tags

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 Amazon Web Services 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 Amazon Web Services resource tag.

  • Value (string) --

    The value for an Amazon Web Services resource tag.

rtype

dict

returns

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

• (dict) --

  • LocationArn (string) --

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