/******************************************************************************* * Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.S3; using Amazon.S3.Model; namespace Amazon.PowerShell.Cmdlets.S3 { /// <summary> /// This implementation of the <code>GET</code> action uses the <code>acl</code> subresource /// to return the access control list (ACL) of a bucket. To use <code>GET</code> to return /// the ACL of the bucket, you must have <code>READ_ACP</code> access to the bucket. If /// <code>READ_ACP</code> permission is granted to the anonymous user, you can return /// the ACL of the bucket without using an authorization header. /// /// /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para><para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para><note><para> /// If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests /// to read ACLs are still supported and return the <code>bucket-owner-full-control</code> /// ACL with the owner being the account that created the bucket. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> /// Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>. /// </para></note><para> /// The following operations are related to <code>GetBucketAcl</code>: /// </para><ul><li><para><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a></para></li></ul> /// </summary> [Cmdlet("Get", "S3ACL")] [OutputType("Amazon.S3.Model.S3AccessControlList")] [AWSCmdlet("Calls the Amazon Simple Storage Service (S3) GetACL API operation.", Operation = new[] {"GetACL"}, SelectReturnType = typeof(Amazon.S3.Model.GetACLResponse))] [AWSCmdletOutput("Amazon.S3.Model.S3AccessControlList or Amazon.S3.Model.GetACLResponse", "This cmdlet returns an Amazon.S3.Model.S3AccessControlList object.", "The service call response (type Amazon.S3.Model.GetACLResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetS3ACLCmdlet : AmazonS3ClientCmdlet, IExecutor { #region Parameter BucketName /// <summary> /// <para> /// <para>The bucket name that contains the object for which to get the ACL information.</para><para>When using this API with an access point, you must direct requests to the access point hostname. /// The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. /// When using this operation with 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 /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using Access Points</a> /// in the <i>Amazon Simple Storage Service Developer Guide</i>.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String BucketName { get; set; } #endregion #region Parameter ExpectedBucketOwner /// <summary> /// <para> /// 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. /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ExpectedBucketOwner { get; set; } #endregion #region Parameter Key /// <summary> /// <para> /// The key of the S3 object to be queried. /// </para> /// </summary> [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] public System.String Key { get; set; } #endregion #region Parameter VersionId /// <summary> /// <para> /// VersionId used to reference a specific version of the object. /// </para> /// </summary> [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] public System.String VersionId { get; set; } #endregion #region Parameter Select /// <summary> /// Use the -Select parameter to control the cmdlet output. The default value is 'AccessControlList'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.GetACLResponse). /// Specifying the name of a property of type Amazon.S3.Model.GetACLResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "AccessControlList"; #endregion #region Parameter PassThru /// <summary> /// Changes the cmdlet behavior to return the value passed to the BucketName parameter. /// The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. /// </summary> [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "s3"; base.ProcessRecord(); var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate<Amazon.S3.Model.GetACLResponse, GetS3ACLCmdlet>(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.BucketName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.BucketName = this.BucketName; context.ExpectedBucketOwner = this.ExpectedBucketOwner; context.Key = this.Key; context.VersionId = this.VersionId; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.S3.Model.GetACLRequest(); if (cmdletContext.BucketName != null) { request.BucketName = cmdletContext.BucketName; } if (cmdletContext.ExpectedBucketOwner != null) { request.ExpectedBucketOwner = cmdletContext.ExpectedBucketOwner; } if (cmdletContext.Key != null) { request.Key = cmdletContext.Key; } if (cmdletContext.VersionId != null) { request.VersionId = cmdletContext.VersionId; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.S3.Model.GetACLResponse CallAWSServiceOperation(IAmazonS3 client, Amazon.S3.Model.GetACLRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Storage Service (S3)", "GetACL"); try { #if DESKTOP return client.GetACL(request); #elif CORECLR return client.GetACLAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public System.String BucketName { get; set; } public System.String ExpectedBucketOwner { get; set; } public System.String Key { get; set; } public System.String VersionId { get; set; } public System.Func<Amazon.S3.Model.GetACLResponse, GetS3ACLCmdlet, object> Select { get; set; } = (response, cmdlet) => response.AccessControlList; } } }