aws-sdk-iotsitewise 1.77.0 → 1.78.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -16,7 +16,8 @@ module Aws::IoTSiteWise
16
16
  # @return [String]
17
17
  #
18
18
  class AccessDeniedException < Struct.new(
19
- :message)
19
+ :message,
20
+ :event_type)
20
21
  SENSITIVE = []
21
22
  include Aws::Structure
22
23
  end
@@ -743,6 +744,9 @@ module Aws::IoTSiteWise
743
744
  #
744
745
  # @!attribute [rw] data_type
745
746
  # The data type of the asset model property.
747
+ #
748
+ # If you specify `STRUCT`, you must also specify `dataTypeSpec` to
749
+ # identify the type of the structure for this property.
746
750
  # @return [String]
747
751
  #
748
752
  # @!attribute [rw] data_type_spec
@@ -2308,6 +2312,25 @@ module Aws::IoTSiteWise
2308
2312
  include Aws::Structure
2309
2313
  end
2310
2314
 
2315
+ # Contains text content to which the SiteWise Assistant refers to, and
2316
+ # generate the final response. It also contains information about the
2317
+ # source.
2318
+ #
2319
+ # @!attribute [rw] reference
2320
+ # Contains information about the data source.
2321
+ # @return [Types::Reference]
2322
+ #
2323
+ # @!attribute [rw] content
2324
+ # Contains the cited text from the data source.
2325
+ # @return [Types::Content]
2326
+ #
2327
+ class Citation < Struct.new(
2328
+ :reference,
2329
+ :content)
2330
+ SENSITIVE = []
2331
+ include Aws::Structure
2332
+ end
2333
+
2311
2334
  # A description of the column in the query results.
2312
2335
  #
2313
2336
  # @!attribute [rw] name
@@ -2481,7 +2504,20 @@ module Aws::IoTSiteWise
2481
2504
  class ConflictingOperationException < Struct.new(
2482
2505
  :message,
2483
2506
  :resource_id,
2484
- :resource_arn)
2507
+ :resource_arn,
2508
+ :event_type)
2509
+ SENSITIVE = []
2510
+ include Aws::Structure
2511
+ end
2512
+
2513
+ # Contains the cited text from the data source.
2514
+ #
2515
+ # @!attribute [rw] text
2516
+ # The cited text from the data source.
2517
+ # @return [String]
2518
+ #
2519
+ class Content < Struct.new(
2520
+ :text)
2485
2521
  SENSITIVE = []
2486
2522
  include Aws::Structure
2487
2523
  end
@@ -3040,13 +3076,18 @@ module Aws::IoTSiteWise
3040
3076
  # @return [String]
3041
3077
  #
3042
3078
  # @!attribute [rw] dashboard_definition
3043
- # The dashboard definition specified in a JSON literal. For detailed
3044
- # information, see [Creating dashboards (CLI)][1] in the *IoT SiteWise
3045
- # User Guide*.
3079
+ # The dashboard definition specified in a JSON literal.
3080
+ #
3081
+ # * IoT SiteWise Monitor (Classic) see [Create dashboards (CLI)][1]
3082
+ #
3083
+ # * IoT SiteWise Monitor (AI-aware) see [Create dashboards (CLI)][2]
3084
+ #
3085
+ # in the *IoT SiteWise User Guide*
3046
3086
  #
3047
3087
  #
3048
3088
  #
3049
3089
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html
3090
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-ai-dashboard-cli.html
3050
3091
  # @return [String]
3051
3092
  #
3052
3093
  # @!attribute [rw] client_token
@@ -3100,6 +3141,80 @@ module Aws::IoTSiteWise
3100
3141
  include Aws::Structure
3101
3142
  end
3102
3143
 
3144
+ # @!attribute [rw] dataset_id
3145
+ # The ID of the dataset.
3146
+ # @return [String]
3147
+ #
3148
+ # @!attribute [rw] dataset_name
3149
+ # The name of the dataset.
3150
+ # @return [String]
3151
+ #
3152
+ # @!attribute [rw] dataset_description
3153
+ # A description about the dataset, and its functionality.
3154
+ # @return [String]
3155
+ #
3156
+ # @!attribute [rw] dataset_source
3157
+ # The data source for the dataset.
3158
+ # @return [Types::DatasetSource]
3159
+ #
3160
+ # @!attribute [rw] client_token
3161
+ # A unique case-sensitive identifier that you can provide to ensure
3162
+ # the idempotency of the request. Don't reuse this client token if a
3163
+ # new idempotent request is required.
3164
+ #
3165
+ # **A suitable default value is auto-generated.** You should normally
3166
+ # not need to pass this option.
3167
+ # @return [String]
3168
+ #
3169
+ # @!attribute [rw] tags
3170
+ # A list of key-value pairs that contain metadata for the access
3171
+ # policy. For more information, see [Tagging your IoT SiteWise
3172
+ # resources][1] in the *IoT SiteWise User Guide*.
3173
+ #
3174
+ #
3175
+ #
3176
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
3177
+ # @return [Hash<String,String>]
3178
+ #
3179
+ class CreateDatasetRequest < Struct.new(
3180
+ :dataset_id,
3181
+ :dataset_name,
3182
+ :dataset_description,
3183
+ :dataset_source,
3184
+ :client_token,
3185
+ :tags)
3186
+ SENSITIVE = []
3187
+ include Aws::Structure
3188
+ end
3189
+
3190
+ # @!attribute [rw] dataset_id
3191
+ # The ID of the dataset.
3192
+ # @return [String]
3193
+ #
3194
+ # @!attribute [rw] dataset_arn
3195
+ # The [ARN][1] of the dataset. The format is
3196
+ # `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`.
3197
+ #
3198
+ #
3199
+ #
3200
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
3201
+ # @return [String]
3202
+ #
3203
+ # @!attribute [rw] dataset_status
3204
+ # The status of the dataset. This contains the state and any error
3205
+ # messages. State is `CREATING` after a successfull call to this API,
3206
+ # and any associated error message. The state is `ACTIVE` when ready
3207
+ # to use.
3208
+ # @return [Types::DatasetStatus]
3209
+ #
3210
+ class CreateDatasetResponse < Struct.new(
3211
+ :dataset_id,
3212
+ :dataset_arn,
3213
+ :dataset_status)
3214
+ SENSITIVE = []
3215
+ include Aws::Structure
3216
+ end
3217
+
3103
3218
  # @!attribute [rw] gateway_name
3104
3219
  # A unique name for the gateway.
3105
3220
  # @return [String]
@@ -3245,6 +3360,19 @@ module Aws::IoTSiteWise
3245
3360
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
3246
3361
  # @return [Types::Alarms]
3247
3362
  #
3363
+ # @!attribute [rw] portal_type
3364
+ # Define the type of portal. The value for IoT SiteWise Monitor
3365
+ # (Classic) is `SITEWISE_PORTAL_V1`. The value for IoT SiteWise
3366
+ # Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.
3367
+ # @return [String]
3368
+ #
3369
+ # @!attribute [rw] portal_type_configuration
3370
+ # The configuration entry associated with the specific portal type.
3371
+ # The value for IoT SiteWise Monitor (Classic) is
3372
+ # `SITEWISE_PORTAL_V1`. The value for IoT SiteWise Monitor (AI-aware)
3373
+ # is `SITEWISE_PORTAL_V2`.
3374
+ # @return [Hash<String,Types::PortalTypeEntry>]
3375
+ #
3248
3376
  class CreatePortalRequest < Struct.new(
3249
3377
  :portal_name,
3250
3378
  :portal_description,
@@ -3255,8 +3383,10 @@ module Aws::IoTSiteWise
3255
3383
  :tags,
3256
3384
  :portal_auth_mode,
3257
3385
  :notification_sender_email,
3258
- :alarms)
3259
- SENSITIVE = []
3386
+ :alarms,
3387
+ :portal_type,
3388
+ :portal_type_configuration)
3389
+ SENSITIVE = [:portal_contact_email, :notification_sender_email]
3260
3390
  include Aws::Structure
3261
3391
  end
3262
3392
 
@@ -3436,6 +3566,116 @@ module Aws::IoTSiteWise
3436
3566
  include Aws::Structure
3437
3567
  end
3438
3568
 
3569
+ # Contains information about the dataset use and it's source.
3570
+ #
3571
+ # @!attribute [rw] dataset_arn
3572
+ # The [ARN][1] of the dataset. The format is
3573
+ # `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`.
3574
+ #
3575
+ #
3576
+ #
3577
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
3578
+ # @return [String]
3579
+ #
3580
+ # @!attribute [rw] source
3581
+ # The data source for the dataset.
3582
+ # @return [Types::Source]
3583
+ #
3584
+ class DataSetReference < Struct.new(
3585
+ :dataset_arn,
3586
+ :source)
3587
+ SENSITIVE = []
3588
+ include Aws::Structure
3589
+ end
3590
+
3591
+ # The data source for the dataset.
3592
+ #
3593
+ # @!attribute [rw] source_type
3594
+ # The type of data source for the dataset.
3595
+ # @return [String]
3596
+ #
3597
+ # @!attribute [rw] source_format
3598
+ # The format of the dataset source associated with the dataset.
3599
+ # @return [String]
3600
+ #
3601
+ # @!attribute [rw] source_detail
3602
+ # The details of the dataset source associated with the dataset.
3603
+ # @return [Types::SourceDetail]
3604
+ #
3605
+ class DatasetSource < Struct.new(
3606
+ :source_type,
3607
+ :source_format,
3608
+ :source_detail)
3609
+ SENSITIVE = []
3610
+ include Aws::Structure
3611
+ end
3612
+
3613
+ # The status of the dataset. This contains the state and any error
3614
+ # messages. The state is `ACTIVE` when ready to use.
3615
+ #
3616
+ # @!attribute [rw] state
3617
+ # The current status of the dataset.
3618
+ # @return [String]
3619
+ #
3620
+ # @!attribute [rw] error
3621
+ # Contains the details of an IoT SiteWise error.
3622
+ # @return [Types::ErrorDetails]
3623
+ #
3624
+ class DatasetStatus < Struct.new(
3625
+ :state,
3626
+ :error)
3627
+ SENSITIVE = []
3628
+ include Aws::Structure
3629
+ end
3630
+
3631
+ # The summary details for the dataset.
3632
+ #
3633
+ # @!attribute [rw] id
3634
+ # The ID of the dataset.
3635
+ # @return [String]
3636
+ #
3637
+ # @!attribute [rw] arn
3638
+ # The [ARN][1] of the dataset. The format is
3639
+ # `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`.
3640
+ #
3641
+ #
3642
+ #
3643
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
3644
+ # @return [String]
3645
+ #
3646
+ # @!attribute [rw] name
3647
+ # The name of the dataset.
3648
+ # @return [String]
3649
+ #
3650
+ # @!attribute [rw] description
3651
+ # A description about the dataset, and its functionality.
3652
+ # @return [String]
3653
+ #
3654
+ # @!attribute [rw] creation_date
3655
+ # The dataset creation date, in Unix epoch time.
3656
+ # @return [Time]
3657
+ #
3658
+ # @!attribute [rw] last_update_date
3659
+ # The date the dataset was last updated, in Unix epoch time.
3660
+ # @return [Time]
3661
+ #
3662
+ # @!attribute [rw] status
3663
+ # The status of the dataset. This contains the state and any error
3664
+ # messages. The state is `ACTIVE` when ready to use.
3665
+ # @return [Types::DatasetStatus]
3666
+ #
3667
+ class DatasetSummary < Struct.new(
3668
+ :id,
3669
+ :arn,
3670
+ :name,
3671
+ :description,
3672
+ :creation_date,
3673
+ :last_update_date,
3674
+ :status)
3675
+ SENSITIVE = []
3676
+ include Aws::Structure
3677
+ end
3678
+
3439
3679
  # Represents a single data point in a query result.
3440
3680
  #
3441
3681
  # @!attribute [rw] scalar_value
@@ -3679,6 +3919,38 @@ module Aws::IoTSiteWise
3679
3919
 
3680
3920
  class DeleteDashboardResponse < Aws::EmptyStructure; end
3681
3921
 
3922
+ # @!attribute [rw] dataset_id
3923
+ # The ID of the dataset.
3924
+ # @return [String]
3925
+ #
3926
+ # @!attribute [rw] client_token
3927
+ # A unique case-sensitive identifier that you can provide to ensure
3928
+ # the idempotency of the request. Don't reuse this client token if a
3929
+ # new idempotent request is required.
3930
+ #
3931
+ # **A suitable default value is auto-generated.** You should normally
3932
+ # not need to pass this option.
3933
+ # @return [String]
3934
+ #
3935
+ class DeleteDatasetRequest < Struct.new(
3936
+ :dataset_id,
3937
+ :client_token)
3938
+ SENSITIVE = []
3939
+ include Aws::Structure
3940
+ end
3941
+
3942
+ # @!attribute [rw] dataset_status
3943
+ # The status of the dataset. This contains the state and any error
3944
+ # messages. State is `DELETING` after a successfull call to this API,
3945
+ # and any associated error message.
3946
+ # @return [Types::DatasetStatus]
3947
+ #
3948
+ class DeleteDatasetResponse < Struct.new(
3949
+ :dataset_status)
3950
+ SENSITIVE = []
3951
+ include Aws::Structure
3952
+ end
3953
+
3682
3954
  # @!attribute [rw] gateway_id
3683
3955
  # The ID of the gateway to delete.
3684
3956
  # @return [String]
@@ -4587,6 +4859,74 @@ module Aws::IoTSiteWise
4587
4859
  include Aws::Structure
4588
4860
  end
4589
4861
 
4862
+ # @!attribute [rw] dataset_id
4863
+ # The ID of the dataset.
4864
+ # @return [String]
4865
+ #
4866
+ class DescribeDatasetRequest < Struct.new(
4867
+ :dataset_id)
4868
+ SENSITIVE = []
4869
+ include Aws::Structure
4870
+ end
4871
+
4872
+ # @!attribute [rw] dataset_id
4873
+ # The ID of the dataset.
4874
+ # @return [String]
4875
+ #
4876
+ # @!attribute [rw] dataset_arn
4877
+ # The [ARN][1] of the dataset. The format is
4878
+ # `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`.
4879
+ #
4880
+ #
4881
+ #
4882
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
4883
+ # @return [String]
4884
+ #
4885
+ # @!attribute [rw] dataset_name
4886
+ # The name of the dataset.
4887
+ # @return [String]
4888
+ #
4889
+ # @!attribute [rw] dataset_description
4890
+ # A description about the dataset, and its functionality.
4891
+ # @return [String]
4892
+ #
4893
+ # @!attribute [rw] dataset_source
4894
+ # The data source for the dataset.
4895
+ # @return [Types::DatasetSource]
4896
+ #
4897
+ # @!attribute [rw] dataset_status
4898
+ # The status of the dataset. This contains the state and any error
4899
+ # messages. State is `CREATING` after a successfull call to this API,
4900
+ # and any associated error message. The state is `ACTIVE` when ready
4901
+ # to use.
4902
+ # @return [Types::DatasetStatus]
4903
+ #
4904
+ # @!attribute [rw] dataset_creation_date
4905
+ # The dataset creation date, in Unix epoch time.
4906
+ # @return [Time]
4907
+ #
4908
+ # @!attribute [rw] dataset_last_update_date
4909
+ # The date the dataset was last updated, in Unix epoch time.
4910
+ # @return [Time]
4911
+ #
4912
+ # @!attribute [rw] dataset_version
4913
+ # The version of the dataset.
4914
+ # @return [String]
4915
+ #
4916
+ class DescribeDatasetResponse < Struct.new(
4917
+ :dataset_id,
4918
+ :dataset_arn,
4919
+ :dataset_name,
4920
+ :dataset_description,
4921
+ :dataset_source,
4922
+ :dataset_status,
4923
+ :dataset_creation_date,
4924
+ :dataset_last_update_date,
4925
+ :dataset_version)
4926
+ SENSITIVE = []
4927
+ include Aws::Structure
4928
+ end
4929
+
4590
4930
  # @api private
