Skip to content

update_assume_role_policy

Operation

update_assume_role_policy

update_assume_role_policy(request: UpdateAssumeRolePolicyInput | UpdateAssumeRolePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAssumeRolePolicyInputDict]) -> UpdateAssumeRolePolicyOutput

Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, see Using roles to delegate permissions and federate identities.

Parameters:

Name Type Description Default
request UpdateAssumeRolePolicyInput | UpdateAssumeRolePolicyInputDict | 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[UpdateAssumeRolePolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateAssumeRolePolicyOutput

An instance of UpdateAssumeRolePolicyOutput.

update_assume_role_policy async

update_assume_role_policy(request: UpdateAssumeRolePolicyInput | UpdateAssumeRolePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAssumeRolePolicyInputDict]) -> UpdateAssumeRolePolicyOutput

Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, see Using roles to delegate permissions and federate identities.

Parameters:

Name Type Description Default
request UpdateAssumeRolePolicyInput | UpdateAssumeRolePolicyInputDict | 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[UpdateAssumeRolePolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateAssumeRolePolicyOutput

An instance of UpdateAssumeRolePolicyOutput.

Input

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

UpdateAssumeRolePolicyInputDict

Bases: TypedDict

Dictionary form of UpdateAssumeRolePolicyInput.

Attributes

policy_document instance-attribute
policy_document: Required[str]

The policy that grants an entity permission to assume the role.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

role_name instance-attribute
role_name: Required[str]

The name of the role to update with the new policy.

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: _+=,.@-

UpdateAssumeRolePolicyInput dataclass

Bases: _SerdeShape

Dataclass for UpdateAssumeRolePolicyInput structure.

Attributes

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

The policy that grants an entity permission to assume the role.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

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

The name of the role to update with the new policy.

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

UpdateAssumeRolePolicyOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateAssumeRolePolicyOutput 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.