ListOriginAccessControlsCommand

Suggest an Edit

Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services 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.

If you're not using origin access controls for your Amazon Web Services account, the ListOriginAccessControls operation doesn't return the Items element in the response.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CloudFrontClient, ListOriginAccessControlsCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import
// const { CloudFrontClient, ListOriginAccessControlsCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import
const client = new CloudFrontClient(config);
const input = { // ListOriginAccessControlsRequest
  Marker: "STRING_VALUE",
  MaxItems: Number("int"),
};
const command = new ListOriginAccessControlsCommand(input);
const response = await client.send(command);
// { // ListOriginAccessControlsResult
//   OriginAccessControlList: { // OriginAccessControlList
//     Marker: "STRING_VALUE", // required
//     NextMarker: "STRING_VALUE",
//     MaxItems: Number("int"), // required
//     IsTruncated: true || false, // required
//     Quantity: Number("int"), // required
//     Items: [ // OriginAccessControlSummaryList
//       { // OriginAccessControlSummary
//         Id: "STRING_VALUE", // required
//         Description: "STRING_VALUE", // required
//         Name: "STRING_VALUE", // required
//         SigningProtocol: "sigv4", // required
//         SigningBehavior: "never" || "always" || "no-override", // required
//         OriginAccessControlOriginType: "s3" || "mediastore" || "mediapackagev2" || "lambda", // required
//       },
//     ],
//   },
// };

ListOriginAccessControlsCommand Input

See ListOriginAccessControlsCommandInput for more details

Parameter
Type
Description
Marker
string | undefined

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
number | undefined

The maximum number of origin access controls that you want in the response.

ListOriginAccessControlsCommand Output

See ListOriginAccessControlsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
OriginAccessControlList
OriginAccessControlList | undefined

A list of origin access controls.

Throws

Name
Fault
Details
InvalidArgument
client

An argument is invalid.

CloudFrontServiceException
Base exception class for all service exceptions from CloudFront service.