Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeAction

Retrieves information about an action.

Request Syntax


GET /actions/actionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

actionId

The ID of the action.

Length Constraints: Fixed length of 36.

Pattern: ^[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

{
   "actionDefinitionId": "string",
   "actionId": "string",
   "actionPayload": { 
      "stringValue": "string"
   },
   "executionTime": number,
   "targetResource": { 
      "assetId": "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.

actionDefinitionId

The ID of the action definition.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

actionId

The ID of the action.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

actionPayload

The JSON payload of the action.

Type: ActionPayload object

executionTime

The time the action was executed.

Type: Timestamp

targetResource

The resource the action will be taken on.

Type: TargetResource object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

Amazon 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 Amazon 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 Amazon IoT SiteWise User Guide.

HTTP Status Code: 429