DeletePortal
Deletes a portal from Amazon IoT SiteWise Monitor.
Request Syntax
DELETE /portals/portalId
?clientToken=clientToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- clientToken
-
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.
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern:
\S{36,64}
- portalId
-
The ID of the portal to delete.
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 202
Content-type: application/json
{
"portalStatus": {
"error": {
"code": "string",
"message": "string"
},
"state": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- portalStatus
-
The status of the portal, which contains a state (
DELETING
after successfully calling this operation) and any error message.Type: PortalStatus object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictingOperationException
-
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
HTTP Status Code: 409
- 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
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: