GetAgentRuntimeEndpoint
Gets information about an Amazon Secure AgentEndpoint.
Request Syntax
GET /runtimes/agentRuntimeId/runtime-endpoints/endpointName/ HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- agentRuntimeId
-
The unique identifier of the agent runtime associated with the endpoint.
Pattern:
[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}Required: Yes
- endpointName
-
The name of the agent runtime endpoint to retrieve.
Pattern:
[a-zA-Z][a-zA-Z0-9_]{0,47}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"agentRuntimeArn": "string",
"agentRuntimeEndpointArn": "string",
"createdAt": "string",
"description": "string",
"failureReason": "string",
"id": "string",
"lastUpdatedAt": "string",
"liveVersion": "string",
"name": "string",
"status": "string",
"targetVersion": "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.
- agentRuntimeArn
-
The Amazon Resource Name (ARN) of the agent runtime.
Type: String
Pattern:
arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:agent/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}:([0-9]{0,4}[1-9][0-9]{0,4}) - agentRuntimeEndpointArn
-
The Amazon Resource Name (ARN) of the agent runtime endpoint.
Type: String
Pattern:
arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:agentEndpoint/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12} - createdAt
-
The timestamp when the agent runtime endpoint was created.
Type: Timestamp
- description
-
The description of the agent runtime endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- failureReason
-
The reason for failure if the agent runtime endpoint is in a failed state.
Type: String
- id
-
The unique identifier of the agent runtime endpoint.
Type: String
Pattern:
[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10} - lastUpdatedAt
-
The timestamp when the agent runtime endpoint was last updated.
Type: Timestamp
- liveVersion
-
The currently deployed version of the agent runtime on the endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
([1-9][0-9]{0,4}) - name
-
The name of the agent runtime endpoint.
Type: String
Pattern:
[a-zA-Z][a-zA-Z0-9_]{0,47} - status
-
The current status of the agent runtime endpoint.
Type: String
Valid Values:
CREATING | CREATE_FAILED | UPDATING | UPDATE_FAILED | READY | DELETING - targetVersion
-
The target version of the agent runtime for the endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
([1-9][0-9]{0,4})
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
- ResourceNotFoundException
-
This exception is thrown when a resource referenced by the operation does not exist
HTTP Status Code: 404
- 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:
