Skip to content

s3-bucket-upload

Help command

> csm-data s3-bucket-upload --help

 Usage: csm-data s3-bucket-upload [OPTIONS]                                                                                                                                                                        

 Upload a folder to a S3 Bucket                                                                                                                                                                                    
 Will upload everything from a given folder to a S3 bucket. If a single file is passed only it will be uploaded, and recursive will be ignored                                                                     

 Giving a prefix will add it to every upload (finishing the prefix with a "/" will allow to upload in a folder inside the bucket)                                                                                  

 Make use of the boto3 library to access the bucket                                                                                                                                                                

 More information is available on this page: [https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html]                                                                                    

╭─ OPTIONS ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *  --source-folder               PATH    The folder/file to upload to the target bucket                                                                                                                         │
│                                          ENV: CSM_DATASET_ABSOLUTE_PATH                                                                                                                                         │
│                                          [required]                                                                                                                                                             │
│    --recursive/--no-recursive            Recursively send the content of every folder inside the starting folder to the bucket                                                                                  │
│ *  --bucket-name                 BUCKET  The bucket on S3 to upload to                                                                                                                                          │
│                                          ENV: CSM_DATA_BUCKET_NAME                                                                                                                                              │
│                                          [required]                                                                                                                                                             │
│    --prefix                      PREFIX  A prefix by which all uploaded files should start with in the bucket                                                                                                   │
│                                          ENV: CSM_DATA_BUCKET_PREFIX                                                                                                                                            │
│    --use-ssl/--no-ssl                    Use SSL to secure connection to S3                                                                                                                                     │
│ *  --s3-url                      URL     URL to connect to the S3 system                                                                                                                                        │
│                                          ENV: AWS_ENDPOINT_URL                                                                                                                                                  │
│                                          [required]                                                                                                                                                             │
│ *  --access-id                   ID      Identity used to connect to the S3 system                                                                                                                              │
│                                          ENV: AWS_ACCESS_KEY_ID                                                                                                                                                 │
│                                          [required]                                                                                                                                                             │
│ *  --secret-key                  ID      Secret tied to the ID used to connect to the S3 system                                                                                                                 │
│                                          ENV: AWS_SECRET_ACCESS_KEY                                                                                                                                             │
│                                          [required]                                                                                                                                                             │
│    --ssl-cert-bundle             PATH    Path to an alternate CA Bundle to validate SSL connections                                                                                                             │
│                                          ENV: CSM_S3_CA_BUNDLE                                                                                                                                                  │
│    --web-help                            Open the web documentation                                                                                                                                             │
│    --help                                Show this message and exit.                                                                                                                                            │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