Skip to content

IAM  >  Operations  >  put_user_permissions_boundary

put_user_permissions_boundary

Operation

put_user_permissions_boundary async

put_user_permissions_boundary(request: PutUserPermissionsBoundaryInput | PutUserPermissionsBoundaryInputDict, /, *, plugins: list[Plugin] | None = None) -> PutUserPermissionsBoundaryOutput
put_user_permissions_boundary(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutUserPermissionsBoundaryInputDict]) -> PutUserPermissionsBoundaryOutput

Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.

Warning

Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.

Parameters:

Name Type Description Default
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

Returns:

Type Description
PutUserPermissionsBoundaryOutput

An instance of PutUserPermissionsBoundaryOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

PutUserPermissionsBoundaryInput dataclass

Bases: _SerdeShape

Dataclass for PutUserPermissionsBoundaryInput structure.

Attributes
permissions_boundary class-attribute instance-attribute
permissions_boundary: str | None = ...

The ARN of the managed policy that is used to set the permissions boundary for the user.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.

user_name class-attribute instance-attribute
user_name: str | None = ...

The name (friendly name, not ARN) of the IAM user for which you want to set the permissions boundary.

Dictionaries

PutUserPermissionsBoundaryInputDict

Bases: TypedDict

Dictionary form of PutUserPermissionsBoundaryInput.

Attributes
permissions_boundary instance-attribute
permissions_boundary: Required[str]

The ARN of the managed policy that is used to set the permissions boundary for the user.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.

user_name instance-attribute
user_name: Required[str]

The name (friendly name, not ARN) of the IAM user for which you want to set the permissions boundary.

Output

PutUserPermissionsBoundaryOutput dataclass

Bases: _SerdeShape

Dataclass for PutUserPermissionsBoundaryOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.