ListResponseHeadersPolicies
Gets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by AWS, or only the custom policies created in your AWS account.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker value from the current
response as the Marker value in the subsequent request.
Request Syntax
GET /2020-05-31/response-headers-policy?Marker=Marker&MaxItems=MaxItems&Type=Type HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Marker
-
Use this field when paginating results to indicate where to begin in your list of response headers policies. The response includes response headers policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarkerfrom the current page's response. - MaxItems
-
The maximum number of response headers policies that you want to get in the response.
- Type
-
A filter to get only the specified kind of response headers policies. Valid values are:
-
managed– Gets only the managed policies created by AWS. -
custom– Gets only the custom policies created in your AWS account.
Valid Values:
managed | custom -
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ResponseHeadersPolicyList>
<Items>
<ResponseHeadersPolicySummary>
<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>
<RemoveHeadersConfig>
<Items>
<ResponseHeadersPolicyRemoveHeader>
<Header>string</Header>
</ResponseHeadersPolicyRemoveHeader>
</Items>
<Quantity>integer</Quantity>
</RemoveHeadersConfig>
<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>
<Type>string</Type>
</ResponseHeadersPolicySummary>
</Items>
<MaxItems>integer</MaxItems>
<NextMarker>string</NextMarker>
<Quantity>integer</Quantity>
</ResponseHeadersPolicyList>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.
- ResponseHeadersPolicyList
-
Root level tag for the ResponseHeadersPolicyList parameters.
Required: Yes
- Items
-
The response headers policies in the list.
Type: Array of ResponseHeadersPolicySummary objects
- MaxItems
-
The maximum number of response headers policies requested.
Type: Integer
- NextMarker
-
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the
Markerfield of a subsequent request to continue listing response headers policies where you left off.Type: String
- Quantity
-
The number of response headers policies returned.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDenied
-
Access denied.
HTTP Status Code: 403
- InvalidArgument
-
An argument is invalid.
HTTP Status Code: 400
- 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:
