list_attached_role_policies¶
Operation¶
list_attached_role_policies
¶
list_attached_role_policies(request: ListAttachedRolePoliciesInput | ListAttachedRolePoliciesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAttachedRolePoliciesInputDict]) -> ListAttachedRolePoliciesOutput
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 ListRolePolicies. 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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListAttachedRolePoliciesInput | ListAttachedRolePoliciesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListAttachedRolePoliciesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListAttachedRolePoliciesOutput
|
An instance of |
list_attached_role_policies
async
¶
list_attached_role_policies(request: ListAttachedRolePoliciesInput | ListAttachedRolePoliciesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAttachedRolePoliciesInputDict]) -> ListAttachedRolePoliciesOutput
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 ListRolePolicies. 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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListAttachedRolePoliciesInput | ListAttachedRolePoliciesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListAttachedRolePoliciesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListAttachedRolePoliciesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListAttachedRolePoliciesInputDict
¶
Bases: TypedDict
Dictionary form of ListAttachedRolePoliciesInput.
Attributes¶
marker
instance-attribute
¶
marker: str | None
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.
max_items
instance-attribute
¶
max_items: int | None
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.
path_prefix
instance-attribute
¶
path_prefix: str | None
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 (through 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.
role_name
instance-attribute
¶
The name (friendly name, not ARN) of the role to list attached policies for.
This parameter allows (through 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: _+=,.@-
ListAttachedRolePoliciesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListAttachedRolePoliciesInput structure.
Attributes¶
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
max_items
class-attribute
instance-attribute
¶
max_items: int | None = ...
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.
path_prefix
class-attribute
instance-attribute
¶
path_prefix: str | None = ...
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 (through 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.
role_name
class-attribute
instance-attribute
¶
role_name: str | None = ...
The name (friendly name, not ARN) of the role to list attached policies for.
This parameter allows (through 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: _+=,.@-
Output¶
ListAttachedRolePoliciesOutput
dataclass
¶
Bases: _SerdeShape
Contains the response to a successful ListAttachedRolePolicies request.
Attributes¶
attached_policies
class-attribute
instance-attribute
¶
attached_policies: list[AttachedPolicy] | None = ...
A list of the attached policies.
is_truncated
class-attribute
instance-attribute
¶
is_truncated: bool = ...
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items. Note that
IAM might return fewer than the MaxItems number of results even when
there are more results available. We recommend that you check
IsTruncated after every call to ensure that you receive all your
results.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
When IsTruncated is true, this element is present and contains the
value to use for the Marker parameter in a subsequent pagination
request.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.