[ aws . iotanalytics ]

put-logging-options

Description

Sets or updates the AWS IoT Analytics logging options.

Note that if you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy) it takes up to 5 minutes for that change to take effect.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-logging-options
--logging-options <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--logging-options (structure)

The new values of the AWS IoT Analytics logging options.

roleArn -> (string)

The ARN of the role that grants permission to AWS IoT Analytics to perform logging.

level -> (string)

The logging level. Currently, only “ERROR” is supported.

enabled -> (boolean)

If true, logging is enabled for AWS IoT Analytics.

Shorthand Syntax:

roleArn=string,level=string,enabled=boolean

JSON Syntax:

{
  "roleArn": "string",
  "level": "ERROR",
  "enabled": true|false
}

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To set or update logging options

The following put-logging-options example sets or updates the AWS IoT Analytics logging options. If you update the value of any loggingOptions field, it can take up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the “roleArn” field (for example, to correct an invalid policy) it can take up to five minutes for that change to take effect.

aws iotanalytics put-logging-options \
    --cli-input-json file://put-logging-options.json

Contents of put-logging-options.json:

{
    "loggingOptions": {
        "roleArn": "arn:aws:iam::123456789012:role/service-role/myIoTAnalyticsRole",
        "level": "ERROR",
        "enabled": true
    }
}

This command produces no output.

For more information, see PutLoggingOptions in the AWS IoT Analytics API Reference.

Output

None