| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.S3.GetObjectLockConfiguration
Description
Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
The following action is related to GetObjectLockConfiguration:
Synopsis
- data GetObjectLockConfiguration = GetObjectLockConfiguration' {}
- newGetObjectLockConfiguration :: BucketName -> GetObjectLockConfiguration
- getObjectLockConfiguration_expectedBucketOwner :: Lens' GetObjectLockConfiguration (Maybe Text)
- getObjectLockConfiguration_bucket :: Lens' GetObjectLockConfiguration BucketName
- data GetObjectLockConfigurationResponse = GetObjectLockConfigurationResponse' {}
- newGetObjectLockConfigurationResponse :: Int -> GetObjectLockConfigurationResponse
- getObjectLockConfigurationResponse_objectLockConfiguration :: Lens' GetObjectLockConfigurationResponse (Maybe ObjectLockConfiguration)
- getObjectLockConfigurationResponse_httpStatus :: Lens' GetObjectLockConfigurationResponse Int
Creating a Request
data GetObjectLockConfiguration Source #
See: newGetObjectLockConfiguration smart constructor.
Constructors
| GetObjectLockConfiguration' | |
Fields
| |
Instances
newGetObjectLockConfiguration Source #
Create a value of GetObjectLockConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetObjectLockConfiguration', getObjectLockConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
GetObjectLockConfiguration, getObjectLockConfiguration_bucket - The bucket whose Object Lock configuration you want to retrieve.
When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
Request Lenses
getObjectLockConfiguration_expectedBucketOwner :: Lens' GetObjectLockConfiguration (Maybe Text) Source #
The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
getObjectLockConfiguration_bucket :: Lens' GetObjectLockConfiguration BucketName Source #
The bucket whose Object Lock configuration you want to retrieve.
When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
Destructuring the Response
data GetObjectLockConfigurationResponse Source #
See: newGetObjectLockConfigurationResponse smart constructor.
Constructors
| GetObjectLockConfigurationResponse' | |
Fields
| |
Instances
newGetObjectLockConfigurationResponse Source #
Arguments
| :: Int | |
| -> GetObjectLockConfigurationResponse |
Create a value of GetObjectLockConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectLockConfiguration:GetObjectLockConfigurationResponse', getObjectLockConfigurationResponse_objectLockConfiguration - The specified bucket's Object Lock configuration.
$sel:httpStatus:GetObjectLockConfigurationResponse', getObjectLockConfigurationResponse_httpStatus - The response's http status code.
Response Lenses
getObjectLockConfigurationResponse_objectLockConfiguration :: Lens' GetObjectLockConfigurationResponse (Maybe ObjectLockConfiguration) Source #
The specified bucket's Object Lock configuration.
getObjectLockConfigurationResponse_httpStatus :: Lens' GetObjectLockConfigurationResponse Int Source #
The response's http status code.