GetRunCache
Retrieve the details for the specified run cache.
For more information, see Call caching for AWS HealthOmics runs in the AWS HealthOmics User Guide.
Request Syntax
GET /runCache/id HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- id
-
The identifier of the run cache to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"cacheBehavior": "string",
"cacheBucketOwnerId": "string",
"cacheS3Uri": "string",
"creationTime": "string",
"description": "string",
"id": "string",
"name": "string",
"status": "string",
"tags": {
"string" : "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.
- arn
-
Unique resource identifier for the run cache.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:.+ - cacheBehavior
-
The default cache behavior for runs using this cache.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
CACHE_ON_FAILURE | CACHE_ALWAYS - cacheBucketOwnerId
-
The identifier of the bucket owner.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
[0-9]+ - cacheS3Uri
-
The S3 URI where the cache data is stored.
Type: String
Pattern:
s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))? - creationTime
-
Creation time of the run cache (an ISO 8601 formatted string).
Type: Timestamp
- description
-
The run cache description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+ - id
-
The run cache ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+ - name
-
The run cache name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+ - status
-
The run cache status.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
ACTIVE | DELETED | FAILED -
The tags associated with the run cache.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The request cannot be applied to the target resource in its current state.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error occurred. Try the request again.
HTTP Status Code: 500
- RequestTimeoutException
-
The request timed out.
HTTP Status Code: 408
- ResourceNotFoundException
-
The target resource was not found in the current Region.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request exceeds a service quota.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS 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:
