PutObjectRetentionRequest

public struct PutObjectRetentionRequest : AWSShape

Undocumented

  • The key for the payload

    Declaration

    Swift

    public static let payloadPath: String?

  • Declaration

    Swift

    public static let _xmlNamespace: String?

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The bucket name that contains the object you want to apply this Object Retention configuration to. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

    Declaration

    Swift

    public let bucket: String

  • Indicates whether this operation should bypass Governance-mode restrictions.

    Declaration

    Swift

    public let bypassGovernanceRetention: Bool?

  • The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

    Declaration

    Swift

    public let expectedBucketOwner: String?
  • key

    The key name for the object that you want to apply this Object Retention configuration to.

    Declaration

    Swift

    public let key: String

  • Undocumented

    Declaration

    Swift

    public let requestPayer: RequestPayer?

  • The container element for the Object Retention configuration.

    Declaration

    Swift

    public let retention: ObjectLockRetention?

  • The version ID for the object that you want to apply this Object Retention configuration to.

    Declaration

    Swift

    public let versionId: String?

  • Undocumented

    Declaration

    Swift

    public init(bucket: String, bypassGovernanceRetention: Bool? = nil, expectedBucketOwner: String? = nil, key: String, requestPayer: RequestPayer? = nil, retention: ObjectLockRetention? = nil, versionId: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws