DescribeLocationAzureBlob
Provides details about how an AWS DataSync transfer location for Microsoft Azure Blob Storage is configured.
Request Syntax
{
"LocationArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- LocationArn
-
Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage transfer location.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$Required: Yes
Response Syntax
{
"AccessTier": "string",
"AgentArns": [ "string" ],
"AuthenticationType": "string",
"BlobType": "string",
"CreationTime": number,
"LocationArn": "string",
"LocationUri": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AccessTier
-
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.
Type: String
Valid Values:
HOT | COOL | ARCHIVE - AgentArns
-
The ARNs of the DataSync agents that can connect with your Azure Blob Storage container.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 4 items.
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ - AuthenticationType
-
The authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
Type: String
Valid Values:
SAS - BlobType
-
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
. Type: String
Valid Values:
BLOCK - CreationTime
-
The time that your Azure Blob Storage transfer location was created.
Type: Timestamp
- LocationArn
-
The ARN of your Azure Blob Storage transfer location.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ - LocationUri
-
The URL of the Azure Blob Storage container involved in your transfer.
Type: String
Length Constraints: Maximum length of 4360.
Pattern:
^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception is thrown when an error occurs in the AWS DataSync service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
