public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.S3.Model.GetBucketPolicyRequest();
if (cmdletContext.BucketName != null)
{
request.BucketName = cmdletContext.BucketName;
}
if (cmdletContext.ExpectedBucketOwner != null)
{
request.ExpectedBucketOwner = cmdletContext.ExpectedBucketOwner;
}
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);
}
/// <summary>
/// <para>Returns the policy of a specified bucket.</para>
/// </summary>
///
/// <param name="getBucketPolicyRequest">Container for the necessary parameters to execute the GetBucketPolicy service method on
/// AmazonS3.</param>
///
/// <returns>The response from the GetBucketPolicy service method, as returned by AmazonS3.</returns>
///
public GetBucketPolicyResponse GetBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
{
IAsyncResult asyncResult = invokeGetBucketPolicy(getBucketPolicyRequest, null, null, true);
return EndGetBucketPolicy(asyncResult);
}
private Amazon.S3.Model.GetBucketPolicyResponse CallAWSServiceOperation(IAmazonS3 client, Amazon.S3.Model.GetBucketPolicyRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Storage Service (S3)", "GetBucketPolicy");
try
{
#if DESKTOP
return(client.GetBucketPolicy(request));
#elif CORECLR
return(client.GetBucketPolicyAsync(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;
}
}
/// <summary>
/// Returns the policy of a specified bucket.
/// </summary>
/// <param name="bucketName">A property of GetBucketPolicyRequest used to execute the GetBucketPolicy service method.</param>
/// <param name="callback">An Action delegate that is invoked when the operation completes.</param>
/// <param name="options">
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// </param>
///
/// <returns>The response from the GetBucketPolicy service method, as returned by S3.</returns>
public void GetBucketPolicyAsync(string bucketName, AmazonServiceCallback<GetBucketPolicyRequest, GetBucketPolicyResponse> callback, AsyncOptions options = null)
{
var request = new GetBucketPolicyRequest();
request.BucketName = bucketName;
GetBucketPolicyAsync(request, callback, options);
}
/// <summary>
/// Initiates the asynchronous execution of the GetBucketPolicy operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetBucketPolicy operation on AmazonS3Client.</param>
/// <param name="callback">An Action delegate that is invoked when the operation completes.</param>
/// <param name="options">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
public void GetBucketPolicyAsync(GetBucketPolicyRequest request, AmazonServiceCallback<GetBucketPolicyRequest, GetBucketPolicyResponse> callback, AsyncOptions options = null)
{
options = options == null?new AsyncOptions():options;
var marshaller = new GetBucketPolicyRequestMarshaller();
var unmarshaller = GetBucketPolicyResponseUnmarshaller.Instance;
Action<AmazonWebServiceRequest, AmazonWebServiceResponse, Exception, AsyncOptions> callbackHelper = null;
if(callback !=null )
callbackHelper = (AmazonWebServiceRequest req, AmazonWebServiceResponse res, Exception ex, AsyncOptions ao) => {
AmazonServiceResult<GetBucketPolicyRequest,GetBucketPolicyResponse> responseObject
= new AmazonServiceResult<GetBucketPolicyRequest,GetBucketPolicyResponse>((GetBucketPolicyRequest)req, (GetBucketPolicyResponse)res, ex , ao.State);
callback(responseObject);
};
BeginInvoke<GetBucketPolicyRequest>(request, marshaller, unmarshaller, options, callbackHelper);
}
internal GetBucketPolicyResponse GetBucketPolicy(GetBucketPolicyRequest request)
{
var marshaller = new GetBucketPolicyRequestMarshaller();
var unmarshaller = GetBucketPolicyResponseUnmarshaller.Instance;
return Invoke<GetBucketPolicyRequest,GetBucketPolicyResponse>(request, marshaller, unmarshaller);
}
public void BucketSamples()
{
{
#region ListBuckets Sample
// Create a client
AmazonS3Client client = new AmazonS3Client();
// Issue call
ListBucketsResponse response = client.ListBuckets();
// View response data
Console.WriteLine("Buckets owner - {0}", response.Owner.DisplayName);
foreach (S3Bucket bucket in response.Buckets)
{
Console.WriteLine("Bucket {0}, Created on {1}", bucket.BucketName, bucket.CreationDate);
}
#endregion
}
{
#region BucketPolicy Sample
// Create a client
AmazonS3Client client = new AmazonS3Client();
// Put sample bucket policy (overwrite an existing policy)
string newPolicy = @"{
""Statement"":[{
""Sid"":""BasicPerms"",
""Effect"":""Allow"",
""Principal"": ""*"",
""Action"":[""s3:PutObject"",""s3:GetObject""],
""Resource"":[""arn:aws:s3:::samplebucketname/*""]
}]}";
PutBucketPolicyRequest putRequest = new PutBucketPolicyRequest
{
BucketName = "SampleBucket",
Policy = newPolicy
};
client.PutBucketPolicy(putRequest);
// Retrieve current policy
GetBucketPolicyRequest getRequest = new GetBucketPolicyRequest
{
BucketName = "SampleBucket"
};
string policy = client.GetBucketPolicy(getRequest).Policy;
Console.WriteLine(policy);
Debug.Assert(policy.Contains("BasicPerms"));
// Delete current policy
DeleteBucketPolicyRequest deleteRequest = new DeleteBucketPolicyRequest
{
BucketName = "SampleBucket"
};
client.DeleteBucketPolicy(deleteRequest);
// Retrieve current policy and verify that it is null
policy = client.GetBucketPolicy(getRequest).Policy;
Debug.Assert(policy == null);
#endregion
}
{
#region GetBucketLocation Sample
// Create a client
AmazonS3Client client = new AmazonS3Client();
// Construct request
GetBucketLocationRequest request = new GetBucketLocationRequest
{
BucketName = "SampleBucket"
};
// Issue call
GetBucketLocationResponse response = client.GetBucketLocation(request);
// View response data
Console.WriteLine("Bucket location - {0}", response.Location);
#endregion
}
{
#region PutBucket Sample
// Create a client
AmazonS3Client client = new AmazonS3Client();
// Construct request
PutBucketRequest request = new PutBucketRequest
{
BucketName = "SampleBucket",
BucketRegion = S3Region.EU, // set region to EU
CannedACL = S3CannedACL.PublicRead // make bucket publicly readable
};
// Issue call
PutBucketResponse response = client.PutBucket(request);
#endregion
}
{
#region DeleteBucket Sample 1
// Create a client
AmazonS3Client client = new AmazonS3Client();
// Construct request
DeleteBucketRequest request = new DeleteBucketRequest
{
BucketName = "SampleBucket"
};
// Issue call
DeleteBucketResponse response = client.DeleteBucket(request);
#endregion
}
{
#region DeleteBucket Sample 2
// Create a client
AmazonS3Client client = new AmazonS3Client();
// List and delete all objects
ListObjectsRequest listRequest = new ListObjectsRequest
{
BucketName = "SampleBucket"
};
ListObjectsResponse listResponse;
do
{
// Get a list of objects
listResponse = client.ListObjects(listRequest);
foreach (S3Object obj in listResponse.S3Objects)
{
// Delete each object
client.DeleteObject(new DeleteObjectRequest
{
BucketName = "SampleBucket",
Key = obj.Key
});
}
// Set the marker property
listRequest.Marker = listResponse.NextMarker;
} while (listResponse.IsTruncated);
// Construct DeleteBucket request
DeleteBucketRequest request = new DeleteBucketRequest
{
BucketName = "SampleBucket"
};
// Issue call
DeleteBucketResponse response = client.DeleteBucket(request);
#endregion
}
{
#region LifecycleConfiguration Sample
// Create a client
AmazonS3Client client = new AmazonS3Client();
// Put sample lifecycle configuration (overwrite an existing configuration)
LifecycleConfiguration newConfiguration = new LifecycleConfiguration
{
Rules = new List<LifecycleRule>
{
// Rule to delete keys with prefix "Test-" after 5 days
new LifecycleRule
{
Prefix = "Test-",
Expiration = new LifecycleRuleExpiration { Days = 5 }
},
// Rule to delete keys in subdirectory "Logs" after 2 days
new LifecycleRule
{
Prefix = "Logs/",
Expiration = new LifecycleRuleExpiration { Days = 2 },
Id = "log-file-removal"
}
}
};
PutLifecycleConfigurationRequest putRequest = new PutLifecycleConfigurationRequest
{
BucketName = "SampleBucket",
Configuration = newConfiguration
};
client.PutLifecycleConfiguration(putRequest);
// Retrieve current configuration
GetLifecycleConfigurationRequest getRequest = new GetLifecycleConfigurationRequest
{
BucketName = "SampleBucket"
};
LifecycleConfiguration configuration = client.GetLifecycleConfiguration(getRequest).Configuration;
Console.WriteLine("Configuration contains {0} rules", configuration.Rules.Count);
foreach (LifecycleRule rule in configuration.Rules)
{
Console.WriteLine("Rule");
Console.WriteLine(" Prefix = " + rule.Prefix);
Console.WriteLine(" Expiration (days) = " + rule.Expiration.Days);
Console.WriteLine(" Id = " + rule.Id);
Console.WriteLine(" Status = " + rule.Status);
}
// Put a new configuration and overwrite the existing configuration
configuration.Rules.RemoveAt(0); // remove first rule
client.PutLifecycleConfiguration(putRequest);
// Delete current configuration
DeleteLifecycleConfigurationRequest deleteRequest = new DeleteLifecycleConfigurationRequest
{
BucketName = "SampleBucket"
};
client.DeleteLifecycleConfiguration(deleteRequest);
// Retrieve current configuration and verify that it is null
configuration = client.GetLifecycleConfiguration(getRequest).Configuration;
Debug.Assert(configuration == null);
#endregion
}
}
/// <summary>
/// Initiates the asynchronous execution of the GetBucketPolicy operation.
/// <seealso cref="Amazon.S3.IAmazonS3.GetBucketPolicy"/>
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetBucketPolicy operation.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The task object representing the asynchronous operation.</returns>
public Task<GetBucketPolicyResponse> GetBucketPolicyAsync(GetBucketPolicyRequest request, CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new GetBucketPolicyRequestMarshaller();
var unmarshaller = GetBucketPolicyResponseUnmarshaller.GetInstance();
return Invoke<IRequest, GetBucketPolicyRequest, GetBucketPolicyResponse>(request, marshaller, unmarshaller, signer, cancellationToken);
}
/// <summary>
/// Initiates the asynchronous execution of the GetBucketPolicy operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetBucketPolicy operation on AmazonS3Client.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicy
/// operation.</returns>
public IAsyncResult BeginGetBucketPolicy(GetBucketPolicyRequest request, AsyncCallback callback, object state)
{
var marshaller = new GetBucketPolicyRequestMarshaller();
var unmarshaller = GetBucketPolicyResponseUnmarshaller.Instance;
return BeginInvoke<GetBucketPolicyRequest>(request, marshaller, unmarshaller,
callback, state);
}
/// <summary>
/// <para>Returns the policy of a specified bucket.</para>
/// </summary>
///
/// <param name="getBucketPolicyRequest">Container for the necessary parameters to execute the GetBucketPolicy service method on
/// AmazonS3.</param>
///
/// <returns>The response from the GetBucketPolicy service method, as returned by AmazonS3.</returns>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
public async Task<GetBucketPolicyResponse> GetBucketPolicyAsync(GetBucketPolicyRequest getBucketPolicyRequest, CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new GetBucketPolicyRequestMarshaller();
var unmarshaller = GetBucketPolicyResponseUnmarshaller.GetInstance();
var response = await Invoke<IRequest, GetBucketPolicyRequest, GetBucketPolicyResponse>(getBucketPolicyRequest, marshaller, unmarshaller, signer, cancellationToken)
.ConfigureAwait(continueOnCapturedContext: false);
return response;
}
/// <summary>
/// <para>Returns the policy of a specified bucket.</para>
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetBucketPolicy service method on
/// AmazonS3.</param>
///
/// <returns>The response from the GetBucketPolicy service method, as returned by AmazonS3.</returns>
public GetBucketPolicyResponse GetBucketPolicy(GetBucketPolicyRequest request)
{
var task = GetBucketPolicyAsync(request);
try
{
return task.Result;
}
catch(AggregateException e)
{
throw e.InnerException;
}
}
/// <summary>
/// <para>Returns the policy of a specified bucket.</para>
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetBucketPolicy service method on
/// AmazonS3.</param>
///
/// <returns>The response from the GetBucketPolicy service method, as returned by AmazonS3.</returns>
public GetBucketPolicyResponse GetBucketPolicy(GetBucketPolicyRequest request)
{
var task = GetBucketPolicyAsync(request);
try
{
return task.Result;
}
catch(AggregateException e)
{
ExceptionDispatchInfo.Capture(e.InnerException).Throw();
return null;
}
}
public void BucketI_GetBucketPolicyTest_ForException_EmptyBucketName()
{
string actualValue = string.Empty;
string emptyBucketName = string.Empty;
//Create request object.
GetBucketPolicyRequest request = new GetBucketPolicyRequest { BucketName = emptyBucketName };
_client.GetBucketPolicy(request);
EnqueueTestComplete();
}
public void BucketI_GetBucketPolicyTest()
{
bool expectedValue = true;
bool actualValue = false;
bool hasCallbackArrived = false;
S3ResponseEventHandler<object, ResponseEventArgs> handler = null;
handler = delegate(object sender, ResponseEventArgs args)
{
IS3Response result = args.Response;
//Unhook from event.
_client.OnS3Response -= handler;
GetBucketPolicyResponse response = result as GetBucketPolicyResponse;
if (null != response)
actualValue = response.IsRequestSuccessful;
hasCallbackArrived = true;
};
_client.OnS3Response += handler;
GetBucketPolicyRequest request = new GetBucketPolicyRequest() { BucketName = _bucketNameForBucketAPIs };
_client.GetBucketPolicy(request);
EnqueueConditional(() => hasCallbackArrived);
EnqueueCallback(() => Assert.IsTrue(expectedValue == actualValue,
string.Format("Expected Value = {0}, Actual Value = {1}", expectedValue, actualValue)));
EnqueueTestComplete();
}
/// <summary>
/// Initiates the asynchronous execution of the GetBucketPolicy operation.
/// <seealso cref="Amazon.S3.IAmazonS3.GetBucketPolicy"/>
/// </summary>
///
/// <param name="getBucketPolicyRequest">Container for the necessary parameters to execute the GetBucketPolicy operation on AmazonS3.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicy
/// operation.</returns>
public IAsyncResult BeginGetBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest, AsyncCallback callback, object state)
{
return invokeGetBucketPolicy(getBucketPolicyRequest, callback, state, false);
}
/// <summary>
/// Returns the policy of a specified bucket.
/// </summary>
/// <param name="bucketName">A property of GetBucketPolicyRequest used to execute the GetBucketPolicy service method.</param>
///
/// <returns>The response from the GetBucketPolicy service method, as returned by S3.</returns>
public GetBucketPolicyResponse GetBucketPolicy(string bucketName)
{
var request = new GetBucketPolicyRequest();
request.BucketName = bucketName;
return GetBucketPolicy(request);
}
IAsyncResult invokeGetBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest, AsyncCallback callback, object state, bool synchronized)
{
IRequest irequest = new GetBucketPolicyRequestMarshaller().Marshall(getBucketPolicyRequest);
var unmarshaller = GetBucketPolicyResponseUnmarshaller.GetInstance();
AsyncResult result = new AsyncResult(irequest, callback, state, synchronized, signer, unmarshaller);
Invoke(result);
return result;
}
/// <summary>
/// Returns the policy of a specified bucket.
/// </summary>
/// <param name="bucketName">A property of GetBucketPolicyRequest used to execute the GetBucketPolicy service method.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
///
/// <returns>The response from the GetBucketPolicy service method, as returned by S3.</returns>
public Task<GetBucketPolicyResponse> GetBucketPolicyAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetBucketPolicyRequest();
request.BucketName = bucketName;
return GetBucketPolicyAsync(request, cancellationToken);
}
/// <summary>
/// Initiates the asynchronous execution of the GetBucketPolicy operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetBucketPolicy operation.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The task object representing the asynchronous operation.</returns>
public Task<GetBucketPolicyResponse> GetBucketPolicyAsync(GetBucketPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new GetBucketPolicyRequestMarshaller();
var unmarshaller = GetBucketPolicyResponseUnmarshaller.Instance;
return InvokeAsync<GetBucketPolicyRequest,GetBucketPolicyResponse>(request, marshaller,
unmarshaller, cancellationToken);
}
private void GetBucketPolicyButton_Click(object sender, RoutedEventArgs e)
{
try
{
S3Common.client.OnS3Response += GetBucketPolicyWebResponse;
GetBucketPolicyRequest request = new GetBucketPolicyRequest();
request.BucketName = SelectedBucketName;
S3Common.client.GetBucketPolicy(request);
}
catch (Exception ex)
{
S3Common.client.OnS3Response -= GetBucketPolicyWebResponse;
this.Dispatcher.BeginInvoke(() =>
{
MessageBox.Show(ex.Message);
});
}
}
