Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"api."} @@ -407,7 +409,8 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, - {"shape":"ConflictingOperationException"} + {"shape":"ConflictingOperationException"}, + {"shape":"PreconditionFailedException"} ], "documentation":"Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"api."} @@ -1090,7 +1093,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"Retrieves a paginated list of associated assets.
You can use this operation to do the following:
List child assets associated to a parent asset by a hierarchy that you specify.
List an asset's parent asset.
Retrieves a paginated list of associated assets.
You can use this operation to do the following:
CHILD - List all child assets associated to the asset.
PARENT - List the asset's parent asset.
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.
The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
" + }, + "externalId":{ + "shape":"ExternalId", + "documentation":"An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + }, "name":{ "shape":"Name", "documentation":"The name of the composite model.
" @@ -1972,14 +1985,6 @@ "properties":{ "shape":"AssetModelPropertyDefinitions", "documentation":"The asset property definitions for this composite model.
" - }, - "id":{ - "shape":"ID", - "documentation":"The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
" - }, - "externalId":{ - "shape":"ExternalId", - "documentation":"An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } }, "documentation":"Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
" @@ -2064,6 +2069,10 @@ "shape":"CustomID", "documentation":"The ID of the asset model hierarchy. This ID is a hierarchyId.
If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing hierarchy: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + }, "name":{ "shape":"Name", "documentation":"The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
" @@ -2071,10 +2080,6 @@ "childAssetModelId":{ "shape":"CustomID", "documentation":"The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } }, "documentation":"Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
" @@ -2086,14 +2091,6 @@ "childAssetModelId" ], "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
" - }, - "childAssetModelId":{ - "shape":"CustomID", - "documentation":"The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
" @@ -2101,6 +2098,14 @@ "externalId":{ "shape":"ExternalId", "documentation":"An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
" + }, + "childAssetModelId":{ + "shape":"CustomID", + "documentation":"The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.
" @@ -2125,6 +2130,10 @@ "shape":"CustomID", "documentation":"The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + }, "name":{ "shape":"Name", "documentation":"The name of the asset model property.
" @@ -2148,10 +2157,6 @@ "path":{ "shape":"AssetModelPropertyPath", "documentation":"The structured path to the property from the root of the asset model.
" - }, - "externalId":{ - "shape":"ExternalId", - "documentation":"The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } }, "documentation":"Contains information about an asset model property.
" @@ -2164,6 +2169,14 @@ "type" ], "members":{ + "id":{ + "shape":"ID", + "documentation":"The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
" + }, + "externalId":{ + "shape":"ExternalId", + "documentation":"An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + }, "name":{ "shape":"Name", "documentation":"The name of the property definition.
" @@ -2183,14 +2196,6 @@ "type":{ "shape":"PropertyType", "documentation":"The property definition type (see PropertyType). You can only specify one type in a property definition.
The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
" - }, - "externalId":{ - "shape":"ExternalId", - "documentation":"An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } }, "documentation":"Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
" @@ -2233,6 +2238,10 @@ "shape":"ID", "documentation":"The ID of the property.
" }, + "externalId":{ + "shape":"ExternalId", + "documentation":"The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + }, "name":{ "shape":"Name", "documentation":"The name of the property.
" @@ -2257,10 +2266,6 @@ "path":{ "shape":"AssetModelPropertyPath", "documentation":"The structured path to the property from the root of the asset model.
" - }, - "externalId":{ - "shape":"ExternalId", - "documentation":"The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } }, "documentation":"Contains a summary of a property associated with a model.
" @@ -2311,6 +2316,10 @@ "shape":"ID", "documentation":"The ID of the asset model (used with IoT SiteWise API operations).
" }, + "externalId":{ + "shape":"ExternalId", + "documentation":"The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + }, "arn":{ "shape":"ARN", "documentation":"The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
The name of the asset model.
" }, + "assetModelType":{ + "shape":"AssetModelType", + "documentation":"The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
The asset model description.
" @@ -2335,13 +2348,9 @@ "shape":"AssetModelStatus", "documentation":"The current status of the asset model.
" }, - "assetModelType":{ - "shape":"AssetModelType", - "documentation":"The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + "version":{ + "shape":"Version", + "documentation":"The version number of the asset model.
" } }, "documentation":"Contains a summary of an asset model.
" @@ -2353,6 +2362,17 @@ "COMPONENT_MODEL" ] }, + "AssetModelVersionFilter":{ + "type":"string", + "pattern":"^(LATEST|ACTIVE)$" + }, + "AssetModelVersionType":{ + "type":"string", + "enum":[ + "LATEST", + "ACTIVE" + ] + }, "AssetProperties":{ "type":"list", "member":{"shape":"AssetProperty"} @@ -3759,14 +3779,14 @@ "location":"uri", "locationName":"assetModelId" }, - "parentAssetModelCompositeModelId":{ - "shape":"CustomID", - "documentation":"The ID of the parent composite model in this asset model relationship.
" - }, "assetModelCompositeModelExternalId":{ "shape":"ExternalId", "documentation":"An external ID to assign to the composite model.
If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
The ID of the parent composite model in this asset model relationship.
" + }, "assetModelCompositeModelId":{ "shape":"ID", "documentation":"The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
" @@ -3795,6 +3815,24 @@ "assetModelCompositeModelProperties":{ "shape":"AssetModelPropertyDefinitions", "documentation":"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.
" + }, + "ifMatch":{ + "shape":"ETag", + "documentation":"The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The create request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
Accepts * to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.
A unique name for the asset model.
" }, + "assetModelType":{ + "shape":"AssetModelType", + "documentation":"The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
" + }, + "assetModelExternalId":{ + "shape":"ExternalId", + "documentation":"An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + }, "assetModelDescription":{ "shape":"Description", "documentation":"A description for the asset model.
" @@ -3849,18 +3899,6 @@ "tags":{ "shape":"TagMap", "documentation":"A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
" - }, - "assetModelId":{ - "shape":"ID", - "documentation":"The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
" - }, - "assetModelExternalId":{ - "shape":"ExternalId", - "documentation":"An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
" - }, - "assetModelType":{ - "shape":"AssetModelType", - "documentation":"The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The delete request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
Accepts * to reject the delete request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the delete operation.
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The delete request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
Accepts * to reject the delete request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the delete operation.
The ID of a composite model on this asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
Whether or not to exclude asset model properties from the response.
", "location":"querystring", "locationName":"excludeProperties" + }, + "assetModelVersion":{ + "shape":"AssetModelVersionFilter", + "documentation":"The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
The ID of the asset model, in UUID format.
" }, + "assetModelExternalId":{ + "shape":"ExternalId", + "documentation":"The external ID of the asset model, if any.
" + }, "assetModelArn":{ "shape":"ARN", "documentation":"The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
The name of the asset model.
" }, + "assetModelType":{ + "shape":"AssetModelType", + "documentation":"The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
The asset model's description.
" @@ -4882,6 +4976,10 @@ "shape":"AssetModelCompositeModels", "documentation":"The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
The list of the immediate child custom composite model summaries for the asset model.
" + }, "assetModelCreationDate":{ "shape":"Timestamp", "documentation":"The date the asset model was created, in Unix epoch time.
" @@ -4894,17 +4992,15 @@ "shape":"AssetModelStatus", "documentation":"The current status of the asset model, which contains a state and any error message.
" }, - "assetModelType":{ - "shape":"AssetModelType", - "documentation":"The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
The version of the asset model. See Asset model versions in the IoT SiteWise User Guide.
" }, - "assetModelCompositeModelSummaries":{ - "shape":"AssetModelCompositeModelSummaries", - "documentation":"The list of the immediate child custom composite model summaries for the asset model.
" - }, - "assetModelExternalId":{ - "shape":"ExternalId", - "documentation":"The external ID of the asset model, if any.
" + "eTag":{ + "shape":"ETag", + "documentation":"The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make concurrent updates safely to the resource. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
", + "location":"header", + "locationName":"ETag" } } }, @@ -5681,6 +5777,10 @@ "DISABLED" ] }, + "ETag":{ + "type":"string", + "pattern":"^[\\w-]{43}$" + }, "Email":{ "type":"string", "max":255, @@ -6730,6 +6830,12 @@ "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" + }, + "assetModelVersion":{ + "shape":"AssetModelVersionFilter", + "documentation":"The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
Filters the requested list of asset model properties. You can choose one of the following options:
ALL – The list includes all asset model properties for a given asset model ID.
BASE – The list includes only base asset model properties for a given asset model ID.
Default: BASE
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
The type of asset model. If you don't provide an assetModelTypes, all types of asset models are returned.
ASSET_MODEL – An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
The token to be used for the next set of paginated results.
", @@ -6813,11 +6931,11 @@ "location":"querystring", "locationName":"maxResults" }, - "assetModelTypes":{ - "shape":"ListAssetModelsTypeFilter", - "documentation":"The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.
For more information, see Asset hierarchies in the IoT SiteWise User Guide.
", + "documentation":"(Optional) If you don't provide a hierarchyId, all the immediate assets in the traversalDirection will be returned.
The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.)
For more information, see Asset hierarchies in the IoT SiteWise User Guide.
", "location":"querystring", "locationName":"hierarchyId" }, "traversalDirection":{ "shape":"TraversalDirection", - "documentation":"The direction to list associated assets. Choose one of the following options:
CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.
PARENT – The list includes the asset's parent asset.
Default: CHILD
The direction to list associated assets. Choose one of the following options:
CHILD – The list includes all child assets associated to the asset.
PARENT – The list includes the asset's parent asset.
Default: CHILD
Contains a portal summary.
" }, + "PreconditionFailedException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceArn" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "resourceId":{ + "shape":"ResourceId", + "documentation":"The ID of the resource on which precondition failed with this operation.
" + }, + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"The ARN of the resource on which precondition failed with this operation.
" + } + }, + "documentation":"The precondition in one or more of the request-header fields evaluated to FALSE.
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.
" + }, + "ifMatch":{ + "shape":"ETag", + "documentation":"The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.
An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + }, "assetModelName":{ "shape":"Name", "documentation":"A unique name for the asset model.
" @@ -8521,9 +8687,23 @@ "documentation":"A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", "idempotencyToken":true }, - "assetModelExternalId":{ - "shape":"ExternalId", - "documentation":"An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
" + "ifMatch":{ + "shape":"ETag", + "documentation":"The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.
Contains an asset property value (of a single type only).
" }, + "Version":{ + "type":"string", + "max":10, + "min":1, + "pattern":"^(0|([1-9]{1}\\d*))$" + }, "WarmTierRetentionPeriod":{ "type":"structure", "members":{ diff --git a/botocore/data/workspaces/2015-04-08/service-2.json b/botocore/data/workspaces/2015-04-08/service-2.json index 306e6faafa..67fad796ef 100644 --- a/botocore/data/workspaces/2015-04-08/service-2.json +++ b/botocore/data/workspaces/2015-04-08/service-2.json @@ -3456,6 +3456,47 @@ } } }, + "DescribeWorkspaceDirectoriesFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"DescribeWorkspaceDirectoriesFilterName", + "documentation":"The name of the WorkSpaces to filter.
" + }, + "Values":{ + "shape":"DescribeWorkspaceDirectoriesFilterValues", + "documentation":"The values for filtering WorkSpaces
" + } + }, + "documentation":"Describes the filter conditions for the WorkSpaces to return.
" + }, + "DescribeWorkspaceDirectoriesFilterList":{ + "type":"list", + "member":{"shape":"DescribeWorkspaceDirectoriesFilter"}, + "max":25, + "min":1 + }, + "DescribeWorkspaceDirectoriesFilterName":{ + "type":"string", + "enum":[ + "USER_IDENTITY_TYPE", + "WORKSPACE_TYPE" + ] + }, + "DescribeWorkspaceDirectoriesFilterValue":{ + "type":"string", + "pattern":"^[0-9a-zA-Z\\*\\.\\\\/\\?-_]{0,64}$" + }, + "DescribeWorkspaceDirectoriesFilterValues":{ + "type":"list", + "member":{"shape":"DescribeWorkspaceDirectoriesFilterValue"}, + "max":25, + "min":1 + }, "DescribeWorkspaceDirectoriesRequest":{ "type":"structure", "members":{ @@ -3474,6 +3515,10 @@ "NextToken":{ "shape":"PaginationToken", "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The filter condition for the WorkSpaces.
" } } }, @@ -4005,6 +4050,20 @@ } } }, + "IDCConfig":{ + "type":"structure", + "members":{ + "InstanceArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the identity center instance.
" + }, + "ApplicationArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the application.
" + } + }, + "documentation":"Specifies the configurations of the identity center.
" + }, "IdleDisconnectTimeoutInSeconds":{ "type":"integer", "max":36000, @@ -4445,6 +4504,24 @@ "type":"integer", "min":0 }, + "MicrosoftEntraConfig":{ + "type":"structure", + "members":{ + "TenantId":{ + "shape":"MicrosoftEntraConfigTenantId", + "documentation":"The identifier of the tenant.
" + }, + "ApplicationConfigSecretArn":{ + "shape":"SecretsManagerArn", + "documentation":"The Amazon Resource Name (ARN) of the application config.
" + } + }, + "documentation":"Specifies the configurations of the Microsoft Entra.
" + }, + "MicrosoftEntraConfigTenantId":{ + "type":"string", + "pattern":"^[a-zA-Z0-9-]{1,100}$" + }, "MigrateWorkspaceRequest":{ "type":"structure", "required":[ @@ -4976,6 +5053,14 @@ "shape":"UserIdentityType", "documentation":"The type of identity management the user is using.
" }, + "IdcInstanceArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the identity center instance.
" + }, + "MicrosoftEntraConfig":{ + "shape":"MicrosoftEntraConfig", + "documentation":"The details about Microsoft Entra config.
" + }, "WorkspaceType":{ "shape":"WorkspaceType", "documentation":"Indicates whether the directory's WorkSpace type is personal or pools.
" @@ -5869,7 +5954,8 @@ "type":"string", "enum":[ "CUSTOMER_MANAGED", - "AWS_DIRECTORY_SERVICE" + "AWS_DIRECTORY_SERVICE", + "AWS_IAM_IDENTITY_CENTER" ] }, "UserName":{ @@ -6364,6 +6450,10 @@ "shape":"CertificateBasedAuthProperties", "documentation":"The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
" }, + "MicrosoftEntraConfig":{ + "shape":"MicrosoftEntraConfig", + "documentation":"Specifies details about Microsoft Entra configurations.
" + }, "WorkspaceDirectoryName":{ "shape":"WorkspaceDirectoryName", "documentation":"The name fo the WorkSpace directory.
" @@ -6380,6 +6470,10 @@ "shape":"WorkspaceType", "documentation":"Indicates whether the directory's WorkSpace type is personal or pools.
" }, + "IDCConfig":{ + "shape":"IDCConfig", + "documentation":"Specifies details about identity center configurations.
" + }, "ActiveDirectoryConfig":{ "shape":"ActiveDirectoryConfig", "documentation":"Information about the Active Directory config.
" @@ -6424,7 +6518,8 @@ "enum":[ "SIMPLE_AD", "AD_CONNECTOR", - "CUSTOMER_MANAGED" + "CUSTOMER_MANAGED", + "AWS_IAM_IDENTITY_CENTER" ] }, "WorkspaceErrorCode":{"type":"string"}, diff --git a/docs/source/conf.py b/docs/source/conf.py index e4e498c46b..6c5d1a10a7 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.35' # The full version, including alpha/beta/rc tags. -release = '1.35.5' +release = '1.35.6' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.