Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iotanalytics ]

update-channel

Description

Updates the settings of a channel.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-channel
--channel-name <value>
[--channel-storage <value>]
[--retention-period <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--channel-name (string)

The name of the channel to be updated.

--channel-storage (structure)

Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.

Shorthand Syntax:

serviceManagedS3={},customerManagedS3={bucket=string,keyPrefix=string,roleArn=string}

JSON Syntax:

{
  "serviceManagedS3": {

  },
  "customerManagedS3": {
    "bucket": "string",
    "keyPrefix": "string",
    "roleArn": "string"
  }
}

--retention-period (structure)

How long, in days, message data is kept for the channel. The retention period cannot be updated if the channel's S3 storage is customer-managed.

Shorthand Syntax:

unlimited=boolean,numberOfDays=integer

JSON Syntax:

{
  "unlimited": true|false,
  "numberOfDays": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To modify a channel

The following update-channel example modifies the settings for the specified channel.

aws iotanalytics update-channel \
    --cli-input-json file://update-channel.json

Contents of update-channel.json:

{
    "channelName": "mychannel",
    "retentionPeriod": {
        "numberOfDays": 92
    }
}

This command produces no output.

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

Output

None