/// <summary>
/// Initiates the asynchronous execution of the DescribeWorkspaces operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeWorkspaces 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<DescribeWorkspacesResponse> DescribeWorkspacesAsync(DescribeWorkspacesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DescribeWorkspacesRequestMarshaller();
var unmarshaller = DescribeWorkspacesResponseUnmarshaller.Instance;
return InvokeAsync<DescribeWorkspacesRequest,DescribeWorkspacesResponse>(request, marshaller,
unmarshaller, cancellationToken);
}
/// <summary>
/// Obtains information about the specified WorkSpaces.
///
///
/// <para>
/// Only one of the filter parameters, such as <code>BundleId</code>, <code>DirectoryId</code>,
/// or <code>WorkspaceIds</code>, can be specified at a time.
/// </para>
///
/// <para>
/// This operation supports pagination with the use of the <code>NextToken</code> request
/// and response parameters. If more results are available, the <code>NextToken</code>
/// response member contains a token that you pass in the next call to this operation
/// to retrieve the next set of items.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeWorkspaces service method.</param>
///
/// <returns>The response from the DescribeWorkspaces service method, as returned by WorkSpaces.</returns>
/// <exception cref="Amazon.WorkSpaces.Model.InvalidParameterValuesException">
/// One or more parameter values are not valid.
/// </exception>
/// <exception cref="Amazon.WorkSpaces.Model.ResourceUnavailableException">
/// The specified resource is not available.
/// </exception>
public DescribeWorkspacesResponse DescribeWorkspaces(DescribeWorkspacesRequest request)
{
var marshaller = new DescribeWorkspacesRequestMarshaller();
var unmarshaller = DescribeWorkspacesResponseUnmarshaller.Instance;
return Invoke<DescribeWorkspacesRequest,DescribeWorkspacesResponse>(request, marshaller, unmarshaller);
}
/// <summary>
/// Obtains information about the specified WorkSpaces.
///
///
/// <para>
/// Only one of the filter parameters, such as <code>BundleId</code>, <code>DirectoryId</code>,
/// or <code>WorkspaceIds</code>, can be specified at a time.
/// </para>
///
/// <para>
/// This operation supports pagination with the use of the <code>NextToken</code> request
/// and response parameters. If more results are available, the <code>NextToken</code>
/// response member contains a token that you pass in the next call to this operation
/// to retrieve the next set of items.
/// </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 DescribeWorkspaces service method, as returned by WorkSpaces.</returns>
/// <exception cref="Amazon.WorkSpaces.Model.InvalidParameterValuesException">
/// One or more parameter values are not valid.
/// </exception>
/// <exception cref="Amazon.WorkSpaces.Model.ResourceUnavailableException">
/// The specified resource is not available.
/// </exception>
public Task<DescribeWorkspacesResponse> DescribeWorkspacesAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DescribeWorkspacesRequest();
return DescribeWorkspacesAsync(request, cancellationToken);
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeWorkspaces operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeWorkspaces operation on AmazonWorkSpacesClient.</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 EndDescribeWorkspaces
/// operation.</returns>
public IAsyncResult BeginDescribeWorkspaces(DescribeWorkspacesRequest request, AsyncCallback callback, object state)
{
var marshaller = new DescribeWorkspacesRequestMarshaller();
var unmarshaller = DescribeWorkspacesResponseUnmarshaller.Instance;
return BeginInvoke<DescribeWorkspacesRequest>(request, marshaller, unmarshaller,
callback, state);
}
/// <summary>
/// Obtains information about the specified WorkSpaces.
///
///
/// <para>
/// Only one of the filter parameters, such as <code>BundleId</code>, <code>DirectoryId</code>,
/// or <code>WorkspaceIds</code>, can be specified at a time.
/// </para>
///
/// <para>
/// This operation supports pagination with the use of the <code>NextToken</code> request
/// and response parameters. If more results are available, the <code>NextToken</code>
/// response member contains a token that you pass in the next call to this operation
/// to retrieve the next set of items.
/// </para>
/// </summary>
///
/// <returns>The response from the DescribeWorkspaces service method, as returned by WorkSpaces.</returns>
/// <exception cref="Amazon.WorkSpaces.Model.InvalidParameterValuesException">
/// One or more parameter values are not valid.
/// </exception>
/// <exception cref="Amazon.WorkSpaces.Model.ResourceUnavailableException">
/// The specified resource is not available.
/// </exception>
public DescribeWorkspacesResponse DescribeWorkspaces()
{
var request = new DescribeWorkspacesRequest();
return DescribeWorkspaces(request);
}
/// <summary>
/// Paginator for DescribeWorkspaces operation
///</summary>
public IDescribeWorkspacesPaginator DescribeWorkspaces(DescribeWorkspacesRequest request)
{
return(new DescribeWorkspacesPaginator(this.client, request));
}
internal DescribeWorkspacesPaginator(IAmazonWorkSpaces client, DescribeWorkspacesRequest request)
{
this._client = client;
this._request = request;
}
private Amazon.WorkSpaces.Model.DescribeWorkspacesResponse CallAWSServiceOperation(IAmazonWorkSpaces client, Amazon.WorkSpaces.Model.DescribeWorkspacesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkSpaces", "DescribeWorkspaces");
try
{
#if DESKTOP
return(client.DescribeWorkspaces(request));
#elif CORECLR
return(client.DescribeWorkspacesAsync(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.WorkSpaces.Model.DescribeWorkspacesRequest();
if (cmdletContext.BundleId != null)
{
request.BundleId = cmdletContext.BundleId;
}
if (cmdletContext.DirectoryId != null)
{
request.DirectoryId = cmdletContext.DirectoryId;
}
if (cmdletContext.UserName != null)
{
request.UserName = cmdletContext.UserName;
}
if (cmdletContext.WorkspaceId != null)
{
request.WorkspaceIds = cmdletContext.WorkspaceId;
}
// Initialize loop variants and commence piping
System.String _nextToken = null;
int? _emitLimit = null;
int _retrievedSoFar = 0;
if (AutoIterationHelpers.HasValue(cmdletContext.NextToken))
{
_nextToken = cmdletContext.NextToken;
}
if (cmdletContext.Limit.HasValue)
{
// The service has a maximum page size of 25. 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 25 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.NextToken));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.NextToken = _nextToken;
if (_emitLimit.HasValue)
{
int correctPageSize = Math.Min(25, _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.Workspaces.Count;
_nextToken = response.NextToken;
_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.WorkSpaces.Model.DescribeWorkspacesRequest();
if (cmdletContext.BundleId != null)
{
request.BundleId = cmdletContext.BundleId;
}
if (cmdletContext.DirectoryId != null)
{
request.DirectoryId = cmdletContext.DirectoryId;
}
if (cmdletContext.Limit != null)
{
request.Limit = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.Limit.Value);
}
if (cmdletContext.UserName != null)
{
request.UserName = cmdletContext.UserName;
}
if (cmdletContext.WorkspaceId != null)
{
request.WorkspaceIds = cmdletContext.WorkspaceId;
}
// Initialize loop variant and commence piping
var _nextToken = cmdletContext.NextToken;
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.NextToken = _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.NextToken;
}
catch (Exception e)
{
output = new CmdletOutput {
ErrorResponse = e
};
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return(null);
}
