describe_location_efs

describe_location_efs(**kwargs)

Returns metadata about your DataSync location for an Amazon EFS file system.

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 Amazon EFS file system location that you want information about.

Return type

dict

Returns

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'Ec2Config': {
        'SubnetArn': 'string',
        'SecurityGroupArns': [
            'string',
        ]
    },
    'CreationTime': datetime(2015, 1, 1),
    'AccessPointArn': 'string',
    'FileSystemAccessRoleArn': 'string',
    'InTransitEncryption': 'NONE'|'TLS1_2'
}

Response Structure

• (dict) --

  DescribeLocationEfsResponse

  • LocationArn (string) --

    The ARN of the Amazon EFS file system location.

  • LocationUri (string) --

    The URL of the Amazon EFS file system location.

  • Ec2Config (dict) --

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

    • SubnetArn (string) --

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

      The subnet must be located:

      • In the same virtual private cloud (VPC) as the Amazon EFS file system.
      • In the same Availability Zone as at least one mount target for the Amazon EFS file system.

      Note

      You don't need to specify a subnet that includes a file system mount target.

    • SecurityGroupArns (list) --

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

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

    The time that the location was created.

  • AccessPointArn (string) --

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

  • FileSystemAccessRoleArn (string) --

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

  • InTransitEncryption (string) --

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

Exceptions

• DataSync.Client.exceptions.InvalidRequestException
• DataSync.Client.exceptions.InternalException