DescribeLocationHdfsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataSyncClient, DescribeLocationHdfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeLocationHdfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeLocationHdfsRequest
  LocationArn: "STRING_VALUE", // required
};
const command = new DescribeLocationHdfsCommand(input);
const response = await client.send(command);
// { // DescribeLocationHdfsResponse
//   LocationArn: "STRING_VALUE",
//   LocationUri: "STRING_VALUE",
//   NameNodes: [ // HdfsNameNodeList
//     { // HdfsNameNode
//       Hostname: "STRING_VALUE", // required
//       Port: Number("int"), // required
//     },
//   ],
//   BlockSize: Number("int"),
//   ReplicationFactor: Number("int"),
//   KmsKeyProviderUri: "STRING_VALUE",
//   QopConfiguration: { // QopConfiguration
//     RpcProtection: "DISABLED" || "AUTHENTICATION" || "INTEGRITY" || "PRIVACY",
//     DataTransferProtection: "DISABLED" || "AUTHENTICATION" || "INTEGRITY" || "PRIVACY",
//   },
//   AuthenticationType: "SIMPLE" || "KERBEROS",
//   SimpleUser: "STRING_VALUE",
//   KerberosPrincipal: "STRING_VALUE",
//   AgentArns: [ // AgentArnList
//     "STRING_VALUE",
//   ],
//   CreationTime: new Date("TIMESTAMP"),
// };

DescribeLocationHdfsCommand Input

See DescribeLocationHdfsCommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

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

DescribeLocationHdfsCommand Output

See DescribeLocationHdfsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AgentArns
string[] | undefined

The ARNs of the DataSync agents that can connect with your HDFS cluster.

AuthenticationType
HdfsAuthenticationType | undefined

The type of authentication used to determine the identity of the user.

BlockSize
number | undefined

The size of the data blocks to write into the HDFS cluster.

CreationTime
Date | undefined

The time that the HDFS location was created.

KerberosPrincipal
string | undefined

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.

KmsKeyProviderUri
string | undefined

The URI of the HDFS cluster's Key Management Server (KMS).

LocationArn
string | undefined

The ARN of the HDFS location.

LocationUri
string | undefined

The URI of the HDFS location.

NameNodes
HdfsNameNode[] | undefined

The NameNode that manages the HDFS namespace.

QopConfiguration
QopConfiguration | undefined

The Quality of Protection (QOP) configuration, which specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the HDFS cluster.

ReplicationFactor
number | undefined

The number of DataNodes to replicate the data to when writing to the HDFS cluster.

SimpleUser
string | undefined

The user name to identify the client on the host operating system. This parameter is used if the AuthenticationType is defined as SIMPLE.

Throws

Name
Fault
Details
InternalException
server

This exception is thrown when an error occurs in the DataSync service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

DataSyncServiceException
Base exception class for all service exceptions from DataSync service.