<a id="cli-aws-s3tables-put-table-bucket-logging"></a>

# put-table-bucket-logging

## Description

Sets, updates, or removes the server access logging configuration for a table bucket. When logging is enabled, Amazon S3 delivers a record of the requests made to the table bucket and its tables to the target general purpose bucket that you specify. To disable logging, call this operation with an empty `tableBucketLoggingStatus` . For more information, see [Server access logging for table buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-server-logs.html) in the *Amazon Simple Storage Service User Guide* .

> Permissions

You must have the `s3tables:PutTableBucketLogging` permission to use this operation.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/s3tables-2018-05-10/PutTableBucketLogging)

## Synopsis

```
  put-table-bucket-logging
--table-bucket-arn <value>
--table-bucket-logging-status <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--table-bucket-arn` (string) [required]

> The Amazon Resource Name (ARN) of the table bucket.

> Constraints:

> * pattern: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})`

`--table-bucket-logging-status` (structure) [required]

> The logging status to apply to the table bucket. To disable logging, specify an empty `tableBucketLoggingStatus` .

> loggingEnabled -> (structure)

> > Where logs for the table bucket are delivered and how the log objects are named. Must be populated to enable logging.

> > targetBucket -> (string) [required]

> > > The name of the general purpose bucket that logs are delivered to. The bucket must be in the same Amazon Web Services Region and owned by the same Amazon Web Services account as the table bucket. The bucket can’t use SSE-KMS or DSSE-KMS default encryption, can’t have S3 Object Lock enabled, and can’t have Requester Pays enabled. You can deliver logs from multiple table buckets to the same target bucket. In this case, choose a different `targetPrefix` for each table bucket so that you can tell their log objects apart.

> > > Constraints:

> > > * min: `3`
> > > * max: `63`

> > targetPrefix -> (string) [required]

> > > The prefix for the keys of the log objects that are delivered to the target bucket.

> > > Constraints:

> > > * min: `0`
> > > * max: `1024`

> > targetObjectKeyFormat -> (structure) [required]

> > > The key format of the log objects. Log object keys are always partitioned by date.

> > > partitionedPrefix -> (structure) [required]

> > > > Partitions log object keys by date.

> > > > partitionDateSource -> (string) [required]

> > > > > The date to use for the log object key partitions. Valid values are `EventTime` , the time that the requests in the log were made, and `DeliveryTime` , the time that the log was delivered.

> > > > > Possible values:

> > > > > * `EventTime`
> > > > > * `DeliveryTime`

JSON Syntax:

```json
{
  "loggingEnabled": {
    "targetBucket": "string",
    "targetPrefix": "string",
    "targetObjectKeyFormat": {
      "partitionedPrefix": {
        "partitionDateSource": "EventTime"|"DeliveryTime"
      }
    }
  }
}
```

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

None