Skip to content

CloudFront  >  Operations  >  list_origin_access_controls

list_origin_access_controls

Operation

list_origin_access_controls async 

list_origin_access_controls(input: ListOriginAccessControlsInput, plugins: list[Plugin] | None = None) -> ListOriginAccessControlsOutput

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.

Note

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.

Parameters:

Name Type Description Default
input ListOriginAccessControlsInput

An instance of ListOriginAccessControlsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ListOriginAccessControlsOutput

An instance of ListOriginAccessControlsOutput.

Input

ListOriginAccessControlsInput dataclass

Bases: _SerdeShape

Dataclass for ListOriginAccessControlsInput structure.

Attributes

marker class-attribute instance-attribute 
marker: str | None = ...

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.

max_items class-attribute instance-attribute 
max_items: int | None = ...

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

Output

ListOriginAccessControlsOutput dataclass

Bases: _SerdeShape

Dataclass for ListOriginAccessControlsOutput structure.

Attributes

origin_access_control_list class-attribute instance-attribute 
origin_access_control_list: OriginAccessControlList | None = ...

A list of origin access controls.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.