Skip to content

AssumeRootRequest

Source code in docs_src/capo_sts/types/assume_root_request.py
class AssumeRootRequest(TypedDict, closed=True):
    target_principal: "capo_sts.types.target_principal_type.TargetPrincipalType"
    """<p>The member account principal ARN or account ID.</p>"""
    task_policy_arn: "capo_sts.types.policy_descriptor_type.PolicyDescriptorType"
    """<p>The identity based policy that scopes the session to the privileged tasks that can be performed. You must use one of following Amazon Web Services managed policies to scope root session actions:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMAuditRootUserCredentials">IAMAuditRootUserCredentials</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMCreateRootUserPassword">IAMCreateRootUserPassword</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMDeleteRootUserCredentials">IAMDeleteRootUserCredentials</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-S3UnlockBucketPolicy">S3UnlockBucketPolicy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-SQSUnlockQueuePolicy">SQSUnlockQueuePolicy</a> </p> </li> </ul>"""
    duration_seconds: NotRequired[
        "capo_sts.types.root_duration_seconds_type.RootDurationSecondsType"
    ]
    """<p>The duration, in seconds, of the privileged session. The value can range from 0 seconds up to the maximum session duration of 900 seconds (15 minutes). If you specify a value higher than this setting, the operation fails.</p> <p>By default, the value is set to <code>900</code> seconds.</p>"""
    minimum_session_token_size: NotRequired[
        "capo_sts.types.minimum_session_token_size_type.minimumSessionTokenSizeType"
    ]

duration_seconds instance-attribute

duration_seconds: NotRequired[RootDurationSecondsType]

The duration, in seconds, of the privileged session. The value can range from 0 seconds up to the maximum session duration of 900 seconds (15 minutes). If you specify a value higher than this setting, the operation fails.

By default, the value is set to 900 seconds.

minimum_session_token_size instance-attribute

minimum_session_token_size: NotRequired[minimumSessionTokenSizeType]

target_principal instance-attribute

target_principal: TargetPrincipalType

The member account principal ARN or account ID.

task_policy_arn instance-attribute

task_policy_arn: PolicyDescriptorType

The identity based policy that scopes the session to the privileged tasks that can be performed. You must use one of following Amazon Web Services managed policies to scope root session actions: