AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ListEntitiesForPolicyInput

import "github.com/aws/aws-sdk-go/service/iam"

type ListEntitiesForPolicyInput struct { EntityFilter *string `type:"string" enum:"EntityType"` Marker *string `min:"1" type:"string"` MaxItems *int64 `min:"1" type:"integer"` PathPrefix *string `min:"1" type:"string"` PolicyArn *string `min:"20" type:"string" required:"true"` PolicyUsageFilter *string `type:"string" enum:"PolicyUsageType"` }

EntityFilter

Type: *string

The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.

Marker

Type: *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.

MaxItems

Type: *int64

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.

PathPrefix

Type: *string

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) 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.

PolicyArn

Type: *string

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the AWS General Reference.

PolicyArn is a required field

PolicyUsageFilter

Type: *string

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

Method

GoString

func (s ListEntitiesForPolicyInput) GoString() string

GoString returns the string representation

SetEntityFilter

func (s *ListEntitiesForPolicyInput) SetEntityFilter(v string) *ListEntitiesForPolicyInput

SetEntityFilter sets the EntityFilter field's value.

SetMarker

func (s *ListEntitiesForPolicyInput) SetMarker(v string) *ListEntitiesForPolicyInput

SetMarker sets the Marker field's value.

SetMaxItems

func (s *ListEntitiesForPolicyInput) SetMaxItems(v int64) *ListEntitiesForPolicyInput

SetMaxItems sets the MaxItems field's value.

SetPathPrefix

func (s *ListEntitiesForPolicyInput) SetPathPrefix(v string) *ListEntitiesForPolicyInput

SetPathPrefix sets the PathPrefix field's value.

SetPolicyArn

func (s *ListEntitiesForPolicyInput) SetPolicyArn(v string) *ListEntitiesForPolicyInput

SetPolicyArn sets the PolicyArn field's value.

SetPolicyUsageFilter

func (s *ListEntitiesForPolicyInput) SetPolicyUsageFilter(v string) *ListEntitiesForPolicyInput

SetPolicyUsageFilter sets the PolicyUsageFilter field's value.

String

func (s ListEntitiesForPolicyInput) String() string

String returns the string representation

Validate

func (s *ListEntitiesForPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: