Nuix · Schema

IngestibleS3Bucket

Schema for IngestibleS3Bucket in Nuix REST API

ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence

Properties

Name Type Description
access string This parameter specifies the access key ID for an Amazon Web Service account.
secret string This parameter specifies the secret access key for an Amazon Web Service account.
bucket string This optional parameter specifies a bucket and optionally a path to a folder within the bucket that contains the evidence to ingest. For example, 'com.nuix.mybucket/top folder/sub folder'. Omitting th
endpoint string This optional parameter specifies a particular Amazon Web Service server endpoint. This can be used to connect to a particular regional server e.g., https://s3.amazonaws.com.
useCredentialDiscovery boolean Use credential discovery instead of anonymous access.
View JSON Schema on GitHub

JSON Schema

nuix-rest-ingestibles3bucket.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-rest-ingestibles3bucket.json",
  "title": "IngestibleS3Bucket",
  "description": "Schema for IngestibleS3Bucket in Nuix REST API",
  "type": "object",
  "properties": {
    "access": {
      "type": "string",
      "description": "This parameter specifies the access key ID for an Amazon Web Service account."
    },
    "secret": {
      "type": "string",
      "description": "This parameter specifies the secret access key for an Amazon Web Service account."
    },
    "bucket": {
      "type": "string",
      "description": "This optional parameter specifies a bucket and optionally a path to a folder within the bucket that contains the evidence to ingest. For example, 'com.nuix.mybucket/top folder/sub folder'. Omitting this parameter will cause all buckets to be added to evidence."
    },
    "endpoint": {
      "type": "string",
      "description": "This optional parameter specifies a particular Amazon Web Service server endpoint. This can be used to connect to a particular regional server e.g., https://s3.amazonaws.com."
    },
    "useCredentialDiscovery": {
      "type": "boolean",
      "description": "Use credential discovery instead of anonymous access."
    }
  }
}