DataSync / Client / describe_location_hdfs

describe_location_hdfs

DataSync.Client.describe_location_hdfs(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

LocationArn (string) –

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the HDFS location.

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),
    'ManagedSecretConfig': {
        'SecretArn': 'string'
    },
    'CmkSecretConfig': {
        'SecretArn': 'string',
        'KmsKeyArn': 'string'
    },
    'CustomSecretConfig': {
        'SecretArn': 'string',
        'SecretAccessRoleArn': 'string'
    }
}

Response Structure

  • (dict) –

    • LocationArn (string) –

      The ARN of the HDFS location.

    • LocationUri (string) –

      The URI of the HDFS location.

    • NameNodes (list) –

      The NameNode that manages 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, which specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the 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 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 DataSync agents that can connect with your HDFS cluster.

      • (string) –

    • CreationTime (datetime) –

      The time that the HDFS location was created.

    • ManagedSecretConfig (dict) –

      Describes configuration information for a DataSync-managed secret, such as a KerberosKeytab that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

      • SecretArn (string) –

        Specifies the ARN for an Secrets Manager secret.

    • CmkSecretConfig (dict) –

      Describes configuration information for a DataSync-managed secret, such as a KerberosKeytab that DataSync uses to access a specific storage location, with a customer-managed KMS key.

      • SecretArn (string) –

        Specifies the ARN for the DataSync-managed Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn.

      • KmsKeyArn (string) –

        Specifies the ARN for the customer-managed KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn. DataSync provides this key to Secrets Manager.

    • CustomSecretConfig (dict) –

      Describes configuration information for a customer-managed secret, such as a KerberosKeytab that DataSync uses to access a specific storage location, with a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

      • SecretArn (string) –

        Specifies the ARN for an Secrets Manager secret.

      • SecretAccessRoleArn (string) –

        Specifies the ARN for the Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.

Exceptions