public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.KeyManagementService.Model.DisableKeyRequest();
if (cmdletContext.KeyId != null)
{
request.KeyId = cmdletContext.KeyId;
}
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>
/// Initiates the asynchronous execution of the DisableKey operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DisableKey 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<DisableKeyResponse> DisableKeyAsync(DisableKeyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DisableKeyRequestMarshaller();
var unmarshaller = DisableKeyResponseUnmarshaller.Instance;
return InvokeAsync<DisableKeyRequest,DisableKeyResponse>(request, marshaller,
unmarshaller, cancellationToken);
}
/// <summary>
/// Marks a key as disabled, thereby preventing its use.
/// </summary>
/// <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </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 DisableKey service method, as returned by KeyManagementService.</returns>
/// <exception cref="Amazon.KeyManagementService.Model.DependencyTimeoutException">
/// The system timed out while trying to fulfill the request.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
/// The request was rejected because a specified ARN was not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.KMSInternalException">
/// The request was rejected because an internal exception occurred. This error can be
/// retried.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.NotFoundException">
/// The request was rejected because the specified entity or resource could not be found.
/// </exception>
public Task<DisableKeyResponse> DisableKeyAsync(string keyId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DisableKeyRequest();
request.KeyId = keyId;
return DisableKeyAsync(request, cancellationToken);
}
/// <summary>
/// Marks a key as disabled, thereby preventing its use.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DisableKey service method.</param>
///
/// <returns>The response from the DisableKey service method, as returned by KeyManagementService.</returns>
/// <exception cref="Amazon.KeyManagementService.Model.DependencyTimeoutException">
/// The system timed out while trying to fulfill the request.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
/// The request was rejected because a specified ARN was not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.KMSInternalException">
/// The request was rejected because an internal exception occurred. This error can be
/// retried.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.NotFoundException">
/// The request was rejected because the specified entity or resource could not be found.
/// </exception>
public DisableKeyResponse DisableKey(DisableKeyRequest request)
{
var marshaller = new DisableKeyRequestMarshaller();
var unmarshaller = DisableKeyResponseUnmarshaller.Instance;
return Invoke<DisableKeyRequest,DisableKeyResponse>(request, marshaller, unmarshaller);
}
/// <summary>
/// Marks a key as disabled, thereby preventing its use.
/// </summary>
/// <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param>
///
/// <returns>The response from the DisableKey service method, as returned by KeyManagementService.</returns>
/// <exception cref="Amazon.KeyManagementService.Model.DependencyTimeoutException">
/// The system timed out while trying to fulfill the request.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
/// The request was rejected because a specified ARN was not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.KMSInternalException">
/// The request was rejected because an internal exception occurred. This error can be
/// retried.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.NotFoundException">
/// The request was rejected because the specified entity or resource could not be found.
/// </exception>
public DisableKeyResponse DisableKey(string keyId)
{
var request = new DisableKeyRequest();
request.KeyId = keyId;
return DisableKey(request);
}
private Amazon.KeyManagementService.Model.DisableKeyResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.DisableKeyRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "DisableKey");
try
{
#if DESKTOP
return(client.DisableKey(request));
#elif CORECLR
return(client.DisableKeyAsync(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>
/// Initiates the asynchronous execution of the DisableKey operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DisableKey operation on AmazonKeyManagementServiceClient.</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 EndDisableKey
/// operation.</returns>
public IAsyncResult BeginDisableKey(DisableKeyRequest request, AsyncCallback callback, object state)
{
var marshaller = new DisableKeyRequestMarshaller();
var unmarshaller = DisableKeyResponseUnmarshaller.Instance;
return BeginInvoke<DisableKeyRequest>(request, marshaller, unmarshaller,
callback, state);
}
