/******************************************************************************* * 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.SageMaker; using Amazon.SageMaker.Model; namespace Amazon.PowerShell.Cmdlets.SM { /// /// List hub content versions. /// /// /// Hub APIs are only callable through SageMaker Studio. ///

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. ///
[Cmdlet("Get", "SMHubContentVersionList")] [OutputType("Amazon.SageMaker.Model.HubContentInfo")] [AWSCmdlet("Calls the Amazon SageMaker Service ListHubContentVersions API operation.", Operation = new[] {"ListHubContentVersions"}, SelectReturnType = typeof(Amazon.SageMaker.Model.ListHubContentVersionsResponse))] [AWSCmdletOutput("Amazon.SageMaker.Model.HubContentInfo or Amazon.SageMaker.Model.ListHubContentVersionsResponse", "This cmdlet returns a collection of Amazon.SageMaker.Model.HubContentInfo objects.", "The service call response (type Amazon.SageMaker.Model.ListHubContentVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetSMHubContentVersionListCmdlet : AmazonSageMakerClientCmdlet, IExecutor { #region Parameter CreationTimeAfter /// /// /// Only list hub content versions that were created after the time specified. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? CreationTimeAfter { get; set; } #endregion #region Parameter CreationTimeBefore /// /// /// Only list hub content versions that were created before the time specified. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? CreationTimeBefore { get; set; } #endregion #region Parameter HubContentName /// /// /// The name of the hub content. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String HubContentName { get; set; } #endregion #region Parameter HubContentType /// /// /// The type of hub content to list versions of. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.SageMaker.HubContentType")] public Amazon.SageMaker.HubContentType HubContentType { get; set; } #endregion #region Parameter HubName /// /// /// The name of the hub to list the content versions of. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String HubName { get; set; } #endregion #region Parameter MaxSchemaVersion /// /// /// The upper bound of the hub content schema version. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String MaxSchemaVersion { get; set; } #endregion #region Parameter MinVersion /// /// /// The lower bound of the hub content versions to list. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String MinVersion { get; set; } #endregion #region Parameter SortBy /// /// /// Sort hub content versions by either name or creation time. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.SageMaker.HubContentSortBy")] public Amazon.SageMaker.HubContentSortBy SortBy { get; set; } #endregion #region Parameter SortOrder /// /// /// Sort hub content versions by ascending or descending order. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.SageMaker.SortOrder")] public Amazon.SageMaker.SortOrder SortOrder { get; set; } #endregion #region Parameter MaxResult /// /// /// The maximum number of hub content versions to list. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// If the response to a previous ListHubContentVersions request was truncated, /// the response includes a NextToken. To retrieve the next set of hub content /// versions, use the token in the next request. /// /// ///
Note: This parameter is only used if you are manually controlling output pagination of the service API call. ///
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NextToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'HubContentSummaries'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListHubContentVersionsResponse). /// Specifying the name of a property of type Amazon.SageMaker.Model.ListHubContentVersionsResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "HubContentSummaries"; #endregion #region Parameter NoAutoIteration /// /// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple /// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken /// as the start point. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter NoAutoIteration { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.CreationTimeAfter = this.CreationTimeAfter; context.CreationTimeBefore = this.CreationTimeBefore; context.HubContentName = this.HubContentName; #if MODULAR if (this.HubContentName == null && ParameterWasBound(nameof(this.HubContentName))) { WriteWarning("You are passing $null as a value for parameter HubContentName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.HubContentType = this.HubContentType; #if MODULAR if (this.HubContentType == null && ParameterWasBound(nameof(this.HubContentType))) { WriteWarning("You are passing $null as a value for parameter HubContentType which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.HubName = this.HubName; #if MODULAR if (this.HubName == null && ParameterWasBound(nameof(this.HubName))) { WriteWarning("You are passing $null as a value for parameter HubName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.MaxResult = this.MaxResult; context.MaxSchemaVersion = this.MaxSchemaVersion; context.MinVersion = this.MinVersion; context.NextToken = this.NextToken; context.SortBy = this.SortBy; context.SortOrder = this.SortOrder; // 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; var useParameterSelect = this.Select.StartsWith("^"); // create request and set iteration invariants var request = new Amazon.SageMaker.Model.ListHubContentVersionsRequest(); if (cmdletContext.CreationTimeAfter != null) { request.CreationTimeAfter = cmdletContext.CreationTimeAfter.Value; } if (cmdletContext.CreationTimeBefore != null) { request.CreationTimeBefore = cmdletContext.CreationTimeBefore.Value; } if (cmdletContext.HubContentName != null) { request.HubContentName = cmdletContext.HubContentName; } if (cmdletContext.HubContentType != null) { request.HubContentType = cmdletContext.HubContentType; } if (cmdletContext.HubName != null) { request.HubName = cmdletContext.HubName; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.MaxSchemaVersion != null) { request.MaxSchemaVersion = cmdletContext.MaxSchemaVersion; } if (cmdletContext.MinVersion != null) { request.MinVersion = cmdletContext.MinVersion; } if (cmdletContext.SortBy != null) { request.SortBy = cmdletContext.SortBy; } if (cmdletContext.SortOrder != null) { request.SortOrder = cmdletContext.SortOrder; } // 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; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.SageMaker.Model.ListHubContentVersionsResponse CallAWSServiceOperation(IAmazonSageMaker client, Amazon.SageMaker.Model.ListHubContentVersionsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon SageMaker Service", "ListHubContentVersions"); try { #if DESKTOP return client.ListHubContentVersions(request); #elif CORECLR return client.ListHubContentVersionsAsync(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.DateTime? CreationTimeAfter { get; set; } public System.DateTime? CreationTimeBefore { get; set; } public System.String HubContentName { get; set; } public Amazon.SageMaker.HubContentType HubContentType { get; set; } public System.String HubName { get; set; } public System.Int32? MaxResult { get; set; } public System.String MaxSchemaVersion { get; set; } public System.String MinVersion { get; set; } public System.String NextToken { get; set; } public Amazon.SageMaker.HubContentSortBy SortBy { get; set; } public Amazon.SageMaker.SortOrder SortOrder { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.HubContentSummaries; } } }