4591
4931
  #
4592
4932
  class DescribeDefaultEncryptionConfigurationRequest < Aws::EmptyStructure; end
@@ -4657,10 +4997,18 @@ module Aws::IoTSiteWise
4657
4997
  #
4658
4998
  # * `IN_SYNC` – The gateway is running the capability configuration.
4659
4999
  #
5000
+ # * `NOT_APPLICABLE` – Synchronization is not required for this
5001
+ # capability configuration. This is most common when integrating
5002
+ # partner data sources, because the data integration is handled
5003
+ # externally by the partner.
5004
+ #
4660
5005
  # * `OUT_OF_SYNC` – The gateway hasn't received the capability
4661
5006
  # configuration.
4662
5007
  #
4663
5008
  # * `SYNC_FAILED` – The gateway rejected the capability configuration.
5009
+ #
5010
+ # * `UNKNOWN` – The synchronization status is currently unknown due to
5011
+ # an undetermined or temporary error.
4664
5012
  # @return [String]
4665
5013
  #
4666
5014
  class DescribeGatewayCapabilityConfigurationResponse < Struct.new(
@@ -4841,6 +5189,19 @@ module Aws::IoTSiteWise
4841
5189
  # SiteWise Monitor portal.
4842
5190
  # @return [Types::Alarms]
4843
5191
  #
5192
+ # @!attribute [rw] portal_type
5193
+ # Define the type of portal. The value for IoT SiteWise Monitor
5194
+ # (Classic) is `SITEWISE_PORTAL_V1`. The value for IoT SiteWise
5195
+ # Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.
5196
+ # @return [String]
5197
+ #
5198
+ # @!attribute [rw] portal_type_configuration
5199
+ # The configuration entry associated with the specific portal type.
5200
+ # The value for IoT SiteWise Monitor (Classic) is
5201
+ # `SITEWISE_PORTAL_V1`. The value for IoT SiteWise Monitor (AI-aware)
5202
+ # is `SITEWISE_PORTAL_V2`.
5203
+ # @return [Hash<String,Types::PortalTypeEntry>]
5204
+ #
4844
5205
  class DescribePortalResponse < Struct.new(
4845
5206
  :portal_id,
4846
5207
  :portal_arn,
@@ -4856,8 +5217,10 @@ module Aws::IoTSiteWise
4856
5217
  :role_arn,
4857
5218
  :portal_auth_mode,
4858
5219
  :notification_sender_email,
4859
- :alarms)
4860
- SENSITIVE = []
5220
+ :alarms,
5221
+ :portal_type,
5222
+ :portal_type_configuration)
5223
+ SENSITIVE = [:portal_contact_email, :notification_sender_email]
4861
5224
  include Aws::Structure
4862
5225
  end
4863
5226
 
@@ -5318,10 +5681,20 @@ module Aws::IoTSiteWise
5318
5681
  # 25.
5319
5682
  # @return [Integer]
5320
5683
  #
5684
+ # @!attribute [rw] client_token
5685
+ # A unique case-sensitive identifier that you can provide to ensure
5686
+ # the idempotency of the request. Don't reuse this client token if a
5687
+ # new idempotent request is required.
5688
+ #
5689
+ # **A suitable default value is auto-generated.** You should normally
5690
+ # not need to pass this option.
5691
+ # @return [String]
5692
+ #
5321
5693
  class ExecuteQueryRequest < Struct.new(
5322
5694
  :query_statement,
5323
5695
  :next_token,
5324
- :max_results)
5696
+ :max_results,
5697
+ :client_token)
5325
5698
  SENSITIVE = []
5326
5699
  include Aws::Structure
5327
5700
  end
@@ -5434,10 +5807,18 @@ module Aws::IoTSiteWise
5434
5807
  #
5435
5808
  # * `IN_SYNC` – The gateway is running the capability configuration.
5436
5809
  #
5810
+ # * `NOT_APPLICABLE` – Synchronization is not required for this
5811
+ # capability configuration. This is most common when integrating
5812
+ # partner data sources, because the data integration is handled
5813
+ # externally by the partner.
5814
+ #
5437
5815
  # * `OUT_OF_SYNC` – The gateway hasn't received the capability
5438
5816
  # configuration.
5439
5817
  #
5440
5818
  # * `SYNC_FAILED` – The gateway rejected the capability configuration.
