GetOriginAccessControlConfig - Amazon CloudFront

GetOriginAccessControlConfig

Gets a CloudFront origin access control configuration.

Request Syntax

GET /2020-05-31/origin-access-control/Id/config HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id

The unique identifier of the origin access control.

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"?> <OriginAccessControlConfig> <Description>string</Description> <Name>string</Name> <OriginAccessControlOriginType>string</OriginAccessControlOriginType> <SigningBehavior>string</SigningBehavior> <SigningProtocol>string</SigningProtocol> </OriginAccessControlConfig>

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.

OriginAccessControlConfig

Root level tag for the OriginAccessControlConfig parameters.

Required: Yes

Description

A description of the origin access control.

Type: String

Name

A name to identify the origin access control.

Type: String

OriginAccessControlOriginType

The type of origin that this origin access control is for. The only valid value is s3.

Type: String

Valid Values: s3

SigningBehavior

Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

This field can have one of the following values:

  • always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

  • never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

  • no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

Type: String

Valid Values: never | always | no-override

SigningProtocol

The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

Type: String

Valid Values: sigv4

Errors

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

AccessDenied

Access denied.

HTTP Status Code: 403

NoSuchOriginAccessControl

The origin access control 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: