DescribeLocationAzureBlobCommand

Suggest an Edit

Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.

Example Syntax

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

import { DataSyncClient, DescribeLocationAzureBlobCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeLocationAzureBlobCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeLocationAzureBlobRequest
  LocationArn: "STRING_VALUE", // required
};
const command = new DescribeLocationAzureBlobCommand(input);
const response = await client.send(command);
// { // DescribeLocationAzureBlobResponse
//   LocationArn: "STRING_VALUE",
//   LocationUri: "STRING_VALUE",
//   AuthenticationType: "SAS",
//   BlobType: "BLOCK",
//   AccessTier: "HOT" || "COOL" || "ARCHIVE",
//   AgentArns: [ // AgentArnList
//     "STRING_VALUE",
//   ],
//   CreationTime: new Date("TIMESTAMP"),
// };

DescribeLocationAzureBlobCommand Input

See DescribeLocationAzureBlobCommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage transfer location.

DescribeLocationAzureBlobCommand Output

See DescribeLocationAzureBlobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AccessTier
AzureAccessTier | undefined

The access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers .

AgentArns
string[] | undefined

The ARNs of the DataSync agents that can connect with your Azure Blob Storage container.

AuthenticationType
AzureBlobAuthenticationType | undefined

The authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).

BlobType
AzureBlobType | undefined

The type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation .

CreationTime
Date | undefined

The time that your Azure Blob Storage transfer location was created.

LocationArn
string | undefined

The ARN of your Azure Blob Storage transfer location.

LocationUri
string | undefined

The URL of the Azure Blob Storage container involved in your transfer.

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.