DataSync / Client / describe_location_azure_blob

describe_location_azure_blob

DataSync.Client.describe_location_azure_blob(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_location_azure_blob(
    LocationArn='string'
)
Parameters:

LocationArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'AuthenticationType': 'SAS'|'NONE',
    'BlobType': 'BLOCK',
    'AccessTier': 'HOT'|'COOL'|'ARCHIVE',
    'AgentArns': [
        'string',
    ],
    'CreationTime': datetime(2015, 1, 1),
    'ManagedSecretConfig': {
        'SecretArn': 'string'
    },
    'CmkSecretConfig': {
        'SecretArn': 'string',
        'KmsKeyArn': 'string'
    },
    'CustomSecretConfig': {
        'SecretArn': 'string',
        'SecretAccessRoleArn': 'string'
    }
}

Response Structure

  • (dict) –

    • LocationArn (string) –

      The ARN of your Azure Blob Storage transfer location.

    • LocationUri (string) –

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

    • AuthenticationType (string) –

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

    • BlobType (string) –

      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.

    • AccessTier (string) –

      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 (list) –

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

      • (string) –

    • CreationTime (datetime) –

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

    • ManagedSecretConfig (dict) –

      Describes configuration information for a DataSync-managed secret, such as an authentication token that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

      • SecretArn (string) –

        Specifies the ARN for an Secrets Manager secret.

    • CmkSecretConfig (dict) –

      Describes configuration information for a DataSync-managed secret, such as an authentication token that DataSync uses to access a specific storage location, with a customer-managed KMS key.

      • SecretArn (string) –

        Specifies the ARN for the DataSync-managed Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn.

      • KmsKeyArn (string) –

        Specifies the ARN for the customer-managed KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn. DataSync provides this key to Secrets Manager.

    • CustomSecretConfig (dict) –

      Describes configuration information for a customer-managed secret, such as an authentication token that DataSync uses to access a specific storage location, with a customer-managed KMS key.

      • SecretArn (string) –

        Specifies the ARN for an Secrets Manager secret.

      • SecretAccessRoleArn (string) –

        Specifies the ARN for the Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.

Exceptions