NAME

Paws::S3::Redirect

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::S3::Redirect object:

  $service_obj->Method(Att1 => { HostName => $value, ..., ReplaceKeyWith => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::S3::Redirect object:

  $result = $service_obj->Method(...);
  $result->Att1->HostName

DESCRIPTION

Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.

ATTRIBUTES

HostName => Str

The host name to use in the redirect request.

HttpRedirectCode => Str

The HTTP redirect code to use on the response. Not required if one of the siblings is present.

Protocol => Str

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix "docs/" (objects in the "docs/" folder) to "documents/", you can set a condition block with "KeyPrefixEquals" set to "docs/" and in the Redirect set "ReplaceKeyPrefixWith" to "/documents". Not required if one of the siblings is present. Can be present only if "ReplaceKeyWith" is not provided.

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).

ReplaceKeyWith => Str

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 if "ReplaceKeyPrefixWith" is not provided.

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>