Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
Contents
- HostName
-
The host name to use in the redirect request.
Type: String
Required: No
- HttpRedirectCode
-
The HTTP redirect code to use on the response. Not required if one of the siblings is present.
Type: String
Required: No
- Protocol
-
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
Type: String
Valid Values:
http | httpsRequired: No
- ReplaceKeyPrefixWith
-
The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix
docs/(objects in thedocs/folder) todocuments/, you can set a condition block withKeyPrefixEqualsset todocs/and in the Redirect setReplaceKeyPrefixWithto/documents. Not required if one of the siblings is present. Can be present only ifReplaceKeyWithis not provided.Important
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
Type: String
Required: No
- ReplaceKeyWith
-
The specific object key to use in the redirect request. For example, redirect request to
error.html. Not required if one of the siblings is present. Can be present only ifReplaceKeyPrefixWithis not provided.Important
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
