ListOriginAccessControls
Gets the list of CloudFront origin access controls (OACs) in this 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 another
request that specifies the NextMarker
value from the current response as
the Marker
value in the next request.
Note
If you're not using origin access controls for your AWS account, the
ListOriginAccessControls
operation doesn't return the
Items
element in the response.
Request Syntax
GET /2020-05-31/origin-access-control?Marker=Marker
&MaxItems=MaxItems
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 origin access controls. The response includes the items 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
NextMarker
from the current page's response. - MaxItems
-
The maximum number of origin access controls that you want in the response.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<OriginAccessControlList>
<IsTruncated>boolean</IsTruncated>
<Items>
<OriginAccessControlSummary>
<Description>string</Description>
<Id>string</Id>
<Name>string</Name>
<OriginAccessControlOriginType>string</OriginAccessControlOriginType>
<SigningBehavior>string</SigningBehavior>
<SigningProtocol>string</SigningProtocol>
</OriginAccessControlSummary>
</Items>
<Marker>string</Marker>
<MaxItems>integer</MaxItems>
<NextMarker>string</NextMarker>
<Quantity>integer</Quantity>
</OriginAccessControlList>
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.
- OriginAccessControlList
-
Root level tag for the OriginAccessControlList parameters.
Required: Yes
- IsTruncated
-
If there are more items in the list than are in this response, this value is
true
.Type: Boolean
- Items
-
Contains the origin access controls in the list.
Type: Array of OriginAccessControlSummary objects
- Marker
-
The value of the
Marker
field that was provided in the request.Type: String
- MaxItems
-
The maximum number of origin access controls 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 to use in the
Marker
field of another request to continue listing origin access controls.Type: String
- Quantity
-
The number of origin access controls returned in the response.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidArgument
-
An argument is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: