aws_iotanalytics_channel

account_id

Type: STRING

channel

Type: STRUCT
Provider name: channel
Description: An object that contains information about the channel.

• arn
  Type: STRING
  Provider name: arn
  Description: The ARN of the channel.
  
• creation_time
  Type: TIMESTAMP
  Provider name: creationTime
  Description: When the channel was created.
  
• last_message_arrival_time
  Type: TIMESTAMP
  Provider name: lastMessageArrivalTime
  Description: The last time when a new message arrived in the channel. IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation. This feature only applies to messages that arrived in the data store after October 23, 2020.
  
• last_update_time
  Type: TIMESTAMP
  Provider name: lastUpdateTime
  Description: When the channel was last updated.
  
• name
  Type: STRING
  Provider name: name
  Description: The name of the channel.
  
• retention_period
  Type: STRUCT
  Provider name: retentionPeriod
  Description: How long, in days, message data is kept for the channel.
  
  • number_of_days
    Type: INT32
    Provider name: numberOfDays
    Description: The number of days that message data is kept. The unlimited parameter must be false.
    
  • unlimited
    Type: BOOLEAN
    Provider name: unlimited
    Description: If true, message data is kept indefinitely.
    
• status
  Type: STRING
  Provider name: status
  Description: The status of the channel.
  
• storage
  Type: STRUCT
  Provider name: storage
  Description: Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can’t change this storage option after the channel is created.
  
  • customer_managed_s3
    Type: STRUCT
    Provider name: customerManagedS3
    Description: Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can’t change the choice of S3 storage after the data store is created.
    
    • bucket
      Type: STRING
      Provider name: bucket
      Description: The name of the S3 bucket in which channel data is stored.
      
    • key_prefix
      Type: STRING
      Provider name: keyPrefix
      Description: (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
      
    • role_arn
      Type: STRING
      Provider name: roleArn
      Description: The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
      
  • service_managed_s3
    Type: STRUCT
    Provider name: serviceManagedS3
    Description: Used to store channel data in an S3 bucket managed by IoT Analytics. You can’t change the choice of S3 storage after the data store is created.
    

statistics

Type: STRUCT
Provider name: statistics
Description: Statistics about the channel. Included if the includeStatistics parameter is set to true in the request.

• size
  Type: STRUCT
  Provider name: size
  Description: The estimated size of the channel.
  
  • estimated_on
    Type: TIMESTAMP
    Provider name: estimatedOn
    Description: The time when the estimate of the size of the resource was made.
    
  • estimated_size_in_bytes
    Type: DOUBLE
    Provider name: estimatedSizeInBytes
    Description: The estimated size of the resource, in bytes.
    

tags

Type: UNORDERED_LIST_STRING