ListAgentRuntimes
Lists all Amazon Secure Agents in your account.
Request Syntax
POST /runtimes/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return in the response.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
A token to retrieve the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
\S*
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"agentRuntimes": [
{
"agentRuntimeArn": "string",
"agentRuntimeId": "string",
"agentRuntimeName": "string",
"agentRuntimeVersion": "string",
"description": "string",
"lastUpdatedAt": "string",
"status": "string"
}
],
"nextToken": "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.
- agentRuntimes
-
The list of AgentCore Runtime resources.
Type: Array of Agent objects
- nextToken
-
A token to retrieve the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
\S*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
This exception is thrown when a request is denied per access permissions
HTTP Status Code: 403
- InternalServerException
-
This exception is thrown if there was an unexpected error during processing of request
HTTP Status Code: 500
- ThrottlingException
-
This exception is thrown when the number of requests exceeds the limit
HTTP Status Code: 429
- ValidationException
-
The input 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:
