ListUpdates
Lists the updates on a gateway, link, or routing rule, newest first. To see flow updates,
specify linkId. Results are paginated. Use nextToken to get the next
page.
Request Syntax
GET /gateway/gatewayId/updates?linkId=linkId&maxResults=maxResults&nextToken=nextToken&ruleId=ruleId&status=status&type=type HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- gatewayId
-
The unique identifier of the gateway.
Length Constraints: Minimum length of 8. Maximum length of 32.
Pattern:
rtb-gw-[a-z0-9-]{1,25}Required: Yes
- linkId
-
The ID of a link on this gateway, to list only that link's updates. Omit both
linkIdandruleIdto list the gateway's own updates.Length Constraints: Minimum length of 6. Maximum length of 30.
Pattern:
link-[a-z0-9-]{1,25} - maxResults
-
The maximum number of results to return for each call. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. A nextToken expires after 24 hours.
Length Constraints: Minimum length of 0. Maximum length of 2048.
- ruleId
-
The ID of a routing rule, to list only that rule's updates. Requires
linkId, because you address a rule through its link. AruleIdwithoutlinkIdfails with ValidationException.Length Constraints: Minimum length of 6. Maximum length of 30.
Pattern:
rule-[a-z0-9-]{1,25} - status
-
Lists only updates in this status.
Valid Values:
IN_PROGRESS | SUCCESSFUL | FAILED - type
-
Lists only updates of this type.
Valid Values:
GATEWAY_CONFIG_UPDATE | LINK_CONFIG_UPDATE | LINK_FLOW_UPDATE | ROUTING_RULE_UPDATE
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"updates": [
{
"createdAt": number,
"status": "string",
"type": "string",
"updateId": "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.
- nextToken
-
If nextToken is returned, there are more results available. Keep calling while it's present, even when
updatesis empty.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- updates
-
The updates on this page.
Type: Array of UpdateSummary objects
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
The request could not be completed because you do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request could not be completed because of an internal server error. Try your call again.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request could not be completed because the resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The request could not be completed because it fails to satisfy the constraints specified by the service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: