/*******************************************************************************
* 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.ResourceGroups;
using Amazon.ResourceGroups.Model;
namespace Amazon.PowerShell.Cmdlets.RG
{
///
/// Returns a list of ARNs of the resources that are members of a specified resource group.
///
///
/// Minimum permissions
/// To run this command, you must have the following permissions:
/// resource-groups:ListGroupResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
In the AWS.Tools.ResourceGroups module, 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", "RGGroupResourceList")]
[OutputType("Amazon.ResourceGroups.Model.ListGroupResourcesResponse")]
[AWSCmdlet("Calls the AWS Resource Groups ListGroupResources API operation.", Operation = new[] {"ListGroupResources"}, SelectReturnType = typeof(Amazon.ResourceGroups.Model.ListGroupResourcesResponse))]
[AWSCmdletOutput("Amazon.ResourceGroups.Model.ListGroupResourcesResponse",
"This cmdlet returns an Amazon.ResourceGroups.Model.ListGroupResourcesResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetRGGroupResourceListCmdlet : AmazonResourceGroupsClientCmdlet, IExecutor
{
#region Parameter Filter
///
///
/// Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources
/// operation. Filters the results to include only those of the specified resource types.resource-type
- Filter resources by their type. Specify up to five resource
/// types in the format AWS::ServiceCode::ResourceType
. For example, AWS::EC2::Instance
,
/// or AWS::S3::Bucket
.
When you specify a resource-type
filter for ListGroupResources
,
/// Resource Groups validates your filter resource types against the types that are defined
/// in the query associated with the group. For example, if a group contains only S3 buckets
/// because its query specifies only that resource type, but your resource-type
/// filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances.
/// In this case, a ListGroupResources
request returns a BadRequestException
/// error with a message similar to the following:The resource types specified as filters in the request are not valid.
The error includes a list of resource types that failed the validation because they
/// are not part of the query associated with the group. This validation doesn't occur
/// when the group query specifies AWS::AllSupported
, because a group based
/// on such a query can contain any of the allowed resource types for the query type (tag-based
/// or Amazon CloudFront stack-based queries).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Filters")]
public Amazon.ResourceGroups.Model.ResourceFilter[] Filter { get; set; }
#endregion
#region Parameter Group
///
///
/// The name or the ARN of the resource group
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Group { get; set; }
#endregion
#region Parameter GroupName
///
///
/// Deprecated - don't use this parameter. Use the Group
request
/// field instead.
///
/// This parameter is deprecated.
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
[System.ObsoleteAttribute("This field is deprecated, use Group instead.")]
[Alias("Name")]
public System.String GroupName { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The total number of results that you want included on each page of the response. If
/// you do not include this parameter, it defaults to a value that is specific to the
/// operation. If additional items exist beyond the maximum you specify, the NextToken
/// response element is present and has a value (is not null). Include that value as the
/// NextToken
request parameter in the next call to the operation to get
/// the next part of the results. Note that the service might return fewer results than
/// the maximum even when there are more results available. You should check NextToken
/// after every operation to ensure that you receive all of the results.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// The parameter for receiving additional results if you receive a NextToken
/// response in a previous request. A NextToken
response indicates that more
/// output is available. Set this parameter to the value provided by a previous call's
/// NextToken
response to indicate where the output should continue from.
///
///
///
Note: In the AWS.Tools.ResourceGroups module, 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 '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceGroups.Model.ListGroupResourcesResponse).
/// Specifying the name of a property of type Amazon.ResourceGroups.Model.ListGroupResourcesResponse 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; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the GroupName parameter.
/// The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter NoAutoIteration
#if MODULAR
///
/// 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; }
#endif
#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);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.GroupName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.Filter != null)
{
context.Filter = new List(this.Filter);
}
context.Group = this.Group;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.GroupName = this.GroupName;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
#if MODULAR
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// create request and set iteration invariants
var request = new Amazon.ResourceGroups.Model.ListGroupResourcesRequest();
if (cmdletContext.Filter != null)
{
request.Filters = cmdletContext.Filter;
}
if (cmdletContext.Group != null)
{
request.Group = cmdletContext.Group;
}
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.GroupName != null)
{
request.GroupName = cmdletContext.GroupName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
// 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;
}
#else
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.ResourceGroups.Model.ListGroupResourcesRequest();
if (cmdletContext.Filter != null)
{
request.Filters = cmdletContext.Filter;
}
if (cmdletContext.Group != null)
{
request.Group = cmdletContext.Group;
}
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.GroupName != null)
{
request.GroupName = cmdletContext.GroupName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NextToken != null)
{
request.NextToken = cmdletContext.NextToken;
}
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;
}
#endif
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.ResourceGroups.Model.ListGroupResourcesResponse CallAWSServiceOperation(IAmazonResourceGroups client, Amazon.ResourceGroups.Model.ListGroupResourcesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Resource Groups", "ListGroupResources");
try
{
#if DESKTOP
return client.ListGroupResources(request);
#elif CORECLR
return client.ListGroupResourcesAsync(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 List Filter { get; set; }
public System.String Group { get; set; }
[System.ObsoleteAttribute]
public System.String GroupName { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}