IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Interface GetObjectAclCommandInput

    The input for GetObjectAclCommand.

    interface GetObjectAclCommandInput {
        Bucket: string | undefined;
        Key: string | undefined;
        VersionId?: string;
        RequestPayer?: "requester";
        ExpectedBucketOwner?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Bucket: string | undefined

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

    Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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.

    Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@ibm-cos/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

    Key: string | undefined

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

    VersionId?: string

    Version ID used to reference a specific version of the object.

    This functionality is not supported for directory buckets.

    RequestPayer?: "requester"

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

    This functionality is not supported for directory buckets.

    ExpectedBucketOwner?: string

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).