5819
+ #
5820
+ # * `UNKNOWN` – The synchronization status is currently unknown due to
5821
+ # an undetermined or temporary error.
5441
5822
  # @return [String]
5442
5823
  #
5443
5824
  class GatewayCapabilitySummary < Struct.new(
@@ -6096,7 +6477,8 @@ module Aws::IoTSiteWise
6096
6477
  # @return [String]
6097
6478
  #
6098
6479
  class InternalFailureException < Struct.new(
6099
- :message)
6480
+ :message,
6481
+ :event_type)
6100
6482
  SENSITIVE = []
6101
6483
  include Aws::Structure
6102
6484
  end
@@ -6126,7 +6508,70 @@ module Aws::IoTSiteWise
6126
6508
  # @return [String]
6127
6509
  #
6128
6510
  class InvalidRequestException < Struct.new(
6129
- :message)
6511
+ :message,
6512
+ :event_type)
6513
+ SENSITIVE = []
6514
+ include Aws::Structure
6515
+ end
6516
+
6517
+ # This contains the SiteWise Assistant's response and the corresponding
6518
+ # citation.
6519
+ #
6520
+ # @!attribute [rw] message
6521
+ # The text message of the SiteWise Assistant's response.
6522
+ # @return [String]
6523
+ #
6524
+ # @!attribute [rw] citations
6525
+ # A list of citations, and related information for the SiteWise
6526
+ # Assistant's response.
6527
+ # @return [Array<Types::Citation>]
6528
+ #
6529
+ class InvocationOutput < Struct.new(
6530
+ :message,
6531
+ :citations,
6532
+ :event_type)
6533
+ SENSITIVE = []
6534
+ include Aws::Structure
6535
+ end
6536
+
6537
+ # @!attribute [rw] conversation_id
6538
+ # The ID assigned to a conversation. IoT SiteWise automatically
6539
+ # generates a unique ID for you, and this parameter is never required.
6540
+ # However, if you prefer to have your own ID, you must specify it here
6541
+ # in UUID format. If you specify your own ID, it must be globally
6542
+ # unique.
6543
+ # @return [String]
6544
+ #
6545
+ # @!attribute [rw] message
6546
+ # A text message sent to the SiteWise Assistant by the user.
6547
+ # @return [String]
6548
+ #
6549
+ # @!attribute [rw] enable_trace
6550
+ # Specifies if to turn trace on or not. It is used to track the
6551
+ # SiteWise Assistant's reasoning, and data access process.
6552
+ # @return [Boolean]
6553
+ #
6554
+ class InvokeAssistantRequest < Struct.new(
6555
+ :conversation_id,
6556
+ :message,
6557
+ :enable_trace)
6558
+ SENSITIVE = [:message]
6559
+ include Aws::Structure
6560
+ end
6561
+
6562
+ # @!attribute [rw] body
6563
+ # Contains the response, citation, and trace from the SiteWise
6564
+ # Assistant.
6565
+ # @return [Types::ResponseStream]
6566
+ #
6567
+ # @!attribute [rw] conversation_id
6568
+ # The ID of the conversation, in UUID format. This ID uniquely
6569
+ # identifies the conversation within IoT SiteWise.
6570
+ # @return [String]
6571
+ #
6572
+ class InvokeAssistantResponse < Struct.new(
6573
+ :body,
6574
+ :conversation_id)
6130
6575
  SENSITIVE = []
6131
6576
  include Aws::Structure
6132
6577
  end
@@ -6186,6 +6631,23 @@ module Aws::IoTSiteWise
6186
6631
  include Aws::Structure
6187
6632
  end
6188
6633
 
6634
+ # The source details for the Kendra dataset source.
6635
+ #
6636
+ # @!attribute [rw] knowledge_base_arn
6637
+ # The `knowledgeBaseArn` details for the Kendra dataset source.
6638
+ # @return [String]
6639
+ #
6640
+ # @!attribute [rw] role_arn
6641
+ # The `roleARN` details for the Kendra dataset source.
6642
+ # @return [String]
6643
+ #
6644
+ class KendraSourceDetail < Struct.new(
6645
+ :knowledge_base_arn,
6646
+ :role_arn)
6647
+ SENSITIVE = []
6648
+ include Aws::Structure
6649
+ end
6650
+
6189
6651
  # You've reached the limit for a resource. For example, this can occur
6190
6652
  # if you're trying to associate more than the allowed number of child
6191
6653
  # assets or attempting to create more than the allowed number of
@@ -6202,7 +6664,8 @@ module Aws::IoTSiteWise
6202
6664
  # @return [String]
6203
6665
  #
6204
6666
  class LimitExceededException < Struct.new(
6205
- :message)
6667
+ :message,
6668
+ :event_type)
6206
6669
  SENSITIVE = []
6207
6670
  include Aws::Structure
6208
6671
  end
@@ -6878,6 +7341,43 @@ module Aws::IoTSiteWise
6878
7341
  include Aws::Structure
6879
7342
  end
6880
7343
 
7344
+ # @!attribute [rw] source_type
7345
+ # The type of data source for the dataset.
7346
+ # @return [String]
7347
+ #
7348
+ # @!attribute [rw] next_token
7349
+ # The token for the next set of results, or null if there are no
7350
+ # additional results.
7351
+ # @return [String]
7352
+ #
7353
+ # @!attribute [rw] max_results
7354
+ # The maximum number of results to return for each paginated request.
7355
+ # @return [Integer]
7356
+ #
7357
+ class ListDatasetsRequest < Struct.new(
7358
+ :source_type,
7359
+ :next_token,
7360
+ :max_results)
7361
+ SENSITIVE = []
7362
+ include Aws::Structure
7363
+ end
7364
+
7365
+ # @!attribute [rw] dataset_summaries
7366
+ # A list that summarizes the dataset response.
7367
+ # @return [Array<Types::DatasetSummary>]
7368
+ #
7369
+ # @!attribute [rw] next_token
7370
+ # The token for the next set of results, or null if there are no
7371
+ # additional results.
7372
+ # @return [String]
7373
+ #
7374
+ class ListDatasetsResponse < Struct.new(
7375
+ :dataset_summaries,
7376
+ :next_token)
7377
+ SENSITIVE = []
7378
+ include Aws::Structure
7379
+ end
7380
+
6881
7381
  # @!attribute [rw] next_token
6882
7382
  # The token to be used for the next set of paginated results.
6883
7383
  # @return [String]
@@ -7112,6 +7612,19 @@ module Aws::IoTSiteWise
7112
7612
  include Aws::Structure
7113
7613
  end
7114
7614
 
7615
+ # Contains location information about the cited text and where it's
7616
+ # stored.
7617
+ #
7618
+ # @!attribute [rw] uri
7619
+ # The URI of the location.
7620
+ # @return [String]
7621
+ #
7622
+ class Location < Struct.new(
7623
+ :uri)
7624
+ SENSITIVE = []
7625
+ include Aws::Structure
7626
+ end
7627
+
7115
7628
  # Contains logging options.
7116
7629
  #
7117
7630
  # @!attribute [rw] level
@@ -7351,6 +7864,12 @@ module Aws::IoTSiteWise
7351
7864
  # Contains information about the current status of a portal.
7352
7865
  # @return [Types::PortalStatus]
7353
7866
  #
7867
+ # @!attribute [rw] portal_type
7868
+ # Define the type of portal. The value for IoT SiteWise Monitor
7869
+ # (Classic) is `SITEWISE_PORTAL_V1`. The value for IoT SiteWise
7870
+ # Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.
7871
+ # @return [String]
7872
+ #
7354
7873
  class PortalSummary < Struct.new(
7355
7874
  :id,
7356
7875
  :name,
@@ -7359,7 +7878,23 @@ module Aws::IoTSiteWise
7359
7878
  :creation_date,
7360
7879
  :last_update_date,
7361
7880
  :role_arn,
7362
- :status)
7881
+ :status,
7882
+ :portal_type)
7883
+ SENSITIVE = []
7884
+ include Aws::Structure
7885
+ end
7886
+
7887
+ # The configuration entry associated with the specific portal type. The
7888
+ # `portalTypeConfiguration` is a map of the `portalTypeKey` to the
7889
+ # `PortalTypeEntry`.
7890
+ #
7891
+ # @!attribute [rw] portal_tools
7892
+ # The array of tools associated with the specified portal type. The
7893
+ # possible values are `ASSISTANT` and `DASHBOARD`.
7894
+ # @return [Array<String>]
7895
+ #
7896
+ class PortalTypeEntry < Struct.new(
7897
+ :portal_tools)
7363
7898
  SENSITIVE = []
7364
7899
  include Aws::Structure
7365
7900
  end
@@ -7819,6 +8354,18 @@ module Aws::IoTSiteWise
7819
8354
  include Aws::Structure
7820
8355
  end
7821
8356
 
8357
+ # Contains the reference information.
8358
+ #
8359
+ # @!attribute [rw] dataset
8360
+ # Contains the dataset reference information.
8361
+ # @return [Types::DataSetReference]
8362
+ #
8363
+ class Reference < Struct.new(
8364
+ :dataset)
8365
+ SENSITIVE = []
8366
+ include Aws::Structure
8367
+ end
8368
+
7822
8369
  # Contains an IoT SiteWise Monitor resource ID for a portal or project.
7823
8370
  #
7824
8371
  # @!attribute [rw] portal
@@ -7863,7 +8410,8 @@ module Aws::IoTSiteWise
7863
8410
  # @return [String]
7864
8411
  #
7865
8412
  class ResourceNotFoundException < Struct.new(
7866
- :message)
8413
+ :message,
8414
+ :event_type)
7867
8415
  SENSITIVE = []
7868
8416
  include Aws::Structure
7869
8417
  end
@@ -7932,6 +8480,39 @@ module Aws::IoTSiteWise
7932
8480
  include Aws::Structure
7933
8481
  end
7934
8482
 
