aws-sdk 2.1662.0 → 2.1663.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/apis/cleanrooms-2022-02-17.min.json +444 -156
- package/apis/iotsitewise-2019-12-02.min.json +113 -98
- package/apis/mediapackagev2-2022-12-25.min.json +0 -3
- package/apis/medical-imaging-2023-07-19.min.json +75 -35
- package/apis/pinpoint-sms-voice-v2-2022-03-31.min.json +6 -0
- package/clients/cleanrooms.d.ts +328 -63
- package/clients/dynamodb.d.ts +6 -6
- package/clients/iotsitewise.d.ts +37 -25
- package/clients/mediapackagev2.d.ts +1 -1
- package/clients/medicalimaging.d.ts +38 -0
- package/clients/pinpointsmsvoicev2.d.ts +56 -56
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +6 -6
- package/dist/aws-sdk.js +3 -3
- package/dist/aws-sdk.min.js +2 -2
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/dynamodb.d.ts
CHANGED
@@ -15,11 +15,11 @@ declare class DynamoDB extends DynamoDBCustomizations {
|
|
15
15
|
constructor(options?: DynamoDB.Types.ClientConfiguration)
|
16
16
|
config: Config & DynamoDB.Types.ClientConfiguration;
|
17
17
|
/**
|
18
|
-
* This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item. The entire batch must consist of either read statements or write statements, you cannot mix both in one batch. A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.
|
18
|
+
* This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB . The entire batch must consist of either read statements or write statements, you cannot mix both in one batch. A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.
|
19
19
|
*/
|
20
20
|
batchExecuteStatement(params: DynamoDB.Types.BatchExecuteStatementInput, callback?: (err: AWSError, data: DynamoDB.Types.BatchExecuteStatementOutput) => void): Request<DynamoDB.Types.BatchExecuteStatementOutput, AWSError>;
|
21
21
|
/**
|
22
|
-
* This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item. The entire batch must consist of either read statements or write statements, you cannot mix both in one batch. A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.
|
22
|
+
* This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB . The entire batch must consist of either read statements or write statements, you cannot mix both in one batch. A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.
|
23
23
|
*/
|
24
24
|
batchExecuteStatement(callback?: (err: AWSError, data: DynamoDB.Types.BatchExecuteStatementOutput) => void): Request<DynamoDB.Types.BatchExecuteStatementOutput, AWSError>;
|
25
25
|
/**
|
@@ -31,11 +31,11 @@ declare class DynamoDB extends DynamoDBCustomizations {
|
|
31
31
|
*/
|
32
32
|
batchGetItem(callback?: (err: AWSError, data: DynamoDB.Types.BatchGetItemOutput) => void): Request<DynamoDB.Types.BatchGetItemOutput, AWSError>;
|
33
33
|
/**
|
34
|
-
* The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types. BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
|
34
|
+
* The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types. BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed. For tables and indexes with provisioned capacity, if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. For all tables and indexes, if none of the items can be processed due to other throttling scenarios (such as exceeding partition level limits), then BatchWriteItem returns a ThrottlingException. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response. If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. If one or more of the following is true, DynamoDB rejects the entire batch write operation: One or more tables specified in the BatchWriteItem request does not exist. Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. Your request contains at least two items with identical hash and range keys (which essentially is two put operations). There are more than 25 requests in the batch. Any individual item in a batch exceeds 400 KB. The total request size exceeds 16 MB. Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.
|
35
35
|
*/
|
36
36
|
batchWriteItem(params: DynamoDB.Types.BatchWriteItemInput, callback?: (err: AWSError, data: DynamoDB.Types.BatchWriteItemOutput) => void): Request<DynamoDB.Types.BatchWriteItemOutput, AWSError>;
|
37
37
|
/**
|
38
|
-
* The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types. BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
|
38
|
+
* The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types. BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed. For tables and indexes with provisioned capacity, if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. For all tables and indexes, if none of the items can be processed due to other throttling scenarios (such as exceeding partition level limits), then BatchWriteItem returns a ThrottlingException. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response. If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. If one or more of the following is true, DynamoDB rejects the entire batch write operation: One or more tables specified in the BatchWriteItem request does not exist. Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. Your request contains at least two items with identical hash and range keys (which essentially is two put operations). There are more than 25 requests in the batch. Any individual item in a batch exceeds 400 KB. The total request size exceeds 16 MB. Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.
|
39
39
|
*/
|
40
40
|
batchWriteItem(callback?: (err: AWSError, data: DynamoDB.Types.BatchWriteItemOutput) => void): Request<DynamoDB.Types.BatchWriteItemOutput, AWSError>;
|
41
41
|
/**
|
@@ -87,11 +87,11 @@ declare class DynamoDB extends DynamoDBCustomizations {
|
|
87
87
|
*/
|
88
88
|
deleteResourcePolicy(callback?: (err: AWSError, data: DynamoDB.Types.DeleteResourcePolicyOutput) => void): Request<DynamoDB.Types.DeleteResourcePolicyOutput, AWSError>;
|
89
89
|
/**
|
90
|
-
* The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned. For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. When you delete a table, any indexes on that table are also deleted. If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours. Use the DescribeTable action to check the status of the table.
|
90
|
+
* The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned. For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. For the full list of table states, see TableStatus. When you delete a table, any indexes on that table are also deleted. If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours. Use the DescribeTable action to check the status of the table.
|
91
91
|
*/
|
92
92
|
deleteTable(params: DynamoDB.Types.DeleteTableInput, callback?: (err: AWSError, data: DynamoDB.Types.DeleteTableOutput) => void): Request<DynamoDB.Types.DeleteTableOutput, AWSError>;
|
93
93
|
/**
|
94
|
-
* The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned. For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. When you delete a table, any indexes on that table are also deleted. If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours. Use the DescribeTable action to check the status of the table.
|
94
|
+
* The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned. For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. For the full list of table states, see TableStatus. When you delete a table, any indexes on that table are also deleted. If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours. Use the DescribeTable action to check the status of the table.
|
95
95
|
*/
|
96
96
|
deleteTable(callback?: (err: AWSError, data: DynamoDB.Types.DeleteTableOutput) => void): Request<DynamoDB.Types.DeleteTableOutput, AWSError>;
|
97
97
|
/**
|
package/clients/iotsitewise.d.ts
CHANGED
@@ -621,11 +621,11 @@ declare class IoTSiteWise extends Service {
|
|
621
621
|
*/
|
622
622
|
updateAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetResponse) => void): Request<IoTSiteWise.Types.UpdateAssetResponse, AWSError>;
|
623
623
|
/**
|
624
|
-
* Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
|
624
|
+
* Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide. If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing asset model property with a new one with the same name, do the following: Submit an UpdateAssetModel request with the entire existing property removed. Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.
|
625
625
|
*/
|
626
626
|
updateAssetModel(params: IoTSiteWise.Types.UpdateAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelResponse, AWSError>;
|
627
627
|
/**
|
628
|
-
* Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
|
628
|
+
* Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide. If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing asset model property with a new one with the same name, do the following: Submit an UpdateAssetModel request with the entire existing property removed. Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.
|
629
629
|
*/
|
630
630
|
updateAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelResponse, AWSError>;
|
631
631
|
/**
|
@@ -1029,7 +1029,7 @@ declare namespace IoTSiteWise {
|
|
1029
1029
|
export type AssetModelCompositeModelSummaries = AssetModelCompositeModelSummary[];
|
1030
1030
|
export interface AssetModelCompositeModelSummary {
|
1031
1031
|
/**
|
1032
|
-
* The ID of the
|
1032
|
+
* The ID of the composite model that this summary describes..
|
1033
1033
|
*/
|
1034
1034
|
id: ID;
|
1035
1035
|
/**
|
@@ -1037,15 +1037,15 @@ declare namespace IoTSiteWise {
|
|
1037
1037
|
*/
|
1038
1038
|
externalId?: ExternalId;
|
1039
1039
|
/**
|
1040
|
-
* The name of the
|
1040
|
+
* The name of the composite model that this summary describes..
|
1041
1041
|
*/
|
1042
1042
|
name: Name;
|
1043
1043
|
/**
|
1044
|
-
* The
|
1044
|
+
* The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
|
1045
1045
|
*/
|
1046
1046
|
type: Name;
|
1047
1047
|
/**
|
1048
|
-
* The description of the
|
1048
|
+
* The description of the composite model that this summary describes..
|
1049
1049
|
*/
|
1050
1050
|
description?: Description;
|
1051
1051
|
/**
|
@@ -1932,7 +1932,7 @@ declare namespace IoTSiteWise {
|
|
1932
1932
|
export type Bucket = string;
|
1933
1933
|
export type CapabilityConfiguration = string;
|
1934
1934
|
export type CapabilityNamespace = string;
|
1935
|
-
export type CapabilitySyncStatus = "IN_SYNC"|"OUT_OF_SYNC"|"SYNC_FAILED"|"UNKNOWN"|string;
|
1935
|
+
export type CapabilitySyncStatus = "IN_SYNC"|"OUT_OF_SYNC"|"SYNC_FAILED"|"UNKNOWN"|"NOT_APPLICABLE"|string;
|
1936
1936
|
export type ClientToken = string;
|
1937
1937
|
export interface ColumnInfo {
|
1938
1938
|
/**
|
@@ -2077,7 +2077,7 @@ declare namespace IoTSiteWise {
|
|
2077
2077
|
*/
|
2078
2078
|
assetModelCompositeModelDescription?: Description;
|
2079
2079
|
/**
|
2080
|
-
* A unique
|
2080
|
+
* A unique name for the composite model.
|
2081
2081
|
*/
|
2082
2082
|
assetModelCompositeModelName: Name;
|
2083
2083
|
/**
|
@@ -2089,11 +2089,11 @@ declare namespace IoTSiteWise {
|
|
2089
2089
|
*/
|
2090
2090
|
clientToken?: ClientToken;
|
2091
2091
|
/**
|
2092
|
-
* The ID of a
|
2092
|
+
* The ID of a component model which is reused to create this composite model.
|
2093
2093
|
*/
|
2094
2094
|
composedAssetModelId?: CustomID;
|
2095
2095
|
/**
|
2096
|
-
* The property definitions of the composite model. For more information, see
|
2096
|
+
* The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide. You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
|
2097
2097
|
*/
|
2098
2098
|
assetModelCompositeModelProperties?: AssetModelPropertyDefinitions;
|
2099
2099
|
}
|
@@ -2110,7 +2110,7 @@ declare namespace IoTSiteWise {
|
|
2110
2110
|
}
|
2111
2111
|
export interface CreateAssetModelRequest {
|
2112
2112
|
/**
|
2113
|
-
* A unique
|
2113
|
+
* A unique name for the asset model.
|
2114
2114
|
*/
|
2115
2115
|
assetModelName: Name;
|
2116
2116
|
/**
|
@@ -2126,7 +2126,7 @@ declare namespace IoTSiteWise {
|
|
2126
2126
|
*/
|
2127
2127
|
assetModelHierarchies?: AssetModelHierarchyDefinitions;
|
2128
2128
|
/**
|
2129
|
-
* The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see
|
2129
|
+
* The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.
|
2130
2130
|
*/
|
2131
2131
|
assetModelCompositeModels?: AssetModelCompositeModelDefinitions;
|
2132
2132
|
/**
|
@@ -2290,9 +2290,9 @@ declare namespace IoTSiteWise {
|
|
2290
2290
|
}
|
2291
2291
|
export interface CreateGatewayRequest {
|
2292
2292
|
/**
|
2293
|
-
* A unique
|
2293
|
+
* A unique name for the gateway.
|
2294
2294
|
*/
|
2295
|
-
gatewayName:
|
2295
|
+
gatewayName: GatewayName;
|
2296
2296
|
/**
|
2297
2297
|
* The gateway's platform. You can only specify one platform in a gateway.
|
2298
2298
|
*/
|
@@ -3081,7 +3081,7 @@ declare namespace IoTSiteWise {
|
|
3081
3081
|
/**
|
3082
3082
|
* The name of the gateway.
|
3083
3083
|
*/
|
3084
|
-
gatewayName:
|
3084
|
+
gatewayName: GatewayName;
|
3085
3085
|
/**
|
3086
3086
|
* The ARN of the gateway, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
|
3087
3087
|
*/
|
@@ -3491,6 +3491,7 @@ declare namespace IoTSiteWise {
|
|
3491
3491
|
*/
|
3492
3492
|
capabilitySyncStatus: CapabilitySyncStatus;
|
3493
3493
|
}
|
3494
|
+
export type GatewayName = string;
|
3494
3495
|
export interface GatewayPlatform {
|
3495
3496
|
/**
|
3496
3497
|
* A gateway that runs on IoT Greengrass.
|
@@ -3500,6 +3501,10 @@ declare namespace IoTSiteWise {
|
|
3500
3501
|
* A gateway that runs on IoT Greengrass V2.
|
3501
3502
|
*/
|
3502
3503
|
greengrassV2?: GreengrassV2;
|
3504
|
+
/**
|
3505
|
+
* A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.
|
3506
|
+
*/
|
3507
|
+
siemensIE?: SiemensIE;
|
3503
3508
|
}
|
3504
3509
|
export type GatewaySummaries = GatewaySummary[];
|
3505
3510
|
export interface GatewaySummary {
|
@@ -3508,9 +3513,9 @@ declare namespace IoTSiteWise {
|
|
3508
3513
|
*/
|
3509
3514
|
gatewayId: ID;
|
3510
3515
|
/**
|
3511
|
-
* The name of the
|
3516
|
+
* The name of the gateway.
|
3512
3517
|
*/
|
3513
|
-
gatewayName:
|
3518
|
+
gatewayName: GatewayName;
|
3514
3519
|
gatewayPlatform?: GatewayPlatform;
|
3515
3520
|
/**
|
3516
3521
|
* A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
|
@@ -3717,7 +3722,7 @@ declare namespace IoTSiteWise {
|
|
3717
3722
|
}
|
3718
3723
|
export interface Greengrass {
|
3719
3724
|
/**
|
3720
|
-
* The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference.
|
3725
|
+
* The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass V1 API Reference.
|
3721
3726
|
*/
|
3722
3727
|
groupArn: ARN;
|
3723
3728
|
}
|
@@ -3805,6 +3810,7 @@ declare namespace IoTSiteWise {
|
|
3805
3810
|
export type Interval = string;
|
3806
3811
|
export type IntervalInSeconds = number;
|
3807
3812
|
export type IntervalWindowInSeconds = number;
|
3813
|
+
export type IotCoreThingName = string;
|
3808
3814
|
export interface JobConfiguration {
|
3809
3815
|
/**
|
3810
3816
|
* The file format of the data in S3.
|
@@ -4668,6 +4674,12 @@ declare namespace IoTSiteWise {
|
|
4668
4674
|
export type SSOApplicationId = string;
|
4669
4675
|
export type ScalarType = "BOOLEAN"|"INT"|"DOUBLE"|"TIMESTAMP"|"STRING"|string;
|
4670
4676
|
export type ScalarValue = string;
|
4677
|
+
export interface SiemensIE {
|
4678
|
+
/**
|
4679
|
+
* The name of the IoT Thing for your SiteWise Edge gateway.
|
4680
|
+
*/
|
4681
|
+
iotCoreThingName: IotCoreThingName;
|
4682
|
+
}
|
4671
4683
|
export type StorageType = "SITEWISE_DEFAULT_STORAGE"|"MULTI_LAYER_STORAGE"|string;
|
4672
4684
|
export type String = string;
|
4673
4685
|
export type TagKey = string;
|
@@ -4835,7 +4847,7 @@ declare namespace IoTSiteWise {
|
|
4835
4847
|
*/
|
4836
4848
|
assetModelCompositeModelDescription?: Description;
|
4837
4849
|
/**
|
4838
|
-
* A unique
|
4850
|
+
* A unique name for the composite model.
|
4839
4851
|
*/
|
4840
4852
|
assetModelCompositeModelName: Name;
|
4841
4853
|
/**
|
@@ -4843,7 +4855,7 @@ declare namespace IoTSiteWise {
|
|
4843
4855
|
*/
|
4844
4856
|
clientToken?: ClientToken;
|
4845
4857
|
/**
|
4846
|
-
* The property definitions of the composite model. For more information, see
|
4858
|
+
* The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide. You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
|
4847
4859
|
*/
|
4848
4860
|
assetModelCompositeModelProperties?: AssetModelProperties;
|
4849
4861
|
}
|
@@ -4860,7 +4872,7 @@ declare namespace IoTSiteWise {
|
|
4860
4872
|
*/
|
4861
4873
|
assetModelId: CustomID;
|
4862
4874
|
/**
|
4863
|
-
* A unique
|
4875
|
+
* A unique name for the asset model.
|
4864
4876
|
*/
|
4865
4877
|
assetModelName: Name;
|
4866
4878
|
/**
|
@@ -4876,7 +4888,7 @@ declare namespace IoTSiteWise {
|
|
4876
4888
|
*/
|
4877
4889
|
assetModelHierarchies?: AssetModelHierarchies;
|
4878
4890
|
/**
|
4879
|
-
* The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see
|
4891
|
+
* The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.
|
4880
4892
|
*/
|
4881
4893
|
assetModelCompositeModels?: AssetModelCompositeModels;
|
4882
4894
|
/**
|
@@ -5002,9 +5014,9 @@ declare namespace IoTSiteWise {
|
|
5002
5014
|
*/
|
5003
5015
|
gatewayId: ID;
|
5004
5016
|
/**
|
5005
|
-
* A unique
|
5017
|
+
* A unique name for the gateway.
|
5006
5018
|
*/
|
5007
|
-
gatewayName:
|
5019
|
+
gatewayName: GatewayName;
|
5008
5020
|
}
|
5009
5021
|
export interface UpdatePortalRequest {
|
5010
5022
|
/**
|
@@ -5095,7 +5107,7 @@ declare namespace IoTSiteWise {
|
|
5095
5107
|
*/
|
5096
5108
|
stringValue?: PropertyValueStringValue;
|
5097
5109
|
/**
|
5098
|
-
* Asset property data of type integer (number
|
5110
|
+
* Asset property data of type integer (whole number).
|
5099
5111
|
*/
|
5100
5112
|
integerValue?: PropertyValueIntegerValue;
|
5101
5113
|
/**
|
@@ -676,7 +676,7 @@ declare namespace MediaPackageV2 {
|
|
676
676
|
}
|
677
677
|
export interface DeleteOriginEndpointResponse {
|
678
678
|
}
|
679
|
-
export type DrmSystem = "CLEAR_KEY_AES_128"|"FAIRPLAY"|"PLAYREADY"|"WIDEVINE"|string;
|
679
|
+
export type DrmSystem = "CLEAR_KEY_AES_128"|"FAIRPLAY"|"PLAYREADY"|"WIDEVINE"|"IRDETO"|string;
|
680
680
|
export interface Encryption {
|
681
681
|
/**
|
682
682
|
* A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
|
@@ -160,7 +160,9 @@ declare class MedicalImaging extends Service {
|
|
160
160
|
declare namespace MedicalImaging {
|
161
161
|
export type Arn = string;
|
162
162
|
export type AwsAccountId = string;
|
163
|
+
export type Boolean = boolean;
|
163
164
|
export type ClientToken = string;
|
165
|
+
export type CopiableAttributes = string;
|
164
166
|
export interface CopyDestinationImageSet {
|
165
167
|
/**
|
166
168
|
* The image set identifier for the destination image set.
|
@@ -224,6 +226,10 @@ declare namespace MedicalImaging {
|
|
224
226
|
* Copy image set information.
|
225
227
|
*/
|
226
228
|
copyImageSetInformation: CopyImageSetInformation;
|
229
|
+
/**
|
230
|
+
* Setting this flag will force the CopyImageSet operation, even if Patient, Study, or Series level metadata are mismatched across the sourceImageSet and destinationImageSet.
|
231
|
+
*/
|
232
|
+
force?: Boolean;
|
227
233
|
}
|
228
234
|
export interface CopyImageSetResponse {
|
229
235
|
/**
|
@@ -244,6 +250,10 @@ declare namespace MedicalImaging {
|
|
244
250
|
* The latest version identifier for the source image set.
|
245
251
|
*/
|
246
252
|
latestVersionId: ImageSetExternalVersionId;
|
253
|
+
/**
|
254
|
+
* Contains MetadataCopies structure and wraps information related to specific copy use cases. For example, when copying subsets.
|
255
|
+
*/
|
256
|
+
DICOMCopies?: MetadataCopies;
|
247
257
|
}
|
248
258
|
export interface CopySourceImageSetProperties {
|
249
259
|
/**
|
@@ -723,6 +733,10 @@ declare namespace MedicalImaging {
|
|
723
733
|
* The Amazon Resource Name (ARN) assigned to the image set.
|
724
734
|
*/
|
725
735
|
imageSetArn?: Arn;
|
736
|
+
/**
|
737
|
+
* This object contains the details of any overrides used while creating a specific image set version. If an image set was copied or updated using the force flag, this object will contain the forced flag.
|
738
|
+
*/
|
739
|
+
overrides?: Overrides;
|
726
740
|
}
|
727
741
|
export type ImageFrameId = string;
|
728
742
|
export interface ImageFrameInformation {
|
@@ -767,6 +781,10 @@ declare namespace MedicalImaging {
|
|
767
781
|
* The error message thrown if an image set action fails.
|
768
782
|
*/
|
769
783
|
message?: Message;
|
784
|
+
/**
|
785
|
+
* Contains details on overrides used when creating the returned version of an image set. For example, if forced exists, the forced flag was used when creating the image set.
|
786
|
+
*/
|
787
|
+
overrides?: Overrides;
|
770
788
|
}
|
771
789
|
export type ImageSetPropertiesList = ImageSetProperties[];
|
772
790
|
export type ImageSetState = "ACTIVE"|"LOCKED"|"DELETED"|string;
|
@@ -895,14 +913,30 @@ declare namespace MedicalImaging {
|
|
895
913
|
tags: TagMap;
|
896
914
|
}
|
897
915
|
export type Message = string;
|
916
|
+
export interface MetadataCopies {
|
917
|
+
/**
|
918
|
+
* The JSON string used to specify a subset of SOP Instances to copy from source to destination image set.
|
919
|
+
*/
|
920
|
+
copiableAttributes: CopiableAttributes;
|
921
|
+
}
|
898
922
|
export interface MetadataUpdates {
|
899
923
|
/**
|
900
924
|
* The object containing removableAttributes and updatableAttributes.
|
901
925
|
*/
|
902
926
|
DICOMUpdates?: DICOMUpdates;
|
927
|
+
/**
|
928
|
+
* Specifies the previous image set version ID to revert the current image set back to. You must provide either revertToVersionId or DICOMUpdates in your request. A ValidationException error is thrown if both parameters are provided at the same time.
|
929
|
+
*/
|
930
|
+
revertToVersionId?: ImageSetExternalVersionId;
|
903
931
|
}
|
904
932
|
export type NextToken = string;
|
905
933
|
export type Operator = "EQUAL"|"BETWEEN"|string;
|
934
|
+
export interface Overrides {
|
935
|
+
/**
|
936
|
+
* Setting this flag will force the CopyImageSet and UpdateImageSetMetadata operations, even if Patient, Study, or Series level metadata are mismatched.
|
937
|
+
*/
|
938
|
+
forced?: Boolean;
|
939
|
+
}
|
906
940
|
export type PayloadBlob = Buffer|Uint8Array|Blob|string|Readable;
|
907
941
|
export type RoleArn = string;
|
908
942
|
export type S3Uri = string;
|
@@ -1097,6 +1131,10 @@ declare namespace MedicalImaging {
|
|
1097
1131
|
* The latest image set version identifier.
|
1098
1132
|
*/
|
1099
1133
|
latestVersionId: ImageSetExternalVersionId;
|
1134
|
+
/**
|
1135
|
+
* Setting this flag will force the UpdateImageSetMetadata operation for the following attributes: Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID, and Tag.StudyID Adding, removing, or updating private tags for an individual SOP Instance
|
1136
|
+
*/
|
1137
|
+
force?: Boolean;
|
1100
1138
|
/**
|
1101
1139
|
* Update image set metadata updates.
|
1102
1140
|
*/
|