s3_move>: Move files in Amazon S3

s3_move> operator moves files within Amazon S3 by copying them to the destination and then deleting the source.

Copy
Copied
+move_file:
  s3_move>: 
  source: source-bucket/source-key
  destination: destination-bucket/destination-key

Secrets

When you don't know how to set secrets, please refer to Managing Workflow Secret

  • aws.s3.access_key_id, aws.access_key_id

    The AWS Access Key ID to use when accessing S3.

  • aws.s3.secret_access_key, aws.secret_access_key

    The AWS Secret Access Key to use when accessing S3.

  • aws.s3.region, aws.region

    An optional explicit AWS Region in which to access S3.

Options

  • source : SOURCE_BUCKET/SOURCE_KEY

    Path to the source file in Amazon S3 to move from. Use either this parameter or the combination of source_bucket and source_key.

    Examples:

    Copy
    Copied
    source: source-bucket/my-data.gz
    Copy
    Copied
    source: source-bucket/file/in/a/directory
  • source_bucket : SOURCE_BUCKET

    The S3 bucket where the source file is located. Can be used together with the source_key parameter.

  • source_key : SOURCE_KEY

    The S3 key of the source file. Can be used together with the source_bucket parameter.

  • destination : DESTINATION_BUCKET/DESTINATION_KEY

    Path to the destination file in Amazon S3 to move to. Use either this parameter or the combination of destination_bucket and destination_key.

    Examples:

    Copy
    Copied
    destination: destination-bucket/my-data-moved.gz
    Copy
    Copied
    destination: destination-bucket/file/in/another/directory
  • destination_bucket : DESTINATION_BUCKET

    The S3 bucket where the destination file will be created. Can be used together with the destination_key parameter.

  • destination_key : DESTINATION_KEY

    The S3 key of the destination file. Can be used together with the destination_bucket parameter.

  • recursive : BOOLEAN

    Move all objects with the specified prefix recursively. Default is false.

    Examples:

    Copy
    Copied
    +move_directory:
    s3_move>:
    source: source-bucket/my-directory/
    destination: destination-bucket/backup/
    recursive: true
  • objects_per_iteration : NUMBER

    Maximum number of objects to move per iteration when using recursive mode. Must be between 1 and 1000. Default is 1000.

  • region : REGION

    An optional explicit AWS Region in which to access S3. This may also be specified using the aws.s3.region secret.

  • path_style_access : BOOLEAN

    An optional flag to control whether to use path-style or virtual hosted-style access when accessing S3. Default is false.

  • log_each_object : BOOLEAN

    Whether to log each object being moved. Default is true.

Notes

  • When moving folders recursively, you cannot move a folder into itself or into one of its subfolders. For example, you cannot move my-folder/ to my-folder/backup/ .
  • The move operation works by copying files first, then deleting the originals. If something goes wrong during the process, some files might be copied to the destination but not yet deleted from the source.