DescribeExecution
Retrieves information about the execution.
Request Syntax
GET /executions/executionId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- executionId
-
The ID of the execution.
Length Constraints: Fixed length of 36.
Pattern:
^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"actionType": "string",
"executionDetails": {
"string" : "string"
},
"executionEndTime": number,
"executionEntityVersion": "string",
"executionId": "string",
"executionResult": {
"string" : "string"
},
"executionStartTime": number,
"executionStatus": {
"state": "string"
},
"resolveTo": {
"assetId": "string"
},
"targetResource": {
"assetId": "string",
"computationModelId": "string"
},
"targetResourceVersion": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- actionType
-
The type of action exectued.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+ - executionDetails
-
Provides detailed information about the execution of your anomaly detection models. This includes model metrics and training timestamps for both training and inference actions.
-
The training action (AWS/ANOMALY_DETECTION_TRAINING), includes performance metrics that help you compare different versions of your anomaly detection models. These metrics provide insights into the model's performance during the training process.
-
The inference action (AWS/ANOMALY_DETECTION_INFERENCE), includes information about the results of executing your anomaly detection models. This helps you understand the output of your models and assess their performance.
Type: String to string map
Key Pattern:
^[a-zA-Z0-9 _\-#$*!@]+$Value Pattern:
^[a-zA-Z0-9 _\-#$*!@]+$ -
- executionEndTime
-
The time the process ended.
Type: Timestamp
- executionEntityVersion
-
Entity version used for the execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern:
^(0|([1-9]{1}\d*))$ - executionId
-
The ID of the execution.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - executionResult
-
The result of the execution.
Type: String to string map
Key Pattern:
^[a-zA-Z0-9 _\-#$*!@]+$Value Pattern:
^[a-zA-Z0-9 _\-#$*!@]+$ - executionStartTime
-
The time the process started.
Type: Timestamp
- executionStatus
-
The status of the execution process.
Type: ExecutionStatus object
- resolveTo
-
The detailed resource this execution resolves to.
Type: ResolveTo object
- targetResource
-
The resource the action will be taken on.
Type: TargetResource object
- targetResourceVersion
-
The version of the target resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern:
^(0|([1-9]{1}\d*))$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalFailureException
-
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500
- InvalidRequestException
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
