sharing.s3.recoverable_buckets
==============================

Returns buckets that are no longer registered but whose datasets still exist.

Every mounted dataset no bucket uses is scanned for a configuration backup, and the configuration each backup holds is returned. :doc:`sharing.s3.recover <api_methods_sharing.s3.recover>` registers exactly that. Unmounted datasets and backups this version cannot read are skipped. A ``DATASET`` bucket has no backup and is never listed.

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionCall_parameters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters">
    <div class="card-body pl-5">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>Result</h4><span class="badge badge-dark value-type">Type: array of object</span><br/>
    <span class="description"><p>Array of datasets containing S3 data and configuration that can be recovered.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_items">
    <h4>SharingS3RecoverableBucket</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The stored configuration of a bucket that is no longer registered.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_items_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_name" data-toggle="collapse" onclick="setAnchor('#Return_value_items_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_name" id="Return_value_items_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Bucket name must be three to 63 characters of lowercase letters, digits, dots and hyphens, starting and ending with a letter or digit, no adjacent dots, and not an IP address.</p>
    </span><span class="pattern-value" id="Return_value_items_name_pattern">Must match regular expression: <code>^[a-z0-9][a-z0-9.-]*[a-z0-9]$</code></span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_items_name_minLength">Must be at least <code>3</code> characters long</span></p><p><span class="badge badge-light restriction max-length-restriction" id="Return_value_items_name_maxLength">Must be at most <code>63</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_dataset">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_dataset">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_dataset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_dataset" data-toggle="collapse" onclick="setAnchor('#Return_value_items_dataset')" type="button"><span class="property-name">dataset</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_dataset" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_dataset" id="Return_value_items_dataset">
    <div class="card-body pl-5">
    <h4>Dataset</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>The ZFS dataset of the bucket. The location of S3 data within the dataset depends on the <code>layout</code> field.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_items_dataset_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_layout">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_layout">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_layout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_layout" data-toggle="collapse" onclick="setAnchor('#Return_value_items_layout')" type="button"><span class="property-name">layout</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_layout" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_layout" id="Return_value_items_layout">
    <div class="card-body pl-5">
    <h4>Layout</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "BUCKET"</span><br/>
    <span class="description"><p>This create-time mutable field determines where S3 objects are located within the share. If set to <code>BUCKET</code> (the default), then the S3 share is a conventional S3 bucket that supports writes through the S3 protocol. Data must be accessed through the <code>s3data</code> directory inside the dataset. If set to <code>DATASET</code>, then the entire dataset contents are exposed as S3 objects, but S3 protocol access is restricted to read only operations. This setting is available to S3 protocol access to non-S3 data, for example, SMB or NFS shares.</p>
    </span><div class="enum-value" id="Return_value_items_layout_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"BUCKET"</li><li class="list-group-item enum-item">"DATASET"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_enabled">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_enabled">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_enabled" data-toggle="collapse" onclick="setAnchor('#Return_value_items_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_enabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_enabled" id="Return_value_items_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>Whether the bucket is served. Changing it reloads the S3 service.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_owner">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_owner">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_owner" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_owner" data-toggle="collapse" onclick="setAnchor('#Return_value_items_owner')" type="button"><span class="property-name">owner</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_owner" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_owner" id="Return_value_items_owner">
    <div class="card-body pl-5">
    <h4>Owner</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Account that owns the bucket and bypasses its grants, owns the <code>s3data</code> directory when the S3 service creates it, and owns every object written under the <code>BUCKET_OWNER_ENFORCED</code> object ownership setting.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_items_owner_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_owner_uid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_owner_uid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_owner_uid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_owner_uid" data-toggle="collapse" onclick="setAnchor('#Return_value_items_owner_uid')" type="button"><span class="property-name">owner_uid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_owner_uid" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_owner_uid" id="Return_value_items_owner_uid">
    <div class="card-body pl-5">
    <h4>Owner Uid</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>The uid that owns the bucket.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_grants">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_grants">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_grants" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_grants" data-toggle="collapse" onclick="setAnchor('#Return_value_items_grants')" type="button"><span class="property-name">grants</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_grants" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_grants" id="Return_value_items_grants">
    <div class="card-body pl-5">
    <h4>Grants</h4><span class="badge badge-dark value-type">Type: array of object</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>Who may access the bucket and how, beyond its owner.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_items_grants_items">
    <h4>S3GrantEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_items_grants_items_principal_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_grants_items_principal_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_grants_items_principal_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_grants_items_principal_type" data-toggle="collapse" onclick="setAnchor('#Return_value_items_grants_items_principal_type')" type="button"><span class="property-name">principal_type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_grants_items_principal_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_grants_items_principal_type" id="Return_value_items_grants_items_principal_type">
    <div class="card-body pl-5">
    <h4>Principal Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Who the grant applies to. A user, a group, or everyone with a valid access key.</p>
    </span><div class="enum-value" id="Return_value_items_grants_items_principal_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"USER"</li><li class="list-group-item enum-item">"GROUP"</li><li class="list-group-item enum-item">"EVERYONE"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_grants_items_xid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_grants_items_xid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_grants_items_xid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_grants_items_xid" data-toggle="collapse" onclick="setAnchor('#Return_value_items_grants_items_xid')" type="button"><span class="property-name">xid</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_grants_items_xid" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_grants_items_xid" id="Return_value_items_grants_items_xid">
    <div class="card-body pl-5">
    <h4>Xid</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>The uid of the user or the gid of the group. Required for <code>USER</code> and <code>GROUP</code>, forbidden for <code>EVERYONE</code>.</p>
    </span><div class="any-of-value" id="Return_value_items_grants_items_xid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_grants_items_xid_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_grants_items_xid_anyOf_i0" id="Return_value_items_grants_items_xid_anyOf_i0" onclick="setAnchor('#Return_value_items_grants_items_xid_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_grants_items_xid_anyOf_i1" id="Return_value_items_grants_items_xid_anyOf_i1" onclick="setAnchor('#Return_value_items_grants_items_xid_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_grants_items_xid_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_grants_items_xid_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_grants_items_access">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_grants_items_access">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_grants_items_access" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_grants_items_access" data-toggle="collapse" onclick="setAnchor('#Return_value_items_grants_items_access')" type="button"><span class="property-name">access</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_grants_items_access" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_grants_items_access" id="Return_value_items_grants_items_access">
    <div class="card-body pl-5">
    <h4>Access</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>What the grant allows. <code>READONLY</code>, <code>WRITEONLY</code> and <code>READWRITE</code> allow the matching operations. <code>DENY</code> refuses every operation for the principal and outranks the bucket owner.</p>
    </span><div class="enum-value" id="Return_value_items_grants_items_access_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"READONLY"</li><li class="list-group-item enum-item">"WRITEONLY"</li><li class="list-group-item enum-item">"READWRITE"</li><li class="list-group-item enum-item">"DENY"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_grants_items_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_grants_items_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_grants_items_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_grants_items_name" data-toggle="collapse" onclick="setAnchor('#Return_value_items_grants_items_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_grants_items_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_grants_items_name" id="Return_value_items_grants_items_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name of the user or group the grant applies to, resolved for display. Empty for <code>EVERYONE</code>.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_permissions_model">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_permissions_model">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_permissions_model" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_permissions_model" data-toggle="collapse" onclick="setAnchor('#Return_value_items_permissions_model')" type="button"><span class="property-name">permissions_model</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_permissions_model" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_permissions_model" id="Return_value_items_permissions_model">
    <div class="card-body pl-5">
    <h4>Permissions Model</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "S3"</span><br/>
    <span class="description"><p>How the S3 service treats the filesystem permissions on the bucket's tree. When <code>S3</code> is set, access is solely determined by the bucket's grants and object ACL if the <code>object_ownership</code> bucket configuration field is not set to <code>BUCKET_OWNER_ENFORCED</code>. In this configuration, filesystem ACLs are not evaluated by the S3 server. When <code>MULTIPROTOCOL</code> is set, filesystem ACLs are enforced in addition to S3 protocol access control mechanisms. S3 shares with <code>DATASET</code> layout default to the <code>MULTIPROTOCOL</code> permissions model.</p>
    </span><div class="enum-value" id="Return_value_items_permissions_model_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"S3"</li><li class="list-group-item enum-item">"MULTIPROTOCOL"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_object_ownership">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_object_ownership">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_object_ownership" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_object_ownership" data-toggle="collapse" onclick="setAnchor('#Return_value_items_object_ownership')" type="button"><span class="property-name">object_ownership</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_object_ownership" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_object_ownership" id="Return_value_items_object_ownership">
    <div class="card-body pl-5">
    <h4>Object Ownership</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "BUCKET_OWNER_ENFORCED"</span><br/>
    <span class="description"><p>S3 Object Ownership, the bucket-level setting that controls ownership of objects uploaded to the bucket and disables or enables ACLs, and what <code>GetBucketOwnershipControls</code> reports. <code>BUCKET_OWNER_ENFORCED</code> (the default): ACLs are disabled, and the bucket owner automatically owns and has full control over every object in the bucket. ACLs no longer affect permissions to data in the bucket, and the bucket uses its grants to define access control. Requests to set or update ACLs fail with <code>AccessControlListNotSupported</code>; requests to read ACLs are supported. Only uploads with bucket owner full control ACLs, or uploads that do not specify an ACL, are accepted. <code>BUCKET_OWNER_PREFERRED</code>: the bucket owner owns and has full control over new objects that other accounts write to the bucket with the <code>bucket-owner-full-control</code> canned ACL. Objects uploaded with other ACLs are owned by the writing account. ACLs can be updated and can grant permissions. <code>OBJECT_WRITER</code>: the account that uploads an object owns the object, has full control over it, and can grant other users access to it through ACLs. A <code>MULTIPROTOCOL</code> bucket is always <code>OBJECT_WRITER</code> whatever is given here, and its ACLs stay disabled: the other protocols' users own the filesystem permissions on the tree.</p>
    </span><div class="enum-value" id="Return_value_items_object_ownership_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"BUCKET_OWNER_ENFORCED"</li><li class="list-group-item enum-item">"BUCKET_OWNER_PREFERRED"</li><li class="list-group-item enum-item">"OBJECT_WRITER"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_versioning">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_versioning">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_versioning" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_versioning" data-toggle="collapse" onclick="setAnchor('#Return_value_items_versioning')" type="button"><span class="property-name">versioning</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_versioning" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_versioning" id="Return_value_items_versioning">
    <div class="card-body pl-5">
    <h4>Versioning</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "OFF"</span><br/>
    <span class="description"><p>Bucket versioning state. One-way: a bucket that has been <code>ENABLED</code> or <code>SUSPENDED</code> cannot return to <code>OFF</code> here, only move between those two, so its stored versions never go unreachable. <code>sharing.s3.force_disable_versioning</code> is the one destructive way back, and it destroys every prior object version. NOTE: this is a licensed feature.</p>
    </span><div class="enum-value" id="Return_value_items_versioning_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"OFF"</li><li class="list-group-item enum-item">"ENABLED"</li><li class="list-group-item enum-item">"SUSPENDED"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_snapshot_versions">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_snapshot_versions">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_snapshot_versions" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_snapshot_versions" data-toggle="collapse" onclick="setAnchor('#Return_value_items_snapshot_versions')" type="button"><span class="property-name">snapshot_versions</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_snapshot_versions" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_snapshot_versions" id="Return_value_items_snapshot_versions">
    <div class="card-body pl-5">
    <h4>Snapshot Versions</h4><span class="badge badge-dark value-type">Type: array of string</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>Patterns over the names of the bucket dataset's ZFS snapshots, <code>*</code> and <code>?</code> the only metacharacters, each matched against a whole name. Every snapshot a pattern selects serves each object's state frozen in it as a read-only version: listed by <code>ListObjectVersions</code> and read by its version id. Empty serves none. Requires <code>versioning</code> to be <code>ENABLED</code> or <code>SUSPENDED</code>.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_items_snapshot_versions_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_items_snapshot_versions_items_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_snapshot_versions_max">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_snapshot_versions_max">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_snapshot_versions_max" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_snapshot_versions_max" data-toggle="collapse" onclick="setAnchor('#Return_value_items_snapshot_versions_max')" type="button"><span class="property-name">snapshot_versions_max</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_snapshot_versions_max" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_snapshot_versions_max" id="Return_value_items_snapshot_versions_max">
    <div class="card-body pl-5">
    <h4>Snapshot Versions Max</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 64</span><br/>
    <span class="description"><p>How many of the newest selected snapshots one <code>ListObjectVersions</code> listing consults. Bounds the listing alone: a selected snapshot beyond it still serves by its version id.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_items_snapshot_versions_max_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>4294967295</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_multipart_etag">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_multipart_etag">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_multipart_etag" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_multipart_etag" data-toggle="collapse" onclick="setAnchor('#Return_value_items_multipart_etag')" type="button"><span class="property-name">multipart_etag</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_multipart_etag" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_multipart_etag" id="Return_value_items_multipart_etag">
    <div class="card-body pl-5">
    <h4>Multipart Etag</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "MINTED"</span><br/>
    <span class="description"><p>ETag format for objects created by multipart upload. <code>MINTED</code> gives the object an opaque token. <code>COMPOSITE</code> gives it the standard S3 multipart ETag, built from the MD5 of each part. Choose <code>COMPOSITE</code> if a client verifies or resumes uploads by computing that ETag itself and comparing.</p>
    </span><div class="enum-value" id="Return_value_items_multipart_etag_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"COMPOSITE"</li><li class="list-group-item enum-item">"MINTED"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_object_lock">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_object_lock">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_object_lock" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_object_lock" data-toggle="collapse" onclick="setAnchor('#Return_value_items_object_lock')" type="button"><span class="property-name">object_lock</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_object_lock" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_object_lock" id="Return_value_items_object_lock">
    <div class="card-body pl-5">
    <h4>Object Lock</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Whether object lock is enabled. Requires <code>versioning</code> to be <code>ENABLED</code> and a permissions model other than <code>MULTIPROTOCOL</code>: a locked bucket is the S3 service's alone. One-way: the lock is latched on the bucket's dataset and cannot be disabled once enabled. NOTE: this is a licensed feature.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_object_lock_default_mode">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_object_lock_default_mode">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_object_lock_default_mode" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_object_lock_default_mode" data-toggle="collapse" onclick="setAnchor('#Return_value_items_object_lock_default_mode')" type="button"><span class="property-name">object_lock_default_mode</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_object_lock_default_mode" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_object_lock_default_mode" id="Return_value_items_object_lock_default_mode">
    <div class="card-body pl-5">
    <h4>Object Lock Default Mode</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Retention mode of the default object lock rule, or <code>null</code> for no default rule.</p>
    </span><div class="any-of-value" id="Return_value_items_object_lock_default_mode_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_object_lock_default_mode_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_object_lock_default_mode_anyOf_i0" id="Return_value_items_object_lock_default_mode_anyOf_i0" onclick="setAnchor('#Return_value_items_object_lock_default_mode_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_object_lock_default_mode_anyOf_i1" id="Return_value_items_object_lock_default_mode_anyOf_i1" onclick="setAnchor('#Return_value_items_object_lock_default_mode_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_object_lock_default_mode_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <div class="enum-value" id="Return_value_items_object_lock_default_mode_anyOf_i0_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"GOVERNANCE"</li><li class="list-group-item enum-item">"COMPLIANCE"</li></ul>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_object_lock_default_mode_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_object_lock_default_days">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_object_lock_default_days">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_object_lock_default_days" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_object_lock_default_days" data-toggle="collapse" onclick="setAnchor('#Return_value_items_object_lock_default_days')" type="button"><span class="property-name">object_lock_default_days</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_object_lock_default_days" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_object_lock_default_days" id="Return_value_items_object_lock_default_days">
    <div class="card-body pl-5">
    <h4>Object Lock Default Days</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Retention period of the default object lock rule in days, up to 36500 (a hundred years).</p>
    </span><div class="any-of-value" id="Return_value_items_object_lock_default_days_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_object_lock_default_days_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_object_lock_default_days_anyOf_i0" id="Return_value_items_object_lock_default_days_anyOf_i0" onclick="setAnchor('#Return_value_items_object_lock_default_days_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_object_lock_default_days_anyOf_i1" id="Return_value_items_object_lock_default_days_anyOf_i1" onclick="setAnchor('#Return_value_items_object_lock_default_days_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_object_lock_default_days_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_items_object_lock_default_days_anyOf_i0_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>36500</code></span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_object_lock_default_days_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_audit">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_audit">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_audit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_audit" data-toggle="collapse" onclick="setAnchor('#Return_value_items_audit')" type="button"><span class="property-name">audit</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_audit" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_audit" id="Return_value_items_audit">
    <div class="card-body pl-5">
    <h4>Audit</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Actions audited on this bucket, <code>ALL</code>, or an empty list to audit nothing. <code>null</code> inherits the service's <code>default_audit</code>. <code>CreateBucket</code> and <code>ListAllMyBuckets</code> never match here — the service <code>default_audit</code> governs both — while <code>DeleteBucket</code> does match this bucket's own deletion. NOTE: this is a licensed feature.</p>
    </span><div class="any-of-value" id="Return_value_items_audit_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_audit_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_audit_anyOf_i0" id="Return_value_items_audit_anyOf_i0" onclick="setAnchor('#Return_value_items_audit_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_audit_anyOf_i1" id="Return_value_items_audit_anyOf_i1" onclick="setAnchor('#Return_value_items_audit_anyOf_i1')" role="tab">Option 2</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_audit_anyOf_i2" id="Return_value_items_audit_anyOf_i2" onclick="setAnchor('#Return_value_items_audit_anyOf_i2')" role="tab">Option 3</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_audit_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: array of enum (of string)</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_items_audit_anyOf_i0_items">
    <span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <div class="enum-value" id="Return_value_items_audit_anyOf_i0_items_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"GetObject"</li><li class="list-group-item enum-item">"PutObject"</li><li class="list-group-item enum-item">"DeleteObject"</li><li class="list-group-item enum-item">"GetObjectTagging"</li><li class="list-group-item enum-item">"PutObjectTagging"</li><li class="list-group-item enum-item">"DeleteObjectTagging"</li><li class="list-group-item enum-item">"ListBucket"</li><li class="list-group-item enum-item">"GetBucketLocation"</li><li class="list-group-item enum-item">"ListBucketMultipartUploads"</li><li class="list-group-item enum-item">"ListMultipartUploadParts"</li><li class="list-group-item enum-item">"AbortMultipartUpload"</li><li class="list-group-item enum-item">"PutObjectRetention"</li><li class="list-group-item enum-item">"PutObjectLegalHold"</li><li class="list-group-item enum-item">"ListAllMyBuckets"</li><li class="list-group-item enum-item">"GetObjectAcl"</li><li class="list-group-item enum-item">"PutObjectAcl"</li><li class="list-group-item enum-item">"GetBucketAcl"</li><li class="list-group-item enum-item">"PutBucketAcl"</li><li class="list-group-item enum-item">"PutBucketVersioning"</li><li class="list-group-item enum-item">"CreateBucket"</li><li class="list-group-item enum-item">"DeleteBucket"</li></ul>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_audit_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Return_value_items_audit_anyOf_i1_const">Specific value: <code>"ALL"</code></span>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_audit_anyOf_i2" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_audit_overflow">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_audit_overflow">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_audit_overflow" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_audit_overflow" data-toggle="collapse" onclick="setAnchor('#Return_value_items_audit_overflow')" type="button"><span class="property-name">audit_overflow</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_audit_overflow" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_audit_overflow" id="Return_value_items_audit_overflow">
    <div class="card-body pl-5">
    <h4>Audit Overflow</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Overflow behavior for this bucket's audit records, or <code>null</code> to inherit the service's default.</p>
    </span><div class="any-of-value" id="Return_value_items_audit_overflow_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_audit_overflow_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_audit_overflow_anyOf_i0" id="Return_value_items_audit_overflow_anyOf_i0" onclick="setAnchor('#Return_value_items_audit_overflow_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_audit_overflow_anyOf_i1" id="Return_value_items_audit_overflow_anyOf_i1" onclick="setAnchor('#Return_value_items_audit_overflow_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_audit_overflow_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <div class="enum-value" id="Return_value_items_audit_overflow_anyOf_i0_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"DROP"</li><li class="list-group-item enum-item">"BACKPRESSURE"</li></ul>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_audit_overflow_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SHARING_S3_READ

