AWS Identity and Access Management: Get-IAMAttachedRolePolicyList Cmdlet

Synopsis

Calls the AWS Identity and Access Management ListAttachedRolePolicies API operation.

Syntax

Get-IAMAttachedRolePolicyList
-RoleName <String>
-PathPrefix <String>
-Marker <String>
-MaxItem <Int32>

Description

Lists all managed policies that are attached to the specified IAM role. An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.

This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.

Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias, Get-IAMAttachedRolePolicies.

Parameters

-Marker <String>

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: This parameter is only used if you are manually controlling output pagination of the service API call.

Required?	False
Position?	Named
Accept pipeline input?	False

-MaxItem <Int32>

(Optional) 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, it 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.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.

Required?	False
Position?	Named
Accept pipeline input?	False

-PathPrefix <String>

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.This parameter allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Required?	False
Position?	Named
Accept pipeline input?	False

-RoleName <String>

The name (friendly name, not ARN) of the role to list attached policies for.This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Required?	False
Position?	2
Accept pipeline input?	True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>

The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.

Required?	False
Position?	Named
Accept pipeline input?	False

-Credential <AWSCredentials>

An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.

Required?	False
Position?	Named
Accept pipeline input?	False

-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required?	False
Position?	Named
Accept pipeline input?	False

-ProfileName <String>

The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.

Required?	False
Position?	Named
Accept pipeline input?	False

-NetworkCredential <PSCredential>

Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.

Required?	False
Position?	Named
Accept pipeline input?	False

-SecretKey <String>

The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.

Required?	False
Position?	Named
Accept pipeline input?	False

-SessionToken <String>

The session token if the access and secret keys are temporary session-based credentials.

Required?	False
Position?	Named
Accept pipeline input?	False

-Region <String>

The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.

Required?	False
Position?	Named
Accept pipeline input?	False

-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required?	False
Position?	Named
Accept pipeline input?	False

Inputs

This cmdlet does not accept pipeline input.

Outputs

Amazon.IdentityManagement.Model.AttachedPolicyType

This cmdlet returns a collection of AttachedPolicyType objects. The service call response (type Amazon.IdentityManagement.Model.ListAttachedRolePoliciesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: IsTruncated (type System.Boolean), Marker (type System.String)

Examples

Example 1

PS C:\>Get-IAMAttachedRolePolicyList -RoleName "SecurityAuditRole"

PolicyArn                                                 PolicyName
---------                                                 ----------
arn:aws:iam::aws:policy/SecurityAudit                     SecurityAudit
    
This command returns the names and ARNs of the managed policies attached to the IAM role named SecurityAuditRole in the AWS  account. To see the list of inline policies that are embedded in the role, use the Get-IAMRolePolicyList command.

Supported Version

AWS Tools for PowerShell: 2.x.y.z

Link to this page Did this page help you? Yes No Tell us about it...

Get-IAMAttachedRolePolicyList Cmdlet