GetCachePolicy
Gets a cache policy, including the following metadata:
-
The policy's identifier.
-
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy's identifier. If the cache policy
is attached to a distribution's cache behavior, you can get the policy's identifier
using ListDistributions
or GetDistribution
. If the cache
policy is not attached to a cache behavior, you can get the identifier using
ListCachePolicies
.
Request Syntax
GET /2020-05-31/cache-policy/Id
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Id
-
The unique identifier for the cache policy. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
orGetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier usingListCachePolicies
.Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<CachePolicy>
<CachePolicyConfig>
<Comment>string</Comment>
<DefaultTTL>long</DefaultTTL>
<MaxTTL>long</MaxTTL>
<MinTTL>long</MinTTL>
<Name>string</Name>
<ParametersInCacheKeyAndForwardedToOrigin>
<CookiesConfig>
<CookieBehavior>string</CookieBehavior>
<Cookies>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</Cookies>
</CookiesConfig>
<EnableAcceptEncodingBrotli>boolean</EnableAcceptEncodingBrotli>
<EnableAcceptEncodingGzip>boolean</EnableAcceptEncodingGzip>
<HeadersConfig>
<HeaderBehavior>string</HeaderBehavior>
<Headers>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</Headers>
</HeadersConfig>
<QueryStringsConfig>
<QueryStringBehavior>string</QueryStringBehavior>
<QueryStrings>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</QueryStrings>
</QueryStringsConfig>
</ParametersInCacheKeyAndForwardedToOrigin>
</CachePolicyConfig>
<Id>string</Id>
<LastModifiedTime>timestamp</LastModifiedTime>
</CachePolicy>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- CachePolicy
-
Root level tag for the CachePolicy parameters.
Required: Yes
- CachePolicyConfig
-
The cache policy configuration.
Type: CachePolicyConfig object
- Id
-
The unique identifier for the cache policy.
Type: String
- LastModifiedTime
-
The date and time when the cache policy was last modified.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDenied
-
Access denied.
HTTP Status Code: 403
- NoSuchCachePolicy
-
The cache policy does not exist.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: