- 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.
DescribeLocationFsxLustreCommand
Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataSyncClient, DescribeLocationFsxLustreCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeLocationFsxLustreCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeLocationFsxLustreRequest
LocationArn: "STRING_VALUE", // required
};
const command = new DescribeLocationFsxLustreCommand(input);
const response = await client.send(command);
// { // DescribeLocationFsxLustreResponse
// LocationArn: "STRING_VALUE",
// LocationUri: "STRING_VALUE",
// SecurityGroupArns: [ // Ec2SecurityGroupArnList
// "STRING_VALUE",
// ],
// CreationTime: new Date("TIMESTAMP"),
// };
DescribeLocationFsxLustreCommand Input
See DescribeLocationFsxLustreCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
LocationArn Required | string | undefined | The Amazon Resource Name (ARN) of the FSx for Lustre location to describe. |
DescribeLocationFsxLustreCommand Output
See DescribeLocationFsxLustreCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
CreationTime | Date | undefined | The time that the FSx for Lustre location was created. |
LocationArn | string | undefined | The Amazon Resource Name (ARN) of the FSx for Lustre location that was described. |
LocationUri | string | undefined | The URI of the FSx for Lustre location that was described. |
SecurityGroupArns | string[] | undefined | The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Lustre file system. |
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. |