action S3

delete_object

Delete an object in a S3 bucket

Run it now
View details
Typeaction
Modulechaosaws.s3.actions
Namedelete_object
ReturnNone

Usage

JSON

{
  "name": "delete-object",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosaws.s3.actions",
    "func": "delete_object",
    "arguments": {
      "bucket_name": "",
      "object_key": ""
    }
  }
}

YAML

name: delete-object
provider:
  arguments:
    bucket_name: ""
    object_key: ""
  func: delete_object
  module: chaosaws.s3.actions
  type: python
type: action

Arguments

NameTypeDefaultRequiredTitleDescription
bucket_namestringYesBucketName of the bucket
object_keystringYesObject KeyKey of the object to delete from the bucket
version_idstringnullNoVersionVersion identifier of the object
  • bucket_name: the S3 bucket name
  • object_key: the path to the object
  • version_id: the version id of the object (optional)

Signature

def delete_object(bucket_name: str,
                  object_key: str,
                  version_id: str = None,
                  configuration: Dict[str, Dict[str, str]] = None,
                  secrets: Dict[str, Dict[str, str]] = None):
    pass