- 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.
DescribeLocationObjectStorageCommand
Provides details about how an DataSync transfer location for an object storage system is configured.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataSyncClient, DescribeLocationObjectStorageCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeLocationObjectStorageCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeLocationObjectStorageRequest
LocationArn: "STRING_VALUE", // required
};
const command = new DescribeLocationObjectStorageCommand(input);
const response = await client.send(command);
// { // DescribeLocationObjectStorageResponse
// LocationArn: "STRING_VALUE",
// LocationUri: "STRING_VALUE",
// AccessKey: "STRING_VALUE",
// ServerPort: Number("int"),
// ServerProtocol: "HTTPS" || "HTTP",
// AgentArns: [ // AgentArnList
// "STRING_VALUE",
// ],
// CreationTime: new Date("TIMESTAMP"),
// ServerCertificate: new Uint8Array(),
// };
DescribeLocationObjectStorageCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
LocationArn Required | string | undefined | Specifies the Amazon Resource Name (ARN) of the object storage system location. |
DescribeLocationObjectStorageCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
AccessKey | string | undefined | The access key (for example, a user name) required to authenticate with the object storage system. |
AgentArns | string[] | undefined | The ARNs of the DataSync agents that can connect with your object storage system. |
CreationTime | Date | undefined | The time that the location was created. |
LocationArn | string | undefined | The ARN of the object storage system location. |
LocationUri | string | undefined | The URI of the object storage system location. |
ServerCertificate | Uint8Array | undefined | The certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). |
ServerPort | number | undefined | The port that your object storage server accepts inbound network traffic on (for example, port 443). |
ServerProtocol | ObjectStorageServerProtocol | undefined | The protocol that your object storage system uses to communicate. |
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. |