UpdateLocationAzureBlobCommand

Suggest an Edit

Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with Azure Blob Storage .

Example Syntax

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

import { DataSyncClient, UpdateLocationAzureBlobCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, UpdateLocationAzureBlobCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // UpdateLocationAzureBlobRequest
  LocationArn: "STRING_VALUE", // required
  Subdirectory: "STRING_VALUE",
  AuthenticationType: "SAS" || "NONE",
  SasConfiguration: { // AzureBlobSasConfiguration
    Token: "STRING_VALUE", // required
  },
  BlobType: "BLOCK",
  AccessTier: "HOT" || "COOL" || "ARCHIVE",
  AgentArns: [ // AgentArnList
    "STRING_VALUE",
  ],
  CmkSecretConfig: { // CmkSecretConfig
    SecretArn: "STRING_VALUE",
    KmsKeyArn: "STRING_VALUE",
  },
  CustomSecretConfig: { // CustomSecretConfig
    SecretArn: "STRING_VALUE",
    SecretAccessRoleArn: "STRING_VALUE",
  },
};
const command = new UpdateLocationAzureBlobCommand(input);
const response = await client.send(command);
// {};

UpdateLocationAzureBlobCommand Input

See UpdateLocationAzureBlobCommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

Specifies the ARN of the Azure Blob Storage transfer location that you're updating.

AccessTier
AzureAccessTier | undefined

Specifies 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

(Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

You can specify more than one agent. For more information, see Using multiple agents for your transfer .

You cannot add or remove agents from a storage location after you initially create it.

AuthenticationType
AzureBlobAuthenticationType | undefined

Specifies 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

Specifies 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 .

CmkSecretConfig
CmkSecretConfig | undefined

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

CustomSecretConfig
CustomSecretConfig | undefined

Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

SasConfiguration
AzureBlobSasConfiguration | undefined

Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

Subdirectory
string | undefined

Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images).

UpdateLocationAzureBlobCommand Output

See UpdateLocationAzureBlobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

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.