{ "opencollection": "1.0.0", "info": { "name": "Amazon S3 Control Access Control Objects API", "version": "2018-08-20" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Objects", "type": "folder" }, "items": [ { "info": { "name": "Amazon S3 List Objects V2", "type": "http" }, "http": { "method": "GET", "url": "https://s3-control.{region}.amazonaws.com/:Bucket?list-type=2", "headers": [ { "name": "x-amz-expected-bucket-owner", "value": "example_value" }, { "name": "x-amz-request-payer", "value": "requester" }, { "name": "x-amz-optional-object-attributes", "value": "example_value" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket. Bucket names must be between 3 and 63 characters long, consist only of lowercase letters, numbers, hyphens, and periods, and must begin and end with a letter or number." }, { "name": "list-type", "value": "2", "type": "query", "description": "Set to 2 to use the ListObjectsV2 API." }, { "name": "continuation-token", "value": "example_value", "type": "query", "description": "ContinuationToken indicates to S3 that the list is being continued on this bucket with a token returned in a previous response." }, { "name": "delimiter", "value": "example_value", "type": "query", "description": "A delimiter is a character that you use to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single CommonPrefixes element." }, { "name": "encoding-type", "value": "url", "type": "query", "description": "Encoding type used by Amazon S3 to encode object keys in the response." }, { "name": "fetch-owner", "value": "true", "type": "query", "description": "Set to true to include the owner field in the response." }, { "name": "max-keys", "value": "10", "type": "query", "description": "Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names." }, { "name": "prefix", "value": "example_value", "type": "query", "description": "Limits the response to keys that begin with the specified prefix." }, { "name": "start-after", "value": "example_value", "type": "query", "description": "StartAfter is where you want Amazon S3 to start listing from. S3 starts listing after this specified key." } ] }, "docs": "Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. This is the recommended approach for listing objects. ListObjectsV2 supersedes the older ListObjects API." }, { "info": { "name": "Amazon S3 Get Object", "type": "http" }, "http": { "method": "GET", "url": "https://s3-control.{region}.amazonaws.com/:Bucket/:Key+", "headers": [ { "name": "Range", "value": "example_value" }, { "name": "If-Match", "value": "example_value" }, { "name": "If-None-Match", "value": "example_value" }, { "name": "If-Modified-Since", "value": "2026-01-15T10:30:00Z" }, { "name": "If-Unmodified-Since", "value": "2026-01-15T10:30:00Z" }, { "name": "x-amz-server-side-encryption-customer-algorithm", "value": "example_value" }, { "name": "x-amz-server-side-encryption-customer-key", "value": "example_value" }, { "name": "x-amz-server-side-encryption-customer-key-MD5", "value": "example_value" }, { "name": "x-amz-request-payer", "value": "requester" }, { "name": "x-amz-expected-bucket-owner", "value": "example_value" }, { "name": "x-amz-checksum-mode", "value": "ENABLED" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket. Bucket names must be between 3 and 63 characters long, consist only of lowercase letters, numbers, hyphens, and periods, and must begin and end with a letter or number." }, { "name": "Key+", "value": "", "type": "path", "description": "Key name of the object. The object key can be up to 1,024 bytes in length and may contain any UTF-8 characters." }, { "name": "response-cache-control", "value": "example_value", "type": "query", "description": "Sets the Cache-Control header of the response." }, { "name": "response-content-disposition", "value": "example_value", "type": "query", "description": "Sets the Content-Disposition header of the response." }, { "name": "response-content-encoding", "value": "example_value", "type": "query", "description": "Sets the Content-Encoding header of the response." }, { "name": "response-content-language", "value": "example_value", "type": "query", "description": "Sets the Content-Language header of the response." }, { "name": "response-content-type", "value": "example_value", "type": "query", "description": "Sets the Content-Type header of the response." }, { "name": "response-expires", "value": "example_value", "type": "query", "description": "Sets the Expires header of the response." }, { "name": "versionId", "value": "500123", "type": "query", "description": "VersionId used to reference a specific version of the object." }, { "name": "partNumber", "value": "10", "type": "query", "description": "Part number of the object being read for a multipart object." } ] }, "docs": "Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. You can grant READ access using a bucket policy or an object ACL. Supports conditional retrieval using If-Match, If-None-Match, If-Modified-Since, and If-Unmodified-Since headers. Supports range reads with the Range header." }, { "info": { "name": "Amazon S3 Put Object", "type": "http" }, "http": { "method": "PUT", "url": "https://s3-control.{region}.amazonaws.com/:Bucket/:Key+", "headers": [ { "name": "Cache-Control", "value": "example_value" }, { "name": "Content-Disposition", "value": "example_value" }, { "name": "Content-Encoding", "value": "example_value" }, { "name": "Content-Language", "value": "example_value" }, { "name": "Content-Length", "value": "10" }, { "name": "Content-MD5", "value": "example_value" }, { "name": "Content-Type", "value": "example_value" }, { "name": "Expires", "value": "2026-01-15T10:30:00Z" }, { "name": "x-amz-acl", "value": "private" }, { "name": "x-amz-storage-class", "value": "STANDARD" }, { "name": "x-amz-server-side-encryption", "value": "AES256" }, { "name": "x-amz-server-side-encryption-aws-kms-key-id", "value": "500123" }, { "name": "x-amz-server-side-encryption-context", "value": "example_value" }, { "name": "x-amz-server-side-encryption-bucket-key-enabled", "value": "true" }, { "name": "x-amz-server-side-encryption-customer-algorithm", "value": "example_value" }, { "name": "x-amz-server-side-encryption-customer-key", "value": "example_value" }, { "name": "x-amz-server-side-encryption-customer-key-MD5", "value": "example_value" }, { "name": "x-amz-tagging", "value": "example_value" }, { "name": "x-amz-object-lock-mode", "value": "GOVERNANCE" }, { "name": "x-amz-object-lock-retain-until-date", "value": "2026-01-15T10:30:00Z" }, { "name": "x-amz-object-lock-legal-hold", "value": "ON" }, { "name": "x-amz-expected-bucket-owner", "value": "example_value" }, { "name": "x-amz-checksum-algorithm", "value": "CRC32" }, { "name": "x-amz-checksum-crc32", "value": "example_value" }, { "name": "x-amz-checksum-crc32c", "value": "example_value" }, { "name": "x-amz-checksum-sha1", "value": "example_value" }, { "name": "x-amz-checksum-sha256", "value": "example_value" }, { "name": "x-amz-request-payer", "value": "requester" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket. Bucket names must be between 3 and 63 characters long, consist only of lowercase letters, numbers, hyphens, and periods, and must begin and end with a letter or number." }, { "name": "Key+", "value": "", "type": "path", "description": "Key name of the object. The object key can be up to 1,024 bytes in length and may contain any UTF-8 characters." } ] }, "docs": "Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it. Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. Objects can be up to 5 GiB in size when uploaded in a single PUT operation. For larger objects, use multipart upload." }, { "info": { "name": "Amazon S3 Delete Object", "type": "http" }, "http": { "method": "DELETE", "url": "https://s3-control.{region}.amazonaws.com/:Bucket/:Key+", "headers": [ { "name": "x-amz-mfa", "value": "example_value" }, { "name": "x-amz-request-payer", "value": "requester" }, { "name": "x-amz-bypass-governance-retention", "value": "true" }, { "name": "x-amz-expected-bucket-owner", "value": "example_value" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket. Bucket names must be between 3 and 63 characters long, consist only of lowercase letters, numbers, hyphens, and periods, and must begin and end with a letter or number." }, { "name": "Key+", "value": "", "type": "path", "description": "Key name of the object. The object key can be up to 1,024 bytes in length and may contain any UTF-8 characters." }, { "name": "versionId", "value": "500123", "type": "query", "description": "VersionId used to reference a specific version of the object." } ] }, "docs": "Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there is no null version, Amazon S3 does not remove any objects but will still respond that the command was successful. To remove a specific version, you must use the versionId sub-resource." }, { "info": { "name": "Amazon S3 Head Object", "type": "http" }, "http": { "method": "HEAD", "url": "https://s3-control.{region}.amazonaws.com/:Bucket/:Key+", "headers": [ { "name": "Range", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "x-amz-expected-bucket-owner", "value": "" }, { "name": "x-amz-request-payer", "value": "" }, { "name": "x-amz-checksum-mode", "value": "" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket. Bucket names must be between 3 and 63 characters long, consist only of lowercase letters, numbers, hyphens, and periods, and must begin and end with a letter or number." }, { "name": "Key+", "value": "", "type": "path", "description": "Key name of the object. The object key can be up to 1,024 bytes in length and may contain any UTF-8 characters." }, { "name": "versionId", "value": "", "type": "query", "description": "VersionId used to reference a specific version of the object." }, { "name": "partNumber", "value": "", "type": "query", "description": "Part number of the object being read for multipart objects." } ] }, "docs": "The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you are interested only in an object's metadata. A HEAD request has the same options as a GET action on an object." }, { "info": { "name": "Amazon S3 Copy Object", "type": "http" }, "http": { "method": "PUT", "url": "https://s3-control.{region}.amazonaws.com/:Bucket/:Key+?copy", "headers": [ { "name": "x-amz-copy-source", "value": "example_value" }, { "name": "x-amz-copy-source-if-match", "value": "example_value" }, { "name": "x-amz-copy-source-if-none-match", "value": "example_value" }, { "name": "x-amz-copy-source-if-modified-since", "value": "2026-01-15T10:30:00Z" }, { "name": "x-amz-copy-source-if-unmodified-since", "value": "2026-01-15T10:30:00Z" }, { "name": "x-amz-metadata-directive", "value": "COPY" }, { "name": "x-amz-tagging-directive", "value": "COPY" }, { "name": "x-amz-server-side-encryption", "value": "AES256" }, { "name": "x-amz-storage-class", "value": "STANDARD" }, { "name": "x-amz-acl", "value": "private" }, { "name": "x-amz-expected-bucket-owner", "value": "example_value" }, { "name": "x-amz-source-expected-bucket-owner", "value": "example_value" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket. Bucket names must be between 3 and 63 characters long, consist only of lowercase letters, numbers, hyphens, and periods, and must begin and end with a letter or number." }, { "name": "Key+", "value": "", "type": "path", "description": "Key name of the object. The object key can be up to 1,024 bytes in length and may contain any UTF-8 characters." } ] }, "docs": "Creates a copy of an object that is already stored in Amazon S3. You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets. Objects up to 5 GiB can be copied in a single operation. For objects larger than 5 GiB, you must use the multipart upload Copy API." }, { "info": { "name": "Amazon S3 Delete Objects", "type": "http" }, "http": { "method": "POST", "url": "https://s3-control.{region}.amazonaws.com/:Bucket?delete", "headers": [ { "name": "x-amz-mfa", "value": "example_value" }, { "name": "x-amz-request-payer", "value": "requester" }, { "name": "x-amz-bypass-governance-retention", "value": "true" }, { "name": "x-amz-expected-bucket-owner", "value": "example_value" }, { "name": "x-amz-checksum-algorithm", "value": "CRC32" } ], "params": [ { "name": "Bucket", "value": "", "type": "path", "description": "The name of the bucket. Bucket names must be between 3 and 63 characters long, consist only of lowercase letters, numbers, hyphens, and periods, and must begin and end with a letter or number." } ] }, "docs": "This action enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys in a single request. The request body contains the list of object keys to delete." } ] } ], "bundled": true }