libZSservicesZSamazonka-s3ZSamazonka-s3
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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.

Synopsis

Creating a Request

data GetObjectLockConfiguration Source #

See: newGetObjectLockConfiguration smart constructor.

Constructors

GetObjectLockConfiguration' 

Fields

  • expectedBucketOwner :: Maybe Text

    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.

  • bucket :: BucketName

    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.

Instances

Instances details
Eq GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

Read GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

Show GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

Generic GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

Associated Types

type Rep GetObjectLockConfiguration :: Type -> Type #

NFData GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

Hashable GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

AWSRequest GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

ToHeaders GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

ToPath GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

ToQuery GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

type Rep GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

type Rep GetObjectLockConfiguration = D1 ('MetaData "GetObjectLockConfiguration" "Amazonka.S3.GetObjectLockConfiguration" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "GetObjectLockConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName)))
type AWSResponse GetObjectLockConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

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 will fail with an HTTP 403 (Access Denied) error.

$sel:bucket: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 will fail with an HTTP 403 (Access Denied) error.

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 #

Constructors

GetObjectLockConfigurationResponse' 

Fields

Instances

Instances details
Eq GetObjectLockConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

Read GetObjectLockConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

Show GetObjectLockConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

Generic GetObjectLockConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

Associated Types

type Rep GetObjectLockConfigurationResponse :: Type -> Type #

NFData GetObjectLockConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

type Rep GetObjectLockConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectLockConfiguration

type Rep GetObjectLockConfigurationResponse = D1 ('MetaData "GetObjectLockConfigurationResponse" "Amazonka.S3.GetObjectLockConfiguration" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "GetObjectLockConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "objectLockConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectLockConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetObjectLockConfigurationResponse Source #

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