GetResponseHeadersPolicy - Amazon CloudFront

GetResponseHeadersPolicy

Gets a response headers policy, including metadata (the policy’s identifier and the date and time when the policy was last modified).

To get a response headers policy, you must provide the policy’s identifier. If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies.

Request Syntax

GET /2020-05-31/response-headers-policy/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id

The identifier for the response headers policy.

If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies.

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"?> <ResponseHeadersPolicy> <Id>string</Id> <LastModifiedTime>timestamp</LastModifiedTime> <ResponseHeadersPolicyConfig> <Comment>string</Comment> <CorsConfig> <AccessControlAllowCredentials>boolean</AccessControlAllowCredentials> <AccessControlAllowHeaders> <Items> <Header>string</Header> </Items> <Quantity>integer</Quantity> </AccessControlAllowHeaders> <AccessControlAllowMethods> <Items> <Method>string</Method> </Items> <Quantity>integer</Quantity> </AccessControlAllowMethods> <AccessControlAllowOrigins> <Items> <Origin>string</Origin> </Items> <Quantity>integer</Quantity> </AccessControlAllowOrigins> <AccessControlExposeHeaders> <Items> <Header>string</Header> </Items> <Quantity>integer</Quantity> </AccessControlExposeHeaders> <AccessControlMaxAgeSec>integer</AccessControlMaxAgeSec> <OriginOverride>boolean</OriginOverride> </CorsConfig> <CustomHeadersConfig> <Items> <ResponseHeadersPolicyCustomHeader> <Header>string</Header> <Override>boolean</Override> <Value>string</Value> </ResponseHeadersPolicyCustomHeader> </Items> <Quantity>integer</Quantity> </CustomHeadersConfig> <Name>string</Name> <SecurityHeadersConfig> <ContentSecurityPolicy> <ContentSecurityPolicy>string</ContentSecurityPolicy> <Override>boolean</Override> </ContentSecurityPolicy> <ContentTypeOptions> <Override>boolean</Override> </ContentTypeOptions> <FrameOptions> <FrameOption>string</FrameOption> <Override>boolean</Override> </FrameOptions> <ReferrerPolicy> <Override>boolean</Override> <ReferrerPolicy>string</ReferrerPolicy> </ReferrerPolicy> <StrictTransportSecurity> <AccessControlMaxAgeSec>integer</AccessControlMaxAgeSec> <IncludeSubdomains>boolean</IncludeSubdomains> <Override>boolean</Override> <Preload>boolean</Preload> </StrictTransportSecurity> <XSSProtection> <ModeBlock>boolean</ModeBlock> <Override>boolean</Override> <Protection>boolean</Protection> <ReportUri>string</ReportUri> </XSSProtection> </SecurityHeadersConfig> <ServerTimingHeadersConfig> <Enabled>boolean</Enabled> <SamplingRate>double</SamplingRate> </ServerTimingHeadersConfig> </ResponseHeadersPolicyConfig> </ResponseHeadersPolicy>

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.

ResponseHeadersPolicy

Root level tag for the ResponseHeadersPolicy parameters.

Required: Yes

Id

The identifier for the response headers policy.

Type: String

LastModifiedTime

The date and time when the response headers policy was last modified.

Type: Timestamp

ResponseHeadersPolicyConfig

A response headers policy configuration.

A response headers policy contains information about a set of HTTP response headers and their values. CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match a cache behavior that’s associated with the policy.

Type: ResponseHeadersPolicyConfig object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDenied

Access denied.

HTTP Status Code: 403

NoSuchResponseHeadersPolicy

The response headers 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: