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.GetObjectAcl

Description

Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object.

This action is not supported by Amazon S3 on Outposts.

Versioning

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

The following operations are related to GetObjectAcl:

Synopsis

Creating a Request

data GetObjectAcl Source #

See: newGetObjectAcl smart constructor.

Constructors

GetObjectAcl' 

Fields

  • versionId :: Maybe ObjectVersionId

    VersionId used to reference a specific version of the object.

  • requestPayer :: Maybe RequestPayer
     
  • 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 name that contains the object for which to get the ACL information.

    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.

  • key :: ObjectKey

    The key of the object for which to get the ACL information.

Instances

Instances details
Eq GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

(==) :: GetObjectAcl -> GetObjectAcl -> Bool #

(/=) :: GetObjectAcl -> GetObjectAcl -> Bool #

Read GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

readsPrec :: Int -> ReadS GetObjectAcl #

readList :: ReadS [GetObjectAcl] #

readPrec :: ReadPrec GetObjectAcl #

readListPrec :: ReadPrec [GetObjectAcl] #

Show GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

showsPrec :: Int -> GetObjectAcl -> ShowS #

show :: GetObjectAcl -> String #

showList :: [GetObjectAcl] -> ShowS #

Generic GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Associated Types

type Rep GetObjectAcl :: Type -> Type #

Methods

from :: GetObjectAcl -> Rep GetObjectAcl x #

to :: Rep GetObjectAcl x -> GetObjectAcl #

NFData GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

rnf :: GetObjectAcl -> () #

Hashable GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

hashWithSalt :: Int -> GetObjectAcl -> Int #

hash :: GetObjectAcl -> Int #

AWSRequest GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Associated Types

type AWSResponse GetObjectAcl #

Methods

request :: GetObjectAcl -> Request GetObjectAcl #

response :: MonadResource m => Logger -> Service -> Proxy GetObjectAcl -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetObjectAcl))) #

ToHeaders GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

toHeaders :: GetObjectAcl -> [Header] #

ToPath GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

toPath :: GetObjectAcl -> ByteString #

ToQuery GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

toQuery :: GetObjectAcl -> QueryString #

type Rep GetObjectAcl Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

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

Defined in Amazonka.S3.GetObjectAcl

type AWSResponse GetObjectAcl = GetObjectAclResponse

newGetObjectAcl Source #

Arguments

:: BucketName

$sel:bucket:GetObjectAcl'

-> ObjectKey

$sel:key:GetObjectAcl'

-> GetObjectAcl 

Create a value of GetObjectAcl 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:versionId:GetObjectAcl', getObjectAcl_versionId - VersionId used to reference a specific version of the object.

$sel:requestPayer:GetObjectAcl', getObjectAcl_requestPayer - Undocumented member.

$sel:expectedBucketOwner:GetObjectAcl', getObjectAcl_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:GetObjectAcl', getObjectAcl_bucket - The bucket name that contains the object for which to get the ACL information.

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.

$sel:key:GetObjectAcl', getObjectAcl_key - The key of the object for which to get the ACL information.

Request Lenses

getObjectAcl_versionId :: Lens' GetObjectAcl (Maybe ObjectVersionId) Source #

VersionId used to reference a specific version of the object.

getObjectAcl_requestPayer :: Lens' GetObjectAcl (Maybe RequestPayer) Source #

Undocumented member.

getObjectAcl_expectedBucketOwner :: Lens' GetObjectAcl (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.

getObjectAcl_bucket :: Lens' GetObjectAcl BucketName Source #

The bucket name that contains the object for which to get the ACL information.

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.

getObjectAcl_key :: Lens' GetObjectAcl ObjectKey Source #

The key of the object for which to get the ACL information.

Destructuring the Response

data GetObjectAclResponse Source #

See: newGetObjectAclResponse smart constructor.

Constructors

GetObjectAclResponse' 

Fields

Instances

Instances details
Eq GetObjectAclResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

(==) :: GetObjectAclResponse -> GetObjectAclResponse -> Bool #

(/=) :: GetObjectAclResponse -> GetObjectAclResponse -> Bool #

Read GetObjectAclResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

readsPrec :: Int -> ReadS GetObjectAclResponse #

readList :: ReadS [GetObjectAclResponse] #

readPrec :: ReadPrec GetObjectAclResponse #

readListPrec :: ReadPrec [GetObjectAclResponse] #

Show GetObjectAclResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

showsPrec :: Int -> GetObjectAclResponse -> ShowS #

show :: GetObjectAclResponse -> String #

showList :: [GetObjectAclResponse] -> ShowS #

Generic GetObjectAclResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Associated Types

type Rep GetObjectAclResponse :: Type -> Type #

Methods

from :: GetObjectAclResponse -> Rep GetObjectAclResponse x #

to :: Rep GetObjectAclResponse x -> GetObjectAclResponse #

NFData GetObjectAclResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

Methods

rnf :: GetObjectAclResponse -> () #

type Rep GetObjectAclResponse Source # 
Instance details

Defined in Amazonka.S3.GetObjectAcl

type Rep GetObjectAclResponse = D1 ('MetaData "GetObjectAclResponse" "Amazonka.S3.GetObjectAcl" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "GetObjectAclResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestCharged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestCharged)) :*: S1 ('MetaSel ('Just "grants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Grant]))) :*: (S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Owner)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetObjectAclResponse Source #

Arguments

:: Int

$sel:httpStatus:GetObjectAclResponse'

-> GetObjectAclResponse 

Create a value of GetObjectAclResponse 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:requestCharged:GetObjectAclResponse', getObjectAclResponse_requestCharged - Undocumented member.

$sel:grants:GetObjectAclResponse', getObjectAclResponse_grants - A list of grants.

$sel:owner:GetObjectAclResponse', getObjectAclResponse_owner - Container for the bucket owner's display name and ID.

$sel:httpStatus:GetObjectAclResponse', getObjectAclResponse_httpStatus - The response's http status code.

Response Lenses

getObjectAclResponse_requestCharged :: Lens' GetObjectAclResponse (Maybe RequestCharged) Source #

Undocumented member.

getObjectAclResponse_grants :: Lens' GetObjectAclResponse (Maybe [Grant]) Source #

A list of grants.

getObjectAclResponse_owner :: Lens' GetObjectAclResponse (Maybe Owner) Source #

Container for the bucket owner's display name and ID.

getObjectAclResponse_httpStatus :: Lens' GetObjectAclResponse Int Source #

The response's http status code.