AssumeRoleConfig#

class boto3_refresh_session.utils.config.AssumeRoleConfig[source]#

Configuration for AWS STS AssumeRole API.

Attributes

RoleArn

(str) The Amazon Resource Name (ARN) of the role to assume.

RoleSessionName

(str, optional) An identifier for the assumed role session.

PolicyArns

(list of PolicyDescriptorType, optional) The Amazon Resource Names (ARNs) of the IAM managed policies to use as managed session policies.

Policy

(str, optional) An IAM policy in JSON format to use as an inline session policy.

DurationSeconds

(int, optional) The duration, in seconds, of the role session.

ExternalId

(str, optional) A unique identifier that might be required when you assume a role in another account.

SerialNumber

(str, optional) The identification number of the MFA device.

TokenCode

(str, optional) The value provided by the MFA device. Must be a 6-digit numeric string.

Tags

(list of Tag, optional) A list of session tags.

TransitiveTagKeys

(list of str, optional) A list of keys for session tags that you want to pass to the role session.

SourceIdentity

(str, optional) A unique identifier that is passed in the AssumeRole call.

ProvidedContexts

(list of ProvidedContext, optional) A list of context keys and values for the session.

Notes

Values can be accessed via dot-notation (e.g., config.RoleArn) or dictionary-style access (e.g., config['RoleArn']).

Accessing a valid but unset attribute (e.g., SerialNumber) via dot-notation returns None instead of raising an error. While this behavior is convenient, it may surprise users accustomed to seeing AttributeError exceptions in similar contexts.

For additional information on AWS specifications, refer to the API Reference for AssumeRole.

clear() → None.  Remove all items from D.[source]#
copy() → a shallow copy of D[source]#
fromkeys(iterable, value=None, /)[source]#

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)[source]#

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items[source]#
keys() → a set-like object providing a view on D's keys[source]#
pop(key, default=<unrepresentable>, /)[source]#

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(/)[source]#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key: str, default: Any | None = None) → None[source]#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from dict/iterable E and F.[source]#

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values[source]#