DataSync / Client / describe_location_hdfs

describe_location_hdfs#

DataSync.Client.describe_location_hdfs(**kwargs)#

Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.

Request Syntax

response = client.describe_location_hdfs(
    LocationArn='string'
)

Parameters:

LocationArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'NameNodes': [
        {
            'Hostname': 'string',
            'Port': 123
        },
    ],
    'BlockSize': 123,
    'ReplicationFactor': 123,
    'KmsKeyProviderUri': 'string',
    'QopConfiguration': {
        'RpcProtection': 'DISABLED'|'AUTHENTICATION'|'INTEGRITY'|'PRIVACY',
        'DataTransferProtection': 'DISABLED'|'AUTHENTICATION'|'INTEGRITY'|'PRIVACY'
    },
    'AuthenticationType': 'SIMPLE'|'KERBEROS',
    'SimpleUser': 'string',
    'KerberosPrincipal': 'string',
    'AgentArns': [
        'string',
    ],
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- LocationArn (string) –
  
  The ARN of the HDFS cluster location.
- LocationUri (string) –
  
  The URI of the HDFS cluster location.
- NameNodes (list) –
  
  The NameNode that manage the HDFS namespace.
  - (dict) –
    
    The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system’s namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes.
    - Hostname (string) –
      
      The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that’s installed on-premises uses this hostname to communicate with the NameNode in the network.
    - Port (integer) –
      
      The port that the NameNode uses to listen to client requests.
- BlockSize (integer) –
  
  The size of the data blocks to write into the HDFS cluster.
- ReplicationFactor (integer) –
  
  The number of DataNodes to replicate the data to when writing to the HDFS cluster.
- KmsKeyProviderUri (string) –
  
  The URI of the HDFS cluster’s Key Management Server (KMS).
- QopConfiguration (dict) –
  
  The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster.
  - RpcProtection (string) –
    
    The RPC protection setting configured on the HDFS cluster. This setting corresponds to your hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster.
  - DataTransferProtection (string) –
    
    The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster.
- AuthenticationType (string) –
  
  The type of authentication used to determine the identity of the user.
- SimpleUser (string) –
  
  The user name used to identify the client on the host operating system. This parameter is used if the AuthenticationType is defined as SIMPLE.
- KerberosPrincipal (string) –
  
  The Kerberos principal with access to the files and folders on the HDFS cluster. This parameter is used if the AuthenticationType is defined as KERBEROS.
- AgentArns (list) –
  
  The ARNs of the agents that are used to connect to the HDFS cluster.
  - (string) –
- CreationTime (datetime) –
  
  The time that the HDFS location was created.

Exceptions

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