/*******************************************************************************
* 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.IdentityManagement;
using Amazon.IdentityManagement.Model;
namespace Amazon.PowerShell.Cmdlets.IAM
{
///
/// Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails
/// operation. You can use the JobId
parameter in GetServiceLastAccessedDetails
/// to retrieve the status of your report job. When the report is complete, you can retrieve
/// the generated report. The report includes a list of Amazon Web Services services that
/// the resource (user, group, role, or managed policy) can access.
///
///
/// Service last accessed data does not use other policy types when determining whether
/// a resource could access a service. These other policy types include resource-based
/// policies, access control lists, Organizations policies, IAM permissions boundaries,
/// and STS assume role policies. It only applies permissions policy logic. For more about
/// the evaluation of policy types, see Evaluating
/// policies in the IAM User Guide.
///
/// For each service that the resource could access using permissions policies, the operation
/// returns details about the most recent access attempt. If there was no attempt, the
/// service is listed without details about the most recent attempt to access the service.
/// If the operation fails, the GetServiceLastAccessedDetails
operation returns
/// the reason that it failed.
///
/// The GetServiceLastAccessedDetails
operation returns a list of services.
/// This list includes the number of entities that have attempted to access the service
/// and the date and time of the last attempt. It also returns the ARN of the following
/// entity, depending on the resource ARN that you used to generate the report:
/// - User – Returns the user ARN that you used to generate the report
///
- Group – Returns the ARN of the group member (user) that last attempted to
/// access the service
///
- Role – Returns the role ARN that you used to generate the report
///
- Policy – Returns the ARN of the user or role that last used the policy to
/// attempt to access the service
///
/// By default, the list is sorted by service namespace.
///
/// If you specified ACTION_LEVEL
granularity when you generated the report,
/// this operation returns service and action last accessed data. This includes the most
/// recent access attempt for each tracked action within a service. Otherwise, this operation
/// returns only service data.
///
/// For more information about service and action last accessed data, see Reducing
/// permissions using service last accessed data in the IAM User Guide.
///
In the AWS.Tools.IdentityManagement 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", "IAMServiceLastAccessedDetail")]
[OutputType("Amazon.IdentityManagement.Model.GetServiceLastAccessedDetailsResponse")]
[AWSCmdlet("Calls the AWS Identity and Access Management GetServiceLastAccessedDetails API operation.", Operation = new[] {"GetServiceLastAccessedDetails"}, SelectReturnType = typeof(Amazon.IdentityManagement.Model.GetServiceLastAccessedDetailsResponse))]
[AWSCmdletOutput("Amazon.IdentityManagement.Model.GetServiceLastAccessedDetailsResponse",
"This cmdlet returns an Amazon.IdentityManagement.Model.GetServiceLastAccessedDetailsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetIAMServiceLastAccessedDetailCmdlet : AmazonIdentityManagementServiceClientCmdlet, IExecutor
{
#region Parameter JobId
///
///
/// The ID of the request generated by the GenerateServiceLastAccessedDetails operation.
/// The JobId
returned by GenerateServiceLastAccessedDetail
/// must be used by the same role within a session, or by the same user when used to call
/// GetServiceLastAccessedDetail
.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String JobId { get; set; }
#endregion
#region Parameter Marker
///
///
/// Use this parameter only when paginating results and only after you receive a response
/// indicating that the results are truncated. Set it to the value of the Marker
/// element in the response that you received to indicate where the next call should start.
///
///
///
Note: In the AWS.Tools.IdentityManagement 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 '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("NextToken")]
public System.String Marker { get; set; }
#endregion
#region Parameter MaxItem
///
///
/// Use this only when paginating results to indicate the maximum number of items you
/// want in the response. If additional items exist beyond the maximum you specify, the
/// IsTruncated
response element is true
.If you do not include this parameter, the number of items defaults to 100. Note that
/// IAM might return fewer results, even when there are more results available. In that
/// case, the IsTruncated
response element returns true
, and
/// Marker
contains a value to include in the subsequent call that tells
/// the service where to continue from.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxItems")]
public System.Int32? MaxItem { 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.IdentityManagement.Model.GetServiceLastAccessedDetailsResponse).
/// Specifying the name of a property of type Amazon.IdentityManagement.Model.GetServiceLastAccessedDetailsResponse 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 JobId parameter.
/// The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^JobId' 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 Marker
/// 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.JobId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.JobId = this.JobId;
#if MODULAR
if (this.JobId == null && ParameterWasBound(nameof(this.JobId)))
{
WriteWarning("You are passing $null as a value for parameter JobId 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.Marker = this.Marker;
context.MaxItem = this.MaxItem;
// 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.IdentityManagement.Model.GetServiceLastAccessedDetailsRequest();
if (cmdletContext.JobId != null)
{
request.JobId = cmdletContext.JobId;
}
if (cmdletContext.MaxItem != null)
{
request.MaxItems = cmdletContext.MaxItem.Value;
}
// 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.Marker;
}
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.IdentityManagement.Model.GetServiceLastAccessedDetailsRequest();
if (cmdletContext.JobId != null)
{
request.JobId = cmdletContext.JobId;
}
if (cmdletContext.Marker != null)
{
request.Marker = cmdletContext.Marker;
}
if (cmdletContext.MaxItem != null)
{
request.MaxItems = cmdletContext.MaxItem.Value;
}
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.IdentityManagement.Model.GetServiceLastAccessedDetailsResponse CallAWSServiceOperation(IAmazonIdentityManagementService client, Amazon.IdentityManagement.Model.GetServiceLastAccessedDetailsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Identity and Access Management", "GetServiceLastAccessedDetails");
try
{
#if DESKTOP
return client.GetServiceLastAccessedDetails(request);
#elif CORECLR
return client.GetServiceLastAccessedDetailsAsync(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.String JobId { get; set; }
public System.String Marker { get; set; }
public System.Int32? MaxItem { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}