8483
+ # The data source for the dataset.
8484
+ #
8485
+ # @!attribute [rw] arn
8486
+ # Contains the ARN of the dataset. If the source is Kendra, it's the
8487
+ # ARN of the Kendra index.
8488
+ # @return [String]
8489
+ #
8490
+ # @!attribute [rw] location
8491
+ # Contains the location information where the cited text is originally
8492
+ # stored. For example, if the data source is Kendra, and the text
8493
+ # synchronized is from an S3 bucket, then the location refers to an S3
8494
+ # object.
8495
+ # @return [Types::Location]
8496
+ #
8497
+ class Source < Struct.new(
8498
+ :arn,
8499
+ :location)
8500
+ SENSITIVE = []
8501
+ include Aws::Structure
8502
+ end
8503
+
8504
+ # The details of the dataset source associated with the dataset.
8505
+ #
8506
+ # @!attribute [rw] kendra
8507
+ # Contains details about the Kendra dataset source.
8508
+ # @return [Types::KendraSourceDetail]
8509
+ #
8510
+ class SourceDetail < Struct.new(
8511
+ :kendra)
8512
+ SENSITIVE = []
8513
+ include Aws::Structure
8514
+ end
8515
+
7935
8516
  # @!attribute [rw] resource_arn
7936
8517
  # The [ARN][1] of the resource to tag.
7937
8518
  #
@@ -7986,7 +8567,8 @@ module Aws::IoTSiteWise
7986
8567
  # @return [String]
7987
8568
  #
7988
8569
  class ThrottlingException < Struct.new(
7989
- :message)
8570
+ :message,
8571
+ :event_type)
7990
8572
  SENSITIVE = []
7991
8573
  include Aws::Structure
7992
8574
  end
@@ -8098,6 +8680,20 @@ module Aws::IoTSiteWise
8098
8680
  include Aws::Structure
8099
8681
  end
8100
8682
 
8683
+ # Contains tracing information of the SiteWise Assistant's reasoning
8684
+ # and data access.
8685
+ #
8686
+ # @!attribute [rw] text
8687
+ # The cited text from the data source.
8688
+ # @return [String]
8689
+ #
8690
+ class Trace < Struct.new(
8691
+ :text,
8692
+ :event_type)
8693
+ SENSITIVE = []
8694
+ include Aws::Structure
8695
+ end
8696
+
8101
8697
  # Contains an asset transform property. A transform is a one-to-one
8102
8698
  # mapping of a property's data points from one form to another. For
8103
8699
  # example, you can use a transform to convert a Celsius data stream to
@@ -8213,7 +8809,6 @@ module Aws::IoTSiteWise
8213
8809
  #
8214
8810
  # * If you create the metric after 6 PM (UTC), you get the first
8215
8811
  # aggregation result at 6 PM (UTC) the next day.
8216
- #
8217
8812
  # * The ISO 8601 format.
8218
8813
  #
8219
8814
  # For example, if you specify `PT18H` for `offset` and `1d` for
@@ -8226,7 +8821,6 @@ module Aws::IoTSiteWise
8226
8821
  #
8227
8822
  # * If you create the metric after 6 PM (UTC), you get the first
8228
8823
  # aggregation result at 6 PM (UTC) the next day.
8229
- #
8230
8824
  # * The 24-hour clock.
8231
8825
  #
8232
8826
  # For example, if you specify `00:03:00` for `offset`, `5m` for
@@ -8723,13 +9317,18 @@ module Aws::IoTSiteWise
8723
9317
  # @return [String]
8724
9318
  #
8725
9319
  # @!attribute [rw] dashboard_definition
8726
- # The new dashboard definition, as specified in a JSON literal. For
8727
- # detailed information, see [Creating dashboards (CLI)][1] in the *IoT
8728
- # SiteWise User Guide*.
9320
+ # The new dashboard definition, as specified in a JSON literal.
9321
+ #
9322
+ # * IoT SiteWise Monitor (Classic) see [Create dashboards (CLI)][1]
9323
+ #
9324
+ # * IoT SiteWise Monitor (AI-aware) see [Create dashboards (CLI)][2]
9325
+ #
9326
+ # in the *IoT SiteWise User Guide*
8729
9327
  #
8730
9328
  #
8731
9329
  #
8732
9330
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html
9331
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-ai-dashboard-cli.html
8733
9332
  # @return [String]
8734
9333
  #
8735
9334
  # @!attribute [rw] client_token
@@ -8753,6 +9352,69 @@ module Aws::IoTSiteWise
8753
9352
 
8754
9353
  class UpdateDashboardResponse < Aws::EmptyStructure; end
8755
9354
 
9355
+ # @!attribute [rw] dataset_id
9356
+ # The ID of the dataset.
9357
+ # @return [String]
9358
+ #
9359
+ # @!attribute [rw] dataset_name
9360
+ # The name of the dataset.
9361
+ # @return [String]
9362
+ #
9363
+ # @!attribute [rw] dataset_description
9364
+ # A description about the dataset, and its functionality.
9365
+ # @return [String]
9366
+ #
9367
+ # @!attribute [rw] dataset_source
9368
+ # The data source for the dataset.
9369
+ # @return [Types::DatasetSource]
9370
+ #
9371
+ # @!attribute [rw] client_token
9372
+ # A unique case-sensitive identifier that you can provide to ensure
9373
+ # the idempotency of the request. Don't reuse this client token if a
9374
+ # new idempotent request is required.
9375
+ #
9376
+ # **A suitable default value is auto-generated.** You should normally
9377
+ # not need to pass this option.
9378
+ # @return [String]
9379
+ #
9380
+ class UpdateDatasetRequest < Struct.new(
9381
+ :dataset_id,
9382
+ :dataset_name,
9383
+ :dataset_description,
9384
+ :dataset_source,
9385
+ :client_token)
9386
+ SENSITIVE = []
9387
+ include Aws::Structure
9388
+ end
9389
+
9390
+ # @!attribute [rw] dataset_id
9391
+ # The ID of the dataset.
9392
+ # @return [String]
9393
+ #
9394
+ # @!attribute [rw] dataset_arn
9395
+ # The [ARN][1] of the dataset. The format is
9396
+ # `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`.
9397
+ #
9398
+ #
9399
+ #
9400
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
9401
+ # @return [String]
9402
+ #
9403
+ # @!attribute [rw] dataset_status
9404
+ # The status of the dataset. This contains the state and any error
9405
+ # messages. State is `UPDATING` after a successfull call to this API,
9406
+ # and any associated error message. The state is `ACTIVE` when ready
9407
+ # to use.
9408
+ # @return [Types::DatasetStatus]
9409
+ #
9410
+ class UpdateDatasetResponse < Struct.new(
9411
+ :dataset_id,
9412
+ :dataset_arn,
9413
+ :dataset_status)
9414
+ SENSITIVE = []
9415
+ include Aws::Structure
9416
+ end
9417
+
8756
9418
  # @!attribute [rw] gateway_id
8757
9419
  # The ID of the gateway to be updated.
8758
9420
  # @return [String]
@@ -8793,11 +9455,19 @@ module Aws::IoTSiteWise
8793
9455
  #
8794
9456
  # * `IN_SYNC` – The gateway is running the capability configuration.
8795
9457
  #
9458
+ # * `NOT_APPLICABLE` – Synchronization is not required for this
9459
+ # capability configuration. This is most common when integrating
9460
+ # partner data sources, because the data integration is handled
9461
+ # externally by the partner.
9462
+ #
8796
9463
  # * `OUT_OF_SYNC` – The gateway hasn't received the capability
8797
9464
  # configuration.
8798
9465
  #
8799
9466
  # * `SYNC_FAILED` – The gateway rejected the capability configuration.
8800
9467
  #
9468
+ # * `UNKNOWN` – The synchronization status is currently unknown due to
9469
+ # an undetermined or temporary error.
9470
+ #
8801
9471
  # After you update a capability configuration, its sync status is
8802
9472
  # `OUT_OF_SYNC` until the gateway receives and applies or rejects the
8803
9473
  # updated configuration.
@@ -8887,6 +9557,19 @@ module Aws::IoTSiteWise
8887
9557
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
8888
9558
  # @return [Types::Alarms]
8889
9559
  #
9560
+ # @!attribute [rw] portal_type
9561
+ # Define the type of portal. The value for IoT SiteWise Monitor
9562
+ # (Classic) is `SITEWISE_PORTAL_V1`. The value for IoT SiteWise
9563
+ # Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.
9564
+ # @return [String]
9565
+ #
9566
+ # @!attribute [rw] portal_type_configuration
9567
+ # The configuration entry associated with the specific portal type.
9568
+ # The value for IoT SiteWise Monitor (Classic) is
9569
+ # `SITEWISE_PORTAL_V1`. The value for IoT SiteWise Monitor (AI-aware)
9570
+ # is `SITEWISE_PORTAL_V2`.
9571
+ # @return [Hash<String,Types::PortalTypeEntry>]
9572
+ #
8890
9573
  class UpdatePortalRequest < Struct.new(
8891
9574
  :portal_id,
8892
9575
  :portal_name,
@@ -8896,8 +9579,10 @@ module Aws::IoTSiteWise
8896
9579
  :role_arn,
8897
9580
  :client_token,
8898
9581
  :notification_sender_email,
8899
- :alarms)
8900
- SENSITIVE = []
9582
+ :alarms,
9583
+ :portal_type,
9584
+ :portal_type_configuration)
9585
+ SENSITIVE = [:portal_contact_email, :notification_sender_email]
8901
9586
  include Aws::Structure
8902
9587
  end
8903
9588
 
@@ -9058,6 +9743,30 @@ module Aws::IoTSiteWise
9058
9743
  include Aws::Structure
9059
9744
  end
9060
9745
 
9746
+ # Contains the response, citation, and trace from the SiteWise
9747
+ # Assistant.
9748
+ #
9749
+ # EventStream is an Enumerator of Events.
9750
+ # #event_types #=> Array, returns all modeled event types in the stream
9751
+ #
9752
+ class ResponseStream < Enumerator
9753
+
9754
+ def event_types
9755
+ [
9756
+ :trace,
9757
+ :output,
9758
+ :access_denied_exception,
9759
+ :conflicting_operation_exception,
9760
+ :internal_failure_exception,
9761
+ :invalid_request_exception,
9762
+ :limit_exceeded_exception,
9763
+ :resource_not_found_exception,
9764
+ :throttling_exception
9765
+ ]
9766
+ end
9767
+
9768
+ end
9769
+
9061
9770
  end
9062
9771
  end
9063
9772