Typed dictionaries#
Auto-generated documentation for STS type annotations stubs module mypy-boto3-sts.
PolicyDescriptorTypeTypeDef#
# PolicyDescriptorTypeTypeDef usage example
from mypy_boto3_sts.type_defs import PolicyDescriptorTypeTypeDef
def get_value() -> PolicyDescriptorTypeTypeDef:
return {
"arn": ...,
}
# PolicyDescriptorTypeTypeDef definition
class PolicyDescriptorTypeTypeDef(TypedDict):
arn: NotRequired[str],
TagTypeDef#
# TagTypeDef usage example
from mypy_boto3_sts.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
AssumedRoleUserTypeDef#
# AssumedRoleUserTypeDef usage example
from mypy_boto3_sts.type_defs import AssumedRoleUserTypeDef
def get_value() -> AssumedRoleUserTypeDef:
return {
"AssumedRoleId": ...,
"Arn": ...,
}
# AssumedRoleUserTypeDef definition
class AssumedRoleUserTypeDef(TypedDict):
AssumedRoleId: str,
Arn: str,
CredentialsTypeDef#
# CredentialsTypeDef usage example
from mypy_boto3_sts.type_defs import CredentialsTypeDef
def get_value() -> CredentialsTypeDef:
return {
"AccessKeyId": ...,
"SecretAccessKey": ...,
"SessionToken": ...,
"Expiration": ...,
}
# CredentialsTypeDef definition
class CredentialsTypeDef(TypedDict):
AccessKeyId: str,
SecretAccessKey: str,
SessionToken: str,
Expiration: datetime,
DecodeAuthorizationMessageRequestRequestTypeDef#
# DecodeAuthorizationMessageRequestRequestTypeDef usage example
from mypy_boto3_sts.type_defs import DecodeAuthorizationMessageRequestRequestTypeDef
def get_value() -> DecodeAuthorizationMessageRequestRequestTypeDef:
return {
"EncodedMessage": ...,
}
# DecodeAuthorizationMessageRequestRequestTypeDef definition
class DecodeAuthorizationMessageRequestRequestTypeDef(TypedDict):
EncodedMessage: str,
DecodeAuthorizationMessageResponseTypeDef#
# DecodeAuthorizationMessageResponseTypeDef usage example
from mypy_boto3_sts.type_defs import DecodeAuthorizationMessageResponseTypeDef
def get_value() -> DecodeAuthorizationMessageResponseTypeDef:
return {
"DecodedMessage": ...,
"ResponseMetadata": ...,
}
# DecodeAuthorizationMessageResponseTypeDef definition
class DecodeAuthorizationMessageResponseTypeDef(TypedDict):
DecodedMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
FederatedUserTypeDef#
# FederatedUserTypeDef usage example
from mypy_boto3_sts.type_defs import FederatedUserTypeDef
def get_value() -> FederatedUserTypeDef:
return {
"FederatedUserId": ...,
"Arn": ...,
}
# FederatedUserTypeDef definition
class FederatedUserTypeDef(TypedDict):
FederatedUserId: str,
Arn: str,
GetAccessKeyInfoRequestRequestTypeDef#
# GetAccessKeyInfoRequestRequestTypeDef usage example
from mypy_boto3_sts.type_defs import GetAccessKeyInfoRequestRequestTypeDef
def get_value() -> GetAccessKeyInfoRequestRequestTypeDef:
return {
"AccessKeyId": ...,
}
# GetAccessKeyInfoRequestRequestTypeDef definition
class GetAccessKeyInfoRequestRequestTypeDef(TypedDict):
AccessKeyId: str,
GetAccessKeyInfoResponseTypeDef#
# GetAccessKeyInfoResponseTypeDef usage example
from mypy_boto3_sts.type_defs import GetAccessKeyInfoResponseTypeDef
def get_value() -> GetAccessKeyInfoResponseTypeDef:
return {
"Account": ...,
"ResponseMetadata": ...,
}
# GetAccessKeyInfoResponseTypeDef definition
class GetAccessKeyInfoResponseTypeDef(TypedDict):
Account: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCallerIdentityResponseTypeDef#
# GetCallerIdentityResponseTypeDef usage example
from mypy_boto3_sts.type_defs import GetCallerIdentityResponseTypeDef
def get_value() -> GetCallerIdentityResponseTypeDef:
return {
"UserId": ...,
"Account": ...,
"Arn": ...,
"ResponseMetadata": ...,
}
# GetCallerIdentityResponseTypeDef definition
class GetCallerIdentityResponseTypeDef(TypedDict):
UserId: str,
Account: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetSessionTokenRequestRequestTypeDef#
# GetSessionTokenRequestRequestTypeDef usage example
from mypy_boto3_sts.type_defs import GetSessionTokenRequestRequestTypeDef
def get_value() -> GetSessionTokenRequestRequestTypeDef:
return {
"DurationSeconds": ...,
}
# GetSessionTokenRequestRequestTypeDef definition
class GetSessionTokenRequestRequestTypeDef(TypedDict):
DurationSeconds: NotRequired[int],
SerialNumber: NotRequired[str],
TokenCode: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_sts.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AssumeRoleWithSAMLRequestRequestTypeDef#
# AssumeRoleWithSAMLRequestRequestTypeDef usage example
from mypy_boto3_sts.type_defs import AssumeRoleWithSAMLRequestRequestTypeDef
def get_value() -> AssumeRoleWithSAMLRequestRequestTypeDef:
return {
"RoleArn": ...,
"PrincipalArn": ...,
"SAMLAssertion": ...,
}
# AssumeRoleWithSAMLRequestRequestTypeDef definition
class AssumeRoleWithSAMLRequestRequestTypeDef(TypedDict):
RoleArn: str,
PrincipalArn: str,
SAMLAssertion: str,
PolicyArns: NotRequired[Sequence[PolicyDescriptorTypeTypeDef]], # (1)
Policy: NotRequired[str],
DurationSeconds: NotRequired[int],
AssumeRoleWithWebIdentityRequestRequestTypeDef#
# AssumeRoleWithWebIdentityRequestRequestTypeDef usage example
from mypy_boto3_sts.type_defs import AssumeRoleWithWebIdentityRequestRequestTypeDef
def get_value() -> AssumeRoleWithWebIdentityRequestRequestTypeDef:
return {
"RoleArn": ...,
"RoleSessionName": ...,
"WebIdentityToken": ...,
}
# AssumeRoleWithWebIdentityRequestRequestTypeDef definition
class AssumeRoleWithWebIdentityRequestRequestTypeDef(TypedDict):
RoleArn: str,
RoleSessionName: str,
WebIdentityToken: str,
ProviderId: NotRequired[str],
PolicyArns: NotRequired[Sequence[PolicyDescriptorTypeTypeDef]], # (1)
Policy: NotRequired[str],
DurationSeconds: NotRequired[int],
AssumeRoleRequestRequestTypeDef#
# AssumeRoleRequestRequestTypeDef usage example
from mypy_boto3_sts.type_defs import AssumeRoleRequestRequestTypeDef
def get_value() -> AssumeRoleRequestRequestTypeDef:
return {
"RoleArn": ...,
"RoleSessionName": ...,
}
# AssumeRoleRequestRequestTypeDef definition
class AssumeRoleRequestRequestTypeDef(TypedDict):
RoleArn: str,
RoleSessionName: str,
PolicyArns: NotRequired[Sequence[PolicyDescriptorTypeTypeDef]], # (1)
Policy: NotRequired[str],
DurationSeconds: NotRequired[int],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
TransitiveTagKeys: NotRequired[Sequence[str]],
ExternalId: NotRequired[str],
SerialNumber: NotRequired[str],
TokenCode: NotRequired[str],
SourceIdentity: NotRequired[str],
GetFederationTokenRequestRequestTypeDef#
# GetFederationTokenRequestRequestTypeDef usage example
from mypy_boto3_sts.type_defs import GetFederationTokenRequestRequestTypeDef
def get_value() -> GetFederationTokenRequestRequestTypeDef:
return {
"Name": ...,
}
# GetFederationTokenRequestRequestTypeDef definition
class GetFederationTokenRequestRequestTypeDef(TypedDict):
Name: str,
Policy: NotRequired[str],
PolicyArns: NotRequired[Sequence[PolicyDescriptorTypeTypeDef]], # (1)
DurationSeconds: NotRequired[int],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
AssumeRoleResponseTypeDef#
# AssumeRoleResponseTypeDef usage example
from mypy_boto3_sts.type_defs import AssumeRoleResponseTypeDef
def get_value() -> AssumeRoleResponseTypeDef:
return {
"Credentials": ...,
"AssumedRoleUser": ...,
"PackedPolicySize": ...,
"SourceIdentity": ...,
"ResponseMetadata": ...,
}
# AssumeRoleResponseTypeDef definition
class AssumeRoleResponseTypeDef(TypedDict):
Credentials: CredentialsTypeDef, # (1)
AssumedRoleUser: AssumedRoleUserTypeDef, # (2)
PackedPolicySize: int,
SourceIdentity: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
AssumeRoleWithSAMLResponseTypeDef#
# AssumeRoleWithSAMLResponseTypeDef usage example
from mypy_boto3_sts.type_defs import AssumeRoleWithSAMLResponseTypeDef
def get_value() -> AssumeRoleWithSAMLResponseTypeDef:
return {
"Credentials": ...,
"AssumedRoleUser": ...,
"PackedPolicySize": ...,
"Subject": ...,
"SubjectType": ...,
"Issuer": ...,
"Audience": ...,
"NameQualifier": ...,
"SourceIdentity": ...,
"ResponseMetadata": ...,
}
# AssumeRoleWithSAMLResponseTypeDef definition
class AssumeRoleWithSAMLResponseTypeDef(TypedDict):
Credentials: CredentialsTypeDef, # (1)
AssumedRoleUser: AssumedRoleUserTypeDef, # (2)
PackedPolicySize: int,
Subject: str,
SubjectType: str,
Issuer: str,
Audience: str,
NameQualifier: str,
SourceIdentity: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
AssumeRoleWithWebIdentityResponseTypeDef#
# AssumeRoleWithWebIdentityResponseTypeDef usage example
from mypy_boto3_sts.type_defs import AssumeRoleWithWebIdentityResponseTypeDef
def get_value() -> AssumeRoleWithWebIdentityResponseTypeDef:
return {
"Credentials": ...,
"SubjectFromWebIdentityToken": ...,
"AssumedRoleUser": ...,
"PackedPolicySize": ...,
"Provider": ...,
"Audience": ...,
"SourceIdentity": ...,
"ResponseMetadata": ...,
}
# AssumeRoleWithWebIdentityResponseTypeDef definition
class AssumeRoleWithWebIdentityResponseTypeDef(TypedDict):
Credentials: CredentialsTypeDef, # (1)
SubjectFromWebIdentityToken: str,
AssumedRoleUser: AssumedRoleUserTypeDef, # (2)
PackedPolicySize: int,
Provider: str,
Audience: str,
SourceIdentity: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetSessionTokenResponseTypeDef#
# GetSessionTokenResponseTypeDef usage example
from mypy_boto3_sts.type_defs import GetSessionTokenResponseTypeDef
def get_value() -> GetSessionTokenResponseTypeDef:
return {
"Credentials": ...,
"ResponseMetadata": ...,
}
# GetSessionTokenResponseTypeDef definition
class GetSessionTokenResponseTypeDef(TypedDict):
Credentials: CredentialsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetFederationTokenResponseTypeDef#
# GetFederationTokenResponseTypeDef usage example
from mypy_boto3_sts.type_defs import GetFederationTokenResponseTypeDef
def get_value() -> GetFederationTokenResponseTypeDef:
return {
"Credentials": ...,
"FederatedUser": ...,
"PackedPolicySize": ...,
"ResponseMetadata": ...,
}
# GetFederationTokenResponseTypeDef definition
class GetFederationTokenResponseTypeDef(TypedDict):
Credentials: CredentialsTypeDef, # (1)
FederatedUser: FederatedUserTypeDef, # (2)
PackedPolicySize: int,
ResponseMetadata: ResponseMetadataTypeDef, # (3)