aws_iotanalytics_dataset

account_id

Type: STRING

actions

Type: UNORDERED_LIST_STRUCT
Provider name: actions
Description: The DatasetAction objects that automatically create the dataset contents.

• action_name
  Type: STRING
  Provider name: actionName
  Description: The name of the dataset action by which dataset contents are automatically created.
  
• container_action
  Type: STRUCT
  Provider name: containerAction
  Description: Information that allows the system to run a containerized application to create the dataset contents. The application must be in a Docker container along with any required support libraries.
  
  • execution_role_arn
    Type: STRING
    Provider name: executionRoleArn
    Description: The ARN of the role that gives permission to the system to access required resources to run the containerAction. This includes, at minimum, permission to retrieve the dataset contents that are the input to the containerized application.
    
  • image
    Type: STRING
    Provider name: image
    Description: The ARN of the Docker container stored in your account. The Docker container contains an application and required support libraries and is used to generate dataset contents.
    
  • resource_configuration
    Type: STRUCT
    Provider name: resourceConfiguration
    Description: Configuration of the resource that executes the containerAction.
    
    • compute_type
      Type: STRING
      Provider name: computeType
      Description: The type of the compute resource used to execute the containerAction. Possible values are: ACU_1 (vCPU=4, memory=16 GiB) or ACU_2 (vCPU=8, memory=32 GiB).
      
    • volume_size_in_gb
      Type: INT32
      Provider name: volumeSizeInGB
      Description: The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min: 1, max: 50).
      
  • variables
    Type: UNORDERED_LIST_STRUCT
    Provider name: variables
    Description: The values of variables used in the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of stringValue, datasetContentVersionValue, or outputFileUriValue.
    
    • dataset_content_version_value
      Type: STRUCT
      Provider name: datasetContentVersionValue
      Description: The value of the variable as a structure that specifies a dataset content version.
      
      • dataset_name
        Type: STRING
        Provider name: datasetName
        Description: The name of the dataset whose latest contents are used as input to the notebook or application.
        
    • double_value
      Type: DOUBLE
      Provider name: doubleValue
      Description: The value of the variable as a double (numeric).
      
    • name
      Type: STRING
      Provider name: name
      Description: The name of the variable.
      
    • output_file_uri_value
      Type: STRUCT
      Provider name: outputFileUriValue
      Description: The value of the variable as a structure that specifies an output file URI.
      
      • file_name
        Type: STRING
        Provider name: fileName
        Description: The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.
        
    • string_value
      Type: STRING
      Provider name: stringValue
      Description: The value of the variable as a string.
      
• query_action
  Type: STRUCT
  Provider name: queryAction
  Description: An SqlQueryDatasetAction object that uses an SQL query to automatically create dataset contents.
  
  • filters
    Type: UNORDERED_LIST_STRUCT
    Provider name: filters
    Description: Prefilters applied to message data.
    
    • delta_time
      Type: STRUCT
      Provider name: deltaTime
      Description: Used to limit data to that which has arrived since the last execution of the action.
      
      • offset_seconds
        Type: INT32
        Provider name: offsetSeconds
        Description: The number of seconds of estimated in-flight lag time of message data. When you create dataset contents using message data from a specified timeframe, some message data might still be in flight when processing begins, and so do not arrive in time to be processed. Use this field to make allowances for the in flight time of your message data, so that data not processed from a previous timeframe is included with the next timeframe. Otherwise, missed message data would be excluded from processing during the next timeframe too, because its timestamp places it within the previous timeframe.
        
      • time_expression
        Type: STRING
        Provider name: timeExpression
        Description: An expression by which the time of the message data might be determined. This can be the name of a timestamp field or a SQL expression that is used to derive the time the message data was generated.
        
  • sql_query
    Type: STRING
    Provider name: sqlQuery
    Description: A SQL query string.
    

arn

Type: STRING
Provider name: arn
Description: The ARN of the dataset.

content_delivery_rules

Type: UNORDERED_LIST_STRUCT
Provider name: contentDeliveryRules
Description: When dataset contents are created they are delivered to destinations specified here.

• destination
  Type: STRUCT
  Provider name: destination
  Description: The destination to which dataset contents are delivered.
  
  • iot_events_destination_configuration
    Type: STRUCT
    Provider name: iotEventsDestinationConfiguration
    Description: Configuration information for delivery of dataset contents to IoT Events.
    
    • input_name
      Type: STRING
      Provider name: inputName
      Description: The name of the IoT Events input to which dataset contents are delivered.
      
    • role_arn
      Type: STRING
      Provider name: roleArn
      Description: The ARN of the role that grants IoT Analytics permission to deliver dataset contents to an IoT Events input.
      
  • s3_destination_configuration
    Type: STRUCT
    Provider name: s3DestinationConfiguration
    Description: Configuration information for delivery of dataset contents to Amazon S3.
    
    • bucket
      Type: STRING
      Provider name: bucket
      Description: The name of the S3 bucket to which dataset contents are delivered.
      
    • glue_configuration
      Type: STRUCT
      Provider name: glueConfiguration
      Description: Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
      
      • database_name
        Type: STRING
        Provider name: databaseName
        Description: The name of the database in your Glue Data Catalog in which the table is located. An Glue Data Catalog database contains metadata tables.
        
      • table_name
        Type: STRING
        Provider name: tableName
        Description: The name of the table in your Glue Data Catalog that is used to perform the ETL operations. An Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.
        
    • key
      Type: STRING
      Provider name: key
      Description: The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key. You can create a unique key with the following options:
      • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.
      • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.
      • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.
      The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv If you don’t use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.
      
    • role_arn
      Type: STRING
      Provider name: roleArn
      Description: The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.
      
• entry_name
  Type: STRING
  Provider name: entryName
  Description: The name of the dataset content delivery rules entry.
  

creation_time

Type: TIMESTAMP
Provider name: creationTime
Description: When the dataset was created.

last_update_time

Type: TIMESTAMP
Provider name: lastUpdateTime
Description: The last time the dataset was updated.

late_data_rules

Type: UNORDERED_LIST_STRUCT
Provider name: lateDataRules
Description: A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

• rule_configuration
  Type: STRUCT
  Provider name: ruleConfiguration
  Description: The information needed to configure the late data rule.
  
  • delta_time_session_window_configuration
    Type: STRUCT
    Provider name: deltaTimeSessionWindowConfiguration
    Description: The information needed to configure a delta time session window.
    
    • timeout_in_minutes
      Type: INT32
      Provider name: timeoutInMinutes
      Description: A time interval. You can use timeoutInMinutes so that IoT Analytics can batch up late data notifications that have been generated since the last execution. IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at one time. For more information about how to write a timestamp expression, see Date and Time Functions and Operators, in the Presto 0.172 Documentation.
      
• rule_name
  Type: STRING
  Provider name: ruleName
  Description: The name of the late data rule.
  

name

Type: STRING
Provider name: name
Description: The name of the dataset.

retention_period

Type: STRUCT
Provider name: retentionPeriod
Description: Optional. How long, in days, message data is kept for the dataset.

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

tags

Type: UNORDERED_LIST_STRING

triggers

Type: UNORDERED_LIST_STRUCT
Provider name: triggers
Description: The DatasetTrigger objects that specify when the dataset is automatically updated.

• dataset
  Type: STRUCT
  Provider name: dataset
  Description: The dataset whose content creation triggers the creation of this dataset’s contents.
  
  • name
    Type: STRING
    Provider name: name
    Description: The name of the dataset whose content generation triggers the new dataset content generation.
    
• schedule
  Type: STRUCT
  Provider name: schedule
  Description: The Schedule when the trigger is initiated.
  
  • expression
    Type: STRING
    Provider name: expression
    Description: The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.
    

versioning_configuration

Type: STRUCT
Provider name: versioningConfiguration
Description: Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.

• max_versions
  Type: INT32
  Provider name: maxVersions
  Description: How many versions of dataset contents are kept. The unlimited parameter must be false.
  
• unlimited
  Type: BOOLEAN
  Provider name: unlimited
  Description: If true, unlimited versions of dataset contents are kept.