/// <summary>
/// Returns a list of all grants for which the grant's <code>RetiringPrincipal</code>
/// matches the one specified.
///
///
/// <para>
/// A typical use is to list all grants that you are able to retire. To retire a grant,
/// use <a>RetireGrant</a>.
/// </para>
/// </summary>
/// <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 ListRetirableGrants service method, as returned by KeyManagementService.</returns>
/// <exception cref="Amazon.KeyManagementService.Model.DependencyTimeoutException">
/// The system timed out while trying to fulfill the request. The request can be retried.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
/// The request was rejected because a specified ARN was not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidMarkerException">
/// The request was rejected because the marker that specifies where pagination should
/// next begin is not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.KMSInternalException">
/// The request was rejected because an internal exception occurred. The request 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<ListRetirableGrantsResponse> ListRetirableGrantsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new ListRetirableGrantsRequest();
return ListRetirableGrantsAsync(request, cancellationToken);
}
/// <summary>
/// Initiates the asynchronous execution of the ListRetirableGrants operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ListRetirableGrants 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<ListRetirableGrantsResponse> ListRetirableGrantsAsync(ListRetirableGrantsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new ListRetirableGrantsRequestMarshaller();
var unmarshaller = ListRetirableGrantsResponseUnmarshaller.Instance;
return InvokeAsync<ListRetirableGrantsRequest,ListRetirableGrantsResponse>(request, marshaller,
unmarshaller, cancellationToken);
}
/// <summary>
/// Returns a list of all grants for which the grant's <code>RetiringPrincipal</code>
/// matches the one specified.
///
///
/// <para>
/// A typical use is to list all grants that you are able to retire. To retire a grant,
/// use <a>RetireGrant</a>.
/// </para>
/// </summary>
///
/// <returns>The response from the ListRetirableGrants service method, as returned by KeyManagementService.</returns>
/// <exception cref="Amazon.KeyManagementService.Model.DependencyTimeoutException">
/// The system timed out while trying to fulfill the request. The request can be retried.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
/// The request was rejected because a specified ARN was not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidMarkerException">
/// The request was rejected because the marker that specifies where pagination should
/// next begin is not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.KMSInternalException">
/// The request was rejected because an internal exception occurred. The request 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 ListRetirableGrantsResponse ListRetirableGrants()
{
var request = new ListRetirableGrantsRequest();
return ListRetirableGrants(request);
}
/// <summary>
/// Returns a list of all grants for which the grant's <code>RetiringPrincipal</code>
/// matches the one specified.
///
///
/// <para>
/// A typical use is to list all grants that you are able to retire. To retire a grant,
/// use <a>RetireGrant</a>.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListRetirableGrants service method.</param>
///
/// <returns>The response from the ListRetirableGrants service method, as returned by KeyManagementService.</returns>
/// <exception cref="Amazon.KeyManagementService.Model.DependencyTimeoutException">
/// The system timed out while trying to fulfill the request. The request can be retried.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
/// The request was rejected because a specified ARN was not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidMarkerException">
/// The request was rejected because the marker that specifies where pagination should
/// next begin is not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.KMSInternalException">
/// The request was rejected because an internal exception occurred. The request 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 ListRetirableGrantsResponse ListRetirableGrants(ListRetirableGrantsRequest request)
{
var marshaller = new ListRetirableGrantsRequestMarshaller();
var unmarshaller = ListRetirableGrantsResponseUnmarshaller.Instance;
return Invoke<ListRetirableGrantsRequest,ListRetirableGrantsResponse>(request, marshaller, unmarshaller);
}
/// <summary>
/// Returns a list of all grants for which the grant's <code>RetiringPrincipal</code>
/// matches the one specified.
///
///
/// <para>
/// A typical use is to list all grants that you are able to retire. To retire a grant,
/// use <a>RetireGrant</a>.
/// </para>
/// </summary>
/// <param name="retiringPrincipal">The retiring principal for which to list grants. To specify the retiring principal, use the <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>Amazon Web Services General Reference</i>.</param>
///
/// <returns>The response from the ListRetirableGrants service method, as returned by KeyManagementService.</returns>
/// <exception cref="Amazon.KeyManagementService.Model.DependencyTimeoutException">
/// The system timed out while trying to fulfill the request. The request can be retried.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
/// The request was rejected because a specified ARN was not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.InvalidMarkerException">
/// The request was rejected because the marker that specifies where pagination should
/// next begin is not valid.
/// </exception>
/// <exception cref="Amazon.KeyManagementService.Model.KMSInternalException">
/// The request was rejected because an internal exception occurred. The request 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 ListRetirableGrantsResponse ListRetirableGrants(string retiringPrincipal)
{
var request = new ListRetirableGrantsRequest();
request.RetiringPrincipal = retiringPrincipal;
return ListRetirableGrants(request);
}
private Amazon.KeyManagementService.Model.ListRetirableGrantsResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.ListRetirableGrantsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "ListRetirableGrants");
try
{
#if DESKTOP
return(client.ListRetirableGrants(request));
#elif CORECLR
return(client.ListRetirableGrantsAsync(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;
}
}
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
var useParameterSelect = this.Select.StartsWith("^");
// create request and set iteration invariants
var request = new Amazon.KeyManagementService.Model.ListRetirableGrantsRequest();
if (cmdletContext.RetiringPrincipal != null)
{
request.RetiringPrincipal = cmdletContext.RetiringPrincipal;
}
// Initialize loop variants and commence piping
System.String _nextToken = null;
int? _emitLimit = null;
int _retrievedSoFar = 0;
if (AutoIterationHelpers.HasValue(cmdletContext.Marker))
{
_nextToken = cmdletContext.Marker;
}
if (cmdletContext.Limit.HasValue)
{
// The service has a maximum page size of 1000. If the user has
// asked for more items than page max, and there is no page size
// configured, we rely on the service ignoring the set maximum
// and giving us 1000 items back. If a page size is set, that will
// be used to configure the pagination.
// We'll make further calls to satisfy the user's request.
_emitLimit = cmdletContext.Limit;
}
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.Marker = _nextToken;
if (_emitLimit.HasValue)
{
int correctPageSize = Math.Min(1000, _emitLimit.Value);
request.Limit = AutoIterationHelpers.ConvertEmitLimitToInt32(correctPageSize);
}
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
int _receivedThisCall = response.Grants.Count;
_nextToken = response.NextMarker;
_retrievedSoFar += _receivedThisCall;
if (_emitLimit.HasValue)
{
_emitLimit -= _receivedThisCall;
}
}
catch (Exception e)
{
if (_retrievedSoFar == 0 || !_emitLimit.HasValue)
{
output = new CmdletOutput {
ErrorResponse = e
};
}
else
{
break;
}
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken) && (!_emitLimit.HasValue || _emitLimit.Value >= 1));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return(null);
}
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
var useParameterSelect = this.Select.StartsWith("^");
// create request and set iteration invariants
var request = new Amazon.KeyManagementService.Model.ListRetirableGrantsRequest();
if (cmdletContext.Limit != null)
{
request.Limit = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.Limit.Value);
}
if (cmdletContext.RetiringPrincipal != null)
{
request.RetiringPrincipal = cmdletContext.RetiringPrincipal;
}
// Initialize loop variant and commence piping
var _nextToken = cmdletContext.Marker;
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.Marker = _nextToken;
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
_nextToken = response.NextMarker;
}
catch (Exception e)
{
output = new CmdletOutput {
ErrorResponse = e
};
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return(null);
}
/// <summary>
/// Initiates the asynchronous execution of the ListRetirableGrants operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ListRetirableGrants 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 EndListRetirableGrants
/// operation.</returns>
public IAsyncResult BeginListRetirableGrants(ListRetirableGrantsRequest request, AsyncCallback callback, object state)
{
var marshaller = new ListRetirableGrantsRequestMarshaller();
var unmarshaller = ListRetirableGrantsResponseUnmarshaller.Instance;
return BeginInvoke<ListRetirableGrantsRequest>(request, marshaller, unmarshaller,
callback, state);
}