STSClientConfig#

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

Configuration for boto3 STS Client.

Attributes

service_name

(str, optional) The name of the AWS service. Defaults to ‘sts’.

region_name

(str, optional) The AWS region name.

api_version

(str, optional) The API version to use.

use_ssl

(bool, optional) Whether to use SSL.

verify

(bool or str, optional) Whether to verify SSL certificates or a path to a CA bundle.

endpoint_url

(str, optional) The complete URL to use for the constructed client.

aws_access_key_id

(str, optional) The AWS access key ID.

aws_secret_access_key

(str, optional) The AWS secret access key.

aws_session_token

(str, optional) The AWS session token.

config

(botocore.config.Config, optional) Advanced client configuration options.

aws_account_id

(str, optional) The AWS account ID associated with the credentials.

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.

service_name is enforced to be ‘sts’. If a different value is provided, it will be overridden to ‘sts’ with a warning.

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]#