- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeLocationSmbCommand
Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataSyncClient, DescribeLocationSmbCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeLocationSmbCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeLocationSmbRequest
LocationArn: "STRING_VALUE", // required
};
const command = new DescribeLocationSmbCommand(input);
const response = await client.send(command);
// { // DescribeLocationSmbResponse
// LocationArn: "STRING_VALUE",
// LocationUri: "STRING_VALUE",
// AgentArns: [ // AgentArnList
// "STRING_VALUE",
// ],
// User: "STRING_VALUE",
// Domain: "STRING_VALUE",
// MountOptions: { // SmbMountOptions
// Version: "AUTOMATIC" || "SMB2" || "SMB3" || "SMB1" || "SMB2_0",
// },
// CreationTime: new Date("TIMESTAMP"),
// DnsIpAddresses: [ // DnsIpList
// "STRING_VALUE",
// ],
// KerberosPrincipal: "STRING_VALUE",
// AuthenticationType: "NTLM" || "KERBEROS",
// };
DescribeLocationSmbCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
LocationArnRequired | string | undefined | Specifies the Amazon Resource Name (ARN) of the SMB location that you want information about. |
DescribeLocationSmbCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
AgentArns | string[] | undefined | The ARNs of the DataSync agents that can connect with your SMB file server. |
AuthenticationType | SmbAuthenticationType | undefined | The authentication protocol that DataSync uses to connect to your SMB file server. |
CreationTime | Date | undefined | The time that the SMB location was created. |
DnsIpAddresses | string[] | undefined | The IPv4 addresses for the DNS servers that your SMB file server belongs to. This element applies only if |
Domain | string | undefined | The name of the Windows domain that the SMB file server belongs to. This element applies only if |
KerberosPrincipal | string | undefined | The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server. |
LocationArn | string | undefined | The ARN of the SMB location. |
LocationUri | string | undefined | The URI of the SMB location. |
MountOptions | SmbMountOptions | undefined | The SMB protocol version that DataSync uses to access your SMB file server. |
User | string | undefined | The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if |
Throws
Name | Fault | Details |
|---|
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. |