AWS DataSync

2023/07/25 - AWS DataSync - 3 new api methods

Changes  AWS DataSync now supports Microsoft Azure Blob Storage locations.

UpdateLocationAzureBlob (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_location_azure_blob(
    LocationArn='string',
    Subdirectory='string',
    AuthenticationType='SAS',
    SasConfiguration={
        'Token': 'string'
    },
    BlobType='BLOCK',
    AccessTier='HOT'|'COOL'|'ARCHIVE',
    AgentArns=[
        'string',
    ]
)
type LocationArn:

string

param LocationArn:

[REQUIRED]

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

type Subdirectory:

string

param Subdirectory:

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

type AuthenticationType:

string

param AuthenticationType:

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

type SasConfiguration:

dict

param SasConfiguration:

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

  • Token (string) -- [REQUIRED]

    Specifies a SAS token that provides permissions at the Azure storage account, container, or folder level.

    The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:

    sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D

type BlobType:

string

param BlobType:

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.

type AccessTier:

string

param AccessTier:

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.

type AgentArns:

list

param AgentArns:

Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

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

  • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DescribeLocationAzureBlob (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.describe_location_azure_blob(
    LocationArn='string'
)
type LocationArn:

string

param LocationArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'AuthenticationType': 'SAS',
    'BlobType': 'BLOCK',
    'AccessTier': 'HOT'|'COOL'|'ARCHIVE',
    'AgentArns': [
        'string',
    ],
    'CreationTime': datetime(2015, 1, 1)
}

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.

CreateLocationAzureBlob (new) Link ¶

Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.

Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.

See also: AWS API Documentation

Request Syntax

client.create_location_azure_blob(
    ContainerUrl='string',
    AuthenticationType='SAS',
    SasConfiguration={
        'Token': 'string'
    },
    BlobType='BLOCK',
    AccessTier='HOT'|'COOL'|'ARCHIVE',
    Subdirectory='string',
    AgentArns=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type ContainerUrl:

string

param ContainerUrl:

[REQUIRED]

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

type AuthenticationType:

string

param AuthenticationType:

[REQUIRED]

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

type SasConfiguration:

dict

param SasConfiguration:

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

  • Token (string) -- [REQUIRED]

    Specifies a SAS token that provides permissions at the Azure storage account, container, or folder level.

    The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:

    sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D

type BlobType:

string

param BlobType:

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.

type AccessTier:

string

param AccessTier:

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.

type Subdirectory:

string

param Subdirectory:

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

type AgentArns:

list

param AgentArns:

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

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

  • (string) --

type Tags:

list

param Tags:

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

  • (dict) --

    A key-value pair representing a single tag that's been applied to an Amazon Web Services resource.

    • Key (string) -- [REQUIRED]

      The key for an Amazon Web Services resource tag.

    • Value (string) --

      The value for an Amazon Web Services resource tag.

rtype:

dict

returns:

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

  • (dict) --

    • LocationArn (string) --

      The ARN of the Azure Blob Storage transfer location that you created.