Typed dictionaries

Index > STS > Typed dictionaries

Auto-generated documentation for STS type annotations stubs module mypy-boto3-sts.

PolicyDescriptorTypeTypeDef

Usage Example

from mypy_boto3_sts.type_defs import PolicyDescriptorTypeTypeDef

def get_value() -> PolicyDescriptorTypeTypeDef:
    return {
        "arn": ...,
    }

Definition

class PolicyDescriptorTypeTypeDef(TypedDict):
    arn: NotRequired[str],

TagTypeDef

Usage Example

from mypy_boto3_sts.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }

Definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

AssumedRoleUserTypeDef

Usage Example

from mypy_boto3_sts.type_defs import AssumedRoleUserTypeDef

def get_value() -> AssumedRoleUserTypeDef:
    return {
        "AssumedRoleId": ...,
        "Arn": ...,
    }

Definition

class AssumedRoleUserTypeDef(TypedDict):
    AssumedRoleId: str,
    Arn: str,

CredentialsTypeDef

Usage Example

from mypy_boto3_sts.type_defs import CredentialsTypeDef

def get_value() -> CredentialsTypeDef:
    return {
        "AccessKeyId": ...,
        "SecretAccessKey": ...,
        "SessionToken": ...,
        "Expiration": ...,
    }

Definition

class CredentialsTypeDef(TypedDict):
    AccessKeyId: str,
    SecretAccessKey: str,
    SessionToken: str,
    Expiration: datetime,

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_sts.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DecodeAuthorizationMessageRequestRequestTypeDef

Usage Example

from mypy_boto3_sts.type_defs import DecodeAuthorizationMessageRequestRequestTypeDef

def get_value() -> DecodeAuthorizationMessageRequestRequestTypeDef:
    return {
        "EncodedMessage": ...,
    }

Definition

class DecodeAuthorizationMessageRequestRequestTypeDef(TypedDict):
    EncodedMessage: str,

FederatedUserTypeDef

Usage Example

from mypy_boto3_sts.type_defs import FederatedUserTypeDef

def get_value() -> FederatedUserTypeDef:
    return {
        "FederatedUserId": ...,
        "Arn": ...,
    }

Definition

class FederatedUserTypeDef(TypedDict):
    FederatedUserId: str,
    Arn: str,

GetAccessKeyInfoRequestRequestTypeDef

Usage Example

from mypy_boto3_sts.type_defs import GetAccessKeyInfoRequestRequestTypeDef

def get_value() -> GetAccessKeyInfoRequestRequestTypeDef:
    return {
        "AccessKeyId": ...,
    }

Definition

class GetAccessKeyInfoRequestRequestTypeDef(TypedDict):
    AccessKeyId: str,

GetSessionTokenRequestRequestTypeDef

Usage Example

from mypy_boto3_sts.type_defs import GetSessionTokenRequestRequestTypeDef

def get_value() -> GetSessionTokenRequestRequestTypeDef:
    return {
        "DurationSeconds": ...,
    }

Definition

class GetSessionTokenRequestRequestTypeDef(TypedDict):
    DurationSeconds: NotRequired[int],
    SerialNumber: NotRequired[str],
    TokenCode: NotRequired[str],

AssumeRoleWithSAMLRequestRequestTypeDef

Usage Example

from mypy_boto3_sts.type_defs import AssumeRoleWithSAMLRequestRequestTypeDef

def get_value() -> AssumeRoleWithSAMLRequestRequestTypeDef:
    return {
        "RoleArn": ...,
        "PrincipalArn": ...,
        "SAMLAssertion": ...,
    }

Definition

class AssumeRoleWithSAMLRequestRequestTypeDef(TypedDict):
    RoleArn: str,
    PrincipalArn: str,
    SAMLAssertion: str,
    PolicyArns: NotRequired[Sequence[PolicyDescriptorTypeTypeDef]],  # (1)
    Policy: NotRequired[str],
    DurationSeconds: NotRequired[int],

1. See PolicyDescriptorTypeTypeDef

AssumeRoleWithWebIdentityRequestRequestTypeDef

Usage Example

from mypy_boto3_sts.type_defs import AssumeRoleWithWebIdentityRequestRequestTypeDef

def get_value() -> AssumeRoleWithWebIdentityRequestRequestTypeDef:
    return {
        "RoleArn": ...,
        "RoleSessionName": ...,
        "WebIdentityToken": ...,
    }

Definition

class AssumeRoleWithWebIdentityRequestRequestTypeDef(TypedDict):
    RoleArn: str,
    RoleSessionName: str,
    WebIdentityToken: str,
    ProviderId: NotRequired[str],
    PolicyArns: NotRequired[Sequence[PolicyDescriptorTypeTypeDef]],  # (1)
    Policy: NotRequired[str],
    DurationSeconds: NotRequired[int],

1. See PolicyDescriptorTypeTypeDef

AssumeRoleRequestRequestTypeDef

Usage Example

from mypy_boto3_sts.type_defs import AssumeRoleRequestRequestTypeDef

def get_value() -> AssumeRoleRequestRequestTypeDef:
    return {
        "RoleArn": ...,
        "RoleSessionName": ...,
    }

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

1. See PolicyDescriptorTypeTypeDef
2. See TagTypeDef

GetFederationTokenRequestRequestTypeDef

Usage Example

from mypy_boto3_sts.type_defs import GetFederationTokenRequestRequestTypeDef

def get_value() -> GetFederationTokenRequestRequestTypeDef:
    return {
        "Name": ...,
    }

Definition

class GetFederationTokenRequestRequestTypeDef(TypedDict):
    Name: str,
    Policy: NotRequired[str],
    PolicyArns: NotRequired[Sequence[PolicyDescriptorTypeTypeDef]],  # (1)
    DurationSeconds: NotRequired[int],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)

1. See PolicyDescriptorTypeTypeDef
2. See TagTypeDef

AssumeRoleResponseTypeDef

Usage Example

from mypy_boto3_sts.type_defs import AssumeRoleResponseTypeDef

def get_value() -> AssumeRoleResponseTypeDef:
    return {
        "Credentials": ...,
        "AssumedRoleUser": ...,
        "PackedPolicySize": ...,
        "SourceIdentity": ...,
        "ResponseMetadata": ...,
    }

Definition

class AssumeRoleResponseTypeDef(TypedDict):
    Credentials: CredentialsTypeDef,  # (1)
    AssumedRoleUser: AssumedRoleUserTypeDef,  # (2)
    PackedPolicySize: int,
    SourceIdentity: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See CredentialsTypeDef
2. See AssumedRoleUserTypeDef
3. See ResponseMetadataTypeDef

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": ...,
    }

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)

1. See CredentialsTypeDef
2. See AssumedRoleUserTypeDef
3. See ResponseMetadataTypeDef

AssumeRoleWithWebIdentityResponseTypeDef

Usage Example

from mypy_boto3_sts.type_defs import AssumeRoleWithWebIdentityResponseTypeDef

def get_value() -> AssumeRoleWithWebIdentityResponseTypeDef:
    return {
        "Credentials": ...,
        "SubjectFromWebIdentityToken": ...,
        "AssumedRoleUser": ...,
        "PackedPolicySize": ...,
        "Provider": ...,
        "Audience": ...,
        "SourceIdentity": ...,
        "ResponseMetadata": ...,
    }

Definition

class AssumeRoleWithWebIdentityResponseTypeDef(TypedDict):
    Credentials: CredentialsTypeDef,  # (1)
    SubjectFromWebIdentityToken: str,
    AssumedRoleUser: AssumedRoleUserTypeDef,  # (2)
    PackedPolicySize: int,
    Provider: str,
    Audience: str,
    SourceIdentity: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See CredentialsTypeDef
2. See AssumedRoleUserTypeDef
3. See ResponseMetadataTypeDef

DecodeAuthorizationMessageResponseTypeDef

Usage Example

from mypy_boto3_sts.type_defs import DecodeAuthorizationMessageResponseTypeDef

def get_value() -> DecodeAuthorizationMessageResponseTypeDef:
    return {
        "DecodedMessage": ...,
        "ResponseMetadata": ...,
    }

Definition

class DecodeAuthorizationMessageResponseTypeDef(TypedDict):
    DecodedMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetAccessKeyInfoResponseTypeDef

Usage Example

from mypy_boto3_sts.type_defs import GetAccessKeyInfoResponseTypeDef

def get_value() -> GetAccessKeyInfoResponseTypeDef:
    return {
        "Account": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetAccessKeyInfoResponseTypeDef(TypedDict):
    Account: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetCallerIdentityResponseTypeDef

Usage Example

from mypy_boto3_sts.type_defs import GetCallerIdentityResponseTypeDef

def get_value() -> GetCallerIdentityResponseTypeDef:
    return {
        "UserId": ...,
        "Account": ...,
        "Arn": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetCallerIdentityResponseTypeDef(TypedDict):
    UserId: str,
    Account: str,
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetSessionTokenResponseTypeDef

Usage Example

from mypy_boto3_sts.type_defs import GetSessionTokenResponseTypeDef

def get_value() -> GetSessionTokenResponseTypeDef:
    return {
        "Credentials": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetSessionTokenResponseTypeDef(TypedDict):
    Credentials: CredentialsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CredentialsTypeDef
2. See ResponseMetadataTypeDef

GetFederationTokenResponseTypeDef

Usage Example

from mypy_boto3_sts.type_defs import GetFederationTokenResponseTypeDef

def get_value() -> GetFederationTokenResponseTypeDef:
    return {
        "Credentials": ...,
        "FederatedUser": ...,
        "PackedPolicySize": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetFederationTokenResponseTypeDef(TypedDict):
    Credentials: CredentialsTypeDef,  # (1)
    FederatedUser: FederatedUserTypeDef,  # (2)
    PackedPolicySize: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See CredentialsTypeDef
2. See FederatedUserTypeDef
3. See ResponseMetadataTypeDef