sharing.s3.get_instance
=======================

Returns instance matching `id`. If `id` is not found, Validation error is raised.

Please see `query` method documentation for `options`.

.. 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><h4>Tuple Validation</h4>
    <h5>Parameter 1: id</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    </div>
    </div>
    <h5>Parameter 2: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1">
    <h4>options</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Query options customize the results returned by a query method. More complete documentation with examples     are covered in the "Query methods" section of the TrueNAS API documentation. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_extra">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_extra">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_extra" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_extra" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_extra')" type="button"><span class="property-name">extra</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_extra" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_extra" id="Call_parameters_items_i1_extra">
    <div class="card-body pl-5">
    <h4>Extra</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {}</span><br/>
    <span class="description"><p>Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_order_by">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_order_by">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_order_by" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_order_by" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_order_by')" type="button"><span class="property-name">order_by</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_order_by" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_order_by" id="Call_parameters_items_i1_order_by">
    <div class="card-body pl-5">
    <h4>Order By</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>An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: <code>-</code> (reverse sort direction), <code>nulls_first:</code> (place any null values at the head of the results list), <code>nulls_last:</code> (place any null values at the tail of the results list).</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="Call_parameters_items_i1_order_by_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_order_by_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"size"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"-devname"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"nulls_first:-expiretime"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_select">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_select">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_select" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_select" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_select')" type="button"><span class="property-name">select</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_select" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_select" id="Call_parameters_items_i1_select">
    <div class="card-body pl-5">
    <h4>Select</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>An array of field names specifying the exact fields to include in the query return. The dot character <code>.</code> may be used to explicitly select only subkeys of the query result.</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="Call_parameters_items_i1_select_items">
    <br/>
    <div class="any-of-value" id="Call_parameters_items_i1_select_items_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_select_items_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_select_items_anyOf_i0" id="Call_parameters_items_i1_select_items_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_select_items_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_select_items_anyOf_i1" id="Call_parameters_items_i1_select_items_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_select_items_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_Call_parameters_items_i1_select_items_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_select_items_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: array</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="Call_parameters_items_i1_select_items_anyOf_i1_items">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div>
    </div>
    </div></div></div>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_select_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"username"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"Authentication.status"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_count">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_count">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_count" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_count" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_count')" type="button"><span class="property-name">count</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_count" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_count" id="Call_parameters_items_i1_count">
    <div class="card-body pl-5">
    <h4>Count</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>Return a numeric value representing the number of items that match the specified <code>query-filters</code>.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_get">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_get">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_get" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_get" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_get')" type="button"><span class="property-name">get</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_get" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_get" id="Call_parameters_items_i1_get">
    <div class="card-body pl-5">
    <h4>Get</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>Return the JSON object of the first result matching the specified <code>query-filters</code>. The query fails if there specified <code>query-filters</code> return no results.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_offset">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_offset">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_offset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_offset" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_offset')" type="button"><span class="property-name">offset</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_offset" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_offset" id="Call_parameters_items_i1_offset">
    <div class="card-body pl-5">
    <h4>Offset</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/>
    <span class="description"><p>This specifies the beginning offset of the results array. When combined with the <code>limit</code> query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i1_offset_number">Value must be greater or equal to <code>0</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_limit">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_limit">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_limit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_limit" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_limit')" type="button"><span class="property-name">limit</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_limit" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_limit" id="Call_parameters_items_i1_limit">
    <div class="card-body pl-5">
    <h4>Limit</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/>
    <span class="description"><p>This specifies the maximum number of results matching the specified <code>query-filters</code> to return. When combined wtih the <code>offset</code> query-option it may be used to implement pagination of large results arrays.</p>
    <p>WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i1_limit_number">Value must be greater or equal to <code>0</code> and lesser or equal to <code>10000</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_force_sql_filters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_force_sql_filters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_force_sql_filters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_force_sql_filters" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_force_sql_filters')" type="button"><span class="property-name">force_sql_filters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_force_sql_filters" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_force_sql_filters" id="Call_parameters_items_i1_force_sql_filters">
    <div class="card-body pl-5">
    <h4>Force Sql Filters</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>Force use of SQL for result filtering to reduce response time. May not work for all methods.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </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>SharingS3Entry</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_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Unique identifier for the bucket.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_name" data-toggle="collapse" onclick="setAnchor('#Return_value_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_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_name" id="Return_value_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, following the S3 rules. Three to 63 characters of lowercase letters, digits, dots and hyphens, starting and ending with a letter or digit, no adjacent dots, and never an IPv4 address.</p>
    </span><span class="pattern-value" id="Return_value_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_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_name_maxLength">Must be at most <code>63</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_dataset">
    <div class="card">
    <div class="card-header" id="headingReturn_value_dataset">
    <h2 class="mb-0">
    <button aria-controls="Return_value_dataset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_dataset" data-toggle="collapse" onclick="setAnchor('#Return_value_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_dataset" class="collapse property-definition-div" data-parent="#accordionReturn_value_dataset" id="Return_value_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 the bucket is. Created by <code>sharing.s3.create</code> and owned by it. Objects live in the <code>s3data</code> directory under its mount point, which the S3 service creates on its next start, owned by <code>owner</code>. Under the <code>MULTIPROTOCOL</code> permissions model the filesystem permissions on that tree govern S3 callers too, so a grantee other than the owner reaches only what they allow; set an ACL on the directory as for any share. Under <code>S3</code> they are ignored and the grants decide instead.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_dataset_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_enabled">
    <div class="card">
    <div class="card-header" id="headingReturn_value_enabled">
    <h2 class="mb-0">
    <button aria-controls="Return_value_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_enabled" data-toggle="collapse" onclick="setAnchor('#Return_value_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_enabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_enabled" id="Return_value_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. Toggling restarts the S3 service.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_owner">
    <div class="card">
    <div class="card-header" id="headingReturn_value_owner">
    <h2 class="mb-0">
    <button aria-controls="Return_value_owner" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_owner" data-toggle="collapse" onclick="setAnchor('#Return_value_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_owner" class="collapse property-definition-div" data-parent="#accordionReturn_value_owner" id="Return_value_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. Given by name, held by uid: the name is resolved when set and again whenever the bucket is read, so a renamed account reads as its new name, a reused name never inherits the bucket, and an account that no longer exists reads as its uid. Changing the owner later moves the grants, not the directory.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_owner_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_owner_uid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_owner_uid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_owner_uid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_owner_uid" data-toggle="collapse" onclick="setAnchor('#Return_value_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_owner_uid" class="collapse property-definition-div" data-parent="#accordionReturn_value_owner_uid" id="Return_value_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_grants">
    <div class="card">
    <div class="card-header" id="headingReturn_value_grants">
    <h2 class="mb-0">
    <button aria-controls="Return_value_grants" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_grants" data-toggle="collapse" onclick="setAnchor('#Return_value_grants')" type="button"><span class="property-name">grants</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_grants" class="collapse property-definition-div" data-parent="#accordionReturn_value_grants" id="Return_value_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_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_grants_items_principal_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_grants_items_principal_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_grants_items_principal_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_grants_items_principal_type" data-toggle="collapse" onclick="setAnchor('#Return_value_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_grants_items_principal_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_grants_items_principal_type" id="Return_value_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_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_grants_items_xid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_grants_items_xid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_grants_items_xid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_grants_items_xid" data-toggle="collapse" onclick="setAnchor('#Return_value_grants_items_xid')" type="button"><span class="property-name">xid</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_grants_items_xid" class="collapse property-definition-div" data-parent="#accordionReturn_value_grants_items_xid" id="Return_value_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_grants_items_xid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_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_grants_items_xid_anyOf_i0" id="Return_value_grants_items_xid_anyOf_i0" onclick="setAnchor('#Return_value_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_grants_items_xid_anyOf_i1" id="Return_value_grants_items_xid_anyOf_i1" onclick="setAnchor('#Return_value_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_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_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_grants_items_access">
    <div class="card">
    <div class="card-header" id="headingReturn_value_grants_items_access">
    <h2 class="mb-0">
    <button aria-controls="Return_value_grants_items_access" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_grants_items_access" data-toggle="collapse" onclick="setAnchor('#Return_value_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_grants_items_access" class="collapse property-definition-div" data-parent="#accordionReturn_value_grants_items_access" id="Return_value_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_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_grants_items_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_grants_items_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_grants_items_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_grants_items_name" data-toggle="collapse" onclick="setAnchor('#Return_value_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_grants_items_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_grants_items_name" id="Return_value_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_permissions_model">
    <div class="card">
    <div class="card-header" id="headingReturn_value_permissions_model">
    <h2 class="mb-0">
    <button aria-controls="Return_value_permissions_model" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_permissions_model" data-toggle="collapse" onclick="setAnchor('#Return_value_permissions_model')" type="button"><span class="property-name">permissions_model</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_permissions_model" class="collapse property-definition-div" data-parent="#accordionReturn_value_permissions_model" id="Return_value_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. <code>S3</code> when the S3 service is the only door: those permissions are ignored in their entirety, and access is decided by the bucket's grants and, where <code>object_ownership</code> supports them, its S3 ACLs. <code>MULTIPROTOCOL</code> when SMB or NFS share the tree: the filesystem ACL is enforced as well as the grants, so an ACL set on the tree governs S3 callers too and narrowing it takes effect for them immediately. S3 ACLs are not supported on such a bucket at all, whatever <code>object_ownership</code> says, since no stored S3 record may decide what a write from another protocol could contradict. Which account an S3 operation runs as is <code>object_ownership</code>'s answer, not this one's.</p>
    </span><div class="enum-value" id="Return_value_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_object_ownership">
    <div class="card">
    <div class="card-header" id="headingReturn_value_object_ownership">
    <h2 class="mb-0">
    <button aria-controls="Return_value_object_ownership" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_object_ownership" data-toggle="collapse" onclick="setAnchor('#Return_value_object_ownership')" type="button"><span class="property-name">object_ownership</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_object_ownership" class="collapse property-definition-div" data-parent="#accordionReturn_value_object_ownership" id="Return_value_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_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_versioning">
    <div class="card">
    <div class="card-header" id="headingReturn_value_versioning">
    <h2 class="mb-0">
    <button aria-controls="Return_value_versioning" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_versioning" data-toggle="collapse" onclick="setAnchor('#Return_value_versioning')" type="button"><span class="property-name">versioning</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_versioning" class="collapse property-definition-div" data-parent="#accordionReturn_value_versioning" id="Return_value_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_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_snapshot_versions">
    <div class="card">
    <div class="card-header" id="headingReturn_value_snapshot_versions">
    <h2 class="mb-0">
    <button aria-controls="Return_value_snapshot_versions" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_snapshot_versions" data-toggle="collapse" onclick="setAnchor('#Return_value_snapshot_versions')" type="button"><span class="property-name">snapshot_versions</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_snapshot_versions" class="collapse property-definition-div" data-parent="#accordionReturn_value_snapshot_versions" id="Return_value_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 disables surfacing object versions from ZFS snapshots.</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_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_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_snapshot_versions_max">
    <div class="card">
    <div class="card-header" id="headingReturn_value_snapshot_versions_max">
    <h2 class="mb-0">
    <button aria-controls="Return_value_snapshot_versions_max" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_snapshot_versions_max" data-toggle="collapse" onclick="setAnchor('#Return_value_snapshot_versions_max')" type="button"><span class="property-name">snapshot_versions_max</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_snapshot_versions_max" class="collapse property-definition-div" data-parent="#accordionReturn_value_snapshot_versions_max" id="Return_value_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_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_multipart_etag">
    <div class="card">
    <div class="card-header" id="headingReturn_value_multipart_etag">
    <h2 class="mb-0">
    <button aria-controls="Return_value_multipart_etag" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_multipart_etag" data-toggle="collapse" onclick="setAnchor('#Return_value_multipart_etag')" type="button"><span class="property-name">multipart_etag</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_multipart_etag" class="collapse property-definition-div" data-parent="#accordionReturn_value_multipart_etag" id="Return_value_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_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_object_lock">
    <div class="card">
    <div class="card-header" id="headingReturn_value_object_lock">
    <h2 class="mb-0">
    <button aria-controls="Return_value_object_lock" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_object_lock" data-toggle="collapse" onclick="setAnchor('#Return_value_object_lock')" type="button"><span class="property-name">object_lock</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_object_lock" class="collapse property-definition-div" data-parent="#accordionReturn_value_object_lock" id="Return_value_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_object_lock_default_mode">
    <div class="card">
    <div class="card-header" id="headingReturn_value_object_lock_default_mode">
    <h2 class="mb-0">
    <button aria-controls="Return_value_object_lock_default_mode" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_object_lock_default_mode" data-toggle="collapse" onclick="setAnchor('#Return_value_object_lock_default_mode')" type="button"><span class="property-name">object_lock_default_mode</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_object_lock_default_mode" class="collapse property-definition-div" data-parent="#accordionReturn_value_object_lock_default_mode" id="Return_value_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_object_lock_default_mode_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_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_object_lock_default_mode_anyOf_i0" id="Return_value_object_lock_default_mode_anyOf_i0" onclick="setAnchor('#Return_value_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_object_lock_default_mode_anyOf_i1" id="Return_value_object_lock_default_mode_anyOf_i1" onclick="setAnchor('#Return_value_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_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_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_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_object_lock_default_days">
    <div class="card">
    <div class="card-header" id="headingReturn_value_object_lock_default_days">
    <h2 class="mb-0">
    <button aria-controls="Return_value_object_lock_default_days" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_object_lock_default_days" data-toggle="collapse" onclick="setAnchor('#Return_value_object_lock_default_days')" type="button"><span class="property-name">object_lock_default_days</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_object_lock_default_days" class="collapse property-definition-div" data-parent="#accordionReturn_value_object_lock_default_days" id="Return_value_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_object_lock_default_days_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_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_object_lock_default_days_anyOf_i0" id="Return_value_object_lock_default_days_anyOf_i0" onclick="setAnchor('#Return_value_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_object_lock_default_days_anyOf_i1" id="Return_value_object_lock_default_days_anyOf_i1" onclick="setAnchor('#Return_value_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_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_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_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_audit">
    <div class="card">
    <div class="card-header" id="headingReturn_value_audit">
    <h2 class="mb-0">
    <button aria-controls="Return_value_audit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_audit" data-toggle="collapse" onclick="setAnchor('#Return_value_audit')" type="button"><span class="property-name">audit</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_audit" class="collapse property-definition-div" data-parent="#accordionReturn_value_audit" id="Return_value_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_audit_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_audit_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_audit_anyOf_i0" id="Return_value_audit_anyOf_i0" onclick="setAnchor('#Return_value_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_audit_anyOf_i1" id="Return_value_audit_anyOf_i1" onclick="setAnchor('#Return_value_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_audit_anyOf_i2" id="Return_value_audit_anyOf_i2" onclick="setAnchor('#Return_value_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_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_audit_anyOf_i0_items">
    <span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <div class="enum-value" id="Return_value_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_audit_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Return_value_audit_anyOf_i1_const">Specific value: <code>"ALL"</code></span>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_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_audit_overflow">
    <div class="card">
    <div class="card-header" id="headingReturn_value_audit_overflow">
    <h2 class="mb-0">
    <button aria-controls="Return_value_audit_overflow" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_audit_overflow" data-toggle="collapse" onclick="setAnchor('#Return_value_audit_overflow')" type="button"><span class="property-name">audit_overflow</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_audit_overflow" class="collapse property-definition-div" data-parent="#accordionReturn_value_audit_overflow" id="Return_value_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_audit_overflow_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_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_audit_overflow_anyOf_i0" id="Return_value_audit_overflow_anyOf_i0" onclick="setAnchor('#Return_value_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_audit_overflow_anyOf_i1" id="Return_value_audit_overflow_anyOf_i1" onclick="setAnchor('#Return_value_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_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_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_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 class="accordion" id="accordionReturn_value_locked">
    <div class="card">
    <div class="card-header" id="headingReturn_value_locked">
    <h2 class="mb-0">
    <button aria-controls="Return_value_locked" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_locked" data-toggle="collapse" onclick="setAnchor('#Return_value_locked')" type="button"><span class="property-name">locked</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_locked" class="collapse property-definition-div" data-parent="#accordionReturn_value_locked" id="Return_value_locked">
    <div class="card-body pl-5">
    <h4>Locked</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Whether the bucket's dataset is locked. Read only.</p>
    </span><div class="any-of-value" id="Return_value_locked_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_locked_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_locked_anyOf_i0" id="Return_value_locked_anyOf_i0" onclick="setAnchor('#Return_value_locked_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_locked_anyOf_i1" id="Return_value_locked_anyOf_i1" onclick="setAnchor('#Return_value_locked_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_locked_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: boolean</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_locked_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_tier">
    <div class="card">
    <div class="card-header" id="headingReturn_value_tier">
    <h2 class="mb-0">
    <button aria-controls="Return_value_tier" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_tier" data-toggle="collapse" onclick="setAnchor('#Return_value_tier')" type="button"><span class="property-name">tier</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_tier" class="collapse property-definition-div" data-parent="#accordionReturn_value_tier" id="Return_value_tier">
    <div class="card-body pl-5">
    <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Storage tier in which the bucket's dataset is located. This field is read-only; configure the dataset's tier via <code>zfs.tier.dataset_set_tier</code>. NOTE: this is a licensed feature. Will be <code>null</code> if TrueNAS is unlicensed, if tiering is disabled, or if the pool has no SPECIAL vdev.</p>
    </span><div class="any-of-value" id="Return_value_tier_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_tier_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_tier_anyOf_i0" id="Return_value_tier_anyOf_i0" onclick="setAnchor('#Return_value_tier_anyOf_i0')" role="tab">TierInfo</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_tier_anyOf_i1" id="Return_value_tier_anyOf_i1" onclick="setAnchor('#Return_value_tier_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_tier_anyOf_i0" role="tabpanel">
    <h4>TierInfo</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_tier_anyOf_i0_tier_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_tier_anyOf_i0_tier_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_tier_anyOf_i0_tier_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_tier_anyOf_i0_tier_type" data-toggle="collapse" onclick="setAnchor('#Return_value_tier_anyOf_i0_tier_type')" type="button"><span class="property-name">tier_type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_tier_anyOf_i0_tier_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_tier_anyOf_i0_tier_type" id="Return_value_tier_anyOf_i0_tier_type">
    <div class="card-body pl-5">
    <h4>Tier Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Storage performance tier for this share.</p>
    </span><div class="enum-value" id="Return_value_tier_anyOf_i0_tier_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"REGULAR"</li><li class="list-group-item enum-item">"PERFORMANCE"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_tier_anyOf_i0_tier_job">
    <div class="card">
    <div class="card-header" id="headingReturn_value_tier_anyOf_i0_tier_job">
    <h2 class="mb-0">
    <button aria-controls="Return_value_tier_anyOf_i0_tier_job" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_tier_anyOf_i0_tier_job" data-toggle="collapse" onclick="setAnchor('#Return_value_tier_anyOf_i0_tier_job')" type="button"><span class="property-name">tier_job</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_tier_anyOf_i0_tier_job" class="collapse property-definition-div" data-parent="#accordionReturn_value_tier_anyOf_i0_tier_job" id="Return_value_tier_anyOf_i0_tier_job">
    <div class="card-body pl-5">
    <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Most recent rewrite job for this share's dataset, or <code>null</code> if no job history exists.</p>
    </span><div class="any-of-value" id="Return_value_tier_anyOf_i0_tier_job_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_tier_anyOf_i0_tier_job_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_tier_anyOf_i0_tier_job_anyOf_i0" id="Return_value_tier_anyOf_i0_tier_job_anyOf_i0" onclick="setAnchor('#Return_value_tier_anyOf_i0_tier_job_anyOf_i0')" role="tab">ZfsTierRewriteJobEntry</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_tier_anyOf_i0_tier_job_anyOf_i1" id="Return_value_tier_anyOf_i0_tier_job_anyOf_i1" onclick="setAnchor('#Return_value_tier_anyOf_i0_tier_job_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_tier_anyOf_i0_tier_job_anyOf_i0" role="tabpanel">
    <h4>ZfsTierRewriteJobEntry</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_tier_anyOf_i0_tier_job_anyOf_i0_tier_job_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_tier_job_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_tier_job_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_tier_anyOf_i0_tier_job_anyOf_i0_tier_job_id" data-toggle="collapse" onclick="setAnchor('#Return_value_tier_anyOf_i0_tier_job_anyOf_i0_tier_job_id')" type="button"><span class="property-name">tier_job_id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_tier_job_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_tier_job_id" id="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_tier_job_id">
    <div class="card-body pl-5">
    <h4>Tier Job Id</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Rewrite job identifier in <code>dataset_name@job_uuid</code> format.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_tier_job_id_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_dataset_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_dataset_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_dataset_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_tier_anyOf_i0_tier_job_anyOf_i0_dataset_name" data-toggle="collapse" onclick="setAnchor('#Return_value_tier_anyOf_i0_tier_job_anyOf_i0_dataset_name')" type="button"><span class="property-name">dataset_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_dataset_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_dataset_name" id="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_dataset_name">
    <div class="card-body pl-5">
    <h4>Dataset Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>ZFS dataset this job is operating on.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_dataset_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_job_uuid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_job_uuid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_job_uuid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_tier_anyOf_i0_tier_job_anyOf_i0_job_uuid" data-toggle="collapse" onclick="setAnchor('#Return_value_tier_anyOf_i0_tier_job_anyOf_i0_job_uuid')" type="button"><span class="property-name">job_uuid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_job_uuid" class="collapse property-definition-div" data-parent="#accordionReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_job_uuid" id="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_job_uuid">
    <div class="card-body pl-5">
    <h4>Job Uuid</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Unique identifier for this rewrite job.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_job_uuid_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_status">
    <div class="card">
    <div class="card-header" id="headingReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_status">
    <h2 class="mb-0">
    <button aria-controls="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_status" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_tier_anyOf_i0_tier_job_anyOf_i0_status" data-toggle="collapse" onclick="setAnchor('#Return_value_tier_anyOf_i0_tier_job_anyOf_i0_status')" type="button"><span class="property-name">status</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_status" class="collapse property-definition-div" data-parent="#accordionReturn_value_tier_anyOf_i0_tier_job_anyOf_i0_status" id="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_status">
    <div class="card-body pl-5">
    <h4>Status</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Current lifecycle state of the job.</p>
    <ul>
    <li><code>COMPLETE</code> - All files in the dataset have been processed.</li>
    <li><code>RUNNING</code> - Job is actively processing files.</li>
    <li><code>QUEUED</code> - Job is waiting for a free execution slot (see <code>max_concurrent_jobs</code>).</li>
    <li><code>CANCELLED</code> - Job was stopped via <code>zfs_tier_job.cancel</code>. Not resumable.</li>
    <li><code>STOPPED</code> - Job was RUNNING but its process is no longer active (e.g. daemon restart). This state is computed on read and is never written to persistent storage.</li>
    <li><code>ERROR</code> - Job halted due to an unrecoverable error. Use <code>zfs_tier_job.recover</code> to retry failed files.</li>
    </ul>
    </span><div class="enum-value" id="Return_value_tier_anyOf_i0_tier_job_anyOf_i0_status_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"COMPLETE"</li><li class="list-group-item enum-item">"RUNNING"</li><li class="list-group-item enum-item">"QUEUED"</li><li class="list-group-item enum-item">"CANCELLED"</li><li class="list-group-item enum-item">"STOPPED"</li><li class="list-group-item enum-item">"ERROR"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_tier_anyOf_i0_tier_job_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_tier_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><br><br>

*Required roles:* SHARING_S3_READ

