basePath: /
consumes:
- application/json
definitions:
  AccessTargetDetails:
    description: 'Details of the targets that can be accessed by the private endpoint.

      '
    properties:
      bucket:
        description: 'The name of the bucket. Avoid entering confidential information.
          Wildcards (''*'') are allowed. If value is ''*'', it means all buckets in
          the specified namespace and compartment can be accessed. It cannot be a
          regex.

          Example: my-new-bucket1

          '
        maxLength: 256
        minLength: 1
        type: string
      compartmentId:
        description: The compartment ID which the private endpoint can access. Wildcards
          ('*') are allowed. If value is '*', it means all compartments in the specified
          namespace can be accessed. It cannot be a regex.
        maxLength: 255
        minLength: 1
        type: string
      namespace:
        description: The Object Storage namespace which the private endpoint can access.
          Wildcards ('*') are allowed. If value is '*', it means all namespaces can
          be accessed. It cannot be a regex.
        maxLength: 1024
        minLength: 1
        type: string
    required:
    - namespace
    - compartmentId
    - bucket
  ArchivalState:
    description: Archival state of an object which is in Archive tier.
    enum: &id002
    - Archived
    - Restoring
    - Restored
    type: string
  BatchDeleteObjectIdentifier:
    description: 'Delete object details.

      '
    properties:
      ifMatch:
        description: 'The entity tag (ETag) to match. Avoid entering confidential
          information.

          Example: etag1

          '
        maxLength: 64
        minLength: 1
        type: string
      objectName:
        description: 'The name of the object to delete. Avoid entering confidential
          information.

          Example: test/object1.log

          '
        maxLength: 1024
        minLength: 1
        type: string
    required:
    - objectName
  BatchDeleteObjectsDetails:
    description: 'Batch delete request details.

      '
    properties:
      isSkipDeletedResult:
        default: false
        description: 'Specifies whether to skip the details of successfully deleted
          objects in the response. If specified true

          then only the details of failed deletes will be available in the response.
          Defaults to false.

          '
        type: boolean
      objects:
        description: 'The list of the objects to delete.

          '
        items:
          $ref: '#/definitions/BatchDeleteObjectIdentifier'
        maxItems: 1000
        type: array
    required:
    - objects
  BatchDeleteObjectsResult:
    description: 'Result of a batch delete operation.

      '
    properties:
      deleted:
        description: 'Details of successfully deleted objects.

          '
        items:
          $ref: '#/definitions/DeletedObjectResult'
        type: array
      failed:
        description: 'Details of failed delete operations.

          '
        items:
          $ref: '#/definitions/FailedObjectResult'
        type: array
    required:
    - deleted
  Bucket:
    description: 'A bucket is a container for storing objects in a compartment within
      a namespace. A bucket is associated with a single compartment.

      The compartment has policies that indicate what actions a user can perform on
      a bucket and all the objects in the bucket. For more

      information, see [Managing Buckets](/Content/Object/Tasks/managingbuckets.htm).


      To use any of the API operations, you must be authorized in an IAM policy. If
      you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      approximateCount:
        description: 'The approximate number of objects in the bucket. Count statistics
          are reported periodically. You will see a

          lag between what is displayed and the actual object count.

          '
        format: int64
        type: integer
      approximateSize:
        description: 'The approximate total size in bytes of all objects in the bucket.
          Size statistics are reported periodically. You will

          see a lag between what is displayed and the actual size of the bucket.

          '
        format: int64
        type: integer
      autoTiering:
        description: 'The auto tiering status on the bucket. A bucket is created with
          auto tiering `Disabled` by default.

          For auto tiering `InfrequentAccess`, objects are transitioned automatically
          between the ''Standard''

          and ''InfrequentAccess'' tiers based on the access pattern of the objects.

          '
        enum:
        - Disabled
        - InfrequentAccess
        type: string
      bucketScope:
        description: 'The bucket scope determines weather the bucket name must be
          unique within the tenancy and region (essentially the namespace) or across
          all tenancies in the region. The bucket scope also determines if the bucket
          supports S3 virtual-hosted style URL''s or not.


          Allowed values:

          NAMESPACE: Only supports path-style bucket access, bucket name only needs
          to be unique within the tenancy and region.

          REGION: Supports both path-style and virtual-hosted URL style access, bucket
          name needs to be unique across all tenancies in the region.

          '
        enum:
        - NAMESPACE
        - REGION
        type: string
      compartmentId:
        description: The compartment ID in which the bucket is authorized.
        type: string
      createdBy:
        description: The [OCID](/Content/General/Concepts/identifiers.htm) of the
          user who created the bucket.
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.

            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      etag:
        description: The entity tag (ETag) for the bucket.
        type: string
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair with no predefined name, type, or namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Department": "Finance"}`

          '
        type: object
      id:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          bucket.

          '
        type: string
      isBucketKeyEnabled:
        description: 'Specifies whether Object Storage should use intermediate cached
          Bucket Encryption Keys with server-side

          encryption using KMS (SSE-KMS) for new objects in the bucket. This reduces
          calls to OCI Vault Key Management

          Service (KMS). Existing objects are not affected.

          '
        type: boolean
      isReadOnly:
        description: 'Whether or not this bucket is read only. By default, `isReadOnly`
          is set to `false`. This will

          be set to ''true'' when this bucket is configured as a destination in a
          replication policy.

          '
        type: boolean
      kmsKeyId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a master
          encryption key used to call the Key Management

          service to generate a data encryption key or to encrypt or decrypt a data
          encryption key.

          '
        type: string
      metadata:
        additionalProperties:
          type: string
        description: Arbitrary string keys and values for user-defined metadata.
        type: object
      name:
        description: 'The name of the bucket. Avoid entering confidential information.

          Example: my-new-bucket1

          '
        type: string
      namespace:
        description: The Object Storage namespace in which the bucket resides.
        type: string
      objectEventsEnabled:
        description: 'Whether or not events are emitted for object state changes in
          this bucket. By default, `objectEventsEnabled` is

          set to `false`. Set `objectEventsEnabled` to `true` to emit events for object
          state changes. For more information

          about events, see [Overview of Events](/Content/Events/Concepts/eventsoverview.htm).

          '
        type: boolean
      objectLifecyclePolicyEtag:
        description: The entity tag (ETag) for the live object lifecycle policy on
          the bucket.
        type: string
      publicAccessType:
        description: 'The type of public access enabled on this bucket.

          A bucket is set to `NoPublicAccess` by default, which only allows an authenticated
          caller to access the

          bucket and its contents. When `ObjectRead` is enabled on the bucket, public
          access is allowed for the

          `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList`
          is enabled on the

          bucket, public access is allowed for the `GetObject` and `HeadObject` operations.

          '
        enum:
        - NoPublicAccess
        - ObjectRead
        - ObjectReadWithoutList
        type: string
      replicationEnabled:
        description: 'Whether or not this bucket is a replication source. By default,
          `replicationEnabled` is set to `false`. This will

          be set to ''true'' when you create a replication policy for the bucket.

          '
        type: boolean
      storageTier:
        description: 'The storage tier type assigned to the bucket. A bucket is set
          to `Standard` tier by default, which means

          objects uploaded or copied to the bucket will be in the standard storage
          tier. When the `Archive` tier type

          is set explicitly for a bucket, objects uploaded or copied to the bucket
          will be stored in archive storage.

          The `storageTier` property is immutable after bucket is created.

          '
        enum:
        - Standard
        - Archive
        type: string
      timeCreated:
        description: The date and time the bucket was created, as described in [RFC
          2616](https://tools.ietf.org/html/rfc2616#section-14.29).
        format: date-time
        type: string
      versioning:
        description: 'The versioning status on the bucket. A bucket is created with
          versioning `Disabled` by default.

          For versioning `Enabled`, objects are protected from overwrites and deletes,
          by maintaining their version history. When versioning is `Suspended`, the
          previous versions will still remain but new versions will no longer be created
          when overwitten or deleted.

          '
        enum:
        - Enabled
        - Suspended
        - Disabled
        type: string
    required:
    - namespace
    - name
    - compartmentId
    - createdBy
    - timeCreated
    - metadata
    - etag
  BucketSummary:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      bucketScope:
        description: 'The bucket scope determines weather the bucket name must be
          unique within the tenancy and region (essentially the namespace) or across
          all tenancies in the region. The bucket scope also determines if the bucket
          supports S3 virtual-hosted style URL''s or not.


          Allowed values:

          NAMESPACE: Only supports path-style bucket access, bucket name only needs
          to be unique within the tenancy and region.

          REGION: Supports both path-style and virtual-hosted URL style access, bucket
          name needs to be unique across all tenancies in the region.

          '
        type: string
        x-obmcs-enumref: '#/definitions/Bucket/bucketScope'
      compartmentId:
        description: The compartment ID in which the bucket is authorized.
        type: string
      createdBy:
        description: The [OCID](/Content/General/Concepts/identifiers.htm) of the
          user who created the bucket.
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.

            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      etag:
        description: The entity tag (ETag) for the bucket.
        type: string
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair with no predefined name, type, or namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Department": "Finance"}`

          '
        type: object
      name:
        description: 'The name of the bucket. Avoid entering confidential information.

          Example: my-new-bucket1

          '
        type: string
      namespace:
        description: The Object Storage namespace in which the bucket lives.
        type: string
      timeCreated:
        description: The date and time the bucket was created, as described in [RFC
          2616](https://tools.ietf.org/html/rfc2616#section-14.29).
        format: date-time
        type: string
    required:
    - namespace
    - name
    - compartmentId
    - createdBy
    - timeCreated
    - etag
  CommitMultipartUploadDetails:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      partsToCommit:
        description: The part numbers and entity tags (ETags) for the parts to be
          committed.
        items:
          $ref: '#/definitions/CommitMultipartUploadPartDetails'
        type: array
      partsToExclude:
        description: 'The part numbers for the parts to be excluded from the completed
          object.

          Each part created for this upload must be in either partsToExclude or partsToCommit,
          but cannot be in both.

          '
        items:
          type: integer
        type: array
    required:
    - partsToCommit
  CommitMultipartUploadPartDetails:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      etag:
        description: The entity tag (ETag) returned when this part was uploaded.
        type: string
      partNum:
        description: The part number for this part.
        type: integer
    required:
    - partNum
    - etag
  CopyObjectDetails:
    description: 'The parameters required by Object Storage to process a request to
      copy an object to another bucket.


      To use any of the API operations, you must be authorized in an IAM policy. If
      you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      destinationBucket:
        description: The destination bucket the object will be copied to.
        type: string
      destinationNamespace:
        description: The destination Object Storage namespace the object will be copied
          to.
        type: string
      destinationObjectIfMatchETag:
        description: 'The entity tag (ETag) to match against that of the destination
          object (an object intended to be overwritten).

          Used to confirm that the destination object stored under a given name is
          the version of that object

          storing a specified entity tag.

          '
        type: string
      destinationObjectIfNoneMatchETag:
        description: 'The entity tag (ETag) to avoid matching. The only valid value
          is ''*'', which indicates that the request should fail

          if the object already exists in the destination bucket.

          '
        type: string
      destinationObjectMetadata:
        additionalProperties:
          type: string
        description: 'Arbitrary string keys and values for the user-defined metadata
          for the object. Keys must be in

          "opc-meta-*" format. Avoid entering confidential information. Metadata key-value
          pairs entered

          in this field are assigned to the destination object. If you enter no metadata
          values, the destination

          object will inherit any existing metadata values associated with the source
          object.

          '
        type: object
      destinationObjectName:
        description: The name of the destination object resulting from the copy operation.
          Avoid entering confidential information.
        type: string
      destinationObjectStorageTier:
        description: 'The storage tier that the object should be stored in. If not
          specified, the object will be stored in

          the same storage tier as the bucket.

          '
        enum: &id001
        - Standard
        - InfrequentAccess
        - Archive
        type: string
        x-obmcs-top-level-enum: '#/definitions/StorageTier'
      destinationRegion:
        description: The destination region the object will be copied to, for example
          "us-ashburn-1".
        type: string
      sourceObjectIfMatchETag:
        description: 'The entity tag (ETag) to match against that of the source object.
          Used to confirm that the source object

          with a given name is the version of that object storing a specified ETag.

          '
        type: string
      sourceObjectName:
        description: The name of the object to be copied.
        type: string
      sourceVersionId:
        description: VersionId of the object to copy. If not provided then current
          version is copied by default.
        type: string
    required:
    - sourceObjectName
    - destinationRegion
    - destinationNamespace
    - destinationBucket
    - destinationObjectName
  CreateBucketDetails:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      autoTiering:
        description: 'Set the auto tiering status on the bucket. By default, a bucket
          is created with auto tiering `Disabled`.

          Use this option to enable auto tiering during bucket creation. Objects in
          a bucket with auto tiering set to

          `InfrequentAccess` are transitioned automatically between the ''Standard''
          and ''InfrequentAccess''

          tiers based on the access pattern of the objects.

          '
        type: string
        x-obmcs-enumref: '#/definitions/Bucket/autoTiering'
      bucketScope:
        description: 'The bucket scope determines weather the bucket name must be
          unique within the tenancy and region (essentially the namespace) or across
          all tenancies in the region. The bucket scope also determines if the bucket
          supports S3 virtual-hosted style URL''s or not.


          Allowed values:

          NAMESPACE: Only supports path-style bucket access, bucket name only needs
          to be unique within the tenancy and region.

          REGION: Supports both path-style and virtual-hosted URL style access, bucket
          name needs to be unique across all tenancies in the region.

          '
        type: string
        x-obmcs-enumref: '#/definitions/Bucket/bucketScope'
      compartmentId:
        description: The ID of the compartment in which to create the bucket.
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.

            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair with no predefined name, type, or namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Department": "Finance"}`

          '
        type: object
      isBucketKeyEnabled:
        description: 'Specifies whether Object Storage should use intermediate cached
          Bucket Encryption Keys with server-side

          encryption using KMS (SSE-KMS) for new objects in the bucket. This reduces
          calls to OCI Vault Key Management

          Service (KMS). Existing objects are not affected.

          '
        type: boolean
      kmsKeyId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a master
          encryption key used to call the Key

          Management service to generate a data encryption key or to encrypt or decrypt
          a data encryption key.

          '
        type: string
      metadata:
        additionalProperties:
          type: string
        description: Arbitrary string, up to 4KB, of keys and values for user-defined
          metadata.
        type: object
      name:
        description: 'The name of the bucket. Valid characters are uppercase or lowercase
          letters, numbers, hyphens, underscores, and periods.

          Bucket names must be unique within an Object Storage namespace. Avoid entering
          confidential information.

          example: Example: my-new-bucket1

          '
        maxLength: 256
        minLength: 1
        type: string
      objectEventsEnabled:
        description: 'Whether or not events are emitted for object state changes in
          this bucket. By default, `objectEventsEnabled` is

          set to `false`. Set `objectEventsEnabled` to `true` to emit events for object
          state changes. For more information

          about events, see [Overview of Events](/Content/Events/Concepts/eventsoverview.htm).

          '
        type: boolean
      publicAccessType:
        description: 'The type of public access enabled on this bucket.

          A bucket is set to `NoPublicAccess` by default, which only allows an authenticated
          caller to access the

          bucket and its contents. When `ObjectRead` is enabled on the bucket, public
          access is allowed for the

          `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList`
          is enabled on the bucket,

          public access is allowed for the `GetObject` and `HeadObject` operations.

          '
        enum:
        - NoPublicAccess
        - ObjectRead
        - ObjectReadWithoutList
        type: string
      storageTier:
        description: 'The type of storage tier of this bucket.

          A bucket is set to ''Standard'' tier by default, which means the bucket
          will be put in the standard storage tier.

          When ''Archive'' tier type is set explicitly, the bucket is put in the Archive
          Storage tier. The ''storageTier''

          property is immutable after bucket is created.

          '
        enum:
        - Standard
        - Archive
        type: string
      versioning:
        description: 'Set the versioning status on the bucket. By default, a bucket
          is created with versioning `Disabled`. Use this option to enable versioning
          during bucket creation. Objects in a version enabled bucket are protected
          from overwrites and deletions. Previous versions of the same object will
          be available in the bucket.

          '
        enum:
        - Enabled
        - Disabled
        type: string
    required:
    - name
    - compartmentId
  CreateInventoryRuleDetails:
    allOf:
    - $ref: '#/definitions/InventoryRuleDetails'
    description: The details to create a inventory rule.
    type: object
  CreateMultipartUploadDetails:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      cacheControl:
        description: 'The optional Cache-Control header that defines the caching behavior
          value to be returned in GetObject and

          HeadObject responses. Specifying values for this header has no effect on
          Object Storage behavior. Programs

          that read the object determine what to do based on the value provided.

          For example, you could use this header to identify objects that require
          caching restrictions.

          '
        type: string
      contentDisposition:
        description: 'The optional Content-Disposition header that defines presentational
          information for the object to be

          returned in GetObject and HeadObject responses. Specifying values for this
          header has no effect on Object

          Storage behavior. Programs that read the object determine what to do based
          on the value provided.

          For example, you could use this header to let users download objects with
          custom filenames in a browser.

          '
        type: string
      contentEncoding:
        description: 'The optional Content-Encoding header that defines the content
          encodings that were applied to the object to

          upload. Specifying values for this header has no effect on Object Storage
          behavior. Programs that read the

          object determine what to do based on the value provided. For example, you
          could use this header to determine

          what decoding mechanisms need to be applied to obtain the media-type specified
          by the Content-Type header of

          the object.

          '
        type: string
      contentLanguage:
        description: 'The optional Content-Language header that defines the content
          language of the object to upload. Specifying

          values for this header has no effect on Object Storage behavior. Programs
          that read the object determine what

          to do based on the value provided. For example, you could use this header
          to identify and differentiate objects

          based on a particular language.

          '
        type: string
      contentType:
        description: "The optional Content-Type header that defines the standard MIME\
          \ type format of the object to upload.\nSpecifying values for this header\
          \ has no effect on Object Storage behavior. Programs that read the object\n\
          determine what to do based on the value provided. For example, you could\
          \ use this header to identify and\nperform special operations on text only\
          \ objects. \n"
        type: string
      metadata:
        additionalProperties:
          type: string
        description: 'Arbitrary string keys and values for the user-defined metadata
          for the object.

          Keys must be in "opc-meta-*" format. Avoid entering confidential information.

          '
        type: object
      object:
        description: 'The name of the object to which this multi-part upload is targeted.
          Avoid entering confidential information.

          Example: test/object1.log

          '
        type: string
      storageTier:
        description: 'The storage tier that the object should be stored in. If not
          specified, the object will be stored in

          the same storage tier as the bucket.

          '
        enum: *id001
        type: string
        x-obmcs-top-level-enum: '#/definitions/StorageTier'
    required:
    - object
  CreatePreauthenticatedRequestDetails:
    properties:
      accessType:
        description: The operation that can be performed on this resource.
        enum:
        - ObjectRead
        - ObjectWrite
        - ObjectReadWrite
        - AnyObjectWrite
        - AnyObjectRead
        - AnyObjectReadWrite
        type: string
      bucketListingAction:
        default: Deny
        description: 'Specifies whether a list operation is allowed on a PAR with
          accessType "AnyObjectRead" or "AnyObjectReadWrite".

          Deny: Prevents the user from performing a list operation.

          ListObjects: Authorizes the user to perform a list operation.

          '
        type: string
        x-obmcs-enumref: '#/definitions/PreauthenticatedRequest/bucketListingAction'
      name:
        description: 'A user-specified name for the pre-authenticated request. Names
          can be helpful in managing pre-authenticated requests.

          Avoid entering confidential information.

          '
        type: string
      objectName:
        description: 'The name of the object that is being granted access to by the
          pre-authenticated request. Avoid entering confidential

          information. The object name can be null and if so, the pre-authenticated
          request grants access to the entire bucket

          if the access type allows that. The object name can be a prefix as well,
          in that case pre-authenticated request

          grants access to all the objects within the bucket starting with that prefix
          provided that we have the correct access type.

          '
        type: string
        x-default-description: object name is required for "ObjectRead", "ObjectWrite"
          or "ObjectReadWrite" accessType. It is optional and can be passed as a prefix
          for all other accessTypes, by default "null" will be assigned
      timeExpires:
        description: 'The expiration date for the pre-authenticated request as per
          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          After this date the pre-authenticated request will no longer be valid.

          '
        format: date-time
        type: string
    required:
    - name
    - accessType
    - timeExpires
  CreatePrivateEndpointDetails:
    description: 'Details to create a private endpoint

      '
    properties:
      accessTargets:
        description: 'A list of targets that can be accessed by the private endpoint.

          '
        items:
          $ref: '#/definitions/AccessTargetDetails'
        maxItems: 10
        type: array
        uniqueItems: true
      additionalPrefixes:
        description: 'A list of additional prefix that you can provide along with
          any other prefix. These resulting endpointFqdn''s are added to the

          customer VCN''s DNS record.

          '
        items:
          maxLength: 63
          minLength: 1
          type: string
        maxItems: 10
        type: array
        uniqueItems: true
      compartmentId:
        description: The ID of the compartment in which to create the Private Endpoint.
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.

            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair with no predefined name, type, or namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Department": "Finance"}`

          '
        type: object
      name:
        description: "This name associated with the endpoint. Valid characters are\
          \ uppercase or lowercase letters, numbers, hyphens,\n underscores, and periods.\n\
          Example: my-new-private-endpoint1\n"
        maxLength: 256
        minLength: 1
        type: string
      nsgIds:
        description: 'A list of the OCIDs of the network security groups (NSGs) to
          add the private endpoint''s VNIC to.

          For more information about NSGs, see

          [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).

          '
        items:
          maxLength: 255
          minLength: 1
          type: string
        maxItems: 5
        type: array
        uniqueItems: true
      prefix:
        description: 'A prefix to use for the private endpoint. The customer VCN''s
          DNS records are

          updated with this prefix. The prefix input from the customer will be the
          first sub-domain in the endpointFqdn.

          Example: If the prefix chosen is "abc", then the endpointFqdn will be ''abc.private.objectstorage.<region>.oraclecloud.com''

          '
        maxLength: 63
        minLength: 1
        type: string
      privateEndpointIp:
        description: 'The private IP address to assign to this private endpoint. If
          you provide a value,

          it must be an available IP address in the customer''s subnet. If it''s not
          available, an error

          is returned.


          If you do not provide a value, an available IP address in the subnet is
          automatically chosen.

          '
        maxLength: 46
        minLength: 1
        type: string
      securityAttributes:
        additionalProperties:
          additionalProperties:
            description: 'Attribute value and mode. Only the String type is supported
              for value. Mode is currently always "enforce".

              '
            type: object
          description: 'Key-value pair representing a security attribute key and value,
            scoped to a namespace.


            Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

            '
          type: object
        description: 'Security attributes for Private Endpoint resource. Each key
          is predefined and scoped to a namespace.

          For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


          Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

          '
        type: object
      subnetId:
        description: 'The OCID of the customer''s subnet where the private endpoint
          VNIC will reside.

          '
        maxLength: 256
        minLength: 1
        type: string
    required:
    - name
    - compartmentId
    - subnetId
    - prefix
    - accessTargets
  CreateReplicationPolicyDetails:
    description: The details to create a replication policy.
    properties:
      destinationBucketName:
        description: 'The bucket to replicate to in the destination region. Replication
          policy creation does not automatically

          create a destination bucket. Create the destination bucket before creating
          the policy.

          '
        maxLength: 256
        minLength: 1
        type: string
      destinationRegionName:
        description: The destination region to replicate to, for example "us-ashburn-1".
        maxLength: 64
        minLength: 1
        type: string
      name:
        description: The name of the policy. Avoid entering confidential information.
        maxLength: 256
        minLength: 1
        type: string
    required:
    - name
    - destinationRegionName
    - destinationBucketName
  CreateRetentionRuleDetails:
    allOf:
    - $ref: '#/definitions/RetentionRuleDetails'
    description: The details to create a retention rule.
    type: object
  DeletedObjectResult:
    description: 'Delete object details.

      '
    properties:
      objectName:
        description: 'The name of the deleted object. Avoid entering confidential
          information.

          Example: test/object1.log

          '
        type: string
      timeLastModified:
        description: The time the object was deleted, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
        format: date-time
        type: string
    required:
    - objectName
    - timeLastModified
  Duration:
    description: 'The amount of time that objects in the bucket should be preserved
      for and which is calculated in relation to

      each object''s Last-Modified timestamp. If duration is not present, then there
      is no time limit and the objects

      in the bucket will be preserved indefinitely.

      '
    properties:
      timeAmount:
        description: 'The timeAmount is interpreted in units defined by the timeUnit
          parameter, and is calculated in relation

          to each object''s Last-Modified timestamp.

          '
        format: int64
        type: integer
      timeUnit:
        description: The unit that should be used to interpret timeAmount.
        enum:
        - YEARS
        - DAYS
        type: string
    required:
    - timeAmount
    - timeUnit
  Error:
    properties:
      code:
        description: A short error code meant for programmatic parsing that defines
          the error.
        type: string
      message:
        description: A human-readable error string.
        type: string
    required:
    - code
    - message
  FailedObjectResult:
    description: 'Failed object details.

      '
    properties:
      errorMessage:
        description: Detailed error message on why the delete/update was failed.
        type: string
      objectName:
        description: 'The name of the object.

          Example: test/object1.log

          '
        type: string
      statusCode:
        description: 'HTTP status code for the failure.

          Example: 409

          '
        type: integer
    required:
    - objectName
    - statusCode
    - errorMessage
  InventoryRule:
    allOf:
    - $ref: '#/definitions/InventoryRuleDetails'
    - properties:
        etag:
          description: The entity tag (ETag) for the inventory rule.
          type: string
        id:
          description: Unique identifier for the inventory rule.
          type: string
        timeCreated:
          description: The date and time that the inventory rule was created as per
            [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
        timeModified:
          description: The date and time that the inventory rule was modified as per
            [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
      required:
      - id
      - etag
      - timeCreated
      - timeModified
      type: object
    description: The details of a inventory rule.
    type: object
  InventoryRuleCollection:
    description: Inventory rule collection.
    properties:
      items:
        description: 'An array of inventory rule summaries.

          '
        items:
          $ref: '#/definitions/InventoryRuleSummary'
        type: array
    required:
    - items
    type: object
  InventoryRuleDetails:
    description: The details of a inventory rule.
    properties:
      filter:
        $ref: '#/definitions/RuleFilter'
      isEnabled:
        default: true
        description: 'A Boolean that determines whether this rule is currently enabled.

          '
        type: boolean
      report:
        $ref: '#/definitions/Report'
      reportRecurrences:
        default: FREQ=MONTHLY
        description: "Defines the recurring times for report generation using iCal\
          \ RFC 5545 format.\nThe report will be generated based on the provided frequency\
          \ (e.g., daily, weekly, monthly).\nSupported values:\n-  FREQ=DAILY (Daily\
          \ recurrence)\n-  FREQ=WEEKLY (Weekly recurrence without specifying days)\n\
          -  FREQ=MONTHLY (Monthly recurrence without specifying days, default value)\n\
          The recurrence is based purely on the frequency (e.g., daily, weekly, monthly),\
          \ \nwith no support for finer details like specific days or intervals.\n"
        format: x-obmcs-recurring-time
        type: string
      ruleName:
        description: 'The user-defined name for the inventory rule.

          - Must be unique within the tenancy''s Object Storage namespace.

          - Must be between 1 and 256 characters in length.

          - Valid characters are uppercase and lowercase letters, numbers, hyphens
          (-), underscores (_), and periods (.).

          '
        maxLength: 256
        minLength: 1
        type: string
      ruleType:
        default: OBJECT_RULE
        description: 'The inventory rule type.

          '
        enum:
        - BUCKET_RULE
        - OBJECT_RULE
        type: string
    required:
    - ruleName
    - filter
    - report
    type: object
  InventoryRuleSummary:
    allOf:
    - $ref: '#/definitions/InventoryRule'
    description: The summary of a inventory rule.
    type: object
  ListObjects:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      nextStartWith:
        description: 'The name of the object to use in the `start` parameter to obtain
          the next page of

          a truncated ListObjects response. Avoid entering confidential information.

          Example: test/object1.log

          '
        type: string
      objects:
        description: 'An array of object summaries.

          '
        items:
          $ref: '#/definitions/ObjectSummary'
        type: array
      prefixes:
        description: 'Prefixes that are common to the results returned by the request
          if the request specified a delimiter.

          '
        items:
          type: string
        type: array
    required:
    - objects
  MultipartUpload:
    description: 'Multipart uploads provide efficient and resilient uploads, especially
      for large objects. Multipart uploads also accommodate

      objects that are too large for a single upload operation. With multipart uploads,
      individual parts of an object can be

      uploaded in parallel to reduce the amount of time you spend uploading. Multipart
      uploads can also minimize the impact

      of network failures by letting you retry a failed part upload instead of requiring
      you to retry an entire object upload.

      See [Using Multipart Uploads](/Content/Object/Tasks/usingmultipartuploads.htm).


      To use any of the API operations, you must be authorized in an IAM policy. If
      you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      bucket:
        description: The bucket in which the in-progress multipart upload is stored.
        type: string
      namespace:
        description: The Object Storage namespace in which the in-progress multipart
          upload is stored.
        type: string
      object:
        description: The object name of the in-progress multipart upload.
        type: string
      storageTier:
        description: The storage tier that the object is stored in.
        enum: *id001
        type: string
        x-obmcs-top-level-enum: '#/definitions/StorageTier'
      timeCreated:
        description: The date and time the upload was created, as described in [RFC
          2616](https://tools.ietf.org/html/rfc2616#section-14.29).
        format: date-time
        type: string
      uploadId:
        description: The unique identifier for the in-progress multipart upload.
        type: string
    required:
    - namespace
    - bucket
    - object
    - uploadId
    - timeCreated
  MultipartUploadPartSummary:
    description: 'Gets summary information about multipart uploads.


      To use any of the API operations, you must be authorized in an IAM policy. If
      you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access,

      see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      etag:
        description: The current entity tag (ETag) for the part.
        type: string
      md5:
        description: The MD5 hash of the bytes of the part.
        type: string
      partNumber:
        description: The part number for this part.
        type: integer
      size:
        description: The size of the part in bytes.
        format: int64
        type: integer
    required:
    - etag
    - md5
    - size
    - partNumber
  NamespaceMetadata:
    description: 'NamespaceMetadata maps a namespace string to defaultS3CompartmentId
      and defaultSwiftCompartmentId values.

      '
    properties:
      defaultS3CompartmentId:
        description: If the field is set, specifies the default compartment assignment
          for the Amazon S3 Compatibility API.
        type: string
      defaultSwiftCompartmentId:
        description: If the field is set, specifies the default compartment assignment
          for the Swift API.
        type: string
      namespace:
        description: The Object Storage namespace to which the metadata belongs.
        type: string
    required:
    - namespace
    - defaultS3CompartmentId
    - defaultSwiftCompartmentId
  ObjectLifecyclePolicy:
    description: 'The collection of lifecycle policy rules that together form the
      object lifecycle policy of a given bucket.

      '
    properties:
      items:
        description: 'The live lifecycle policy on the bucket.


          For an example of this value, see the

          [PutObjectLifecyclePolicy API documentation](/iaas/api/#/en/objectstorage/20160918/ObjectLifecyclePolicy/PutObjectLifecyclePolicy).

          '
        items:
          $ref: '#/definitions/ObjectLifecycleRule'
        type: array
      timeCreated:
        description: 'The date and time the object lifecycle policy was created, as
          described in

          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
  ObjectLifecycleRule:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      action:
        description: 'The action of the object lifecycle policy rule.

          Rules using the action ''ARCHIVE'' move objects from Standard and InfrequentAccess
          storage tiers

          into the [Archive storage tier](/Content/Archive/Concepts/archivestorageoverview.htm).

          Rules using the action ''INFREQUENT_ACCESS'' move objects from Standard
          storage tier into the

          Infrequent Access Storage tier. Objects that are already in InfrequentAccess
          tier or in Archive

          tier are left untouched.

          Rules using the action ''DELETE'' permanently delete objects from buckets.

          Rules using ''ABORT'' abort the uncommitted multipart-uploads and permanently
          delete their parts from buckets.

          '
        type: string
      isEnabled:
        description: A Boolean that determines whether this rule is currently enabled.
        type: boolean
      name:
        description: The name of the lifecycle rule to be applied.
        type: string
      objectNameFilter:
        $ref: '#/definitions/ObjectNameFilter'
      target:
        default: objects
        description: 'The target of the object lifecycle policy rule. The values of
          target can be either "objects",

          "multipart-uploads" or "previous-object-versions".

          This field when declared as "objects" is used to specify ARCHIVE, INFREQUENT_ACCESS

          or DELETE rule for objects.

          This field when declared as "previous-object-versions" is used to specify
          ARCHIVE,

          INFREQUENT_ACCESS or DELETE rule for previous versions of existing objects.

          This field when declared as "multipart-uploads" is used to specify the ABORT
          (only) rule for

          uncommitted multipart-uploads.

          '
        type: string
      timeAmount:
        description: 'Specifies the age of objects to apply the rule to. The timeAmount
          is interpreted in units defined by the

          timeUnit parameter, and is calculated in relation to each object''s Last-Modified
          time.

          '
        format: int64
        type: integer
      timeUnit:
        description: 'The unit that should be used to interpret timeAmount.  Days
          are defined as starting and ending at midnight UTC.

          Years are defined as 365.2425 days long and likewise round up to the next
          midnight UTC.

          '
        enum:
        - DAYS
        - YEARS
        type: string
    required:
    - name
    - action
    - timeAmount
    - timeUnit
    - isEnabled
  ObjectNameFilter:
    allOf:
    - $ref: '#/definitions/PatternDetails'
    - properties:
        inclusionPrefixes:
          description: 'An array of object name prefixes that the rule will apply
            to. An empty array means to include all objects.

            '
          items:
            type: string
          type: array
      type: object
    description: 'A filter that compares object names to a set of prefixes or patterns
      to determine if a rule applies to a

      given object. The filter can contain include glob patterns, exclude glob patterns
      and inclusion prefixes.

      The inclusion prefixes property is kept for backward compatibility. It is recommended
      to use inclusion patterns

      instead of prefixes. Exclusions take precedence over inclusions.

      '
  ObjectSummary:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      archivalState:
        description: Archival state of an object. This field is set only for objects
          in Archive tier.
        enum: *id002
        type: string
        x-obmcs-top-level-enum: '#/definitions/ArchivalState'
      etag:
        description: The current entity tag (ETag) for the object.
        type: string
      md5:
        description: Base64-encoded MD5 hash of the object data.
        type: string
      name:
        description: 'The name of the object. Avoid entering confidential information.

          Example: test/object1.log

          '
        type: string
      size:
        description: Size of the object in bytes.
        format: int64
        type: integer
      storageTier:
        description: The storage tier that the object is stored in.
        enum: *id001
        type: string
        x-obmcs-top-level-enum: '#/definitions/StorageTier'
      timeCreated:
        description: The date and time the object was created, as described in [RFC
          2616](https://tools.ietf.org/html/rfc2616#section-14.29).
        format: date-time
        type: string
      timeModified:
        description: The date and time the object was modified, as described in [RFC
          2616](https://tools.ietf.org/rfc/rfc2616), section 14.29.
        format: date-time
        type: string
    required:
    - name
  ObjectVersionCollection:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      items:
        description: 'An array of object version summaries.

          '
        items:
          $ref: '#/definitions/ObjectVersionSummary'
        type: array
      prefixes:
        description: 'Prefixes that are common to the results returned by the request
          if the request specified a delimiter.

          '
        items:
          type: string
        type: array
    required:
    - items
  ObjectVersionSummary:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      archivalState:
        description: Archival state of an object. This field is set only for objects
          in Archive tier.
        enum: *id002
        type: string
        x-obmcs-top-level-enum: '#/definitions/ArchivalState'
      etag:
        description: The current entity tag (ETag) for the object.
        type: string
      isDeleteMarker:
        description: This flag will indicate if the version is deleted or not.
        type: boolean
      md5:
        description: Base64-encoded MD5 hash of the object data.
        type: string
      name:
        description: 'The name of the object. Avoid entering confidential information.

          Example: test/object1.log

          '
        type: string
      size:
        description: Size of the object in bytes.
        format: int64
        type: integer
      storageTier:
        description: The storage tier that the object is stored in.
        enum: *id001
        type: string
        x-obmcs-top-level-enum: '#/definitions/StorageTier'
      timeCreated:
        description: The date and time the object was created, as described in [RFC
          2616](https://tools.ietf.org/html/rfc2616#section-14.29).
        format: date-time
        type: string
      timeModified:
        description: The date and time the object was modified, as described in [RFC
          2616](https://tools.ietf.org/rfc/rfc2616#section-14.29).
        format: date-time
        type: string
      versionId:
        description: VersionId of the object.
        type: string
    required:
    - name
    - versionId
    - isDeleteMarker
    - timeModified
  PatternDetails:
    description: 'Specifying inclusion and exclusion patterns.

      '
    properties:
      exclusionPatterns:
        description: "An array of glob patterns to match the object names to exclude.\
          \ An empty array is ignored. Exclusion\npatterns take precedence over inclusion\
          \ patterns.\nA Glob pattern is a sequence of characters to match text. Any\
          \ character that appears in the pattern, other\nthan the special pattern\
          \ characters described below, matches itself.\n    Glob patterns must be\
          \ between 1 and 1024 characters.\n\n    The special pattern characters have\
          \ the following meanings:\n\n    \\           Escapes the following character\n\
          \    *           Matches any string of characters.\n    ?           Matches\
          \ any single character .\n    [...]       Matches a group of characters.\
          \ A group of characters can be:\n                    A set of characters,\
          \ for example: [Zafg9@]. This matches any character in the brackets.\n \
          \                   A range of characters, for example: [a-z]. This matches\
          \ any character in the range.\n                        [a-f] is equivalent\
          \ to [abcdef].\n                        For character ranges only the CHARACTER-CHARACTER\
          \ pattern is supported.\n                            [ab-yz] is not valid\n\
          \                            [a-mn-z] is not valid\n                   \
          \     Character ranges can not start with ^ or :\n                     \
          \   To include a '-' in the range, make it the first or last character.\n"
        items:
          maxLength: 1024
          minLength: 1
          type: string
        maxItems: 1000
        type: array
      inclusionPatterns:
        description: "An array of glob patterns to match the object names to include.\
          \ An empty array includes all objects in the\nbucket. Exclusion patterns\
          \ take precedence over inclusion patterns.\nA Glob pattern is a sequence\
          \ of characters to match text. Any character that appears in the pattern,\
          \ other\nthan the special pattern characters described below, matches itself.\n\
          \    Glob patterns must be between 1 and 1024 characters.\n\n    The special\
          \ pattern characters have the following meanings:\n\n    \\           Escapes\
          \ the following character\n    *           Matches any string of characters.\n\
          \    ?           Matches any single character .\n    [...]       Matches\
          \ a group of characters. A group of characters can be:\n               \
          \     A set of characters, for example: [Zafg9@]. This matches any character\
          \ in the brackets.\n                    A range of characters, for example:\
          \ [a-z]. This matches any character in the range.\n                    \
          \    [a-f] is equivalent to [abcdef].\n                        For character\
          \ ranges only the CHARACTER-CHARACTER pattern is supported.\n          \
          \                  [ab-yz] is not valid\n                            [a-mn-z]\
          \ is not valid\n                        Character ranges can not start with\
          \ ^ or :\n                        To include a '-' in the range, make it\
          \ the first or last character.\n"
        items:
          maxLength: 1024
          minLength: 1
          type: string
        maxItems: 1000
        type: array
  PreauthenticatedRequest:
    description: 'Pre-authenticated requests provide a way to let users access a bucket
      or an object without having their own credentials.

      When you create a pre-authenticated request, a unique URL is generated. Users
      in your organization, partners, or third

      parties can use this URL to access the targets identified in the pre-authenticated
      request.

      See [Using Pre-Authenticated Requests](/Content/Object/Tasks/usingpreauthenticatedrequests.htm).


      To use any of the API operations, you must be authorized in an IAM policy. If
      you are not authorized, talk to an

      administrator. If you are an administrator who needs to write policies to give
      users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      accessType:
        description: The operation that can be performed on this resource.
        enum:
        - ObjectRead
        - ObjectWrite
        - ObjectReadWrite
        - AnyObjectWrite
        - AnyObjectRead
        - AnyObjectReadWrite
        type: string
      accessUri:
        description: The URI to embed in the URL when using the pre-authenticated
          request.
        type: string
      bucketListingAction:
        description: 'Specifies whether a list operation is allowed on a PAR with
          accessType "AnyObjectRead" or "AnyObjectReadWrite".

          Deny: Prevents the user from performing a list operation.

          ListObjects: Authorizes the user to perform a list operation.

          '
        enum:
        - Deny
        - ListObjects
        type: string
      id:
        description: The unique identifier to use when directly addressing the pre-authenticated
          request.
        type: string
      name:
        description: The user-provided name of the pre-authenticated request.
        type: string
      objectName:
        description: 'The name of the object that is being granted access to by the
          pre-authenticated request. Avoid entering confidential

          information. The object name can be null and if so, the pre-authenticated
          request grants access to the entire bucket.

          Example: test/object1.log

          '
        type: string
      timeCreated:
        description: 'The date when the pre-authenticated request was created as per
          specification

          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
      timeExpires:
        description: 'The expiration date for the pre-authenticated request as per
          [RFC 3339](https://tools.ietf.org/html/rfc3339). After

          this date the pre-authenticated request will no longer be valid.

          '
        format: date-time
        type: string
    required:
    - id
    - name
    - accessUri
    - accessType
    - timeExpires
    - timeCreated
  PreauthenticatedRequestSummary:
    description: 'Get summary information about pre-authenticated requests.

      '
    properties:
      accessType:
        description: The operation that can be performed on this resource.
        enum:
        - ObjectRead
        - ObjectWrite
        - ObjectReadWrite
        - AnyObjectWrite
        - AnyObjectRead
        - AnyObjectReadWrite
        type: string
      bucketListingAction:
        description: 'Specifies whether a list operation is allowed on a PAR with
          accessType "AnyObjectRead" or "AnyObjectReadWrite".

          Deny: Prevents the user from performing a list operation.

          ListObjects: Authorizes the user to perform a list operation.

          '
        type: string
        x-obmcs-enumref: '#/definitions/PreauthenticatedRequest/bucketListingAction'
      id:
        description: The unique identifier to use when directly addressing the pre-authenticated
          request.
        type: string
      name:
        description: The user-provided name of the pre-authenticated request.
        type: string
      objectName:
        description: 'The name of object that is being granted access to by the pre-authenticated
          request. This can be null and if it is,

          the pre-authenticated request grants access to the entire bucket.

          '
        type: string
      timeCreated:
        description: 'The date when the pre-authenticated request was created as per
          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
      timeExpires:
        description: 'The expiration date for the pre-authenticated request as per
          [RFC 3339](https://tools.ietf.org/html/rfc3339). After this date the pre-authenticated
          request will no longer be valid.

          '
        format: date-time
        type: string
    required:
    - id
    - name
    - accessType
    - timeExpires
    - timeCreated
  PrivateEndpoint:
    description: 'A private endpoint makes your service accessible through a private
      IP in the customer''s private network. A private endpoint has a name and is
      associated with a namespace and a single compartment.

      '
    properties:
      accessTargets:
        description: 'A list of targets that can be accessed by the private endpoint.
          At least one or more access targets is required for a private endpoint.

          '
        items:
          $ref: '#/definitions/AccessTargetDetails'
        maxItems: 10
        type: array
        uniqueItems: true
      additionalPrefixes:
        description: 'A list of additional prefix that you can provide along with
          any other prefix. These resulting endpointFqdn''s are added to the

          customer VCN''s DNS record.

          '
        items:
          maxLength: 63
          minLength: 1
          type: string
        maxItems: 10
        type: array
        uniqueItems: true
      compartmentId:
        description: The compartment which is associated with the Private Endpoint.
        type: string
      createdBy:
        description: The [OCID](/Content/General/Concepts/identifiers.htm) of the
          user who created the Private Endpoint.
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.

            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      etag:
        description: The entity tag (ETag) for the Private Endpoint.
        type: string
      fqdns:
        $ref: '#/definitions/fqdns'
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair with no predefined name, type, or namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Department": "Finance"}`

          '
        type: object
      id:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          PrivateEndpoint.

          '
        type: string
      lifecycleState:
        description: The Private Endpoint's lifecycle state.
        enum:
        - CREATING
        - ACTIVE
        - INACTIVE
        - UPDATING
        - DELETING
        - DELETED
        - FAILED
        type: string
      name:
        description: "This name associated with the endpoint. Valid characters are\
          \ uppercase or lowercase letters, numbers, hyphens,\n underscores, and periods.\n\
          Example: my-new-private-endpoint1\n"
        type: string
      namespace:
        description: The Object Storage namespace associated with the private enpoint.
        type: string
      nsgIds:
        description: 'A list of the OCIDs of the network security groups (NSGs) to
          add the private endpoint''s VNIC to.

          For more information about NSGs, see

          [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).

          '
        items:
          maxLength: 255
          minLength: 1
          type: string
        maxItems: 5
        type: array
        uniqueItems: true
      prefix:
        description: 'A prefix to use for the private endpoint. The customer VCN''s
          DNS records are

          updated with this prefix. The prefix input from the customer will be the
          first sub-domain in the endpointFqdn.

          Example: If the prefix chosen is "abc", then the endpointFqdn will be ''abc.private.objectstorage.<region>.oraclecloud.com''

          '
        maxLength: 63
        minLength: 1
        type: string
      privateEndpointIp:
        description: 'The private IP address to assign to this private endpoint. If
          you provide a value,

          it must be an available IP address in the customer''s subnet. If it''s not
          available, an error

          is returned.


          If you do not provide a value, an available IP address in the subnet is
          automatically chosen.

          '
        maxLength: 46
        minLength: 1
        type: string
      securityAttributes:
        additionalProperties:
          additionalProperties:
            description: 'Attribute value and mode. Only the String type is supported
              for value. Mode is currently always "enforce".

              '
            type: object
          description: 'Key-value pair representing a security attribute key and value,
            scoped to a namespace.


            Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

            '
          type: object
        description: 'Security attributes for Private Endpoint resource. Each key
          is predefined and scoped to a namespace.

          For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


          Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

          '
        type: object
      subnetId:
        description: 'The OCID of the customer''s subnet where the private endpoint
          VNIC will reside.

          '
        maxLength: 256
        minLength: 1
        type: string
      timeCreated:
        description: The date and time the Private Endpoint was created, as described
          in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
        format: date-time
        type: string
      timeModified:
        description: The date and time the Private Endpoint was updated, as described
          in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
        format: date-time
        type: string
    required:
    - name
    - namespace
    - compartmentId
    - createdBy
    - timeCreated
    - timeModified
    - subnetId
    - privateEndpointIp
    - prefix
    - fqdns
    - etag
    - accessTargets
  PrivateEndpointSummary:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      compartmentId:
        description: The compartment ID in which the Private Endpoint is authorized.
        type: string
      createdBy:
        description: The [OCID](/Content/General/Concepts/identifiers.htm) of the
          user who created the Private Endpoint.
        type: string
      etag:
        description: The entity tag for the Private Endpoint.
        type: string
      fqdns:
        $ref: '#/definitions/fqdns'
      lifecycleState:
        description: The summaries of Private Endpoints' lifecycle state.
        type: string
        x-obmcs-enumref: '#/definitions/PrivateEndpoint/lifecycleState'
      name:
        description: 'The name given to the Private Endpoint. Avoid entering confidential
          information.

          Example: my-new-pe1

          '
        type: string
      namespace:
        description: The Object Storage namespace with which the Private Endpoint
          is associated.
        type: string
      prefix:
        description: 'A prefix to use for the private endpoint. The customer VCN''s
          DNS records are

          updated with this prefix. The prefix input from the customer will be the
          first sub-domain in the endpointFqdn.

          Example: If the prefix chosen is "abc", then the endpointFqdn will be ''abc.private.objectstorage.<region>.oraclecloud.com''

          '
        maxLength: 63
        minLength: 1
        type: string
      timeCreated:
        description: The date and time the Private Endpoint was created, as described
          in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
        format: date-time
        type: string
      timeModified:
        description: The date and time the Private Endpoint was updated, as described
          in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
        format: date-time
        type: string
    required:
    - name
    - namespace
    - compartmentId
    - createdBy
    - timeCreated
    - timeModified
    - prefix
    - etag
    - fqdns
    - lifecycleState
  PutObjectLifecyclePolicyDetails:
    description: 'Creates a new object lifecycle policy for a bucket.

      '
    properties:
      items:
        description: The bucket's set of lifecycle policy rules.
        items:
          $ref: '#/definitions/ObjectLifecycleRule'
        type: array
    type: object
  ReencryptObjectDetails:
    description: "The details used to re-encrypt the data encryption keys associated\
      \ with an object.\nYou can only specify either a kmsKeyId or an sseCustomerKey\
      \ in the request payload, not both.\nIf the request payload is empty, the object\
      \ is encrypted using the encryption key assigned to the\nbucket. The bucket\
      \ encryption mechanism can either be a master encryption key managed by Oracle\
      \ or the Vault service.\n\n- The sseCustomerKey field specifies the customer-provided\
      \ encryption key (SSE-C) that will be used to re-encrypt the data encryption\
      \ keys of the\n  object and its chunks.\n\n- The sourceSSECustomerKey field\
      \ specifies information about the customer-provided encryption key that is currently\n\
      \  associated with the object source. Specify a value for the sourceSSECustomerKey\
      \ only if the object\n  is encrypted with a customer-provided encryption key.\n"
    properties:
      kmsKeyId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          master encryption key used to call the Vault

          service to re-encrypt the data encryption keys associated with the object
          and its chunks. If the kmsKeyId value is

          empty, whether null or an empty string, the API will perform re-encryption
          by using the kmsKeyId associated with the

          bucket or the master encryption key managed by Oracle, depending on the
          bucket encryption mechanism.

          '
        type: string
      sourceSseCustomerKey:
        $ref: '#/definitions/SSECustomerKeyDetails'
      sseCustomerKey:
        $ref: '#/definitions/SSECustomerKeyDetails'
  RenameObjectDetails:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      newName:
        description: The new name of the source object. Avoid entering confidential
          information.
        type: string
      newObjIfMatchETag:
        description: The if-match entity tag (ETag) of the new object.
        type: string
      newObjIfNoneMatchETag:
        description: 'The if-none-match entity tag (ETag) of the new object. The only
          valid value is ''*'', which indicates

          request should fail if the new object already exists.

          '
        type: string
      sourceName:
        description: The name of the source object to be renamed.
        type: string
      srcObjIfMatchETag:
        description: The if-match entity tag (ETag) of the source object.
        type: string
    required:
    - sourceName
    - newName
  ReplicationPolicy:
    allOf:
    - $ref: '#/definitions/ReplicationPolicySummary'
    description: The details of a replication policy.
    example:
      application-json: "{\n  \"name\": \"mypolicy\",\n  \"destinationRegionName\"\
        : \"us-phoenix-1\",\n  \"destinationBucketName\": \"backup\",\n  \"id\": \"\
        a54f378a-49c0-acvb-189f-58959597453a\",\n  \"timeCreated\": \"2017-10-13T17:23:46.000Z\"\
        ,\n  \"timeLastSync\": \"2019-10-13T17:23:46.000Z\",\n  \"status\": \"ACTIVE\"\
        ,\n  \"statusMessage\": \"Replication is ongoing.\"\n}\n"
  ReplicationPolicySummary:
    description: The summary of a replication policy.
    properties:
      destinationBucketName:
        description: 'The bucket to replicate to in the destination region. Replication
          policy creation does not automatically

          create a destination bucket. Create the destination bucket before creating
          the policy.

          '
        maxLength: 256
        minLength: 1
        type: string
      destinationRegionName:
        description: The destination region to replicate to, for example "us-ashburn-1".
        maxLength: 64
        minLength: 1
        type: string
      id:
        description: The id of the replication policy.
        type: string
      name:
        description: The name of the policy.
        maxLength: 256
        minLength: 1
        type: string
      status:
        description: 'The replication status of the policy. If the status is CLIENT_ERROR,
          once the user fixes the issue

          described in the status message, the status will become ACTIVE.

          '
        enum:
        - ACTIVE
        - CLIENT_ERROR
        type: string
      statusMessage:
        description: A human-readable description of the status.
        type: string
      timeCreated:
        description: 'The date when the replication policy was created as per [RFC
          3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
      timeLastSync:
        description: 'Changes made to the source bucket before this time has been
          replicated.

          '
        format: date-time
        type: string
    required:
    - id
    - name
    - destinationRegionName
    - destinationBucketName
    - timeCreated
    - timeLastSync
    - status
    - statusMessage
  ReplicationSource:
    description: The details of a replication source bucket that replicates to a target
      destination bucket.
    properties:
      policyName:
        description: The name of the policy.
        maxLength: 256
        minLength: 1
        type: string
      sourceBucketName:
        description: The source bucket replicating data from.
        maxLength: 256
        minLength: 1
        type: string
      sourceRegionName:
        description: The source region replicating data from, for example "us-ashburn-1".
        maxLength: 64
        minLength: 1
        type: string
    required:
    - policyName
    - sourceRegionName
    - sourceBucketName
  Report:
    description: Defines output report.
    properties:
      format:
        default: PARQUET
        description: 'The inventory report format specification

          '
        enum:
        - PARQUET
        type: string
      schemaFields:
        description: "An array of fields to be included in report.\nThe valid schemaFields\
          \ for 'object' rules are:\n  - SIZE\n  - ETAG\n  - TIME_CREATED\n  - MD5_CHECKSUM\n\
          \  - TIME_MODIFIED\n  - STORAGE_TIER\n  - ARCHIVAL_STATE\n  - COMPARTMENT_ID\n\
          \  - CREATED_BY\nThe valid schemaFields for 'bucket' rules are:\n  - ETAG\n\
          \  - TIME_CREATED\n  - TIME_MODIFIED\n  - COMPARTMENT_ID\n  - CREATED_BY\n\
          \  - DEFINED_TAGS\n  - FREEFORM_TAGS\n"
        items:
          enum:
          - SIZE
          - ETAG
          - TIME_CREATED
          - MD5_CHECKSUM
          - TIME_MODIFIED
          - STORAGE_TIER
          - ARCHIVAL_STATE
          - COMPARTMENT_ID
          - CREATED_BY
          - DEFINED_TAGS
          - FREEFORM_TAGS
          type: string
        minItems: 1
        type: array
        uniqueItems: true
      targetBucket:
        description: 'The target bucket name to upload the generated report. Create
          the target bucket before creating the rule.

          '
        maxLength: 256
        minLength: 1
        type: string
    required:
    - schemaFields
    - targetBucket
    type: object
  RestoreObjectsDetails:
    properties:
      hours:
        description: 'The number of hours for which this object will be restored.

          By default objects will be restored for 24 hours. You can instead configure
          the duration using the hours parameter.

          '
        maximum: 240
        minimum: 1
        type: integer
      objectName:
        description: An object that is in an archive storage tier and needs to be
          restored.
        type: string
      versionId:
        description: 'The versionId of the object to restore. Current object version
          is used by default.

          '
        type: string
    required:
    - objectName
  RetentionRule:
    description: The details of a retention rule.
    properties:
      displayName:
        description: User specified name for the retention rule.
        type: string
      duration:
        $ref: '#/definitions/Duration'
      etag:
        description: The entity tag (ETag) for the retention rule.
        type: string
      id:
        description: Unique identifier for the retention rule.
        type: string
      timeCreated:
        description: The date and time that the retention rule was created as per
          [RFC3339](https://tools.ietf.org/html/rfc3339).
        format: date-time
        type: string
      timeModified:
        description: The date and time that the retention rule was modified as per
          [RFC3339](https://tools.ietf.org/html/rfc3339).
        format: date-time
        type: string
      timeRuleLocked:
        description: 'The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339)
          after which this rule becomes locked.

          and can only be deleted by deleting the bucket.

          '
        format: date-time
        type: string
    required:
    - id
    - displayName
    - etag
    - timeCreated
    - timeModified
  RetentionRuleCollection:
    description: Retention rule collection.
    properties:
      items:
        description: 'An array of retention rule summaries.

          '
        items:
          $ref: '#/definitions/RetentionRuleSummary'
        type: array
    required:
    - items
  RetentionRuleDetails:
    description: The details to create or update a retention rule.
    properties:
      displayName:
        description: 'A user-specified name for the retention rule. Names can be helpful
          in identifying retention rules.

          Avoid entering confidential information.

          '
        type: string
      duration:
        $ref: '#/definitions/Duration'
      timeRuleLocked:
        description: 'The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339)
          after which this rule is locked

          and can only be deleted by deleting the bucket. Once a rule is locked, only
          increases in the duration are

          allowed and no other properties can be changed. This property cannot be
          updated for rules that are in a

          locked state. Specifying it when a duration is not specified is considered
          an error.

          '
        format: date-time
        type: string
  RetentionRuleSummary:
    allOf:
    - $ref: '#/definitions/RetentionRule'
    description: The summary of a retention rule.
    type: object
  RuleFilter:
    description: Defines rule filter.
    properties:
      createdWithinDays:
        default: -1
        description: 'Objects created within the last createdWithinDays days (inclusive)
          will be considered.

          For example, a value of 3 includes objects created within the last three
          days.

          During report generation, the calculation is based on the report generation
          start time, rounded up to the next full day.

          The object age is calculated relative to this adjusted start time.

          This parameter is optional. If not provided, the value is assumed to be
          -1,

          meaning no filtering based on object age will be applied, and all objects
          will be included in the report regardless of their creation date.

          A value of -1 explicitly indicates that all objects should be included.

          '
        type: integer
      exclusionPrefixes:
        description: 'An array of prefixes that the rule will exclude.

          If the array is not provided, no exclusions will be applied, and all objects
          will be considered.

          Any object matching any Exclude filter will be excluded, regardless of matching
          Include filters.

          Exclude filters take precedence over Include filters.

          '
        items:
          maxLength: 1024
          minLength: 1
          type: string
        maxItems: 5
        type: array
        uniqueItems: true
      inclusionPrefixes:
        description: 'An array of prefixes to which the rule will apply.

          If the array is not provided, the rule applies to all prefixes.

          If one or more prefixes are specified, only buckets/objects matching any
          of the specified prefixes will be included.

          Objects matching any Include filter will be included unless excluded by
          an Exclude filter.

          In case of overlap, Exclude filters take precedence over Include filters.

          '
        items:
          maxLength: 1024
          minLength: 1
          type: string
        maxItems: 5
        type: array
        uniqueItems: true
      objectTypes:
        description: 'An array of object types to be included in report.

          '
        items:
          default: OBJECT
          enum:
          - OBJECT
          type: string
        maxItems: 1
        minItems: 1
        type: array
        uniqueItems: true
    type: object
  SSECustomerKeyDetails:
    description: 'Specifies the details of the customer-provided encryption key (SSE-C)
      associated with an object.

      '
    properties:
      algorithm:
        description: 'Specifies the encryption algorithm. The only supported value
          is "AES256".

          '
        enum:
        - AES256
        type: string
      key:
        description: 'Specifies the base64-encoded 256-bit encryption key to use to
          encrypt or decrypt the object data.

          '
        type: string
      keySha256:
        description: 'Specifies the base64-encoded SHA256 hash of the encryption key.
          This value is used to check the integrity

          of the encryption key.

          '
        type: string
    required:
    - algorithm
    - key
    - keySha256
  StorageTier:
    description: Storage tiers supported by Object Storage
    enum: *id001
    type: string
  UpdateBucketDetails:
    description: 'To use any of the API operations, you must be authorized in an IAM
      policy. If you are not authorized,

      talk to an administrator. If you are an administrator who needs to write policies
      to give users access, see

      [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

      '
    properties:
      autoTiering:
        description: 'The auto tiering status on the bucket. If in state `InfrequentAccess`,
          objects are transitioned

          automatically between the ''Standard'' and ''InfrequentAccess'' tiers based
          on the access pattern of the objects.

          When auto tiering is `Disabled`, there will be no automatic transitions
          between storage tiers.

          '
        type: string
        x-obmcs-enumref: '#/definitions/Bucket/autoTiering'
      bucketScope:
        description: 'The bucket scope determines weather the bucket name must be
          unique within the tenancy and region (essentially the namespace) or across
          all tenancies in the region. The bucket scope also determines if the bucket
          supports S3 virtual-hosted style URL''s or not.


          Allowed values:

          NAMESPACE: Only supports path-style bucket access, bucket name only needs
          to be unique within the tenancy and region.

          REGION: Supports both path-style and virtual-hosted URL style access, bucket
          name needs to be unique across all tenancies in the region.


          BucketScope can only be updated from NAMESPACE to REGION, it cannot be updated
          from REGION to NAMESPACE.

          Updating bucket scope is possible only if the bucket name is valid and there
          is no existing regionally unique

          bucket with the same name.

          '
        type: string
        x-obmcs-enumref: '#/definitions/Bucket/bucketScope'
      compartmentId:
        description: The compartmentId for the compartment to move the bucket to.
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.

            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Operations": {"CostCenter": "42"}}

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair with no predefined name, type, or namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Department": "Finance"}`

          '
        type: object
      isBucketKeyEnabled:
        description: 'Specifies whether Object Storage should use intermediate cached
          Bucket Encryption Keys with server-side

          encryption using KMS (SSE-KMS) for new objects in the bucket. This reduces
          calls to OCI Vault Key Management

          Service (KMS). Existing objects are not affected.

          '
        type: boolean
      kmsKeyId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          Key Management master encryption key to associate

          with the specified bucket. If this value is empty, the Update operation
          will remove the associated key, if

          there is one, from the bucket. (The bucket will continue to be encrypted,
          but with an encryption key managed

          by Oracle.)

          '
        type: string
      metadata:
        additionalProperties:
          type: string
        description: Arbitrary string, up to 4KB, of keys and values for user-defined
          metadata.
        type: object
      name:
        description: 'The name of the bucket. Valid characters are uppercase or lowercase
          letters, numbers, hyphens, underscores, and periods.

          Bucket names must be unique within an Object Storage namespace. Avoid entering
          confidential information.

          Example: my-new-bucket1

          '
        type: string
      namespace:
        description: The Object Storage namespace in which the bucket lives.
        type: string
      objectEventsEnabled:
        description: 'Whether or not events are emitted for object state changes in
          this bucket. By default, `objectEventsEnabled` is

          set to `false`. Set `objectEventsEnabled` to `true` to emit events for object
          state changes. For more information

          about events, see [Overview of Events](/Content/Events/Concepts/eventsoverview.htm).

          '
        type: boolean
      publicAccessType:
        description: 'The type of public access enabled on this bucket. A bucket is
          set to `NoPublicAccess` by default, which only allows an

          authenticated caller to access the bucket and its contents. When `ObjectRead`
          is enabled on the bucket, public access

          is allowed for the `GetObject`, `HeadObject`, and `ListObjects` operations.
          When `ObjectReadWithoutList` is enabled

          on the bucket, public access is allowed for the `GetObject` and `HeadObject`
          operations.

          '
        enum:
        - NoPublicAccess
        - ObjectRead
        - ObjectReadWithoutList
        type: string
      versioning:
        description: 'The versioning status on the bucket. If in state `Enabled`,
          multiple versions of the same object can be kept in the bucket.

          When the object is overwritten or deleted, previous versions will still
          be available. When versioning is `Suspended`, the previous versions will
          still remain but new versions will no longer be created when overwitten
          or deleted.

          Versioning cannot be disabled on a bucket once enabled.

          '
        enum:
        - Enabled
        - Suspended
        type: string
  UpdateInventoryRuleDetails:
    allOf:
    - $ref: '#/definitions/InventoryRuleDetails'
    description: The details to update a inventory rule.
    type: object
  UpdateNamespaceMetadataDetails:
    description: 'UpdateNamespaceMetadataDetails is used to update the NamespaceMetadata.
      To update NamespaceMetadata, a user

      must have OBJECTSTORAGE_NAMESPACE_UPDATE permission.

      '
    properties:
      defaultS3CompartmentId:
        description: The updated compartment id for use by an S3 client, if this field
          is set.
        type: string
      defaultSwiftCompartmentId:
        description: The updated compartment id for use by a Swift client, if this
          field is set.
        type: string
  UpdateObjectStorageTierDetails:
    description: 'To change the storage tier of an object, we specify the object name
      and the desired

      storage tier in the body. Objects can be moved between Standard and InfrequentAccess

      tiers and from Standard or InfrequentAccess tier to Archive tier. If a version
      id is

      specified, only the specified version of the object is moved to a different
      storage

      tier, else the current version is used.

      '
    properties:
      objectName:
        description: An object for which the storage tier needs to be changed.
        type: string
      storageTier:
        description: The storage tier that the object should be moved to.
        enum: *id001
        type: string
        x-obmcs-top-level-enum: '#/definitions/StorageTier'
      versionId:
        description: 'The versionId of the object. Current object version is used
          by default.

          '
        type: string
    required:
    - objectName
    - storageTier
  UpdatePrivateEndpointDetails:
    description: 'Information that can be updated for a private endpoint.

      '
    properties:
      accessTargets:
        description: 'A list of targets that can be accessed by the private endpoint.

          '
        items:
          $ref: '#/definitions/AccessTargetDetails'
        maxItems: 10
        type: array
        uniqueItems: true
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.

            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair with no predefined name, type, or namespace.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

          Example: `{"Department": "Finance"}`

          '
        type: object
      name:
        description: "This name associated with the endpoint. Valid characters are\
          \ uppercase or lowercase letters, numbers, hyphens,\n underscores, and periods.\n\
          Example: my-new-private-endpoint1\n"
        maxLength: 256
        minLength: 1
        type: string
      namespace:
        description: The Object Storage namespace which will associated with the private
          endpoint.
        type: string
      securityAttributes:
        additionalProperties:
          additionalProperties:
            description: 'Attribute value and mode. Only the String type is supported
              for value. Mode is currently always "enforce".

              '
            type: object
          description: 'Key-value pair representing a security attribute key and value,
            scoped to a namespace.


            Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

            '
          type: object
        description: 'Security attributes for Private Endpoint resource. Each key
          is predefined and scoped to a namespace.

          For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


          Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

          '
        type: object
  UpdateRetentionRuleDetails:
    allOf:
    - $ref: '#/definitions/RetentionRuleDetails'
    description: The details to update a retention rule.
    type: object
  WorkRequest:
    description: A description of workRequest status.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment that contains the work request. Work

          requests are scoped to the same compartment as the resource the work request
          affects.


          If the work request affects multiple resources and those resources are not
          in the same compartment, the OCID of

          the primary resource is used. For example, you can copy an object in a bucket
          in one compartment to a bucket in

          another compartment. In this case, the OCID of the source compartment is
          used.

          '
        type: string
      id:
        description: The id of the work request.
        type: string
      operationType:
        description: The type of work request.
        enum:
        - COPY_OBJECT
        - REENCRYPT
        - PRIVATE_ENDPOINT_CREATE
        - PRIVATE_ENDPOINT_UPDATE
        - PRIVATE_ENDPOINT_DELETE
        type: string
      percentComplete:
        description: Percentage of the work request completed.
        format: float
        type: number
      resources:
        items:
          $ref: '#/definitions/WorkRequestResource'
        type: array
      status:
        description: The status of the specified work request.
        enum:
        - ACCEPTED
        - IN_PROGRESS
        - FAILED
        - COMPLETED
        - CANCELING
        - CANCELED
        type: string
      timeAccepted:
        description: 'The date and time the work request was created, as described
          in

          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
      timeFinished:
        description: 'The date and time the work request was finished, as described
          in

          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
      timeStarted:
        description: 'The date and time the work request was started, as described
          in

          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
  WorkRequestError:
    properties:
      code:
        description: 'A machine-usable code for the error that occurred. For the list
          of error codes,

          see [API Errors](/Content/API/References/apierrors.htm).

          '
        type: string
      message:
        description: A human-readable description of the issue that produced the error.
        type: string
      timestamp:
        description: The time the error occurred.
        format: date-time
        type: string
  WorkRequestLogEntry:
    properties:
      message:
        description: Human-readable log message.
        type: string
      timestamp:
        description: 'The date and time the log message was written, as described
          in

          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
  WorkRequestResource:
    properties:
      actionType:
        description: The status of the work request.
        enum:
        - CREATED
        - UPDATED
        - DELETED
        - RELATED
        - IN_PROGRESS
        - READ
        - WRITTEN
        type: string
      entityType:
        description: The resource type the work request affects.
        type: string
      entityUri:
        description: The URI path that you can use for a GET request to access the
          resource metadata.
        type: string
      identifier:
        description: The resource type identifier.
        type: string
      metadata:
        additionalProperties:
          type: string
        description: The metadata of the resource.
        type: object
  WorkRequestResourceMetadataKey:
    description: The keys of WorkRequestResource metadata.
    enum:
    - REGION
    - NAMESPACE
    - BUCKET
    - OBJECT
    - PRIVATE_ENDPOINT_NAME
    type: string
  WorkRequestSummary:
    description: A summary of the status of a work request.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment that contains the work request. Work

          requests are scoped to the same compartment as the resource the work request
          affects.


          If the work request affects multiple resources and those resources are not
          in the same compartment, the OCID of

          the primary resource is used. For example, you can copy an object in a bucket
          in one compartment to a bucket in

          another compartment. In this case, the OCID of the source compartment is
          used.

          '
        type: string
      id:
        description: The id of the work request.
        type: string
      operationType:
        description: The type of work request.
        enum:
        - COPY_OBJECT
        - REENCRYPT
        - PRIVATE_ENDPOINT_CREATE
        - PRIVATE_ENDPOINT_UPDATE
        - PRIVATE_ENDPOINT_DELETE
        type: string
      percentComplete:
        description: Percentage of the work request completed.
        format: float
        type: number
      resources:
        items:
          $ref: '#/definitions/WorkRequestResource'
        type: array
      status:
        description: The status of a specified work request.
        enum:
        - ACCEPTED
        - IN_PROGRESS
        - FAILED
        - COMPLETED
        - CANCELING
        - CANCELED
        type: string
      timeAccepted:
        description: 'The date and time the work request was created, as described
          in

          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
      timeFinished:
        description: 'The date and time the work request was finished, as described
          in

          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
      timeStarted:
        description: 'The date and time the work request was started, as described
          in

          [RFC 3339](https://tools.ietf.org/html/rfc3339).

          '
        format: date-time
        type: string
  fqdns:
    description: 'The object representing FQDN details formed using prefix and additionalPrefixes.

      '
    properties:
      additionalPrefixesFqdns:
        additionalProperties:
          $ref: '#/definitions/prefixFqdns'
        description: 'An object containing FQDNs formed using additionalPrefixes.

          '
        type: object
      prefixFqdns:
        $ref: '#/definitions/prefixFqdns'
    type: object
  prefixFqdns:
    description: 'An object containing FQDNs

      '
    properties:
      objectStorageApiFqdn:
        description: 'ObjectStorage API FQDN

          '
        maxLength: 2048
        minimum: 1
        type: string
      s3CompatibilityApiFqdn:
        description: 'S3 Compatibility API FQDN

          '
        maxLength: 2048
        minimum: 1
        type: string
      swiftApiFqdn:
        description: 'Swift API FQDN

          '
        maxLength: 2048
        minimum: 1
        type: string
    type: object
host: localhost:9000
info:
  description: 'Use Object Storage and Archive Storage APIs to manage buckets, objects,
    and related resources.

    For more information, see [Overview of Object Storage](/Content/Object/Concepts/objectstorageoverview.htm)
    and

    [Overview of Archive Storage](/Content/Archive/Concepts/archivestorageoverview.htm).


    Object Storage supports V2, Swift, and S3 APIs, and provides both IPv4 and dual-stack
    (IPv4 and IPv6) endpoints.

    The default endpoint behavior within OCI''s published SDKs and CLIs use the IPv4-only
    endpoints. Use the

    dual-stack endpoint to connect over IPv6 or IPv4 while maintaining compatibility
    with IPv4-only endpoints.

    Dual-stack endpoints are identified by .ds. in the endpoint hostname. For details
    about how to construct

    dual-stack dedicated endpoints for these APIs, see [Dual-Stack Endpoints And Support
    For IPv6](/iaas/Content/Object/Concepts/use-ipv6-urls.htm).

    '
  license:
    name: Oracle Corporation
  title: Object Storage Service API
  version: '20160918'
parameters:
  BucketPathParam:
    description: 'The name of the bucket. Avoid entering confidential information.

      Example: `my-new-bucket1`

      '
    in: path
    minLength: 1
    name: bucketName
    pattern: '[A-Za-z0-9\\-_\\.]+'
    required: true
    type: string
  ClientRequestIdHeader:
    description: The client request ID for tracing.
    in: header
    name: opc-client-request-id
    type: string
  CompartmentIdQueryParam:
    description: The ID of the compartment in which to list buckets.
    in: query
    name: compartmentId
    required: true
    type: string
  DelimiterQueryParam:
    description: 'When this parameter is set, only objects whose names do not contain
      the delimiter character

      (after an optionally specified prefix) are returned in the objects key of the
      response body.

      Scanned objects whose names contain the delimiter have the part of their name
      up to the first

      occurrence of the delimiter (including the optional prefix) returned as a set
      of prefixes.

      Note that only ''/'' is a supported delimiter character at this time.

      '
    in: query
    name: delimiter
    type: string
  EndBeforeQueryParam:
    description: Returns object names which are lexicographically strictly less than
      this parameter.
    in: query
    name: end
    type: string
  Expect100ContinueHeader:
    description: 'A value of `100-continue` requests preliminary verification of the
      request method, path, and headers before the request body is sent.

      If no error results from such verification, the server will send a 100 (Continue)
      interim response to indicate readiness for the request body.

      The only allowed value for this parameter is "100-Continue" (case-insensitive).

      '
    in: header
    name: Expect
    pattern: ^(100-[cC][oO][nN][tT][iI][nN][uU][eE])?$
    type: string
    x-default-description: 'If you do not supply this parameter, the service will
      accept the entire request body first, before verifying the request.

      If there is an error, accepting the entire request body first may have a negative
      performance impact.

      If you do supply this parameter, but with a value other than "100-Continue"
      (case-insensitive), you will receive a 400 (Bad Request) response.

      '
  GetBucketFieldsQueryParam:
    collectionFormat: csv
    description: 'Bucket summary includes the ''namespace'', ''name'', ''compartmentId'',
      ''createdBy'', ''timeCreated'',

      and ''etag'' fields. This parameter can also include ''approximateCount'' (approximate
      number of objects), ''approximateSize''

      (total approximate size in bytes of all objects) and ''autoTiering'' (state
      of auto tiering on the bucket).

      For example ''approximateCount,approximateSize,autoTiering''.

      '
    in: query
    items:
      enum:
      - approximateCount
      - approximateSize
      - autoTiering
      type: string
      x-obmcs-inline-enum: false
    name: fields
    type: array
  IfMatchHeader:
    description: 'The entity tag (ETag) to match with the ETag of an existing resource.
      If the specified ETag matches the ETag of

      the existing resource, GET and HEAD requests will return the resource and PUT
      and POST requests will upload

      the resource.

      '
    in: header
    name: if-match
    type: string
  IfNoneMatchHeader:
    description: 'The entity tag (ETag) to avoid matching. The only valid value is
      ''*'', which indicates that the request should

      fail if the resource already exists.

      '
    in: header
    maxLength: 1
    minLength: 0
    name: if-none-match
    pattern: ^[*]$
    type: string
  IfNoneMatchHeaderExceptStar:
    description: 'The entity tag (ETag) to avoid matching. Wildcards (''*'') are not
      allowed. If the specified ETag does not

      match the ETag of the existing resource, the request returns the expected response.
      If the ETag matches

      the ETag of the existing resource, the request returns an HTTP 304 status without
      a response body.

      '
    in: header
    name: if-none-match
    type: string
  InventoryRuleIdPathParam:
    description: The ID of the inventory rule.
    in: path
    name: inventoryRuleId
    required: true
    type: string
  ListBucketFieldsQueryParam:
    collectionFormat: csv
    description: 'Bucket summary in list of buckets includes the ''namespace'', ''name'',
      ''compartmentId'', ''createdBy'', ''timeCreated'',

      and ''etag'' fields. This parameter can also include ''tags'' (freeformTags
      and definedTags). The only supported value of this parameter is ''tags'' for
      now. Example ''tags''.

      '
    in: query
    items:
      enum:
      - tags
      type: string
    name: fields
    type: array
  ListPrivateEndpointFieldsQueryParam:
    collectionFormat: csv
    description: "PrivateEndpoint summary in list of PrivateEndpoints includes the\
      \ 'namespace', 'name', 'compartmentId', \n'createdBy', 'timeCreated', 'timeModified'\
      \ and 'etag' fields. \nThis parameter can also include 'tags' (freeformTags\
      \ and definedTags). \nThe only supported value of this parameter is 'tags' for\
      \ now. Example 'tags'.\n"
    in: query
    items:
      enum:
      - tags
      type: string
    name: fields
    type: array
  NamespacePathParam:
    description: The Object Storage namespace used for the request.
    in: path
    minLength: 1
    name: namespaceName
    pattern: '[A-Za-z][A-Za-z0-9\\-_\\.]+'
    required: true
    type: string
  ObjectAppendQueryParam:
    description: 'The option to commit a new chunk of data to the end of an existing
      object. If the object doesn''t exist, it''ll create a new one.

      The maximum size of the data to append to an object in a single append request
      is 512MB. Each object can only be appended up to 10,000 times.

      '
    in: query
    name: isAppend
    required: false
    type: boolean
  ObjectFieldsQueryParam:
    description: "Object summary by default includes only the 'name' field. Use this\
      \ parameter to also\ninclude 'size' (object size in bytes), 'etag', 'md5', 'timeCreated'\
      \ (object creation date and time),\n'timeModified' (object modification date\
      \ and time), 'storageTier' and 'archivalState' fields.\nSpecify the value of\
      \ this parameter as a comma-separated, case-insensitive list of those field\
      \ names. \nFor example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.\n"
    enum:
    - name
    - size
    - etag
    - timeCreated
    - md5
    - timeModified
    - storageTier
    - archivalState
    in: query
    name: fields
    type: string
    x-obmcs-inline-enum: false
  ObjectNamePrefixQueryParam:
    description: User-specified object name prefixes can be used to query and return
      a list of pre-authenticated requests.
    in: query
    name: objectNamePrefix
    type: string
  ObjectPathParam:
    description: 'The name of the object. Avoid entering confidential information.

      Example: `test/object1.log`

      '
    in: path
    maxLength: 1024
    minLength: 1
    name: objectName
    pattern: '[^\\r\\n\\00#\\?]+'
    required: true
    type: string
  OpcMetaHeader:
    description: Optional user-defined metadata key and value.
    in: header
    name: opc-meta-*
    type: string
    x-obmcs-header-collection: true
    x-obmcs-prefix: opc-meta-
  OptionalCacheControlHeader:
    description: 'The optional Cache-Control header that defines the caching behavior
      value to be returned in GetObject and

      HeadObject responses. Specifying values for this header has no effect on Object
      Storage behavior. Programs

      that read the object determine what to do based on the value provided.

      For example, you could use this header to identify objects that require caching
      restrictions.

      '
    in: header
    name: Cache-Control
    type: string
  OptionalCompartmentIdQueryParam:
    description: 'This is an optional field representing either the tenancy [OCID](/Content/General/Concepts/identifiers.htm)
      or the compartment

      [OCID](/Content/General/Concepts/identifiers.htm) within the tenancy whose Object
      Storage namespace is to be retrieved.

      '
    in: query
    name: compartmentId
    type: string
  OptionalContentDispositionHeader:
    description: 'The optional Content-Disposition header that defines presentational
      information for the object to be

      returned in GetObject and HeadObject responses. Specifying values for this header
      has no effect on Object

      Storage behavior. Programs that read the object determine what to do based on
      the value provided.

      For example, you could use this header to let users download objects with custom
      filenames in a browser.

      '
    in: header
    name: Content-Disposition
    type: string
  OptionalContentEncodingHeader:
    description: 'The optional Content-Encoding header that defines the content encodings
      that were applied to the object to

      upload. Specifying values for this header has no effect on Object Storage behavior.
      Programs that read the

      object determine what to do based on the value provided. For example, you could
      use this header to determine

      what decoding mechanisms need to be applied to obtain the media-type specified
      by the Content-Type header of

      the object.

      '
    in: header
    name: Content-Encoding
    type: string
  OptionalContentLanguageHeader:
    description: 'The optional Content-Language header that defines the content language
      of the object to upload. Specifying

      values for this header has no effect on Object Storage behavior. Programs that
      read the object determine what

      to do based on the value provided. For example, you could use this header to
      identify and differentiate objects

      based on a particular language.

      '
    in: header
    name: Content-Language
    type: string
  OptionalContentMD5Header:
    description: 'The optional header that defines the base64-encoded MD5 hash of
      the body. If the optional Content-MD5 header is present, Object

      Storage performs an integrity check on the body of the HTTP request by computing
      the MD5 hash for the body and comparing it to the

      MD5 hash supplied in the header. If the two hashes do not match, the object
      is rejected and an HTTP-400 Unmatched Content MD5 error

      is returned with the message:


      "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5
      header (HEADER_MD5)"

      '
    in: header
    name: Content-MD5
    type: string
  OptionalContentTypeHeader:
    description: 'The optional Content-Type header that defines the standard MIME
      type format of the object. Content type defaults to

      ''application/octet-stream'' if not specified in the PutObject call. In the
      OCI CLI, you can set this value to ''auto''

      to have the CLI infer the content type from the file name. Specifying values
      for this header has no effect on Object

      Storage behavior. Programs that read the object determine what to do based on
      the value provided. For example, you

      could use this header to identify and perform special operations on text only
      objects.

      '
    in: header
    name: Content-Type
    type: string
  OptionalSSECustomerAlgorithmHeader:
    description: 'The optional header that specifies "AES256" as the encryption algorithm.
      For more information, see

      [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).

      '
    in: header
    name: opc-sse-customer-algorithm
    type: string
    x-default-description: 'null'
  OptionalSSECustomerKeyHeader:
    description: 'The optional header that specifies the base64-encoded 256-bit encryption
      key to use to encrypt or

      decrypt the data. For more information, see

      [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).

      '
    in: header
    name: opc-sse-customer-key
    type: string
    x-default-description: 'null'
  OptionalSSECustomerKeySHA256Header:
    description: 'The optional header that specifies the base64-encoded SHA256 hash
      of the encryption key. This

      value is used to check the integrity of the encryption key. For more information,
      see

      [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).

      '
    in: header
    name: opc-sse-customer-key-sha256
    type: string
    x-default-description: 'null'
  OptionalSSEKMSKeyIdHeader:
    description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a master
      encryption key used to call the Key

      Management service to generate a data encryption key or to encrypt or decrypt
      a data encryption key.

      '
    in: header
    name: opc-sse-kms-key-id
    type: string
    x-default-description: 'null'
  OptionalSrcSSECustomerAlgorithmHeader:
    description: 'The optional header that specifies "AES256" as the encryption algorithm
      to use to decrypt the source

      object. For more information, see

      [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).

      '
    in: header
    name: opc-source-sse-customer-algorithm
    type: string
    x-default-description: 'null'
  OptionalSrcSSECustomerKeyHeader:
    description: 'The optional header that specifies the base64-encoded 256-bit encryption
      key to use to decrypt

      the source object. For more information, see

      [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).

      '
    in: header
    name: opc-source-sse-customer-key
    type: string
    x-default-description: 'null'
  OptionalSrcSSECustomerKeySHA256Header:
    description: 'The optional header that specifies the base64-encoded SHA256 hash
      of the encryption key used to

      decrypt the source object. This value is used to check the integrity of the
      encryption key. For

      more information, see

      [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm).

      '
    in: header
    name: opc-source-sse-customer-key-sha256
    type: string
    x-default-description: 'null'
  OptionalStorageTierHeader:
    description: 'The storage tier that the object should be stored in. If not specified,
      the object will be stored in

      the same storage tier as the bucket.

      '
    enum: *id001
    in: header
    name: storage-tier
    required: false
    type: string
    x-obmcs-top-level-enum: '#/definitions/StorageTier'
  PaginationLimitQueryParam:
    description: 'For list pagination. The maximum number of results per page, or
      items to return in a paginated

      "List" call. For important details about how pagination works, see

      [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

      '
    in: query
    maximum: 1000
    minimum: 1
    name: limit
    type: integer
  PaginationReplicationLimitQueryParam:
    default: 100
    description: 'For list pagination. The maximum number of results per page, or
      items to return in a paginated

      "List" call. For important details about how pagination works, see

      [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

      '
    in: query
    maximum: 1000
    minimum: 1
    name: limit
    type: integer
  PaginationTokenQueryParam:
    description: 'For list pagination. The value of the `opc-next-page` response header
      from the previous "List" call. For important

      details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

      '
    in: query
    maxLength: 1024
    minLength: 1
    name: page
    type: string
  PreauthenticatedRequestIdPathParam:
    description: 'The unique identifier for the pre-authenticated request. This can
      be used to manage operations against

      the pre-authenticated request, such as GET or DELETE.

      '
    in: path
    name: parId
    required: true
    type: string
  PrefixQueryParam:
    description: The string to use for matching against the start of object names
      in a list query.
    in: query
    name: prefix
    type: string
  PrivateEndpointNameQueryParam:
    description: The name of the privateEndpoint for which to list work requests.
    in: query
    name: privateEndpointName
    type: string
  PrivateEndpointPathParam:
    description: 'The name of the private endpoint. Avoid entering confidential information.

      Example: `my-new-pe-1`

      '
    in: path
    minLength: 1
    name: peName
    pattern: '[A-Za-z0-9\\-_\\.]+'
    required: true
    type: string
  RangeRequestHeader:
    description: 'Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7233#section-2.1).

      Note that only a single range of bytes is supported.

      '
    in: header
    name: range
    type: string
  ReencryptBucketKeyOnlyQueryParam:
    default: false
    description: If true, reencrypt only the intermediate bucket keys and skip everything
      else in the bucket.
    in: query
    name: isReencryptBucketKeyOnly
    required: false
    type: boolean
  ReplicationIdPathParam:
    description: The ID of the replication policy.
    in: path
    name: replicationId
    required: true
    type: string
  RequiredContentLengthHeader:
    description: The content length of the body.
    format: int64
    in: header
    name: Content-Length
    required: true
    type: integer
  ResponseCacheControlQueryParam:
    description: Specify this query parameter to override the Cache-Control response
      header in the GetObject response.
    in: query
    name: httpResponseCacheControl
    required: false
    type: string
  ResponseContentDispositionQueryParam:
    description: Specify this query parameter to override the value of the Content-Disposition
      response header in the GetObject response.
    in: query
    name: httpResponseContentDisposition
    required: false
    type: string
  ResponseContentEncodingQueryParam:
    description: Specify this query parameter to override the Content-Encoding response
      header in the GetObject response.
    in: query
    name: httpResponseContentEncoding
    required: false
    type: string
  ResponseContentLanguageQueryParam:
    description: Specify this query parameter to override the Content-Language response
      header in the GetObject response.
    in: query
    name: httpResponseContentLanguage
    required: false
    type: string
  ResponseContentTypeQueryParam:
    description: Specify this query parameter to override the Content-Type response
      header in the GetObject response.
    in: query
    name: httpResponseContentType
    required: false
    type: string
  ResponseExpiresQueryParam:
    description: Specify this query parameter to override the Expires response header
      in the GetObject response.
    in: query
    name: httpResponseExpires
    required: false
    type: string
  RetentionRuleIdPathParam:
    description: The ID of the retention rule.
    in: path
    name: retentionRuleId
    required: true
    type: string
  RetryTokenHeader:
    description: 'A token that uniquely identifies a request so it can be retried
      in case of a timeout or

      server error without risk of executing that same action again. Retry tokens
      expire after 24

      hours, but can be invalidated before then due to conflicting operations (for
      example, if a resource

      has been deleted and purged from the system, then a retry of the original creation
      request

      may be rejected).

      '
    in: header
    maxLength: 64
    minLength: 1
    name: opc-retry-token
    type: string
  StartAfterQueryParam:
    description: Returns object names which are lexicographically strictly greater
      than this parameter.
    in: query
    name: startAfter
    type: string
  StartWithQueryParam:
    description: Returns object names which are lexicographically greater than or
      equal to this parameter.
    in: query
    name: start
    type: string
  UploadIdQueryParam:
    description: The upload ID for a multipart upload.
    in: query
    name: uploadId
    required: true
    type: string
  UploadPartNumberQueryParam:
    description: The part number that identifies the object part currently being uploaded.
    in: query
    maximum: 10000
    minimum: 1
    name: uploadPartNum
    required: true
    type: integer
  VersionIdQueryParam:
    description: VersionId used to identify a particular version of the object
    in: query
    name: versionId
    pattern: '[A-Za-z][A-Za-z0-9\\-_\\.]+'
    required: false
    type: string
  WorkRequestIdPathParam:
    description: The ID of the asynchronous request.
    in: path
    name: workRequestId
    required: true
    type: string
  lifecycleState:
    description: The lifecycle state of the Private Endpoint
    in: query
    name: lifecycleState
    type: string
    x-obmcs-enumref: '#/definitions/PrivateEndpoint/lifecycleState'
paths:
  /n/:
    get:
      description: 'Each Oracle Cloud Infrastructure tenant is assigned one unique
        and uneditable Object Storage namespace. The namespace

        is a system-generated string assigned during account creation. For some older
        tenancies, the namespace string may be

        the tenancy name in all lower-case letters. You cannot edit a namespace.


        GetNamespace returns the name of the Object Storage namespace for the user
        making the request.

        If an optional compartmentId query parameter is provided, GetNamespace returns
        the namespace name of the corresponding

        tenancy, provided the user has access to it.

        '
      operationId: GetNamespace
      parameters:
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/OptionalCompartmentIdQueryParam'
      responses:
        200:
          description: The requesting user's Object Storage namespace string.
          examples:
            application-json: '"ansh8lvru1zp"

              '
          schema:
            pattern: '[A-Za-z][A-Za-z0-9\\-_\\.]+'
            type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: GET Namespace Name
      tags:
      - objectStorage
      x-example: 'GET /n/ HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:42:15 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Namespace'
  /n/{namespaceName}:
    get:
      description: 'Gets the metadata for the Object Storage namespace, which contains
        defaultS3CompartmentId and

        defaultSwiftCompartmentId.


        Any user with the OBJECTSTORAGE_NAMESPACE_READ permission will be able to
        see the current metadata. If you are

        not authorized, talk to an administrator. If you are an administrator who
        needs to write policies

        to give users access, see

        [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

        '
      operationId: GetNamespaceMetadata
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The default metadata.
          examples:
            application-json: "[\n  {\n    \"namespace\": \"ansh8lvru1zp\",\n    \"\
              defaultS3CompartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentS3ID\"\
              ,\n    \"defaultSwiftCompartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentSwiftID\"\
              \n  }\n]\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/NamespaceMetadata'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: GET Namespace Metadata
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_metadata&gt;</var> HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:42:15 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Namespace'
    put:
      description: 'By default, buckets created using the Amazon S3 Compatibility
        API or the Swift API are created in the root

        compartment of the Oracle Cloud Infrastructure tenancy.


        You can change the default Swift/Amazon S3 compartmentId designation to a
        different compartmentId. All

        subsequent bucket creations will use the new default compartment, but no previously
        created

        buckets will be modified. A user must have OBJECTSTORAGE_NAMESPACE_UPDATE
        permission to make changes to the default

        compartments for Amazon S3 and Swift.

        '
      operationId: UpdateNamespaceMetadata
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: Request object for update NamespaceMetadata.
        in: body
        name: UpdateNamespaceMetadataDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateNamespaceMetadataDetails'
      responses:
        200:
          description: The updated NamespaceMetadata information.
          examples:
            application-json: "{\n  \"name\": \"ansh8lvru1zp\",\n  \"defaultS3CompartmentId\"\
              : \"ocid.compartment.oc1..exampleuniquecompartmentS3ID\",\n  \"defaultSwiftCompartmentId\"\
              : \"ocid.compartment.oc1..exampleuniquecompartmentS3ID\"\n}\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/NamespaceMetadata'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: PUT Namespace
      tags:
      - objectStorage
      x-example: "PUT /n/<var>&lt;namespace_metadata&gt;</var> HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\n\
        connection: keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent:\
        \ python-requests/2.11.0\ndate: Fri, 12 Aug 2016 22:50:18 GMT\ncontent-type:\
        \ application/json\nauthorization: <var>&lt;authorization and other headers&gt;</var>\n\
        {\n  \"defaultS3CompartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentS3ID\"\
        ,\n  \"defaultSwiftCompartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentSwiftID\"\
        \n}\n"
      x-related-resource: '#/definitions/Namespace'
  /n/{namespaceName}/b/:
    get:
      description: 'Gets a list of all BucketSummary items in a compartment. A BucketSummary
        contains only summary fields for the bucket

        and does not contain fields like the user-defined metadata.


        ListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate
        through more buckets, use the returned

        `opc-next-page` value with the `page` request parameter.


        To use this and other API operations, you must be authorized in an IAM policy.
        If you are not authorized,

        talk to an administrator. If you are an administrator who needs to write policies
        to give users access, see

        [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

        '
      operationId: ListBuckets
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/ListBucketFieldsQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: A page of BucketSummary objects.
          examples:
            application-json: "[\n  {\n    \"namespace\": \"ansh8lvru1zp\",\n    \"\
              name\": \"MyBucket_1\",\n    \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartment1ID\"\
              ,\n    \"createdBy\": \"ocid1.user.oc1..exampleuniqueuserID\",\n   \
              \ \"timeCreated\": \"2016-08-09T01:11:38.639Z\",\n    \"etag\": \"dc450b1e-a22c-479a-aae2-a5903e519661\"\
              \n  },\n  {\n    \"namespace\": \"ansh8lvru1zp\",\n    \"name\": \"\
              MyBucket_2\",\n    \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartment2ID\"\
              ,\n    \"createdBy\": \"ocid1.user.oc1..exampleuniqueuser2ID\",\n  \
              \  \"timeCreated\": \"2016-08-09T00:41:50.236Z\",\n    \"etag\": \"\
              31e21d43-41e8-42b0-beb8-cc0baa50ef94\"\n  },\n  {\n    \"namespace\"\
              : \"ansh8lvru1zp\",\n    \"name\": \"MyBucket_3\",\n    \"compartmentId\"\
              : \"ocid.compartment.oc1..exampleuniquecompartment3ID\",\n    \"createdBy\"\
              : \"ocid1.user.oc1..exampleuniqueuserID\",\n    \"timeCreated\": \"\
              2016-08-08T21:18:37.448Z\",\n    \"etag\": \"ed042fb0-a22f-48cc-a6d3-5590ee0bd0d2\"\
              \n  },\n  {\n    \"namespace\": \"ansh8lvru1zp\",\n    \"name\": \"\
              MyBucket_4\",\n    \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartment4ID\"\
              ,\n    \"createdBy\": \"ocid1.user.oc1..exampleuniqueuserID\",\n   \
              \ \"timeCreated\": \"2017-01-20T00:25:55.758Z\",\n    \"etag\": \"21edf865-d3d9-424f-8218-37188e803db8\"\
              \n  },\n  {\n    \"namespace\": \"ansh8lvru1zp\",\n    \"name\": \"\
              MyBucket_5\",\n    \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartment5ID\"\
              ,\n    \"createdBy\": \"ocid1.user.oc1..exampleuniqueuserID\",\n   \
              \ \"timeCreated\": \"2017-01-20T19:12:41.886Z\",\n    \"etag\": \"30d83c79-dd32-4c07-ace9-9240ed7083fd\"\
              \n  }\n]\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of buckets.

                In the GET request, set the limit to the number of buckets items that
                you want returned in the response.

                If the `opc-next-page` header appears in the response, then this is
                a partial list and there are additional

                buckets to get. Include the header''s value as the `page` parameter
                in the subsequent GET request to get the

                next batch of buckets. Repeat this process to retrieve the entire
                list of buckets.

                By default, the page limit is set to 25 buckets per page, but you
                can specify a value from 1 to 1000.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            items:
              $ref: '#/definitions/BucketSummary'
            type: array
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List Buckets
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/ HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 20 Jan 2017 22:52:33 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Bucket'
    post:
      description: 'Creates a bucket in the given namespace with a bucket name and
        optional user-defined metadata. Avoid entering

        confidential information in bucket names.

        '
      operationId: CreateBucket
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: Request object for creating a bucket.
        in: body
        name: CreateBucketDetails
        required: true
        schema:
          $ref: '#/definitions/CreateBucketDetails'
      responses:
        200:
          description: The complete bucket representation, including fields set by
            the server.
          examples:
            application-json: "{\n  \"namespace\": \"ansh8lvru1zp\",\n  \"name\":\
              \ \"MyBucket6\",\n  \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentID\"\
              ,\n  \"id\": \"ocid1.bucket.oc1.iad.examplebucketID\",\n  \"createdBy\"\
              : \"ocid1.user.oc1..exampleuniqueuserID\",\n  \"timeCreated\": \"2016-08-09T01:11:38.639Z\"\
              ,\n  \"metadata\": {},\n  \"etag\": \"21edf865-d3d9-424f-8218-37188e803db8\"\
              ,\n  \"freeformTags\": {\"Department\" : \"Finance\"},\n  \"definedTags\"\
              :\n  {\n    \"MyTags\":\n    {\n      \"CostCenter\": \"42\",\n    \
              \  \"Project\": \"Stealth\",\n      \"CreatedBy\": \"BillSmith\",\n\
              \      \"CreatedDate\": \"9/21/2017T14:00\"\n    },\n    \"Audit\":\n\
              \    {\n      \"DataSensitivity\": \"PII\",\n      \"CageSecurity\"\
              : \"High\",\n      \"Simplicity\": \"complex\"\n    }\n  }\n}\n"
          headers:
            ETag:
              description: The entity tag (ETag) for the bucket that was created.
              type: string
            Location:
              description: The full path to the bucket that was created.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/Bucket'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        411:
          $ref: '#/responses/ContentLengthRequired'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Create Bucket
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\n\
        connection: keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent:\
        \ python-requests/2.11.0\ndate: Fri, 12 Aug 2016 22:50:18 GMT\nx-content-sha256:\
        \ GzeGbC8Ad9cEhdcnD2wjPiUej5TIHHw2I+uj4w7Jot4=\nContent-Length: 148\ncontent-type:\
        \ application/json\nauthorization: <var>&lt;authorization and other headers&gt;</var>\n\
        {\n  \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentID\"\
        ,\n  \"namespace\": \"ansh8lvru1zp\",\n  \"objectEventsEnabled\": true,\n\
        \  \"name\": \"my-test-1\",\n  \"freeformTags\": {\"Department\": \"Finance\"\
        },\n  \"definedTags\":\n  {\n    \"MyTags\":\n    {\n      \"CostCenter\"\
        : \"42\",\n      \"Project\": \"Stealth\",\n      \"CreatedBy\": \"BillSmith\"\
        ,\n      \"CreatedDate\": \"9/21/2017T14:00\"\n    },\n    \"Audit\":\n  \
        \  {\n      \"DataSensitivity\": \"PII\",\n      \"CageSecurity\": \"High\"\
        ,\n      \"Simplicity\": \"complex\"\n    }\n  }\n}\n"
      x-related-resource: '#/definitions/Bucket'
  /n/{namespaceName}/b/{bucketName}/:
    delete:
      description: 'Deletes a bucket if the bucket is already empty. If the bucket
        is not empty, use

        [DeleteObject](#/en/objectstorage/20160918/Object/DeleteObject) first. In
        addition,

        you cannot delete a bucket that has a multipart upload in progress or a pre-authenticated

        request associated with that bucket.

        '
      operationId: DeleteBucket
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        204:
          description: The response body is always empty.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: DELETE Bucket
      tags:
      - objectStorage
      x-example: 'DELETE /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 23:04:28 GMT

        content-length: 0

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Bucket'
    get:
      description: 'Gets the current representation of the given bucket in the given
        Object Storage namespace.

        '
      operationId: GetBucket
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeaderExceptStar'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/GetBucketFieldsQueryParam'
      responses:
        200:
          description: A bucket representation for the requested bucket.
          examples:
            application-json: "{\n  \"namespace\": \"ansh8lvru1zp\",\n  \"name\":\
              \ \"MyBucket\",\n  \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentID\"\
              ,\n  \"id\": \"ocid1.bucket.oc1.iad.examplebucketID\",\n  \"createdBy\"\
              : \"ocid1.user.oc1..exampleuniqueuserID\",\n  \"timeCreated\": \"2016-08-08T03:48:40.511Z\"\
              ,\n  \"metadata\": {},\n  \"etag\": \"9282a931-6367-4e8a-85d0-cfe9796b20ef\"\
              ,\n  \"freeformTags\": {\"Department\": \"Finance\"},\n  \"definedTags\"\
              :\n  {\n    \"MyTags\":\n    {\n      \"CostCenter\": \"42\",\n    \
              \  \"Project\": \"Stealth\",\n      \"CreatedBy\": \"BillSmith\",\n\
              \      \"CreatedDate\": \"9/21/2017T14:00\"\n    },\n    \"Audit\":\n\
              \    {\n      \"DataSensitivity\": \"PII\",\n      \"CageSecurity\"\
              : \"High\",\n      \"Simplicity\": \"complex\"\n    }\n  }\n}\n"
          headers:
            ETag:
              description: The current entity tag (ETag) for the bucket.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/Bucket'
        304:
          description: Not Modified
          headers:
            ETag:
              description: The current entity tag (ETag) for the bucket.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: GET Bucket
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:52:33 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Bucket'
    head:
      description: 'Efficiently checks to see if a bucket exists and gets the current
        entity tag (ETag) for the bucket.

        '
      operationId: HeadBucket
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeaderExceptStar'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The bucket exists.
          headers:
            ETag:
              description: The current entity tag (ETag) for the bucket.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        304:
          description: Not Modified
          headers:
            ETag:
              description: The current entity tag (ETag) for the bucket.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: HEAD Bucket
      tags:
      - objectStorage
      x-example: 'HEAD /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:52:33 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Bucket'
    post:
      description: 'Performs a partial or full update of a bucket''s user-defined
        metadata.


        Use UpdateBucket to move a bucket from one compartment to another within the
        same tenancy. Supply the compartmentID

        of the compartment that you want to move the bucket to. For more information
        about moving resources between compartments,

        see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: UpdateBucket
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: Request object for updating a bucket.
        in: body
        name: UpdateBucketDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateBucketDetails'
      responses:
        200:
          description: The full representation of the bucket, including fields set
            by the server.
          examples:
            application-json: "{\n  \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentID\"\
              ,\n  \"id\": \"ocid1.bucket.oc1.iad.examplebucketID\",\n  \"createdBy\"\
              : \"ocid1.user.oc1..exampleuniqueuserID\",\n  \"etag\": \"82361183-a765-4e51-be48-933518c6ee5a\"\
              ,\n  \"metadata\":\n    {\n      \"foo\": \"bar\"\n    },\n  \"name\"\
              : \"MyBucket\",\n  \"namespace\": \"ansh8lvru1zp\",\n  \"timeCreated\"\
              : \"2016-08-23T20:58:02.497Z\",\n  \"freeformTags\": {\"Department\"\
              : \"Finance\"},\n  \"definedTags\":\n  {\n    \"MyTags\":\n    {\n \
              \     \"CostCenter\": \"42\",\n      \"Project\": \"Stealth\",\n   \
              \   \"CreatedBy\": \"BillSmith\",\n      \"CreatedDate\": \"9/21/2017T14:00\"\
              \n    },\n    \"Audit\":\n    {\n      \"DataSensitivity\": \"PII\"\
              ,\n      \"CageSecurity\": \"High\",\n      \"Simplicity\": \"complex\"\
              \n    }\n  }\n}\n"
          headers:
            ETag:
              description: The entity tag (ETag) for the updated bucket.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/Bucket'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: POST Bucket
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>\
        \ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection:\
        \ keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.10.0\n\
        date: Tue, 23 Aug 2016 21:01:55 GMT\nx-content-sha256: XK0yY+agfR3IHWjFyQlO5LCU8IysvgpDdDGSRrb/xzA=\n\
        Content-Length: 80\ncontent-type: application/json\nauthorization: <var>&lt;authorization\
        \ and other headers&gt;</var>\n{\n  \"namespace\": \"ansh8lvru1zp\",\n  \"\
        name\": \"MyBucket\",\n  \"metadata\":\n    {\n      \"foo\": \"bar\"\n  \
        \  },\n  \"objectEventsEnabled\": true,  \n  \"freeformTags\": {\"Department\"\
        : \"Finance\"},\n  \"definedTags\":\n  {\n    \"MyTags\":\n    {\n      \"\
        CostCenter\": \"42\",\n       \"Project\": \"Stealth\",\n      \"CreatedBy\"\
        : \"BillSmith\",\n      \"CreatedDate\": \"9/21/2017T14:00\"\n    },\n   \
        \ \"Audit\":\n    {\n      \"DataSensitivity\": \"PII\",\n      \"CageSecurity\"\
        : \"High\",\n      \"Simplicity\": \"complex\"\n    }\n  }\n}\n"
      x-related-resource: '#/definitions/Bucket'
  /n/{namespaceName}/b/{bucketName}/actions/batchDeleteObjects:
    post:
      description: Deletes a batch of objects.
      operationId: BatchDeleteObjects
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: Details about batch of objects to be deleted.
        in: body
        name: BatchDeleteObjectsDetails
        required: true
        schema:
          $ref: '#/definitions/BatchDeleteObjectsDetails'
      responses:
        200:
          description: Always returns this status code if the request was processed
            after validation, authentication and authorization.
          examples:
            application-json: "{\n  \"deleted\": [\n    {\n      \"objectName\": \"\
              object1\",\n      \"lastModified\": \"2016-08-09T01:11:38.639Z\"\n \
              \   }\n  ],\n  \"failures\": [\n    {\n      \"objectName\": \"object2\"\
              ,\n      \"status\": 409,\n      \"error\": \"conflict\"\n    },\n \
              \   {\n      \"objectName\": \"object3\",\n      \"status\": 412,\n\
              \      \"error\": \"precondition failed\"\n    }\n  ]\n}\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/BatchDeleteObjectsResult'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Deletes a batch of objects.
      tags:
      - objectStorage
      x-example: "POST /n/example_namespace/b/example_bucket/actions/deleteObjects\n\
        Host: objectstorage.us-phoenix-1.oraclecloud.com\nUser-Agent: curl/7.43.0\n\
        Accept: */*\nContent-Type: application/json\nContent-Length: 139\nDate: Fri,\
        \ 31 Oct 2025 11:50:24 GMT\nAuthorization: <var>&lt;authorization_string&gt;</var>\n\
        {\n  \"objects\": [\n    {\n      \"objectName\": \"object1\",\n      \"ifMatch\"\
        : \"etag1\"\n    },\n    {\n      \"objectName\": \"object2\",\n      \"ifMatch\"\
        : \"etag1\"\n    },\n    {\n      \"objectName\": \"object3\",\n    }\n  ],\n\
        \  \"isSkipDeletedResult\": false\n}\n"
      x-related-resource: '#/definitions/Object'
  /n/{namespaceName}/b/{bucketName}/actions/copyObject:
    post:
      description: 'Creates a request to copy an object within a region or to another
        region.


        See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)

        for object naming requirements.

        '
      operationId: CopyObject
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/OptionalSSECustomerAlgorithmHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeyHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeySHA256Header'
      - $ref: '#/parameters/OptionalSrcSSECustomerAlgorithmHeader'
      - $ref: '#/parameters/OptionalSrcSSECustomerKeyHeader'
      - $ref: '#/parameters/OptionalSrcSSECustomerKeySHA256Header'
      - $ref: '#/parameters/OptionalSSEKMSKeyIdHeader'
      - description: The source and destination of the object to be copied.
        in: body
        name: CopyObjectDetails
        required: true
        schema:
          $ref: '#/definitions/CopyObjectDetails'
      responses:
        202:
          description: The request has been accepted for processing, but the processing
            has not completed.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous
                request. If you need to contact Oracle about a

                particular request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Creates a copy object request.
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/actions/copyObject\n\
        Host: objectstorage.us-phoenix-1.oraclecloud.com\nUser-Agent: curl/7.43.0\n\
        Accept: */*\nContent-Type: application/json\nContent-Length: 139\nDate: Fri,\
        \ 10 Mar 2017 11:50:24 GMT\nAuthorization: <var>&lt;authorization and other\
        \ headers&gt;</var>\n{\n  \"sourceObjectName\": \"backup.tar.gz\",\n  \"sourceObjectIfMatchETag\"\
        : \"*\",\n  \"destinationRegion\": \"uk-london-1\",\n  \"destinationNamespace\"\
        : \"ansh8lvru1zp\",\n  \"destinationBucket\": \"backup\",\n  \"destinationObjectName\"\
        : \"backup2.tar.gz\",\n  \"destinationObjectIfMatchETag\": \"*\",\n  \"destinationObjectIfNoneMatchETag\"\
        : \"*\",\n  \"destinationObjectMetadata\": {\"opc-meta-a\" : \"b\"}\n}\n"
      x-related-resource: '#/definitions/Object'
  /n/{namespaceName}/b/{bucketName}/actions/makeBucketWritable:
    post:
      description: 'Stops replication to the destination bucket and removes the replication
        policy. When the replication

        policy was created, this destination bucket became read-only except for new
        and changed objects replicated

        automatically from the source bucket. MakeBucketWritable removes the replication
        policy. This bucket is no

        longer the target for replication and is now writable, allowing users to make
        changes to bucket contents.

        '
      operationId: MakeBucketWritable
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The replication policy associated with the bucket is removed.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Stops the replication policy associated with a destination bucket.
      tags:
      - objectStorage
      x-example: 'POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/actions/makeBucketWritable
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.10.0

        date: Fri, 19 Aug 2016 23:39:51 GMT

        authorization: <var>&lt;authorization_string&gt;</var>

        '
      x-related-resource: '#/definitions/Replication'
  /n/{namespaceName}/b/{bucketName}/actions/reencrypt:
    post:
      description: "Re-encrypts the unique data encryption key that encrypts each\
        \ object written to the bucket by using the most recent \nversion of the master\
        \ encryption key assigned to the bucket. (All data encryption keys are encrypted\
        \ by a master \nencryption key. Master encryption keys are assigned to buckets\
        \ and managed by Oracle by default, but you can assign \na key that you created\
        \ and control through the Oracle Cloud Infrastructure Key Management service.)\
        \ The kmsKeyId property \nof the bucket determines which master encryption\
        \ key is assigned to the bucket. If you assigned a different Key Management\
        \ \nmaster encryption key to the bucket, you can call this API to re-encrypt\
        \ all data encryption keys with the newly \nassigned key. Similarly, you might\
        \ want to re-encrypt all data encryption keys if the assigned key has been\
        \ rotated to \na new key version since objects were last added to the bucket.\
        \ If you call this API and there is no kmsKeyId associated \nwith the bucket,\
        \ the call will fail. \nAlso, if you set isBucketKeyEnabled, you might want\
        \ to re-encrypt all data encryption keys\nusing the bucket key. This will\
        \ help reduce calls to OCI Vault KMS when older objects are downloaded.\n\n\
        Calling this API starts a work request task to re-encrypt the data encryption\
        \ key of all objects in the bucket. Only \nobjects created before the time\
        \ of the API call will be re-encrypted. The call can take a long time, depending\
        \ on how many \nobjects are in the bucket and how big they are. This API returns\
        \ a work request ID that you can use to retrieve the status \nof the work\
        \ request task.\nAll the versions of objects will be re-encrypted whether\
        \ versioning is enabled or suspended at the bucket.\n"
      operationId: ReencryptBucket
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ReencryptBucketKeyOnlyQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        202:
          description: The request has been accepted for processing, but the processing
            is not yet done.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous
                request. If you need to contact Oracle about a

                particular request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Re-encrypt Bucket Data Encryption Key
      tags:
      - objectStorage
      x-example: 'POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/actions/reencrypt
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:50:18 GMT

        content-type: application/json

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Bucket'
  /n/{namespaceName}/b/{bucketName}/actions/reencrypt/{objectName}:
    post:
      description: 'Re-encrypts the data encryption keys that encrypt the object and
        its chunks. By default, when you create a bucket, the Object Storage

        service manages the master encryption key used to encrypt each object''s data
        encryption keys. The encryption mechanism that you specify for

        the bucket applies to the objects it contains.


        You can alternatively employ one of these encryption strategies for an object:


        - You can assign a key that you created and control through the Oracle Cloud
        Infrastructure Vault service.


        - You can encrypt an object using your own encryption key. The key you supply
        is known as a customer-provided encryption key (SSE-C).

        '
      operationId: ReencryptObject
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ObjectPathParam'
      - $ref: '#/parameters/VersionIdQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: Request object for re-encrypting the data encryption key associated
          with an object.
        in: body
        name: ReencryptObjectDetails
        required: true
        schema:
          $ref: '#/definitions/ReencryptObjectDetails'
      responses:
        200:
          description: The data encryption key of the object was successfully re-encrypted.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Re-encrypt the data encryption keys associated with an object
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/actions/reencrypt/<var>&lt;example_object&gt;</var>\
        \ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection:\
        \ keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.11.0\n\
        date: Fri, 12 Aug 2016 22:50:18 GMT\ncontent-type: application/json\nauthorization:\
        \ <var>&lt;authorization and other headers&gt;</var>\n{\n  \"kmsKeyId\" :\
        \ \"ocid1.key.region1.sea.examplemaag4s.examples3wg32j37cvbyhs5edj3qxlblk6sevxr7faux4cbc5wyctpnsukva\"\
        \n}\n"
      x-related-resource: '#/definitions/Object'
  /n/{namespaceName}/b/{bucketName}/actions/renameObject:
    post:
      description: 'Rename an object in the given Object Storage namespace.


        See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)

        for object naming requirements.

        '
      operationId: RenameObject
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: The sourceName and newName of rename operation. Avoid entering
          confidential information.
        in: body
        name: RenameObjectDetails
        required: true
        schema:
          $ref: '#/definitions/RenameObjectDetails'
      responses:
        200:
          description: The object was successfully renamed.
          headers:
            ETag:
              description: The entity tag (ETag) for the object.
              type: string
            last-modified:
              description: The time the object was modified, as described in [RFC
                2616](https://tools.ietf.org/html/rfc2616#section-14.29).
              format: date-time
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            version-id:
              description: VersionId of the renamed object
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Rename Object
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/actions/renameObject\
        \ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection:\
        \ keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.11.0\n\
        date: Fri, 12 Aug 2016 22:50:18 GMT\ncontent-type: application/json\nauthorization:\
        \ <var>&lt;authorization and other headers&gt;</var>\n{\n    \"sourceName\"\
        \ : \"SourceObjectName\",\n    \"newName\" : \"TargetObjectName\",\n    \"\
        srcObjIfMatchETag\": \"*\",\n    \"newObjIfMatchETag\": \"*\",\n    \"newObjIfNoneMatchETag\"\
        : \"*\"\n}\n"
      x-related-resource: '#/definitions/Object'
  /n/{namespaceName}/b/{bucketName}/actions/restoreObjects:
    post:
      description: 'Restores the object specified by the objectName parameter.

        By default object will be restored for 24 hours. Duration can be configured
        using the hours parameter.

        '
      operationId: RestoreObjects
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: Request to restore object.
        in: body
        name: RestoreObjectsDetails
        required: true
        schema:
          $ref: '#/definitions/RestoreObjectsDetails'
      responses:
        200:
          description: The object is already restored.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        202:
          description: Accepted the request. The object will be restored.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Restore Object
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/actions/restoreObjects\
        \ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection:\
        \ keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.11.0\n\
        date: Fri, 12 Aug 2017 23:01:51 GMT\nauthorization: <var>&lt;authorization\
        \ and other headers&gt;</var>\n{\n  \"objectName\" : \"objectNameFoo\"\n \
        \ \"hours\" : 48\n}\n"
      x-related-resource: '#/definitions/Object'
  /n/{namespaceName}/b/{bucketName}/actions/updateObjectStorageTier:
    post:
      description: 'Changes the storage tier of the object specified by the objectName
        parameter.

        '
      operationId: UpdateObjectStorageTier
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: The object name and the desired storage tier.
        in: body
        name: UpdateObjectStorageTierDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateObjectStorageTierDetails'
      responses:
        200:
          description: The object storage tier has been changed successfully.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Move the object into a different storage tier
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/actions/updateObjectStorageTier\
        \ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection:\
        \ keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.11.0\n\
        date: Wed, 19 Aug 2020 21:00:18 GMT\ncontent-type: application/json\nauthorization:\
        \ <var>&lt;authorization and other headers&gt;</var>\n{\n  \"objectName\"\
        \ : \"objectNameFoo\"\n  \"storageTier\" : \"InfrequentAccess\"\n}\n"
      x-related-resource: '#/definitions/Object'
  /n/{namespaceName}/b/{bucketName}/l:
    delete:
      description: 'Deletes the object lifecycle policy for the bucket.

        '
      operationId: DeleteObjectLifecyclePolicy
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/IfMatchHeader'
      responses:
        204:
          description: The object lifecycle policy has been deleted successfully.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular request,

                provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Delete object lifecycle policy
      tags:
      - objectStorage
      x-example: 'DELETE /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/l

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Mar 2017 11:50:24 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ObjectLifecyclePolicy'
    get:
      description: 'Gets the object lifecycle policy for the bucket.

        '
      operationId: GetObjectLifecyclePolicy
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The object lifecycle policy of the bucket.
          examples:
            application-json: "{\n  \"timeCreated\": \"2017-10-13T17:23:46.000Z\"\
              ,\n  \"items\": [\n    {\n      \"name\": \"sampleRule\",\n      \"\
              action\": \"ARCHIVE\",\n      \"objectNameFilter\":\n        {\n   \
              \       \"inclusionPrefixes\": [\n              \"samplePrefix\"\n \
              \         ],\n          \"inclusionPatterns\": [\n               \"\
              *.txt\", \"*.log\", \"prefix*\"\n          ],\n          \"exclusionPatterns\"\
              : [\n              \"*.pdf\", \"*.tmp\"\n          ]\n        },\n \
              \     \"timeAmount\": 3,\n      \"timeUnit\": \"DAYS\",\n      \"isEnabled\"\
              : false\n    }\n  ]\n},\n"
          headers:
            ETag:
              description: The entity tag (ETag) for the object lifecycle policy.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular request,

                provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/ObjectLifecyclePolicy'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: GET object lifecycle policy
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/l

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Mar 2017 11:50:24 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: 'Creates or replaces the object lifecycle policy for the bucket.

        '
      operationId: PutObjectLifecyclePolicy
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeader'
      - description: The lifecycle policy to apply to the bucket.
        in: body
        name: PutObjectLifecyclePolicyDetails
        required: true
        schema:
          $ref: '#/definitions/PutObjectLifecyclePolicyDetails'
      responses:
        200:
          description: The object lifecycle policy representation.
          examples:
            application-json: "{\n  \"timeCreated\": \"2017-10-13T17:23:46.000Z\"\
              ,\n  \"items\": [\n    {\n      \"name\": \"sampleRule\",\n      \"\
              target\" : \"objects\",\n      \"action\": \"ARCHIVE\",\n      \"objectNameFilter\"\
              :\n        {\n          \"inclusionPrefixes\": [\n              \"samplePrefix\"\
              \n          ],\n          \"inclusionPatterns\": [\n               \"\
              *.txt\", \"*.log\", \"prefix*\"\n          ],\n          \"exclusionPatterns\"\
              : [\n              \"*.pdf\", \"*.tmp\"\n          ]\n        },\n \
              \     \"timeAmount\": 3,\n      \"timeUnit\": \"DAYS\",\n      \"isEnabled\"\
              : false\n    },\n    {\n      \"name\": \"sampleRule2\",\n      \"target\"\
              \ : \"previous-object-versions\",\n      \"action\": \"ARCHIVE\",\n\
              \      \"objectNameFilter\":\n        {\n          \"inclusionPrefixes\"\
              : [\n              \"samplePrefix\"\n          ],\n          \"inclusionPatterns\"\
              : [\n               \"*.txt\", \"*.log\", \"prefix*\"\n          ],\n\
              \          \"exclusionPatterns\": [\n              \"*.pdf\", \"*.tmp\"\
              \n          ]\n        },\n      \"timeAmount\": 3,\n      \"timeUnit\"\
              : \"DAYS\",\n      \"isEnabled\": false\n    }\n  ]\n}\n"
          headers:
            ETag:
              description: The entity tag (ETag) for the object lifecycle policy.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular request,

                provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/ObjectLifecyclePolicy'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Put object lifecycle policy.
      tags:
      - objectStorage
      x-example: "PUT /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/l\n\
        Host: objectstorage.us-phoenix-1.oraclecloud.com\nUser-Agent: curl/7.43.0\n\
        Accept: */*\nContent-Type: application/json\nContent-Length: 139\nDate: Fri,\
        \ 10 Mar 2017 11:50:24 GMT\nAuthorization: <var>&lt;authorization and other\
        \ headers&gt;</var>\n{\n  \"items\": [\n    {\n      \"name\": \"sampleRule\"\
        ,\n      \"target\" : \"objects\",\n      \"action\": \"ARCHIVE\",\n     \
        \ \"objectNameFilter\":\n        {\n          \"inclusionPrefixes\": [\n \
        \             \"samplePrefix\"\n          ],\n          \"inclusionPatterns\"\
        : [\n               \"*.txt\", \"*.log\", \"prefix*\"\n          ],\n    \
        \      \"exclusionPatterns\": [\n              \"*.pdf\", \"*.tmp\"\n    \
        \      ]\n        },\n      \"timeAmount\": 3,\n      \"timeUnit\": \"DAYS\"\
        ,\n      \"isEnabled\": false\n    },\n    {\n      \"name\": \"sampleRule2\"\
        ,\n      \"target\" : \"objects\",\n      \"action\": \"DELETE\",\n      \"\
        objectNameFilter\":\n        {\n          \"inclusionPrefixes\": [\n     \
        \         \"samplePrefix2\"\n          ],\n          \"inclusionPatterns\"\
        : [\n               \"*.txt\", \"*.log\", \"prefix*\"\n          ],\n    \
        \      \"exclusionPatterns\": [\n              \"*.pdf\", \"*.tmp\"\n    \
        \      ]\n        },\n      \"timeAmount\": 3,\n      \"timeUnit\": \"DAYS\"\
        ,\n      \"isEnabled\": true\n    },\n    {\n      \"name\": \"sampleRule3\"\
        ,\n      \"target\" : \"multipart-uploads\",\n      \"action\": \"ABORT\"\
        ,\n      \"timeAmount\": 7,\n      \"timeUnit\": \"DAYS\",\n      \"isEnabled\"\
        : true\n\n    },\n    {\n      \"name\": \"sampleRule4\",\n      \"target\"\
        \ : \"previous-object-versions\",\n      \"action\": \"ARCHIVE\",\n      \"\
        objectNameFilter\":\n        {\n          \"inclusionPrefixes\": [\n     \
        \         \"samplePrefix4\"\n          ],\n          \"inclusionPatterns\"\
        : [\n               \"*.txt\", \"*.log\", \"prefix*\"\n          ],\n    \
        \      \"exclusionPatterns\": [\n              \"*.pdf\", \"*.tmp\"\n    \
        \      ]\n        },\n      \"timeAmount\": 3,\n      \"timeUnit\": \"DAYS\"\
        ,\n      \"isEnabled\": false\n    },\n    {\n      \"name\": \"sampleRule5\"\
        ,\n      \"target\" : \"previous-object-versions\",\n      \"action\": \"\
        DELETE\",\n      \"objectNameFilter\":\n        {\n          \"inclusionPrefixes\"\
        : [\n              \"samplePrefix5\"\n          ],\n          \"inclusionPatterns\"\
        : [\n               \"*.txt\", \"*.log\", \"prefix*\"\n          ],\n    \
        \      \"exclusionPatterns\": [\n              \"*.pdf\", \"*.tmp\"\n    \
        \      ]\n        },\n      \"timeAmount\": 3,\n      \"timeUnit\": \"DAYS\"\
        ,\n      \"isEnabled\": true\n    },\n    {\n      \"name\": \"sampleRule6\"\
        ,\n      \"action\": \"INFREQUENT_ACCESS\",\n      \"objectNameFilter\":\n\
        \        {\n          \"inclusionPatterns\": [\n               \"*.xml\"\n\
        \          ],\n          \"exclusionPatterns\": [\n              \"*.dat\"\
        , \"*.tmp\"\n          ]\n        },\n      \"timeAmount\": 3,\n      \"timeUnit\"\
        : \"DAYS\",\n      \"isEnabled\": true\n    }\n  ]\n}\n"
  /n/{namespaceName}/b/{bucketName}/o:
    get:
      description: 'Lists the objects in a bucket. By default, ListObjects returns
        object names only. See the `fields`

        parameter for other fields that you can optionally include in ListObjects
        response.


        ListObjects returns at most 1000 objects. To paginate through more objects,
        use the returned ''nextStartWith''

        value with the ''start'' parameter. To filter which objects ListObjects returns,
        use the ''start'' and ''end''

        parameters.


        To use this and other API operations, you must be authorized in an IAM policy.
        If you are not authorized,

        talk to an administrator. If you are an administrator who needs to write policies
        to give users access, see

        [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

        '
      operationId: ListObjects
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/PrefixQueryParam'
      - $ref: '#/parameters/StartWithQueryParam'
      - $ref: '#/parameters/EndBeforeQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/DelimiterQueryParam'
      - $ref: '#/parameters/ObjectFieldsQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/StartAfterQueryParam'
      responses:
        200:
          description: 'List of object summaries, including optional prefixes and,
            in a truncated response, the name of the object to

            start next page of results.

            '
          examples:
            application-json: "{\n  \"objects\": [\n    {\n      \"name\": \"1MB.data\"\
              \n    }\n  ]\n}\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/ListObjects'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List Objects
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/o
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 23:00:25 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Object'
  /n/{namespaceName}/b/{bucketName}/o/{objectName}:
    delete:
      description: 'Deletes an object.

        '
      operationId: DeleteObject
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ObjectPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/VersionIdQueryParam'
      responses:
        204:
          description: The object was successfully deleted.
          headers:
            is-delete-marker:
              description: 'This is `true` if the deleted object is a delete marker,
                otherwise `false`

                '
              type: boolean
            last-modified:
              description: The time the object was deleted, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
              format: date-time
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            version-id:
              description: 'The `versionId` of the delete marker created as a result
                of the DELETE Object.

                If the request contains a specific `versionId`, then this response
                header will be the same as the requested `versionId` of the object
                that was deleted.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: DELETE Object
      tags:
      - objectStorage
      x-example: 'DELETE /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/o/example_object
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 23:01:51 GMT

        content-length: 0

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Object'
    get:
      description: "Gets the metadata and body of an object.  \n"
      operationId: GetObject
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ObjectPathParam'
      - $ref: '#/parameters/VersionIdQueryParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeaderExceptStar'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/RangeRequestHeader'
      - $ref: '#/parameters/OptionalSSECustomerAlgorithmHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeyHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeySHA256Header'
      - $ref: '#/parameters/ResponseContentDispositionQueryParam'
      - $ref: '#/parameters/ResponseCacheControlQueryParam'
      - $ref: '#/parameters/ResponseContentTypeQueryParam'
      - $ref: '#/parameters/ResponseContentLanguageQueryParam'
      - $ref: '#/parameters/ResponseContentEncodingQueryParam'
      - $ref: '#/parameters/ResponseExpiresQueryParam'
      responses:
        200:
          description: The object metadata and bytes.
          examples:
            application-json: "{\n  \"ETag\": \"3A63FDC17F6B9AADE053C20610AC801F\"\
              ,\n  \"MD5\": \"36Gwtu9HoVxgCwlKk+VgAg==\",\n  \"Size\": \"12\",\n \
              \ \"Trace ID\": \"d13fe5a5-0358-9d32-a25c-d6864b5b9a64\"\n}\n"
          headers:
            ETag:
              description: The entity tag (ETag) for the object.
              type: string
            archival-state:
              description: Archival state of an object. This field is set only for
                objects in Archive tier.
              enum: *id002
              type: string
              x-obmcs-top-level-enum: '#/definitions/ArchivalState'
            cache-control:
              description: Cache-Control header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.9).
              type: string
            content-disposition:
              description: Content-Disposition header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-19.5.1).
              type: string
            content-encoding:
              description: Content-Encoding header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.11).
              type: string
            content-language:
              description: Content-Language header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.12).
              type: string
            content-length:
              description: The object size in bytes.
              format: int64
              type: integer
            content-md5:
              description: 'Content-MD5 header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.15).

                Unavailable for objects uploaded using multipart upload.

                '
              type: string
            content-range:
              description: Content-Range header for range requests, per [RFC 7233](https://tools.ietf.org/html/rfc7233#section-4.2).
              type: string
            content-type:
              description: Content-Type header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.17).
              type: string
            expires:
              description: 'The date and time after which the object is no longer
                cached by a browser, proxy, or other caching entity. See

                [RFC 2616](https://tools.ietf.org/rfc/rfc2616#section-14.21).

                '
              format: date-time
              type: string
            last-modified:
              description: The object modification time, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
              format: date-time
              type: string
            opc-bucket-key-enabled:
              description: True if bucket key was enabled and used to encrypt the
                object during upload or reencrypt.
              type: boolean
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-meta-*:
              description: The user-defined metadata for the object.
              type: string
              x-obmcs-header-collection: true
              x-obmcs-prefix: opc-meta-
            opc-multipart-md5:
              description: 'Only applicable to objects uploaded using multipart upload.

                Base-64 representation of the multipart object hash.

                The multipart object hash is calculated by taking the MD5 hashes of
                the parts,

                concatenating the binary representation of those hashes in order of
                their part numbers,

                and then calculating the MD5 hash of the concatenated values.

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            storage-tier:
              description: The storage tier that the object is stored in.
              enum: *id001
              type: string
              x-obmcs-top-level-enum: '#/definitions/StorageTier'
            time-of-archival:
              description: Time that the object is returned to the archived state.
                This field is only present for restored objects.
              format: date-time
              type: string
            version-id:
              description: VersionId of the object
              type: string
          schema:
            format: binary
            type: string
        206:
          description: The object metadata and partial bytes.
          headers:
            ETag:
              description: The entity tag (ETag) for the object.
              type: string
            archival-state:
              description: Archival state of an object. This field is set only for
                objects in Archive tier.
              enum: *id002
              type: string
              x-obmcs-top-level-enum: '#/definitions/ArchivalState'
            cache-control:
              description: Cache-Control header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.9).
              type: string
            content-disposition:
              description: Content-Disposition header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-19.5.1).
              type: string
            content-encoding:
              description: Content-Encoding header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.11).
              type: string
            content-language:
              description: Content-Language header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.12).
              type: string
            content-length:
              description: The object size in bytes.
              format: int64
              type: integer
            content-md5:
              description: 'Content-MD5 header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.15).

                Unavailable for objects uploaded using multipart upload.

                '
              type: string
            content-range:
              description: Content-Range header for range requests, per [RFC 7233](https://tools.ietf.org/html/rfc7233#section-4.2).
              type: string
            content-type:
              description: Content-Type header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.17).
              type: string
            expires:
              description: 'The date and time after which the object is no longer
                cached by a browser, proxy, or other caching entity. See

                [RFC 2616](https://tools.ietf.org/rfc/rfc2616#section-14.21).

                '
              format: date-time
              type: string
            last-modified:
              description: The object modification time, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
              format: date-time
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-meta-*:
              description: The user-defined metadata for the object.
              type: string
              x-obmcs-header-collection: true
              x-obmcs-prefix: opc-meta-
            opc-multipart-md5:
              description: 'Only applicable to objects uploaded using multipart upload.

                Base-64 representation of the multipart object hash.

                The multipart object hash is calculated by taking the MD5 hashes of
                the parts,

                concatenating the binary representation of those hashes in order of
                their part numbers,

                and then calculating the MD5 hash of the concatenated values.

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            storage-tier:
              description: The storage tier that the object is stored in.
              enum: *id001
              type: string
              x-obmcs-top-level-enum: '#/definitions/StorageTier'
            time-of-archival:
              description: Time that the object is returned to the archived state.
                This field is only present for restored objects.
              format: date-time
              type: string
            version-id:
              description: VersionId of the object requested
              type: string
          schema:
            format: binary
            type: string
        304:
          description: Not Modified
          headers:
            ETag:
              description: The entity tag (ETag) for the object.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: GET Object
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/o/dummy_object
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.10.0

        date: Fri, 19 Aug 2016 23:43:49 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Object'
    head:
      description: 'Gets the user-defined metadata and entity tag (ETag) for an object.

        '
      operationId: HeadObject
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ObjectPathParam'
      - $ref: '#/parameters/VersionIdQueryParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeaderExceptStar'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/OptionalSSECustomerAlgorithmHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeyHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeySHA256Header'
      responses:
        200:
          description: The object metadata and bytes.
          headers:
            ETag:
              description: The entity tag (ETag) for the object.
              type: string
            archival-state:
              description: Archival state of an object. This field is set only for
                objects in Archive tier.
              enum: *id002
              type: string
              x-obmcs-top-level-enum: '#/definitions/ArchivalState'
            cache-control:
              description: Cache-Control header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.9).
              type: string
            content-disposition:
              description: Content-Disposition header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-19.5.1).
              type: string
            content-encoding:
              description: Content-Encoding header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.11).
              type: string
            content-language:
              description: Content-Language header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.12).
              type: string
            content-length:
              description: The object size in bytes.
              format: int64
              type: integer
            content-md5:
              description: 'Content-MD5 header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.15).

                Unavailable for objects uploaded using multipart upload.

                '
              type: string
            content-type:
              description: Content-Type header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.17).
              type: string
            last-modified:
              description: The object modification time, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
              format: date-time
              type: string
            opc-bucket-key-enabled:
              description: True if bucket key was enabled and used to encrypt the
                object during upload or reencrypt.
              type: boolean
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-meta-*:
              description: The user-defined metadata for the object.
              type: string
              x-obmcs-header-collection: true
              x-obmcs-prefix: opc-meta-
            opc-multipart-md5:
              description: 'Only applicable to objects uploaded using multipart upload.

                Base-64 representation of the multipart object hash.

                The multipart object hash is calculated by taking the MD5 hashes of
                the parts,

                concatenating the binary representation of those hashes in order of
                their part numbers,

                and then calculating the MD5 hash of the concatenated values.

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            storage-tier:
              description: The storage tier that the object is stored in.
              enum: *id001
              type: string
              x-obmcs-top-level-enum: '#/definitions/StorageTier'
            time-of-archival:
              description: Time that the object is returned to the archived state.
                This field is only present for restored objects.
              format: date-time
              type: string
            version-id:
              description: VersionId of the object requested
              type: string
        304:
          description: Not Modified
          headers:
            ETag:
              description: The entity tag (ETag) for the object.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: HEAD Object
      tags:
      - objectStorage
      x-example: 'HEAD /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/o/dummy_object
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.10.0

        date: Fri, 19 Aug 2016 23:39:51 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Object'
    put:
      description: "Creates a new object or overwrites an existing object with the\
        \ same name. The maximum object size allowed by\nPutObject is 50 GiB.\n\n\
        See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)\n\
        for object naming requirements. \n\nSee [Special Instructions for Object Storage\
        \ PUT](/Content/API/Concepts/signingrequests.htm#ObjectStoragePut)\nfor request\
        \ signature requirements.\n"
      operationId: PutObject
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ObjectPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/Expect100ContinueHeader'
      - $ref: '#/parameters/RequiredContentLengthHeader'
      - $ref: '#/parameters/OptionalContentMD5Header'
      - $ref: '#/parameters/ObjectAppendQueryParam'
      - $ref: '#/parameters/OptionalContentTypeHeader'
      - $ref: '#/parameters/OptionalContentLanguageHeader'
      - $ref: '#/parameters/OptionalContentEncodingHeader'
      - $ref: '#/parameters/OptionalContentDispositionHeader'
      - $ref: '#/parameters/OptionalCacheControlHeader'
      - $ref: '#/parameters/OptionalSSECustomerAlgorithmHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeyHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeySHA256Header'
      - $ref: '#/parameters/OptionalSSEKMSKeyIdHeader'
      - $ref: '#/parameters/OptionalStorageTierHeader'
      - $ref: '#/parameters/OpcMetaHeader'
      - description: The object to upload to the object store.
        in: body
        name: PutObjectBody
        required: true
        schema:
          format: binary
          type: string
      responses:
        200:
          description: The object was successfully created.
          headers:
            ETag:
              description: The entity tag (ETag) for the object.
              type: string
            append-offset:
              description: The offset where the chunk was appended to, in bytes. If
                no object exists, 0 will be returned. This header is only returned
                for append operations.
              format: int64
              type: integer
            committed-chunk-count:
              description: The number of chunks committed to the object. This can
                be used to manage how many more appends can be done.
              type: integer
            last-modified:
              description: The time the object was modified, as described in [RFC
                2616](https://tools.ietf.org/html/rfc2616#section-14.29).
              format: date-time
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-content-md5:
              description: The base64-encoded MD5 hash of the request body as computed
                by the server.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            version-id:
              description: VersionId of the newly created object
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: PUT Object
      tags:
      - objectStorage
      x-example: 'PUT /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/o/example_object
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        Connection: keep-alive

        Accept-Encoding: gzip, deflate

        Accept: */*

        User-Agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:55:34 GMT

        Content-Length: 128

        authorization: <var>&lt;authorization string&gt;</var>

        '
      x-obmcs-signing-strategy: exclude_body
      x-related-resource: '#/definitions/Object'
  /n/{namespaceName}/b/{bucketName}/objectversions:
    get:
      description: 'Lists the object versions in a bucket.


        ListObjectVersions returns an ObjectVersionCollection containing at most 1000
        object versions. To paginate through

        more object versions, use the returned `opc-next-page` value with the `page`
        request parameter.


        To use this and other API operations, you must be authorized in an IAM policy.
        If you are not authorized,

        talk to an administrator. If you are an administrator who needs to write policies
        to give users access, see

        [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

        '
      operationId: ListObjectVersions
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/PrefixQueryParam'
      - $ref: '#/parameters/StartWithQueryParam'
      - $ref: '#/parameters/EndBeforeQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/DelimiterQueryParam'
      - $ref: '#/parameters/ObjectFieldsQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/StartAfterQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      responses:
        200:
          description: 'List of object version summaries, including optional prefixes
            and, in a truncated response, the `opc-next-page` to

            start the next page of results.

            '
          examples:
            application-json: "{\n  \"items\": [\n    {\n      \"name\": \"1MB.data\"\
              ,\n      \"versionId\": \"A_v1\",\n      \"isDeleteMarker\": true,\n\
              \      \"timeModified\": \"Thu Feb 27 16:22:54 PST 2020\"\n    },\n\
              \    {\n      \"name\": \"2MB.data\",\n      \"versionId\": \"B_v1\"\
              ,\n      \"isDeleteMarker\": false,\n      \"timeModified\": \"Thu Feb\
              \ 27 16:22:54 PST 2020\"\n    }\n  ]\n}\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of object versions.

                In the GET request, set the limit to the number of object versions
                that you want returned in the response.

                If the `opc-next-page` header appears in the response, then this is
                a partial list and there are

                additional object versions to get. Include the header''s value as
                the `page` parameter in the subsequent

                GET request to get the next batch of object versions and prefixes.
                Repeat this process to retrieve the entire list of

                object versions and prefixes.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/ObjectVersionCollection'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List Object Versions
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/o/versions
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 23:00:25 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Object'
  /n/{namespaceName}/b/{bucketName}/p/:
    get:
      description: 'Lists pre-authenticated requests for the bucket.

        '
      operationId: ListPreauthenticatedRequests
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ObjectNamePrefixQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: Lists pre-authenticated requests metadata for this bucket and
            object.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of pre-authenticated requests.

                In the GET request, set the limit to the number of pre-authenticated
                requests that you want returned in

                the response. If the `opc-next-page` header appears in the response,
                then this is a partial list and there

                are additional pre-authenticated requests to get. Include the header''s
                value as the `page` parameter in

                the subsequent GET request to get the next batch of pre-authenticated
                requests. Repeat this process to

                retrieve the entire list of pre-authenticated requests.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            items:
              $ref: '#/definitions/PreauthenticatedRequestSummary'
            type: array
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List Preauthenticated Requests
      tags:
      - objectStorage
      x-related-resource: '#/definitions/PreauthenticatedRequest'
    post:
      description: 'Creates a pre-authenticated request specific to the bucket.

        '
      operationId: CreatePreauthenticatedRequest
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: Information needed to create the pre-authenticated request.
        in: body
        name: CreatePreauthenticatedRequestDetails
        required: true
        schema:
          $ref: '#/definitions/CreatePreauthenticatedRequestDetails'
      responses:
        200:
          description: The pre-authenticated request for the object was successfully
            created.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/PreauthenticatedRequest'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Create Preauthenticated Request
      tags:
      - objectStorage
      x-related-resource: '#/definitions/PreauthenticatedRequest'
  /n/{namespaceName}/b/{bucketName}/p/{parId}:
    delete:
      description: Deletes the pre-authenticated request for the bucket.
      operationId: DeletePreauthenticatedRequest
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/PreauthenticatedRequestIdPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: Deletes the metadata for the specified pre-authenticated request.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: DELETE Preauthenticated Request
      tags:
      - objectStorage
      x-related-resource: '#/definitions/PreauthenticatedRequest'
    get:
      description: Gets the pre-authenticated request for the bucket.
      operationId: GetPreauthenticatedRequest
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/PreauthenticatedRequestIdPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: Fetches the metadata for the specified pre-authenticated request.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/PreauthenticatedRequestSummary'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: GET Preauthenticated Request
      tags:
      - objectStorage
      x-related-resource: '#/definitions/PreauthenticatedRequest'
  /n/{namespaceName}/b/{bucketName}/replicationPolicies:
    get:
      description: 'List the replication policies associated with a bucket.

        '
      operationId: ListReplicationPolicies
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationReplicationLimitQueryParam'
      responses:
        200:
          description: The list of replication policies.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of replication policies.

                In the GET request, set the limit to the number of buckets items that
                you want returned in the response.

                If the `opc-next-page` header appears in the response, then this is
                a partial list and there are additional

                policies to get. Include the header''s value as the `page` parameter
                in the subsequent GET request to get the

                next batch of policies. Repeat this process to retrieve the entire
                list of policies.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            items:
              $ref: '#/definitions/ReplicationPolicySummary'
            type: array
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List the replication policies associated with a bucket.
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/replicationPolicies

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Mar 2017 11:50:24 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Replication'
    post:
      description: 'Creates a replication policy for the specified bucket.

        '
      operationId: CreateReplicationPolicy
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: The replication policy.
        in: body
        name: CreateReplicationPolicyDetails
        required: true
        schema:
          $ref: '#/definitions/CreateReplicationPolicyDetails'
      responses:
        200:
          description: The replication policy was created.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular request,

                provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/ReplicationPolicy'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Create replication policy.
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/replicationPolicies\n\
        Host: objectstorage.us-phoenix-1.oraclecloud.com\nUser-Agent: curl/7.43.0\n\
        Accept: */*\nContent-Type: application/json\nDate: Fri, 10 Mar 2017 11:50:24\
        \ GMT\nAuthorization: <var>&lt;authorization and other headers&gt;</var>\n\
        {\n  \"name\": \"mypolicy\",\n  \"destinationRegionName\": \"us-phoenix-1\"\
        ,\n  \"destinationBucketName\": \"backup\"\n}\n"
      x-related-resource: '#/definitions/Replication'
  /n/{namespaceName}/b/{bucketName}/replicationPolicies/{replicationId}:
    delete:
      description: 'Deletes the replication policy associated with the source bucket.

        '
      operationId: DeleteReplicationPolicy
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ReplicationIdPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        204:
          description: The replication policy is being deleted.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular request,

                provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Delete replication policy.
      tags:
      - objectStorage
      x-example: 'DELETE /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/replicationPolicies/<var>&lt;replication_id&gt;</var>

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Mar 2017 11:50:24 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Replication'
    get:
      description: 'Get the replication policy.

        '
      operationId: GetReplicationPolicy
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ReplicationIdPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The replication policy.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular request,

                provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/ReplicationPolicy'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Get replication policy.
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/replicationPolicies/<var>&lt;replication_id&gt;</var>

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Mar 2017 11:50:24 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Replication'
  /n/{namespaceName}/b/{bucketName}/replicationSources:
    get:
      description: 'List the replication sources of a destination bucket.

        '
      operationId: ListReplicationSources
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationReplicationLimitQueryParam'
      responses:
        200:
          description: The list of replication sources.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of replication sources.

                In the GET request, set the limit to the number of items that you
                want returned in the response.

                If the `opc-next-page` header appears in the response, then this is
                a partial list and there are additional

                policies to get. Include the header''s value as the `page` parameter
                in the subsequent GET request to get the

                next batch of policies. Repeat this process to retrieve the entire
                list of sources.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            items:
              $ref: '#/definitions/ReplicationSource'
            type: array
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List the replication sources of a destination bucket.
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/replicationSources

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Mar 2017 11:50:24 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Replication'
  /n/{namespaceName}/b/{bucketName}/retentionRules:
    get:
      description: 'List the retention rules for a bucket. The retention rules are
        sorted based on creation time,

        with the most recently created retention rule returned first.

        '
      operationId: ListRetentionRules
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      responses:
        200:
          description: The list of retention rules.
          examples:
            application-json: "{\n  \"items\": [\n    {\n      \"id\": \"1e32e9ae-2058-4e57-84f4-3f4636dec005\"\
              ,\n      \"displayName\": \"retentionRule_1\",\n      \"duration\":\
              \ {\n        \"timeAmount\": 30,\n        \"timeUnit\": \"DAYS\"\n \
              \     },\n      \"timeRuleLocked\": \"2019-12-13T21:43:00.000Z\",\n\
              \      \"etag\": \"31e21d43-41e8-42b0-beb8-cc0baa50ef94\",\n      \"\
              timeCreated\": \"2019-11-11T17:23:46.000Z\",\n      \"timeModified\"\
              : \"2019-11-11T17:23:46.000Z\"\n    },\n    {\n      \"id\": \"2ae2fcce-5df9-4848-85cf-bee4c8b96e58\"\
              ,\n      \"displayName\": \"retentionRule_2\",\n      \"duration\":\
              \ {\n        \"timeAmount\": 60,\n        \"timeUnit\": \"DAYS\"\n \
              \     },\n      \"timeRuleLocked\": \"2020-12-21T17:23:46.000Z\",\n\
              \      \"etag\": \"31e21d43-41e8-42b0-beb8-cc0baa50ef97\",\n      \"\
              timeCreated\": \"2019-10-18T13:33:12.000Z\",\n      \"timeModified\"\
              : \"2019-11-08T06:48:51.000Z\"\n    },\n    {\n      \"id\": \"f3fbb9d8-12f1-497f-9837-6f596106b6e3\"\
              ,\n      \"displayName\": \"retentionRule_3\",\n      \"duration\":\
              \ {\n        \"timeAmount\": 90,\n        \"timeUnit\": \"DAYS\"\n \
              \     },\n      \"etag\": \"31e21d43-41e8-42b0-beb8-cc0baa50ef99\",\n\
              \      \"timeCreated\": \"2019-09-07T19:21:03.000Z\",\n      \"timeModified\"\
              : \"2019-11-30T19:37:46.000Z\"\n    }\n  ]\n}\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'Paginating a list of retention rules.

                If the `opc-next-page` header appears in the response, it indicates
                that this is a partial list

                of retention rules and there are additional rules to get. Include
                the value of this header as

                the `page` parameter in a subsequent GET request to get the next set
                of retention rules.

                Repeat this process to retrieve the entire list of retention rules.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/RetentionRuleCollection'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List the retention rules for a bucket.
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/retentionRules

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Nov 2019 11:50:24 GMT

        Opc-Client-Request-Id: sampleOpcClientRequestIdForList

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/RetentionRule'
    post:
      description: 'Creates a new retention rule in the specified bucket. The new
        rule will take effect typically within 30 seconds.

        Note that a maximum of 100 rules are supported on a bucket.

        '
      operationId: CreateRetentionRule
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: The retention rule to create for the bucket.
        in: body
        name: CreateRetentionRuleDetails
        required: true
        schema:
          $ref: '#/definitions/CreateRetentionRuleDetails'
      responses:
        200:
          description: The retention rule representation.
          examples:
            application-json: "{\n  \"id\": \"1e32e9ae-2058-4e57-84f4-3f4636dec005\"\
              ,\n  \"displayName\": \"sampleRetentionRule\",\n  \"duration\": {\n\
              \    \"timeAmount\": 30,\n    \"timeUnit\": \"DAYS\"\n  },\n  \"timeRuleLocked\"\
              : \"2019-12-13T17:23:46.000Z\",\n  \"etag\": \"31e21d43-41e8-42b0-beb8-cc0baa50ef94\"\
              ,\n  \"timeCreated\": \"2019-11-13T17:23:46.000Z\",\n  \"timeModified\"\
              : \"2019-11-13T17:23:46.000Z\"\n}\n"
          headers:
            etag:
              description: The entity tag (ETag) for the retention rule that was created.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular request, provide this
                request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/RetentionRule'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Create a new retention rule.
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/retentionRules\n\
        Host: objectstorage.us-phoenix-1.oraclecloud.com\nUser-Agent: curl/7.43.0\n\
        Accept: */*\nContent-Type: application/json\nContent-Length: 139\nDate: Fri,\
        \ 10 Nov 2019 11:50:24 GMT\nOpc-Client-Request-Id: sampleOpcClientRequestIdForCreate\n\
        Authorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"\
        displayName\": \"sampleRetentionRule\",\n  \"duration\": {\n    \"timeAmount\"\
        : 30,\n    \"timeUnit\": \"DAYS\"\n  },\n  \"timeRuleLocked\": \"2019-12-13T17:23:46.000Z\"\
        \n}\n"
      x-related-resource: '#/definitions/RetentionRule'
  /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}:
    delete:
      description: Deletes the specified rule. The deletion takes effect typically
        within 30 seconds.
      operationId: DeleteRetentionRule
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/RetentionRuleIdPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        204:
          description: Specified retention rule has been deleted.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Delete the specified retention rule.
      tags:
      - objectStorage
      x-example: 'DELETE /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/retentionRules/</var>/b/<var>&lt;retentionRuleId_string&gt;</var>
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept: */*

        date: Fri, 12 Nov 2019 23:04:28 GMT

        content-length: 0

        opc-client-request-id: sampleOpcClientRequestIdForDelete

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/RetentionRule'
    get:
      description: Get the specified retention rule.
      operationId: GetRetentionRule
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/RetentionRuleIdPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The specified retention rule.
          examples:
            application-json: "{\n  \"id\": \"1e32e9ae-2058-4e57-84f4-3f4636dec005\"\
              ,\n  \"displayName\": \"retentionRule_1\",\n  \"duration\": {\n    \"\
              timeAmount\": 30,\n    \"timeUnit\": \"DAYS\"\n  },\n  \"timeRuleLocked\"\
              : \"2019-12-13T21:43:00.000Z\",\n  \"etag\": \"31e21d43-41e8-42b0-beb8-cc0baa50ef94\"\
              ,\n  \"timeCreated\": \"2019-11-11T17:23:46.000Z\",\n  \"timeModified\"\
              : \"2019-11-11T17:23:46.000Z\"\n}\n"
          headers:
            etag:
              description: The entity tag (ETag) for the retention rule.
              type: string
            last-modified:
              description: The time the retention rule was last modified, as described
                in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29)
              format: date-time
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/RetentionRule'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Get the specified retention rule.
      tags:
      - objectStorage
      x-related-resource: '#/definitions/RetentionRule'
    put:
      description: 'Updates the specified retention rule. Rule changes take effect
        typically within 30 seconds.

        '
      operationId: UpdateRetentionRule
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/RetentionRuleIdPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: Request object for updating the retention rule.
        in: body
        name: UpdateRetentionRuleDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateRetentionRuleDetails'
      responses:
        200:
          description: The updated RetentionRule information.
          examples:
            application-json: "{\n  \"id\": \"1e32e9ae-2058-4e57-84f4-3f4636dec005\"\
              ,\n  \"displayName\": \"sampleRetentionRule\",\n  \"duration\": {\n\
              \    \"timeAmount\": 30,\n    \"timeUnit\": \"DAYS\"\n  },\n  \"timeRuleLocked\"\
              : \"2019-12-23T17:23:46.000Z\",\n  \"etag\": \"31e21d43-41e8-42b0-beb8-cc0baa50ef94\"\
              ,\n  \"timeCreated\": \"2019-11-13T17:23:46.000Z\",\n  \"timeModified\"\
              : \"2019-11-19T11:23:46.000Z\"\n}\n"
          headers:
            etag:
              description: The entity tag (ETag) for the retention rule that was updated.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/RetentionRule'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Update the specified retention rule.
      tags:
      - objectStorage
      x-example: "PUT /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/retentionRules/<var>&lt;retentionRuleId_string&gt;</var>\
        \ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection:\
        \ keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.11.0\n\
        date: Fri, 12 Nov 2019 22:50:18 GMT\ncontent-type: application/json\nauthorization:\
        \ <var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\"\
        : \"sampleRetentionRule\",\n  \"duration\": {\n    \"timeUnit\": \"DAYS\"\
        ,\n    \"timeAmount\": 30\n  },\n  \"timeRuleLocked\": \"2019-12-13T17:23:46.000Z\"\
        \n}\n"
      x-related-resource: '#/definitions/RetentionRule'
  /n/{namespaceName}/b/{bucketName}/u:
    get:
      description: 'Lists all of the in-progress multipart uploads for the given bucket
        in the given Object Storage namespace.

        '
      operationId: ListMultipartUploads
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The list of in-progress multipart uploads.
          examples:
            application-json: "[\n  {\n    \"namespace\": \"ansh8lvru1zp\",\n    \"\
              bucket\": \"MyBucket\",\n    \"object\": \"MyObject1\",\n    \"uploadId\"\
              : \"c892336f-ccvb-1bb8-6e75-a5649fd91178\"\n  },\n  {\n    \"namespace\"\
              : \"ansh8lvru1zp\",\n    \"bucket\": \"MyBucket\",\n    \"object\":\
              \ \"MyObject2\",\n    \"uploadId\": \"a54f378a-49c0-acvb-189f-58959597453a\"\
              \n  }\n]\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of multipart uploads.

                In the GET request, set the limit to the number of multipart uploads
                that you want returned in the response.

                If the `opc-next-page` header appears in the response, then this is
                a partial list and there are

                additional multipart uploads to get. Include the header''s value as
                the `page` parameter in the subsequent

                GET request to get the next batch of objects. Repeat this process
                to retrieve the entire list of

                multipart uploads.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            items:
              $ref: '#/definitions/MultipartUpload'
            type: array
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List Multipart Uploads
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/u
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Mar 2017 11:19:32 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/MultipartUpload'
    post:
      description: 'Starts a new multipart upload to a specific object in the given
        bucket in the given namespace.


        See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)

        for object naming requirements.

        '
      operationId: CreateMultipartUpload
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/OptionalSSECustomerAlgorithmHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeyHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeySHA256Header'
      - $ref: '#/parameters/OptionalSSEKMSKeyIdHeader'
      - description: Request object for creating a multipart upload.
        in: body
        name: CreateMultipartUploadDetails
        required: true
        schema:
          $ref: '#/definitions/CreateMultipartUploadDetails'
      responses:
        200:
          description: The full details of the newly created multipart upload.
          examples:
            application-json: "{\n  \"namespace\": \"ansh8lvru1zp\",\n  \"bucket\"\
              : \"MyBucket\",\n  \"object\": \"MyObject1\",\n  \"uploadId\": \"c892336f-ccvb-1bb8-6e75-a5649fd91178\"\
              \n}\n"
          headers:
            Location:
              description: The full path to the new upload.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/MultipartUpload'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        411:
          $ref: '#/responses/ContentLengthRequired'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Create Multipart Upload
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/u\
        \ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nUser-Agent:\
        \ curl/7.43.0\nAccept: */*\nDate: Fri, 10 Mar 2017 11:44:08 GMT\nAuthorization:\
        \ <var>&lt;authorization and other headers&gt;</var>\n{\n  \"object\": \"\
        example_object1\"\n}\n"
      x-related-resource: '#/definitions/MultipartUpload'
  /n/{namespaceName}/b/{bucketName}/u/{objectName}:
    delete:
      description: 'Aborts an in-progress multipart upload and deletes all parts that
        have been uploaded.

        '
      operationId: AbortMultipartUpload
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ObjectPathParam'
      - $ref: '#/parameters/UploadIdQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        204:
          description: The abort was successful. The response body is always empty.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Abort Multipart Upload
      tags:
      - objectStorage
      x-example: 'DELETE /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/u/example_object2?uploadid=a54f378a-49c0-acvb-189f-58959597453a
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Mar 2017 11:53:13 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/MultipartUpload'
    get:
      description: 'Lists the parts of an in-progress multipart upload.

        '
      operationId: ListMultipartUploadParts
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ObjectPathParam'
      - $ref: '#/parameters/UploadIdQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The list of parts associated with the specified in-progress
            multipart upload.
          examples:
            application-json: "[\n  {\n    \"partNumber\": 1,\n    \"etag\": \"3d240a5a-a2b0-45b2-bcvb-2ac6a02b422c\"\
              ,\n    \"md5\": \"rvr3UC1SmUw7cvb2NqPN0g==\",\n    \"size\": 8\n  },\n\
              \  {\n    \"partNumber\": 2,\n    \"etag\": \"15de104e-7cvb-3513-8da1-3b5e75a65ad7\"\
              ,\n    \"md5\": \"3poFVtJezCVBOi8RzhUB8Q==\",\n    \"size\": 8\n  }\n\
              ]\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of multipart upload parts.

                In the GET request, set the limit to the number of multipart upload
                parts that you want returned in the

                response. If the `opc-next-page` header appears in the response, then
                this is a partial list and there are

                additional multipart upload parts to get. Include the header''s value
                as the `page` parameter in the subsequent

                GET request to get the next batch of multipart upload parts. Repeat
                this process to retrieve the entire list

                of multipart upload parts.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            items:
              $ref: '#/definitions/MultipartUploadPartSummary'
            type: array
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List Multipart Upload Parts
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/u/example_object2?uploadid=a54f378a-49c0-acvb-189f-58959597453a
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Mar 2017 11:50:55 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/MultipartUpload'
    post:
      description: 'Commits a multipart upload, which involves checking part numbers
        and entity tags (ETags) of the parts, to create an aggregate object.

        '
      operationId: CommitMultipartUpload
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ObjectPathParam'
      - $ref: '#/parameters/UploadIdQueryParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: The part numbers and entity tags (ETags) for the parts you want
          to commit.
        in: body
        name: CommitMultipartUploadDetails
        required: true
        schema:
          $ref: '#/definitions/CommitMultipartUploadDetails'
      responses:
        200:
          description: The commit was successful.
          headers:
            ETag:
              description: The entity tag (ETag) for the object.
              type: string
            last-modified:
              description: The time the object was last modified, as described in
                [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
              format: date-time
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-multipart-md5:
              description: 'Base-64 representation of the multipart object MD5 hash.

                The multipart object hash is calculated by taking the MD5 hashes of
                the parts passed to this call,

                concatenating the binary representation of those hashes in order of
                their part numbers,

                and then calculating the MD5 hash of the concatenated values. The
                multipart object hash is followed

                by a hyphen and the total number of parts (for example, ''-6'').

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            version-id:
              description: VersionId of the newly created object
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Commit Multipart Upload
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/u/example_object1?uploadid=c892336f-ccvb-1bb8-6e75-a5649fd91178\
        \ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nUser-Agent:\
        \ curl/7.43.0\nAccept: */*\nContent-Type: application/json\nContent-Length:\
        \ 139\nDate: Fri, 10 Mar 2017 11:50:24 GMT\nAuthorization: <var>&lt;authorization\
        \ and other headers&gt;</var>\n{\n  \"partsToCommit\": [\n    {\n      \"\
        partNum\": 1,\n      \"etag\": \"3d240a5a-a2b0-45b2-bcvb-2ac6a02b422c\"\n\
        \    },\n    {\n      \"partNum\": 2,\n      \"etag\" : \"15de104e-7cvb-3513-8da1-3b5e75a65ad7\"\
        \n    }\n  ]\n}\n"
      x-related-resource: '#/definitions/MultipartUpload'
    put:
      description: 'Uploads a single part of a multipart upload.

        '
      operationId: UploadPart
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/BucketPathParam'
      - $ref: '#/parameters/ObjectPathParam'
      - $ref: '#/parameters/UploadIdQueryParam'
      - $ref: '#/parameters/UploadPartNumberQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeader'
      - $ref: '#/parameters/Expect100ContinueHeader'
      - $ref: '#/parameters/RequiredContentLengthHeader'
      - $ref: '#/parameters/OptionalContentMD5Header'
      - $ref: '#/parameters/OptionalSSECustomerAlgorithmHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeyHeader'
      - $ref: '#/parameters/OptionalSSECustomerKeySHA256Header'
      - $ref: '#/parameters/OptionalSSEKMSKeyIdHeader'
      - description: The part being uploaded to the Object Storage service.
        in: body
        name: UploadPartBody
        required: true
        schema:
          format: binary
          type: string
      responses:
        200:
          description: The upload of the part was successful. The response includes
            an ETag header.
          headers:
            ETag:
              description: The entity tag (ETag) for the object.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-content-md5:
              description: The base64-encoded MD5 hash of the request body, as computed
                by the server.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Upload Multipart Object Part
      tags:
      - objectStorage
      x-example: 'PUT /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var>/u/example_object2?uploadid=a54f378a-49c0-acvb-189f-58959597453a&uploadPartNum=1
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Content-Length: 8

        Content-Type: application/x-www-form-urlencoded

        Date: Fri, 10 Mar 2017 11:50:55 GMT

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-signing-strategy: exclude_body
      x-related-resource: '#/definitions/MultipartUpload'
  /n/{namespaceName}/inventoryRules:
    get:
      description: 'List the inventory rules.

        '
      operationId: ListInventoryRules
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The list of inventory rules.
          examples:
            application-json: "{\n  \"items\": [\n    {\n      \"etag\": \"4445dd4a-9d79-414e-b393-307bb7bb5871\"\
              ,\n      \"filter\": {\n          \"created-within-days\": 100,\n  \
              \        \"exclusion-prefixes\": [],\n          \"inclusion-prefixes\"\
              : [\n              \"_permanent_ost_tests/o/permanent-object/2025/01/01/00/02/07*\"\
              \n          ],\n          \"object-types\": [\n              \"OBJECT\"\
              \n          ]\n      },\n      \"id\": \"oir-fbe97d5a-2938-4f8b-b512-8ab3d88e310d\"\
              ,\n      \"is-enabled\": true,\n      \"report\": {\n          \"format\"\
              : \"PARQUET\",\n          \"schema-fields\": [\n              \"COMPARTMENT_ID\"\
              \n          ],\n          \"target-bucket\": \"_permanent_ost_tests\"\
              \n      },\n      \"report-recurrences\": \"FREQ=MONTHLY\",\n      \"\
              rule-name\": \"rule_name_1\",\n      \"rule-type\": \"OBJECT_RULE\"\
              ,\n      \"time-created\": \"2025-01-31T01:32:16.373000+00:00\",\n \
              \     \"time-modified\": \"2025-01-31T01:32:16.373000+00:00\"\n    },\n\
              \    {\n      \"etag\": \"824ca947-7485-4ac2-b009-87ccda3bab53\",\n\
              \      \"filter\": {\n          \"created-within-days\": 100,\n    \
              \      \"exclusion-prefixes\": [],\n          \"inclusion-prefixes\"\
              : [\n              \"_permanent_ost_tests/o/permanent-object/2025/01/01/00/02/07*\"\
              \n          ],\n          \"object-types\": [\n              \"OBJECT\"\
              \n          ]\n      },\n      \"id\": \"oir-a8dc0bf6-3e3b-4079-a8c4-40d153a11309\"\
              ,\n      \"is-enabled\": true,\n      \"report\": {\n          \"format\"\
              : \"PARQUET\",\n          \"schema-fields\": [\n              \"COMPARTMENT_ID\"\
              \n          ],\n          \"target-bucket\": \"inv_target_bucket\"\n\
              \      },\n      \"report-recurrences\": \"FREQ=MONTHLY\",\n      \"\
              rule-name\": \"daily\",\n      \"rule-type\": \"OBJECT_RULE\",\n   \
              \   \"time-created\": \"2025-01-31T08:24:30.710000+00:00\",\n      \"\
              time-modified\": \"2025-01-31T08:24:30.710000+00:00\"\n    },\n    {\n\
              \      \"etag\": \"154de92a-b711-498f-99c8-56754c20c94b\",\n      \"\
              filter\": {\n          \"created-within-days\": -1,\n          \"exclusion-prefixes\"\
              : [],\n          \"inclusion-prefixes\": [\n              \"bucket1/o/*\"\
              \n          ],\n          \"object-types\": [\n              \"OBJECT\"\
              \n          ]\n      },\n      \"id\": \"oir-edb87a59-b8cb-4bda-ba71-3abaeeb192fd\"\
              ,\n      \"is-enabled\": true,\n      \"report\": {\n          \"format\"\
              : \"PARQUET\",\n          \"schema-fields\": [\n              \"ETAG\"\
              ,\n              \"SIZE\"\n          ],\n          \"target-bucket\"\
              : \"MyReports\"\n      },\n      \"report-recurrences\": \"FREQ=MONTHLY\"\
              ,\n      \"rule-name\": \"SampleRule_1\",\n      \"rule-type\": \"OBJECT_RULE\"\
              ,\n      \"time-created\": \"2025-01-31T09:02:16.312000+00:00\",\n \
              \     \"time-modified\": \"2025-01-31T09:02:16.312000+00:00\"\n    }\n\
              \  ]\n}\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'Paginating a list of Inventory rules.

                If the `opc-next-page` header appears in the response, it indicates
                that this is a partial list

                of inventory rules and there are additional rules to get. Include
                the value of this header as

                the `page` parameter in a subsequent GET request to get the next set
                of inventory rules.

                Repeat this process to retrieve the entire list of inventory rules.

                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/InventoryRuleCollection'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List the inventory rules.
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/inventoryRules

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        User-Agent: curl/7.43.0

        Accept: */*

        Date: Fri, 10 Nov 2019 11:50:24 GMT

        Opc-Client-Request-Id: sampleOpcClientRequestIdForList

        Authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/InventoryRule'
    post:
      description: 'Creates a new inventory rule in the namespace

        '
      operationId: CreateInventoryRule
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: The inventory rule to create in namespace.
        in: body
        name: CreateInventoryRuleDetails
        required: true
        schema:
          $ref: '#/definitions/CreateInventoryRuleDetails'
      responses:
        200:
          description: The inventory rule representation.
          examples:
            application-json: "{\n  \"etag\": \"154de92a-b711-498f-99c8-56754c20c94b\"\
              ,\n  \"filter\": {\n    \"created-within-days\": -1,\n    \"exclusion-prefixes\"\
              : [],\n    \"inclusion-prefixes\": [\n        \"bucket1/o/*\"\n    ],\n\
              \    \"object-types\": [\n        \"OBJECT\"\n    ]\n  },\n  \"id\"\
              : \"oir-edb87a59-b8cb-4bda-ba71-3abaeeb192fd\",\n  \"is-enabled\": true,\n\
              \  \"report\": {\n    \"format\": \"PARQUET\",\n    \"schema-fields\"\
              : [\n        \"ETAG\",\n        \"SIZE\"\n    ],\n    \"target-bucket\"\
              : \"MyReports\"\n  },\n  \"report-recurrences\": \"FREQ=MONTHLY\",\n\
              \  \"rule-name\": \"SampleRule_1\",\n  \"rule-type\": \"OBJECT_RULE\"\
              ,\n  \"time-created\": \"2025-01-31T09:02:16.312000+00:00\",\n  \"time-modified\"\
              : \"2025-01-31T09:02:16.312000+00:00\"\n}\n"
          headers:
            etag:
              description: The entity tag (ETag) for the inventory rule that was created.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular request, provide this
                request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/InventoryRule'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Create a new inventory rule.
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/inventoryRules\nHost:\
        \ objectstorage.us-phoenix-1.oraclecloud.com\nUser-Agent: curl/7.43.0\nAccept:\
        \ */*\nContent-Type: application/json\nContent-Length: 139\nDate: Fri, 10\
        \ Nov 2019 11:50:24 GMT\nOpc-Client-Request-Id: sampleOpcClientRequestIdForCreate\n\
        Authorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"\
        filter\": {\n    \"createdWithinDays\": -1,\n    \"exclusionPrefixes\": [],\n\
        \    \"inclusionPrefixes\": [\n      \"bucket1/o/*\"\n    ],\n    \"objectTypes\"\
        : [\n      \"OBJECT\"\n    ]\n  },\n  \"isEnabled\": true,\n  \"namespaceName\"\
        : \"r1vqmshs0dzo\",\n  \"report\": {\n    \"format\": \"PARQUET\",\n    \"\
        schemaFields\": [\n      \"ETAG\",\n      \"SIZE\"\n    ],\n    \"targetBucket\"\
        : \"MyReports\"\n  },\n  \"reportRecurrences\": \"FREQ=MONTHLY\",\n  \"ruleName\"\
        : \"SampleRule_1\",\n  \"ruleType\": \"OBJECT_RULE\"\n}\n"
      x-related-resource: '#/definitions/InventoryRule'
  /n/{namespaceName}/inventoryRules/{inventoryRuleId}:
    delete:
      description: Deletes the specified rule.
      operationId: DeleteInventoryRule
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/InventoryRuleIdPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        204:
          description: Specified Inventory rule has been deleted.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Delete the specified inventory rule.
      tags:
      - objectStorage
      x-example: 'DELETE /n/<var>&lt;namespace_string&gt;</var>/inventoryRules/</var><var>&lt;inventoryRuleId_string&gt;</var>
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept: */*

        date: Fri, 12 Nov 2019 23:04:28 GMT

        content-length: 0

        opc-client-request-id: sampleOpcClientRequestIdForDelete

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/InventoryRule'
    get:
      description: Get the specified inventory rule.
      operationId: GetInventoryRule
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/InventoryRuleIdPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The specified inventory rule.
          examples:
            application-json: "{\n  \"etag\": \"154de92a-b711-498f-99c8-56754c20c94b\"\
              ,\n  \"filter\": {\n      \"created-within-days\": -1,\n      \"exclusion-prefixes\"\
              : [],\n      \"inclusion-prefixes\": [\n          \"bucket1/o/*\"\n\
              \      ],\n      \"object-types\": [\n          \"OBJECT\"\n      ]\n\
              \  },\n  \"id\": \"oir-edb87a59-b8cb-4bda-ba71-3abaeeb192fd\",\n  \"\
              is-enabled\": true,\n  \"report\": {\n      \"format\": \"PARQUET\"\
              ,\n      \"schema-fields\": [\n          \"ETAG\",\n          \"SIZE\"\
              \n      ],\n      \"target-bucket\": \"MyReports\"\n  },\n  \"report-recurrences\"\
              : \"FREQ=MONTHLY\",\n  \"rule-name\": \"SampleRule_1\",\n  \"rule-type\"\
              : \"OBJECT_RULE\",\n  \"time-created\": \"2025-01-31T09:02:16.312000+00:00\"\
              ,\n  \"time-modified\": \"2025-01-31T09:02:16.312000+00:00\"\n}\n"
          headers:
            etag:
              description: The entity tag (ETag) for the inventory rule.
              type: string
            last-modified:
              description: The time the inventory rule was last modified, as described
                in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29)
              format: date-time
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/InventoryRule'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Get the specified inventory rule.
      tags:
      - objectStorage
      x-related-resource: '#/definitions/InventoryRule'
    put:
      description: 'Updates the specified inventory rule. Rule changes take effect
        typically within 30 seconds.

        '
      operationId: UpdateInventoryRule
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/InventoryRuleIdPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: Request object for updating the inventory rule.
        in: body
        name: UpdateInventoryRuleDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateInventoryRuleDetails'
      responses:
        200:
          description: The updated InventoryRule information.
          examples:
            application-json: "{\n  \"etag\": \"23b222ca-06d5-4588-9ba0-c3221f7143ce\"\
              ,\n  \"filter\": {\n    \"created-within-days\": 4,\n    \"exclusion-prefixes\"\
              : [\n        \"*/o/tmp*\"\n    ],\n    \"inclusion-prefixes\": [\n \
              \       \"*/o/log*\"\n    ],\n    \"object-types\": [\n        \"OBJECT\"\
              \n    ]\n  },\n  \"id\": \"oir-a6a172b5-42cb-4996-b01b-d6c83a409a4a\"\
              ,\n  \"is-enabled\": true,\n  \"report\": {\n    \"format\": \"PARQUET\"\
              ,\n    \"schema-fields\": [\n        \"SIZE\",\n        \"COMPARTMENT_ID\"\
              \n    ],\n    \"target-bucket\": \"destinationBucket\"\n  },\n  \"report-recurrences\"\
              : \"FREQ=MONTHLY\",\n  \"rule-name\": \"SampleRuleUpdate\",\n  \"rule-type\"\
              : \"OBJECT_RULE\",\n  \"time-created\": \"2025-01-31T08:58:15.867000+00:00\"\
              ,\n  \"time-modified\": \"2025-01-31T09:19:56.725000+00:00\"\n}\n"
          headers:
            etag:
              description: The entity tag (ETag) for the inventory rule that was updated.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/InventoryRule'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Update the specified inventory rule.
      tags:
      - objectStorage
      x-example: "PUT /n/<var>&lt;namespace_string&gt;</var>/inventoryRules/<var>&lt;inventoryRuleId_string&gt;</var>\
        \ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection:\
        \ keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.11.0\n\
        date: Fri, 12 Nov 2019 22:50:18 GMT\ncontent-type: application/json\nauthorization:\
        \ <var>&lt;authorization and other headers&gt;</var>\n{\n  \"filter\": {\n\
        \    \"created-within-days\": 4,\n    \"exclusion-prefixes\": [\n        \"\
        */o/tmp*\"\n    ],\n    \"inclusion-prefixes\": [\n        \"*/o/log*\"\n\
        \    ],\n    \"object-types\": [\n        \"OBJECT\"\n    ]\n  },\n  \"inventoryRuleId\"\
        : \"oir-a6a172b5-42cb-4996-b01b-d6c83a409a4a\",\n  \"is-enabled\": true,\n\
        \  \"report\": {\n    \"format\": \"PARQUET\",\n    \"schema-fields\": [\n\
        \        \"SIZE\",\n        \"COMPARTMENT_ID\"\n    ],\n    \"target-bucket\"\
        : \"destinationBucket\"\n  },\n  \"report-recurrences\": \"FREQ=MONTHLY\"\
        ,\n  \"rule-name\": \"SampleRuleUpdate\",\n  \"rule-type\": \"OBJECT_RULE\"\
        \n}\n"
      x-related-resource: '#/definitions/InventoryRule'
  /n/{namespaceName}/pe/:
    get:
      description: 'Gets a list of all PrivateEndpointSummary in a compartment associated
        with a namespace.

        To use this and other API operations, you must be authorized in an IAM policy.
        If you are not authorized,

        talk to an administrator. If you are an administrator who needs to write policies
        to give users access, see

        [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

        '
      operationId: ListPrivateEndpoints
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/ListPrivateEndpointFieldsQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/lifecycleState'
      responses:
        200:
          description: A page of PrivateEndpointSummary objects.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of PEs.

                In the GET request, set the limit to the number of Private Endpoint
                items that you want returned in the response.

                If the `opc-next-page` header appears in the response, then this is
                a partial list and there are additional

                Private Endpoint''s to get. Include the header''s value as the `page`
                parameter in the subsequent GET request to get the

                next batch of PEs. Repeat this process to retrieve the entire list
                of Private Endpoint''s.

                By default, the page limit is set to 25 Private Endpoint''s per page,
                but you can specify a value from 1 to 1000.

                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            items:
              $ref: '#/definitions/PrivateEndpointSummary'
            type: array
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List Private Endpoints
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/pe/ HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 20 Jan 2017 22:52:33 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
    post:
      description: 'Create a PrivateEndpoint.

        '
      operationId: CreatePrivateEndpoint
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - description: Details to create a private endpoint.
        in: body
        name: CreatePrivateEndpointDetails
        required: true
        schema:
          $ref: '#/definitions/CreatePrivateEndpointDetails'
      responses:
        202:
          description: The request has been accepted for processing, but the processing
            has not completed.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous
                request. If you need to contact Oracle about a

                particular request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Create PrivateEndpoint
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/pe/ HTTP/1.1\nHost:\
        \ objectstorage.us-phoenix-1.oraclecloud.com\nconnection: keep-alive\naccept-encoding:\
        \ gzip, deflate\naccept: */*\nuser-agent: python-requests/2.11.0\ndate: Fri,\
        \ 12 Aug 2016 22:50:18 GMT\nx-content-sha256: GzeGbC8Ad9cEhdcnD2wjPiUej5TIHHw2I+uj4w7Jot4=\n\
        Content-Length: 148\ncontent-type: application/json\nauthorization: <var>&lt;authorization\
        \ and other headers&gt;</var>\n{\n  \"name\": \"my-new-private-endpoint-1\"\
        ,\n  \"namespace\": \"unique_namespace\",\n  \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentID\"\
        ,\n  \"subnetId\": \"ocid.subnet.oc1..exampleuniquesubnetID\",\n  \"prefix\"\
        : \"myprefix\",\n  \"additionalPrefixes\": [\"myprefix-1\", \"myprefix-2\"\
        ],\n  \"accessTargets\": [\n    {\n      \"namespace\": \"ns1\",\n      \"\
        compartmentId\": \"comp1\",\n      \"bucket\": \"b1\"\n    },\n    {\n   \
        \   \"namespace\": \"ns2\",\n      \"compartmentId\": \"comp2\",\n      \"\
        bucket\" : \"*\"\n    },\n    {\n      \"namespace\": \"ns3\",\n      \"compartmentId\"\
        : \"*\",\n      \"bucket\": \"b2\"\n    },\n    {\n      \"namespace\": \"\
        ns4\",\n      \"compartmentId\": \"*\",\n      \"bucket\": \"*\"\n    }\n\
        \  ],\n  \"freeformTags\": {\"Department\": \"Finance\"},\n  \"definedTags\"\
        :\n  {\n    \"MyTags\":\n    {\n      \"CostCenter\": \"42\",\n      \"Project\"\
        : \"Stealth\",\n      \"CreatedBy\": \"BillSmith\",\n      \"CreatedDate\"\
        : \"9/21/2017T14:00\"\n    },\n    \"Audit\":\n    {\n      \"DataSensitivity\"\
        : \"PII\",\n      \"CageSecurity\": \"High\",\n      \"Simplicity\": \"complex\"\
        \n    }\n  }\n}\n"
      x-related-resource: '#/definitions/PrivateEndpoint'
  /n/{namespaceName}/pe/{peName}/:
    delete:
      description: 'Deletes a Private Endpoint if it exists in the given namespace.

        '
      operationId: DeletePrivateEndpoint
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/PrivateEndpointPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        202:
          description: The request has been accepted for processing, but the processing
            is not yet done.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous
                request. If you need to contact Oracle about a

                particular request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        403:
          $ref: '#/responses/Forbidden'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: DELETE Private Endpoint
      tags:
      - objectStorage
      x-example: 'DELETE /n/<var>&lt;namespace_string&gt;</var>/pe/<var>&lt;</var>
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 23:04:28 GMT

        content-length: 0

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/PrivateEndpoint'
    get:
      description: 'Gets the current representation of the given Private Endpoint
        in the given Object Storage namespace.

        '
      operationId: GetPrivateEndpoint
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/PrivateEndpointPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeaderExceptStar'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: A private endpoint representation for the requested private
            endpoint.
          examples:
            application-json: "{\n  \"name\": \"new_pe_1\",\n  \"namespace\": \"namespace_1\"\
              ,\n  \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentID\"\
              ,\n  \"id\": \"ocid1.pe.oc1.iad.examplepeID\",\n  \"createdBy\": \"\
              ocid1.user.oc1..exampleuniqueuserID\",\n  \"timeCreated\": \"2022-11-08T03:48:40.511Z\"\
              ,\n  \"subnetId\": \"ocid.subnet.oc1..exampleuniquesubnetID\",\n  \"\
              privateEndpointIp\": \"10.0.0.10\",\n  \"prefix\": \"myprefix\",\n \
              \ \"additionalPrefixes\": [\"myprefix-1\", \"myprefix-2\"],\n  \"etag\"\
              : \"9282a931-6367-4e8a-85d0-cfe9796b20ef\",\n  \"freeformTags\": {\"\
              Department\": \"Finance\"},\n  \"fqdns\": {\n    \"prefixFqdns\": {\n\
              \      \"objectStorageApiFqdn\": \"https://myprefix-namespace_1.private.customer-oci.objectstorage.r1.oci.oraclecloud.com\"\
              ,\n      \"s3CompatibilityApiFqdn\": \"myprefix-namespace_1.private.customer-oci.compat.objectstorage.r1.oci.oraclecloud.com\"\
              ,\n      \"swiftApiFqdn\": \"myprefix-namespace_1.private.customer-oci.swiftobjectstorage.r1.oci.oraclecloud.com\"\
              \n    },\n    \"additionalPrefixesFqdns\": {\n      \"addPrefix1\":\
              \ {\n        \"objectStorageApiFqdn\": \"https://addPrefix1-namespace_1.private.customer-oci.objectstorage.r1.oci.oraclecloud.com\"\
              ,\n        \"s3CompatibilityApiFqdn\": \"addPrefix1-namespace_1.private.customer-oci.compat.objectstorage.r1.oci.oraclecloud.com\"\
              ,\n        \"swiftApiFqdn\": \"addPrefix1-namespace_1.private.customer-oci.swiftobjectstorage.r1.oci.oraclecloud.com\"\
              \n      },\n      \"addPrefix2\": {\n        \"objectStorageApiFqdn\"\
              : \"https://addPrefix2-namespace_2.private.customer-oci.objectstorage.r1.oci.oraclecloud.com\"\
              ,\n        \"s3CompatibilityApiFqdn\": \"addPrefix2-namespace_2.private.customer-oci.compat.objectstorage.r1.oci.oraclecloud.com\"\
              ,\n        \"swiftApiFqdn\": \"addPrefix2-namespace_2.private.customer-oci.swiftobjectstorage.r1.oci.oraclecloud.com\"\
              \n      }\n    }\n  },\n  \"definedTags\":\n  {\n    \"MyTags\":\n \
              \   {\n      \"CostCenter\": \"42\",\n      \"Project\": \"Stealth\"\
              ,\n      \"CreatedBy\": \"BillSmith\",\n      \"CreatedDate\": \"9/21/2017T14:00\"\
              \n    },\n    \"Audit\":\n    {\n      \"DataSensitivity\": \"PII\"\
              ,\n      \"CageSecurity\": \"High\",\n      \"Simplicity\": \"complex\"\
              \n    }\n  }\n}\n"
          headers:
            eTag:
              description: The entity tag (ETag) for the Private Endpoint.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            $ref: '#/definitions/PrivateEndpoint'
        304:
          description: Not Modified
          headers:
            ETag:
              description: The entity tag (ETag) for the Private Endpoint.
              type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Get PrivateEndpoint
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/pe/<var>&lt;pe_name&gt;</var>
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:52:33 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/PrivateEndpoint'
    post:
      description: "Performs a partial or full update of a user-defined data associated\
        \ with the Private Endpoint.\n\nUse UpdatePrivateEndpoint to move a Private\
        \ Endpoint from one compartment to another within the same tenancy. Supply\
        \ the compartmentID\nof the compartment that you want to move the Private\
        \ Endpoint to. Or use it to update the name, subnetId, endpointFqdn or privateEndpointIp\
        \ or accessTargets of the Private Endpoint.\nFor more information about moving\
        \ resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\
        \nThis API follows replace semantics (rather than merge semantics). That means\
        \ if the body provides values for \nparameters and the resource has exisiting\
        \ ones, this operation will replace those existing values.  \n"
      operationId: UpdatePrivateEndpoint
      parameters:
      - $ref: '#/parameters/NamespacePathParam'
      - $ref: '#/parameters/PrivateEndpointPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/IfMatchHeader'
      - description: Request object for updating the Private Endpoint.
        in: body
        name: UpdatePrivateEndpointDetails
        required: true
        schema:
          $ref: '#/definitions/UpdatePrivateEndpointDetails'
      responses:
        202:
          description: The request has been accepted for processing, but the processing
            is not yet done.
          examples:
            application-json: "{\n  \"name\": \"my-pe-1\",\n  \"namespace\": \"namespace_1\"\
              ,\n  \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentID\"\
              ,\n  \"id\": \"ocid1.pe.oc1.iad.examplePEID\",\n  \"createdBy\": \"\
              ocid1.user.oc1..exampleuniqueuserID\",\n  \"timeCreated\": \"2016-08-23T20:58:02.497Z\"\
              ,\n  \"subnetId\": \"ocid.subnet.oc1..exampleuniquesubnetID\",\n  \"\
              prefix\": \"myprefix\",\n  \"additionalPrefixes\": [\"myprefix-1\",\
              \ \"myprefix-2\"],\n  \"etag\": \"82361183-a765-4e51-be48-933518c6ee5a\"\
              ,\n  \"accessTargets\":\n  [\n    {\n      \"namespace\": \"ns1\",\n\
              \      \"compartmentId\": \"comp1\",\n      \"bucket\": \"b1\"\n   \
              \ },\n    {\n      \"namespace\": \"ns2\",\n      \"compartmentId\"\
              : \"comp2\",\n      \"bucket\": \"*\"\n    },\n    {\n      \"namespace\"\
              : \"ns3\",\n      \"compartmentId\": \"*\",\n      \"bucket\": \"b2\"\
              \n    },\n    {\n      \"namespace\": \"ns4\",\n      \"compartmentId\"\
              : \"*\",\n      \"bucket\": \"*\"\n    }\n  ],\n  \"freeformTags\":\
              \ {\"Department\": \"Finance\"},\n  \"definedTags\":\n  {\n    \"MyTags\"\
              :\n    {\n      \"CostCenter\": \"42\",\n      \"Project\": \"Stealth\"\
              ,\n      \"CreatedBy\": \"BillSmith\",\n      \"CreatedDate\": \"9/21/2017T14:00\"\
              \n    },\n    \"Audit\":\n    {\n      \"DataSensitivity\": \"PII\"\
              ,\n      \"CageSecurity\": \"High\",\n      \"Simplicity\": \"complex\"\
              \n    }\n  }\n}\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous
                request. If you need to contact Oracle about a

                particular request, provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        409:
          $ref: '#/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/responses/PreconditionFailed'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: POST Private Endpoint
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/pe/<var>&lt;pe_name&gt;</var>\
        \ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection:\
        \ keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.10.0\n\
        date: Tue, 23 Aug 2016 21:01:55 GMT\nx-content-sha256: XK0yY+agfR3IHWjFyQlO5LCU8IysvgpDdDGSRrb/xzA=\n\
        Content-Length: 80\ncontent-type: application/json\nauthorization: <var>&lt;authorization\
        \ and other headers&gt;</var>\n{\n  \"name\": \"my-new-private-endpoint-1\"\
        ,\n  \"namespace\": \"unique_namespace\",\n  \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentID\"\
        ,\n  \"subnetId\": \"ocid1.subnet.region1.sea..exampleSubnetId\",\n  \"privateEndpointIp\"\
        : \"10.0.0.10\",\n  \"prefix\": \"myprefix\",\n  \"additionalPrefixes\": [\"\
        myprefix-1\", \"myprefix-2\"],\n  \"accessTargets\":\n    [\n      {\n   \
        \     \"namespace\": \"ns1\",\n        \"compartmentId\": \"comp1\",\n   \
        \     \"bucket\": \"b1\"\n      },\n      {\n        \"namespace\": \"ns2\"\
        ,\n        \"compartmentId\": \"comp2\",\n        \"bucket\": \"*\"\n    \
        \  },\n      {\n        \"namespace\": \"ns3\",\n        \"compartmentId\"\
        : \"*\",\n        \"bucket\": \"b2\"\n      },\n      {\n        \"namespace\"\
        : \"ns4\",\n        \"compartmentId\": \"*\",\n        \"bucket\": \"*\"\n\
        \      },\n    ],\n  \"freeformTags\": {\"Department\": \"Finance\"},\n  \"\
        definedTags\":\n  {\n    \"MyTags\":\n    {\n      \"CostCenter\": \"42\"\
        ,\n       \"Project\": \"Stealth\",\n      \"CreatedBy\": \"BillSmith\",\n\
        \      \"CreatedDate\": \"9/21/2017T14:00\"\n    },\n    \"Audit\":\n    {\n\
        \      \"DataSensitivity\": \"PII\",\n      \"CageSecurity\": \"High\",\n\
        \      \"Simplicity\": \"complex\"\n    }\n  }\n}\n"
      x-related-resource: '#/definitions/PrivateEndpoint'
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/PrivateEndpointNameQueryParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: The list of work requests.
          examples:
            application-json: "[\n  {\n    \"operationType\": \"COPY_OBJECT\",\n \
              \   \"status\": \"IN_PROGRESS\",\n    \"id\": \"f54527d6-029b-4221-9046-a811b7686202\"\
              ,\n    \"resources\": [\n      {\n        \"entityType\": \"object\"\
              ,\n        \"actionType\": \"READ\",\n        \"entityUri\": \"/n/ansh8lvru1zp/b/backups/o/backup.tar.gz\"\
              ,\n        \"metadata\": {\n          \"REGION\": \"us-phoenix-1\",\n\
              \          \"NAMESPACE\": \"ansh8lvru1zp\",\n          \"BUCKET\": \"\
              backups\",\n          \"OBJECT\": \"backup.tar.gz\"\n        }\n   \
              \   },\n      {\n        \"entityType\": \"object\",\n        \"actionType\"\
              : \"WRITTEN\",\n        \"entityUri\": \"/n/ansh8lvru1zp/b/backups/o/backup2.tar.gz\"\
              ,\n        \"metadata\": {\n          \"REGION\": \"us-phoenix-1\",\n\
              \          \"NAMESPACE\": \"ansh8lvru1zp\",\n          \"BUCKET\": \"\
              backups\",\n          \"OBJECT\": \"backup2.tar.gz\"\n        }\n  \
              \    }\n    ],\n    \"timeAccepted\": \"2017-10-13T17:23:46.000Z\",\n\
              \    \"timeStarted\": \"2017-10-13T17:23:52.198Z\",\n    \"percentComplete\"\
              : 10.0\n  }\n]\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of work requests.

                In the GET request, set the limit to the number of compartment work
                requests that you want returned in the

                response. If the `opc-next-page` header appears in the response, then
                this is a partial list and there are

                additional work requests to get. Include the header''s value as the
                `page` parameter in the subsequent

                GET request to get the next batch of work requests. Repeat this process
                to retrieve the entire list of work

                requests.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            items:
              $ref: '#/definitions/WorkRequestSummary'
            type: array
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List Work Requests
      tags:
      - objectStorage
      x-example: 'GET /WorkRequests?compartmentId=ocid.compartment.oc1..exampleuniqueID
        HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 23:00:25 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    delete:
      description: 'Cancels a work request.

        '
      operationId: CancelWorkRequest
      parameters:
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        202:
          description: The request has been accepted for processing, but the processing
            has not completed.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular request,

                provide this request ID.

                '
              type: string
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: Cancel a work request
      tags:
      - objectStorage
      x-example: 'DELETE /WorkRequests/<example_work_request_ID> HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 23:01:51 GMT

        content-length: 0

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequest'
    get:
      description: Gets the status of the work request for the given ID.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The details of the work request.
          examples:
            application-json: "{\n  \"operationType\": \"COPY_OBJECT\",\n  \"status\"\
              : \"IN_PROGRESS\",\n  \"id\": \"f54527d6-029b-4221-9046-a811b7686202\"\
              ,\n  \"resources\": [\n    {\n      \"entityType\": \"object\",\n  \
              \    \"actionType\": \"READ\",\n      \"entityUri\": \"/n/ansh8lvru1zp/b/backups/o/backup.tar.gz\"\
              ,\n      \"metadata\": {\n        \"REGION\": \"us-phoenix-1\",\n  \
              \      \"NAMESPACE\": \"ansh8lvru1zp\",\n        \"BUCKET\": \"backups\"\
              ,\n        \"OBJECT\": \"backup.tar.gz\"\n      }\n    },\n    {\n \
              \     \"entityType\": \"object\",\n      \"actionType\": \"WRITTEN\"\
              ,\n      \"entityUri\": \"/n/ansh8lvru1zp/b/backups/o/backup2.tar.gz\"\
              ,\n      \"metadata\": {\n        \"REGION\": \"us-phoenix-1\",\n  \
              \      \"NAMESPACE\": \"ansh8lvru1zp\",\n        \"BUCKET\": \"backups\"\
              ,\n        \"OBJECT\": \"backup2.tar.gz\"\n      }\n    }\n  ],\n  \"\
              timeAccepted\": \"2017-10-13T17:23:46.000Z\",\n  \"timeStarted\": \"\
              2017-10-13T17:23:52.198Z\",\n  \"percentComplete\": 10.0\n}\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
            retry-after:
              description: A decimal number representing the number of seconds the
                client should wait before polling this endpoint again.
              format: float
              type: number
          schema:
            $ref: '#/definitions/WorkRequest'
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: GET Work Request Status
      tags:
      - objectStorage
      x-example: 'GET /WorkRequests/example_work_request_id HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.10.0

        date: Fri, 19 Aug 2016 23:43:49 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: Lists the errors of the work request with the given ID.
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The errors of the work request.
          examples:
            application-json: "{\n  \"errors\": [\n    {\n      \"code\": \"NotAuthorizedOrNotFound\"\
              ,\n      \"message\": \"This is an error\",\n      \"time\": \"2017-10-13T17:23:46.000Z\"\
              \n    },\n    {\n      \"code\": \"NotAuthorizedOrNotFound\",\n    \
              \  \"message\": \"This is another error\",\n      \"time\": \"2017-10-13T17:23:47.000Z\"\
              \n    }\n  ]\n}\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of work request errors.

                In the GET request, set the limit to the number of work request errors
                that you want returned in the

                response. If the `opc-next-page` header appears in the response, then
                this is a partial list and there are

                additional work request errors to get. Include the header''s value
                as the `page` parameter in the subsequent

                GET request to get the next batch of work request errors. Repeat this
                process to retrieve the entire list of work

                request errors.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            items:
              $ref: '#/definitions/WorkRequestError'
            type: array
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List Work Request Errors
      tags:
      - objectStorage
      x-example: 'GET /WorkRequests/example_work_request_id/errors HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.10.0

        date: Fri, 19 Aug 2016 23:43:49 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: Lists the logs of the work request with the given ID.
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The logs of the work request.
          examples:
            application-json: "{\n  \"logs\": [\n    {\n      \"message\": \"This\
              \ is a log\",\n      \"time\": \"2017-10-13T17:23:46.000Z\"\n    },\n\
              \    {\n      \"message\": \"This is another log\",\n      \"time\"\
              : \"2017-10-13T17:23:47.000Z\"\n    }\n  ]\n}\n"
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id
                header, for use by clients when debugging.
              type: string
            opc-next-page:
              description: 'For paginating a list of work request logs.

                In the GET request, set the limit to the number of compartment work
                requests that you want returned in the

                response. If the `opc-next-page` header appears in the response, then
                this is a partial list and there are

                additional work requests to get. Include the header''s value as the
                `page` parameter in the subsequent

                GET request to get the next batch of work requests. Repeat this process
                to retrieve the entire list of work

                requests.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If
                you need to contact Oracle about a particular

                request, provide this request ID.

                '
              type: string
          schema:
            items:
              $ref: '#/definitions/WorkRequestLogEntry'
            type: array
        400:
          $ref: '#/responses/BadRequest'
        401:
          $ref: '#/responses/NotAuthenticated'
        404:
          $ref: '#/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/responses/RequestTimeout'
        429:
          $ref: '#/responses/TooManyRequests'
        500:
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/Error'
      summary: List Work Request Logs
      tags:
      - objectStorage
      x-example: 'GET /WorkRequests/example_work_request_id/logs HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.10.0

        date: Fri, 19 Aug 2016 23:43:49 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequestLogEntry'
produces:
- application/json
responses:
  BadRequest:
    description: Bad Request
    headers:
      opc-request-id:
        description: Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular request, please provide the request
          ID.
        type: string
    schema:
      $ref: '#/definitions/Error'
  ContentLengthRequired:
    description: Content-Length Required
    headers:
      opc-request-id:
        description: Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular request, please provide the request
          ID.
        type: string
    schema:
      $ref: '#/definitions/Error'
  Error:
    description: A description of an error that occurred.
    headers:
      opc-client-request-id:
        description: Echoes back the value passed in the opc-client-request-id header,
          for use by clients when debugging.
        type: string
      opc-request-id:
        description: 'Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular

          request, provide this request ID.

          '
        type: string
    schema:
      $ref: '#/definitions/Error'
  Forbidden:
    description: Forbidden
    headers:
      opc-request-id:
        description: Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular request, please provide the request
          ID.
        type: string
    schema:
      $ref: '#/definitions/Error'
  InternalServerError:
    description: Internal Server Error
    headers:
      opc-request-id:
        description: Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular request, please provide the request
          ID.
        type: string
    schema:
      $ref: '#/definitions/Error'
  NotAuthenticated:
    description: Unauthorized
    headers:
      opc-request-id:
        description: Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular request, please provide the request
          ID.
        type: string
    schema:
      $ref: '#/definitions/Error'
  NotAuthorizedOrInternalConflict:
    description: Conflict
    headers:
      opc-request-id:
        description: Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular request, please provide the request
          ID.
        type: string
    schema:
      $ref: '#/definitions/Error'
  NotAuthorizedOrNotFound:
    description: Not Found
    headers:
      opc-request-id:
        description: Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular request, please provide the request
          ID.
        type: string
    schema:
      $ref: '#/definitions/Error'
  PreconditionFailed:
    description: Precondition Failed
    headers:
      opc-request-id:
        description: Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular request, please provide the request
          ID.
        type: string
    schema:
      $ref: '#/definitions/Error'
  RequestTimeout:
    description: Request Timeout
    headers:
      opc-request-id:
        description: Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular request, please provide the request
          ID.
        type: string
    schema:
      $ref: '#/definitions/Error'
  TooManyRequests:
    description: Too Many Requests
    headers:
      opc-request-id:
        description: Unique Oracle-assigned identifier for the request. If you need
          to contact Oracle about a particular request, please provide the request
          ID.
        type: string
    schema:
      $ref: '#/definitions/Error'
schemes:
- https
swagger: '2.0'
