Get S3 Capabilities

Get S3 Capabilities

Operation ID: getS3Capabilities
Get S3 capabilities of the platform

Request
URI
GET
https://{api_host}/osis/api/v1/s3capabilities
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Return S3 capabilities of the platform in exclusion mode.

  • If the platform S3 is fully compliant with Amazon S3, return an empty object.
  • If not, return excluded S3 capabilities in the exclusions field.
    • If a S3 action is completely not supported, exclude it with API code and an empty object as value. For instance, GetBucketVersioning is not supported, .
    • If a S3 action is partially not supported, exclude it with API code and specific excluded area by params, by header or by payload. For instance, GetObject does not support query parameter partNummber, and response header response-cache-control, .

Returns OsisS3Capabilities of type(s) application/json
Operation doesn't return any data structure
object
exclusions
Optional

S3 capabilities in exclusion mode. If a S3 capability is in the exclusions, it is not supported, either completely or partially. A S3 capability is a S3 API code in snake case. For example S3 CopyObject action in OSIS API code is named copy_object. For full S3 actions, please refer to https://docs.aws.amazon.com/AmazonS3/latest/API/Type_API_Reference.html.

  • If the platform S3 is fully compliant with Amazon S3, return an empty object.
  • If not, return excluded S3 capabilities in the exclusions field.
    • If a S3 action is completely not supported, exclude it with API code and an empty object as value. For instance, GetBucketVersioning is not supported, .
    • If a S3 action is partially not supported, exclude it with API code and specific excluded area by params, by header or by payload. For instance, GetObject does not support query parameter partNummber, and response header response-cache-control, .


On This Page
S3capability Operations
GET
Get S3 Capabilities