ibm-cos-sdk
Version:
IBM SDK for JavaScript
1,887 lines (1,886 loc) • 120 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2006-03-01",
"checksumFormat": "md5",
"endpointPrefix": "s3",
"globalEndpoint": "s3.amazonaws.com",
"protocol": "rest-xml",
"serviceAbbreviation": "IBM COS",
"serviceFullName": "IBM Cloud Object Storage",
"serviceId": "S3",
"signatureVersion": "s3",
"timestampFormat": "rfc822",
"uid": "s3-2006-03-01",
"auth": [
"aws.auth#sigv4"
]
},
"operations": {
"AbortMultipartUpload": {
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}/{Key+}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key",
"UploadId"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"contextParam": {
"name": "Key"
},
"location": "uri",
"locationName": "Key"
},
"UploadId": {
"location": "querystring",
"locationName": "uploadId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AddLegalHold": {
"http": {
"requestUri": "/{Bucket}/{Key+}?legalHold&add={RetentionLegalHoldId}"
},
"input": {
"shape": "S6"
}
},
"CompleteMultipartUpload": {
"http": {
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key",
"UploadId"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"contextParam": {
"name": "Key"
},
"location": "uri",
"locationName": "Key"
},
"MultipartUpload": {
"locationName": "CompleteMultipartUpload",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
},
"type": "structure",
"members": {
"Parts": {
"locationName": "Part",
"type": "list",
"member": {
"type": "structure",
"members": {
"ETag": {},
"PartNumber": {
"type": "integer"
}
}
},
"flattened": true
}
}
},
"IfNoneMatch": {
"location": "header",
"locationName": "If-None-Match"
},
"RetentionExpirationDate": {
"shape": "Sf",
"location": "header",
"locationName": "Retention-Expiration-Date"
},
"RetentionLegalHoldId": {
"location": "header",
"locationName": "Retention-Legal-Hold-ID"
},
"RetentionPeriod": {
"location": "header",
"locationName": "Retention-Period",
"type": "integer"
},
"UploadId": {
"location": "querystring",
"locationName": "uploadId"
}
},
"payload": "MultipartUpload"
},
"output": {
"type": "structure",
"members": {
"Location": {},
"Bucket": {},
"Key": {},
"Expiration": {
"location": "header",
"locationName": "x-amz-expiration"
},
"ETag": {},
"ServerSideEncryption": {
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"VersionId": {
"location": "header",
"locationName": "x-amz-version-id"
},
"SSEKMSKeyId": {
"shape": "Sm",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
}
}
},
"httpChecksum": {
"requestChecksumRequired": true
}
},
"CopyObject": {
"http": {
"method": "PUT",
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"type": "structure",
"required": [
"Bucket",
"CopySource",
"Key"
],
"members": {
"ACL": {
"location": "header",
"locationName": "x-amz-acl"
},
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"CacheControl": {
"location": "header",
"locationName": "Cache-Control"
},
"ContentDisposition": {
"location": "header",
"locationName": "Content-Disposition"
},
"ContentEncoding": {
"location": "header",
"locationName": "Content-Encoding"
},
"ContentLanguage": {
"location": "header",
"locationName": "Content-Language"
},
"ContentType": {
"location": "header",
"locationName": "Content-Type"
},
"CopySource": {
"contextParam": {
"name": "CopySource"
},
"location": "header",
"locationName": "x-amz-copy-source"
},
"CopySourceIfMatch": {
"location": "header",
"locationName": "x-amz-copy-source-if-match"
},
"CopySourceIfModifiedSince": {
"location": "header",
"locationName": "x-amz-copy-source-if-modified-since",
"type": "timestamp"
},
"CopySourceIfNoneMatch": {
"location": "header",
"locationName": "x-amz-copy-source-if-none-match"
},
"CopySourceIfUnmodifiedSince": {
"location": "header",
"locationName": "x-amz-copy-source-if-unmodified-since",
"type": "timestamp"
},
"Expires": {
"location": "header",
"locationName": "Expires",
"type": "timestamp"
},
"GrantFullControl": {
"location": "header",
"locationName": "x-amz-grant-full-control"
},
"GrantRead": {
"location": "header",
"locationName": "x-amz-grant-read"
},
"GrantReadACP": {
"location": "header",
"locationName": "x-amz-grant-read-acp"
},
"GrantWriteACP": {
"location": "header",
"locationName": "x-amz-grant-write-acp"
},
"Key": {
"contextParam": {
"name": "Key"
},
"location": "uri",
"locationName": "Key"
},
"Metadata": {
"shape": "S14",
"location": "headers",
"locationName": "x-amz-meta-"
},
"MetadataDirective": {
"location": "header",
"locationName": "x-amz-metadata-directive"
},
"TaggingDirective": {
"location": "header",
"locationName": "x-amz-tagging-directive"
},
"RetentionDirective": {
"location": "header",
"locationName": "Retention-Directive"
},
"RetentionExpirationDate": {
"shape": "Sf",
"location": "header",
"locationName": "Retention-Expiration-Date"
},
"RetentionLegalHoldId": {
"location": "header",
"locationName": "Retention-Legal-Hold-ID"
},
"RetentionPeriod": {
"location": "header",
"locationName": "Retention-Period",
"type": "integer"
},
"ServerSideEncryption": {
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"StorageClass": {
"location": "header",
"locationName": "x-amz-storage-class"
},
"VersionId": {
"location": "querystring",
"locationName": "versionId"
},
"WebsiteRedirectLocation": {
"location": "header",
"locationName": "x-amz-website-redirect-location"
},
"SSECustomerAlgorithm": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "S1d",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "Sm",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"CopySourceSSECustomerAlgorithm": {
"location": "header",
"locationName": "x-amz-copy-source-server-side-encryption-customer-algorithm"
},
"CopySourceSSECustomerKey": {
"shape": "S1g",
"location": "header",
"locationName": "x-amz-copy-source-server-side-encryption-customer-key"
},
"CopySourceSSECustomerKeyMD5": {
"location": "header",
"locationName": "x-amz-copy-source-server-side-encryption-customer-key-MD5"
},
"Tagging": {
"location": "header",
"locationName": "x-amz-tagging"
},
"ObjectLockMode": {
"location": "header",
"locationName": "x-amz-object-lock-mode"
},
"ObjectLockRetainUntilDate": {
"shape": "S1k",
"location": "header",
"locationName": "x-amz-object-lock-retain-until-date"
},
"ObjectLockLegalHoldStatus": {
"location": "header",
"locationName": "x-amz-object-lock-legal-hold"
}
}
},
"output": {
"type": "structure",
"members": {
"CopyObjectResult": {
"type": "structure",
"members": {
"ETag": {},
"LastModified": {
"type": "timestamp"
}
}
},
"Expiration": {
"location": "header",
"locationName": "x-amz-expiration"
},
"CopySourceVersionId": {
"location": "header",
"locationName": "x-amz-copy-source-version-id"
},
"VersionId": {
"location": "header",
"locationName": "x-amz-version-id"
},
"ServerSideEncryption": {
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"SSECustomerAlgorithm": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "Sm",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
}
},
"payload": "CopyObjectResult"
},
"alias": "PutObjectCopy"
},
"CreateBucket": {
"http": {
"method": "PUT",
"requestUri": "/{Bucket}"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"ACL": {
"location": "header",
"locationName": "x-amz-acl"
},
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"CreateBucketConfiguration": {
"locationName": "CreateBucketConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
},
"type": "structure",
"members": {
"LocationConstraint": {}
}
},
"GrantFullControl": {
"location": "header",
"locationName": "x-amz-grant-full-control"
},
"GrantRead": {
"location": "header",
"locationName": "x-amz-grant-read"
},
"GrantReadACP": {
"location": "header",
"locationName": "x-amz-grant-read-acp"
},
"GrantWrite": {
"location": "header",
"locationName": "x-amz-grant-write"
},
"GrantWriteACP": {
"location": "header",
"locationName": "x-amz-grant-write-acp"
},
"ObjectLockEnabledForBucket": {
"location": "header",
"locationName": "x-amz-bucket-object-lock-enabled",
"type": "boolean"
},
"IBMServiceInstanceId": {
"location": "header",
"locationName": "Ibm-Service-Instance-Id"
},
"IBMSSEKPEncryptionAlgorithm": {
"location": "header",
"locationName": "ibm-sse-kp-encryption-algorithm"
},
"IBMSSEKPCustomerRootKeyCrn": {
"location": "header",
"locationName": "ibm-sse-kp-customer-root-key-crn"
}
},
"payload": "CreateBucketConfiguration"
},
"output": {
"type": "structure",
"members": {
"Location": {
"location": "header",
"locationName": "Location"
}
}
},
"alias": "PutBucket"
},
"CreateMultipartUpload": {
"http": {
"requestUri": "/{Bucket}/{Key+}?uploads"
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"ACL": {
"location": "header",
"locationName": "x-amz-acl"
},
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"CacheControl": {
"location": "header",
"locationName": "Cache-Control"
},
"ContentDisposition": {
"location": "header",
"locationName": "Content-Disposition"
},
"ContentEncoding": {
"location": "header",
"locationName": "Content-Encoding"
},
"ContentLanguage": {
"location": "header",
"locationName": "Content-Language"
},
"ContentType": {
"location": "header",
"locationName": "Content-Type"
},
"Expires": {
"location": "header",
"locationName": "Expires",
"type": "timestamp"
},
"GrantFullControl": {
"location": "header",
"locationName": "x-amz-grant-full-control"
},
"GrantRead": {
"location": "header",
"locationName": "x-amz-grant-read"
},
"GrantReadACP": {
"location": "header",
"locationName": "x-amz-grant-read-acp"
},
"GrantWriteACP": {
"location": "header",
"locationName": "x-amz-grant-write-acp"
},
"Key": {
"contextParam": {
"name": "Key"
},
"location": "uri",
"locationName": "Key"
},
"Metadata": {
"shape": "S14",
"location": "headers",
"locationName": "x-amz-meta-"
},
"ServerSideEncryption": {
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"StorageClass": {
"location": "header",
"locationName": "x-amz-storage-class"
},
"WebsiteRedirectLocation": {
"location": "header",
"locationName": "x-amz-website-redirect-location"
},
"SSECustomerAlgorithm": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "S1d",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "Sm",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"Tagging": {
"location": "header",
"locationName": "x-amz-tagging"
},
"ObjectLockMode": {
"location": "header",
"locationName": "x-amz-object-lock-mode"
},
"ObjectLockRetainUntilDate": {
"shape": "S1k",
"location": "header",
"locationName": "x-amz-object-lock-retain-until-date"
},
"ObjectLockLegalHoldStatus": {
"location": "header",
"locationName": "x-amz-object-lock-legal-hold"
}
}
},
"output": {
"type": "structure",
"members": {
"AbortDate": {
"location": "header",
"locationName": "x-amz-abort-date",
"type": "timestamp"
},
"AbortRuleId": {
"location": "header",
"locationName": "x-amz-abort-rule-id"
},
"Bucket": {
"locationName": "Bucket"
},
"Key": {},
"UploadId": {},
"ServerSideEncryption": {
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"SSECustomerAlgorithm": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "Sm",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
}
}
},
"alias": "InitiateMultipartUpload"
},
"DeleteBucket": {
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
}
},
"DeleteBucketCors": {
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?cors",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
}
},
"DeleteLegalHold": {
"http": {
"requestUri": "/{Bucket}/{Key+}?legalHold&remove={RetentionLegalHoldId}"
},
"input": {
"shape": "S6"
}
},
"DeleteBucketLifecycle": {
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?lifecycle",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
}
},
"DeleteBucketReplication": {
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?replication",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
}
},
"DeleteBucketTagging": {
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?tagging",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
}
},
"DeleteBucketWebsite": {
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?website",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
}
},
"DeleteObject": {
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}/{Key+}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"contextParam": {
"name": "Key"
},
"location": "uri",
"locationName": "Key"
},
"MFA": {
"location": "header",
"locationName": "x-amz-mfa"
},
"VersionId": {
"location": "querystring",
"locationName": "versionId"
},
"BypassGovernanceRetention": {
"location": "header",
"locationName": "x-amz-bypass-governance-retention",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {
"DeleteMarker": {
"location": "header",
"locationName": "x-amz-delete-marker",
"type": "boolean"
},
"VersionId": {
"location": "header",
"locationName": "x-amz-version-id"
}
}
}
},
"DeleteObjectTagging": {
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}/{Key+}?tagging",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"location": "querystring",
"locationName": "versionId"
}
}
},
"output": {
"type": "structure",
"members": {
"VersionId": {
"location": "header",
"locationName": "x-amz-version-id"
}
}
}
},
"DeleteObjects": {
"http": {
"requestUri": "/{Bucket}?delete"
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Delete"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"Delete": {
"locationName": "Delete",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
},
"type": "structure",
"required": [
"Objects"
],
"members": {
"Objects": {
"locationName": "Object",
"type": "list",
"member": {
"type": "structure",
"required": [
"Key"
],
"members": {
"Key": {},
"VersionId": {}
}
},
"flattened": true
},
"Quiet": {
"type": "boolean"
}
}
},
"MFA": {
"location": "header",
"locationName": "x-amz-mfa"
},
"BypassGovernanceRetention": {
"location": "header",
"locationName": "x-amz-bypass-governance-retention",
"type": "boolean"
}
},
"payload": "Delete"
},
"output": {
"type": "structure",
"members": {
"Deleted": {
"type": "list",
"member": {
"type": "structure",
"members": {
"Key": {},
"VersionId": {},
"DeleteMarker": {
"type": "boolean"
},
"DeleteMarkerVersionId": {}
}
},
"flattened": true
},
"Errors": {
"locationName": "Error",
"type": "list",
"member": {
"type": "structure",
"members": {
"Key": {},
"VersionId": {},
"Code": {},
"Message": {}
}
},
"flattened": true
}
}
},
"alias": "DeleteMultipleObjects",
"httpChecksum": {
"requestChecksumRequired": true
}
},
"ExtendObjectRetention": {
"http": {
"requestUri": "/{Bucket}/{Key+}?extendRetention"
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"location": "uri",
"locationName": "Key"
},
"AdditionalRetentionPeriod": {
"location": "header",
"locationName": "Additional-Retention-Period",
"type": "integer"
},
"ExtendRetentionFromCurrentTime": {
"location": "header",
"locationName": "Extend-Retention-From-Current-Time",
"type": "integer"
},
"NewRetentionExpirationDate": {
"location": "header",
"locationName": "New-Retention-Expiration-Date",
"type": "timestamp",
"timestampFormat": "iso8601"
},
"NewRetentionPeriod": {
"location": "header",
"locationName": "New-Retention-Period",
"type": "integer"
}
}
}
},
"DeletePublicAccessBlock": {
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?publicAccessBlock",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"ExpectedBucketOwner": {
"location": "header",
"locationName": "x-amz-expected-bucket-owner"
}
}
}
},
"GetBucketAcl": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?acl"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
},
"output": {
"type": "structure",
"members": {
"Owner": {
"shape": "S33"
},
"Grants": {
"shape": "S36",
"locationName": "AccessControlList"
}
}
}
},
"GetBucketCors": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?cors"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"MirrorDestination": {
"location": "header",
"locationName": "Mirror-Destination"
}
}
},
"output": {
"type": "structure",
"members": {
"CORSRules": {
"shape": "S3g",
"locationName": "CORSRule"
}
}
}
},
"GetBucketLifecycle": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?lifecycle"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
},
"output": {
"type": "structure",
"members": {
"Rules": {
"locationName": "Rule",
"type": "list",
"member": {
"type": "structure",
"required": [
"Prefix",
"Status"
],
"members": {
"Expiration": {
"shape": "S3v"
},
"ID": {},
"Prefix": {},
"Status": {},
"Transition": {
"shape": "S41"
},
"NoncurrentVersionExpiration": {
"shape": "S43"
},
"AbortIncompleteMultipartUpload": {
"shape": "S45"
}
}
},
"flattened": true
}
}
},
"deprecated": true
},
"GetBucketLifecycleConfiguration": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?lifecycle"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
},
"output": {
"type": "structure",
"members": {
"Rules": {
"shape": "S49",
"locationName": "Rule"
}
}
}
},
"GetBucketLocation": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?location"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
},
"output": {
"type": "structure",
"members": {
"LocationConstraint": {}
}
}
},
"GetBucketProtectionConfiguration": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?protection"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
},
"output": {
"type": "structure",
"members": {
"Status": {},
"MinimumRetention": {
"shape": "S4o"
},
"DefaultRetention": {
"shape": "S4p"
},
"MaximumRetention": {
"shape": "S4q"
},
"EnablePermanentRetention": {
"type": "boolean"
},
"IbmProtectionManagementState": {
"location": "header",
"locationName": "x-ibm-protection-management-state"
}
}
}
},
"GetBucketReplication": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?replication"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
},
"output": {
"type": "structure",
"members": {
"ReplicationConfiguration": {
"shape": "S4v"
}
},
"payload": "ReplicationConfiguration"
}
},
"GetBucketTagging": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?tagging"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"MirrorDestination": {
"location": "header",
"locationName": "Mirror-Destination"
}
}
},
"output": {
"type": "structure",
"required": [
"TagSet"
],
"members": {
"TagSet": {
"shape": "S4h"
}
}
}
},
"GetBucketVersioning": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?versioning"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
},
"output": {
"type": "structure",
"members": {
"Status": {},
"MFADelete": {
"locationName": "MfaDelete"
}
}
}
},
"GetBucketWebsite": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?website"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
}
}
},
"output": {
"type": "structure",
"members": {
"RedirectAllRequestsTo": {
"shape": "S5e"
},
"IndexDocument": {
"shape": "S5h"
},
"ErrorDocument": {
"shape": "S5j"
},
"RoutingRules": {
"shape": "S5k"
}
}
}
},
"GetObject": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"IfMatch": {
"location": "header",
"locationName": "If-Match"
},
"IfModifiedSince": {
"location": "header",
"locationName": "If-Modified-Since",
"type": "timestamp"
},
"IfNoneMatch": {
"location": "header",
"locationName": "If-None-Match"
},
"IfUnmodifiedSince": {
"location": "header",
"locationName": "If-Unmodified-Since",
"type": "timestamp"
},
"Key": {
"contextParam": {
"name": "Key"
},
"location": "uri",
"locationName": "Key"
},
"MirrorDestination": {
"location": "header",
"locationName": "Mirror-Destination"
},
"Range": {
"location": "header",
"locationName": "Range"
},
"ResponseCacheControl": {
"location": "querystring",
"locationName": "response-cache-control"
},
"ResponseContentDisposition": {
"location": "querystring",
"locationName": "response-content-disposition"
},
"ResponseContentEncoding": {
"location": "querystring",
"locationName": "response-content-encoding"
},
"ResponseContentLanguage": {
"location": "querystring",
"locationName": "response-content-language"
},
"ResponseContentType": {
"location": "querystring",
"locationName": "response-content-type"
},
"ResponseExpires": {
"location": "querystring",
"locationName": "response-expires",
"type": "timestamp",
"timestampFormat": "rfc822"
},
"VersionId": {
"location": "querystring",
"locationName": "versionId"
},
"SSECustomerAlgorithm": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "S1d",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"PartNumber": {
"location": "querystring",
"locationName": "partNumber",
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"Body": {
"streaming": true,
"type": "blob"
},
"DeleteMarker": {
"location": "header",
"locationName": "x-amz-delete-marker",
"type": "boolean"
},
"AcceptRanges": {
"location": "header",
"locationName": "accept-ranges"
},
"Expiration": {
"location": "header",
"locationName": "x-amz-expiration"
},
"Restore": {
"location": "header",
"locationName": "x-amz-restore"
},
"LastModified": {
"location": "header",
"locationName": "Last-Modified",
"type": "timestamp"
},
"ContentLength": {
"location": "header",
"locationName": "Content-Length",
"type": "long"
},
"ETag": {
"location": "header",
"locationName": "ETag"
},
"VersionId": {
"location": "header",
"locationName": "x-amz-version-id"
},
"CacheControl": {
"location": "header",
"locationName": "Cache-Control"
},
"ContentDisposition": {
"location": "header",
"locationName": "Content-Disposition"
},
"ContentEncoding": {
"location": "header",
"locationName": "Content-Encoding"
},
"ContentLanguage": {
"location": "header",
"locationName": "Content-Language"
},
"ContentRange": {
"location": "header",
"locationName": "Content-Range"
},
"ContentType": {
"location": "header",
"locationName": "Content-Type"
},
"Expires": {
"location": "header",
"locationName": "Expires",
"deprecated": true,
"type": "timestamp"
},
"ExpiresString": {
"location": "header",
"locationName": "ExpiresString"
},
"WebsiteRedirectLocation": {
"location": "header",
"locationName": "x-amz-website-redirect-location"
},
"ServerSideEncryption": {
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"Metadata": {
"shape": "S14",
"location": "headers",
"locationName": "x-amz-meta-"
},
"RetentionExpirationDate": {
"shape": "Sf",
"location": "header",
"locationName": "Retention-Expiration-Date"
},
"RetentionLegalHoldCount": {
"location": "header",
"locationName": "Retention-Legal-Hold-Count",
"type": "integer"
},
"RetentionPeriod": {
"location": "header",
"locationName": "Retention-Period",
"type": "integer"
},
"RetentionPeriodSource": {
"location": "header",
"locationName": "Retention-Period-Source"
},
"SSECustomerAlgorithm": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5": {
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "Sm",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"StorageClass": {
"location": "header",
"locationName": "x-amz-storage-class"
},
"PartsCount": {
"location": "header",
"locationName": "x-amz-mp-parts-count",
"type": "integer"
},
"TagCount": {
"location": "header",
"locationName": "x-amz-tagging-count",
"type": "integer"
},
"ObjectLockMode": {
"location": "header",
"locationName": "x-amz-object-lock-mode"
},
"ObjectLockRetainUntilDate": {
"shape": "S1k",
"location": "header",
"locationName": "x-amz-object-lock-retain-until-date"
},
"ObjectLockLegalHoldStatus": {
"location": "header",
"locationName": "x-amz-object-lock-legal-hold"
},
"TemporaryCopyStorageClass": {
"location": "header",
"locationName": "x-ibm-restored-copy-storage-class"
},
"Transition": {
"location": "header",
"locationName": "x-ibm-transition"
}
},
"payload": "Body"
}
},
"GetObjectAcl": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}?acl"
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"contextParam": {
"name": "Key"
},
"location": "uri",
"locationName": "Key"
},
"MirrorDestination": {
"location": "header",
"locationName": "Mirror-Destination"
},
"VersionId": {
"location": "querystring",
"locationName": "versionId"
}
}
},
"output": {
"type": "structure",
"members": {
"Owner": {
"shape": "S33"
},
"Grants": {
"shape": "S36",
"locationName": "AccessControlList"
}
}
}
},
"GetObjectLegalHold": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}?legal-hold"
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"location": "querystring",
"locationName": "versionId"
},
"ExpectedBucketOwner": {
"location": "header",
"locationName": "x-amz-expected-bucket-owner"
}
}
},
"output": {
"type": "structure",
"members": {
"LegalHold": {
"shape": "S6k",
"locationName": "LegalHold"
}
},
"payload": "LegalHold"
}
},
"GetObjectLockConfiguration": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}?object-lock"
},
"input": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"ExpectedBucketOwner": {
"location": "header",
"locationName": "x-amz-expected-bucket-owner"
}
}
},
"output": {
"type": "structure",
"members": {
"ObjectLockConfiguration": {
"shape": "S6n"
},
"IbmProtectionManagementState": {
"location": "header",
"locationName": "x-ibm-protection-management-state"
}
},
"payload": "ObjectLockConfiguration"
}
},
"GetObjectRetention": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}?retention"
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"location": "querystring",
"locationName": "versionId"
},
"ExpectedBucketOwner": {
"location": "header",
"locationName": "x-amz-expected-bucket-owner"
}
}
},
"output": {
"type": "structure",
"members": {
"Retention": {
"shape": "S6v",
"locationName": "Retention"
}
},
"payload": "Retention"
}
},
"GetObjectTagging": {
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}?tagging"
},
"input": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"contextParam": {
"name": "Bucket"
},
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"location": "querystring",
"locationName": "versionId"
}
}
},
"output": {
"type": "structure",
"required": [