Breadcrumbs

Amazon S3 - Move or Rename Files

Overview

Quickly and seamlessly move a file within an S3 bucket to another bucket or folder, or rename a file within an S3 bucket.

Variables

Name

Reference

Type

Required

Default

Options

Description

S3 Source Bucket Name

S3_SOURCE_BUCKET_NAME

Alphanumeric

None

-

Name of the S3 bucket where the file is located

S3 Source Folder Name

S3_SOURCE_FOLDER_NAME

Alphanumeric

None

-

Name of the folder within the bucket where the source file is located. If left blank, the file will be scanned for in the root directory

S3 Original File Name Match Type

S3_FILE_MATCH_TYPE

Select

exact_match

Exact Match: exact_match

Regex Match: regex_match

Determines if the text in "S3 Original File Name" will look for one file with exact match, or multiple files using regex.

S3 Original File Name

S3_SOURCE_FILE_NAME

Alphanumeric

None

-

The name of the file desired to move. If regex match is selected, then it is the pattern to match files

S3 Destination Bucket Name

S3_DESTINATION_BUCKET_NAME

Alphanumeric

None

-

The name of the destination S3 Bucket

S3 Destination Folder Name

S3_DESTINATION_FOLDER_NAME

Alphanumeric

None

-

The folder in S3 in which you would like to move the file. If left blank, the file will be moved to the root directory

S3 New File Name

S3_DESTINATION_FILE_NAME

Alphanumeric

None

-

The name of the file once it is moved

Default Region

AWS_DEFAULT_REGION

Select

us-east-2

us-east-2

us-east-1

us-west-1

us-west-2

af-south-1

ap-east-1

ap-south-1

ap-northeast-3

ap-northeast-2

ap-northeast-1

ap-southeast-1

ap-southeast-2

ca-central-1

cn-north-1

cn-northwest-1

eu-central-1

eu-west-1

eu-west-2

eu-west-3

eu-south-1

eu-north-1

sa-east-1

me-south-1

The AWS region for the S3 bucket and IAM user.

Access Key ID

AWS_ACCESS_KEY_ID

Password

None

-

The access key ID for programmatic IAM user used to download the file. See Authorization documentation for more information.

Secret Access Key

AWS_SECRET_ACCESS_KEY

Password

None

-

The secret access key for programmatic IAM user used to download the file. See Authorization documentation for more information.

YAML

Below is the YAML template

YAML

source:
  template: Amazon S3 - Move or Rename Files
  inputs:
    S3_SOURCE_BUCKET_NAME:
    S3_SOURCE_FOLDER_NAME:
    S3_FILE_MATCH_TYPE: exact_match
    S3_SOURCE_FILE_NAME:
    S3_DESTINATION_BUCKET_NAME:
    S3_DESTINATION_FOLDER_NAME:
    S3_DESTINATION_FILE_NAME:
    AWS_DEFAULT_REGION: us-east-2
    AWS_ACCESS_KEY_ID:
    AWS_SECRET_ACCESS_KEY:
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 10
    - 14
    - 101
    - 102
    - 204
    - 205
    - 206