probeS3

bucket_exists

Validate that a bucket exists

Activity as code

Below are the details and signature of the activity Python module.

Typeprobe
Modulechaosaws.s3.probes
Namebucket_exists
Returnboolean

Usage

JSON

{
  "name": "bucket-exists",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosaws.s3.probes",
    "func": "bucket_exists",
    "arguments": {
      "bucket_name": ""
    }
  }
}

YAML

name: bucket-exists
provider:
  arguments:
    bucket_name: ""
  func: bucket_exists
  module: chaosaws.s3.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
bucket_namestringYesBucketName of the bucket

Signature

def bucket_exists(bucket_name: str,
                  configuration: Dict[str, Dict[str, str]] = None,
                  secrets: Dict[str, Dict[str, str]] = None) -> bool:
    pass