update-channel¶

Description¶

Updates the settings of a channel.

Synopsis¶

  update-channel
--channel-name <value>
[--channel-storage <value>]
[--retention-period <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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.

serviceManagedS3 -> (structure)

Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel.

customerManagedS3 -> (structure)

Use this to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the “retentionPeriod” parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel.

bucket -> (string)

The name of the Amazon S3 bucket in which channel data is stored.

keyPrefix -> (string)

[Optional] The prefix used to create the keys of the channel data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a ‘/’.

roleArn -> (string)

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

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.

unlimited -> (boolean)

If true, message data is kept indefinitely.

numberOfDays -> (integer)

The number of days that message data is kept. The “unlimited” parameter must be false.

Shorthand Syntax:

unlimited=boolean,numberOfDays=integer

JSON Syntax:

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

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

Table of Contents

Feedback

User Guide