STS / Client / assume_root

assume_root#

STS.Client.assume_root(**kwargs)#

Returns a set of short term credentials you can use to perform privileged tasks in a member account.

Before you can launch a privileged session, you must have enabled centralized root access in your organization. For steps to enable this feature, see Centralize root access for member accounts in the IAM User Guide.

Note

The global endpoint is not supported for AssumeRoot. You must send this request to a Regional STS endpoint. For more information, see Endpoints.

You can track AssumeRoot in CloudTrail logs to determine what actions were performed in a session. For more information, see Track privileged tasks in CloudTrail in the IAM User Guide.

See also: AWS API Documentation

Request Syntax

response = client.assume_root(
    TargetPrincipal='string',
    TaskPolicyArn={
        'arn': 'string'
    },
    DurationSeconds=123
)
Parameters:

  • TargetPrincipal (string) –

    [REQUIRED]

    The member account principal ARN or account ID.

  • TaskPolicyArn (dict) –

    [REQUIRED]

    The identity based policy that scopes the session to the privileged tasks that can be performed. You can use one of following Amazon Web Services managed policies to scope root session actions. You can add additional customer managed policies to further limit the permissions for the root session.

  • DurationSeconds (integer) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'Credentials': {
        'AccessKeyId': 'string',
        'SecretAccessKey': 'string',
        'SessionToken': 'string',
        'Expiration': datetime(2015, 1, 1)
    },
    'SourceIdentity': 'string'
}

Response Structure

  • (dict) –

    • Credentials (dict) –

      The temporary security credentials, which include an access key ID, a secret access key, and a security token.

      Note

      The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

      • AccessKeyId (string) –

        The access key ID that identifies the temporary security credentials.

      • SecretAccessKey (string) –

        The secret access key that can be used to sign requests.

      • SessionToken (string) –

        The token that users must pass to the service API to use the temporary credentials.

      • Expiration (datetime) –

        The date on which the current credentials expire.

    • SourceIdentity (string) –

      The source identity specified by the principal that is calling the AssumeRoot operation.

      You can use the aws:SourceIdentity condition key to control access based on the value of source identity. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.

      The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Exceptions