Skip to content

Type definitions#

Index > SSO > Type definitions

Auto-generated documentation for SSO type annotations stubs module types-boto3-sso.

AccountInfoTypeDef#

# AccountInfoTypeDef TypedDict usage example

from types_boto3_sso.type_defs import AccountInfoTypeDef


def get_value() -> AccountInfoTypeDef:
    return {
        "accountId": ...,
    }


# AccountInfoTypeDef definition

class AccountInfoTypeDef(TypedDict):
    accountId: NotRequired[str],
    accountName: NotRequired[str],
    emailAddress: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_sso.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

GetRoleCredentialsRequestTypeDef#

# GetRoleCredentialsRequestTypeDef TypedDict usage example

from types_boto3_sso.type_defs import GetRoleCredentialsRequestTypeDef


def get_value() -> GetRoleCredentialsRequestTypeDef:
    return {
        "roleName": ...,
    }


# GetRoleCredentialsRequestTypeDef definition

class GetRoleCredentialsRequestTypeDef(TypedDict):
    roleName: str,
    accountId: str,
    accessToken: str,

RoleCredentialsTypeDef#

# RoleCredentialsTypeDef TypedDict usage example

from types_boto3_sso.type_defs import RoleCredentialsTypeDef


def get_value() -> RoleCredentialsTypeDef:
    return {
        "accessKeyId": ...,
    }


# RoleCredentialsTypeDef definition

class RoleCredentialsTypeDef(TypedDict):
    accessKeyId: NotRequired[str],
    secretAccessKey: NotRequired[str],
    sessionToken: NotRequired[str],
    expiration: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_sso.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAccountRolesRequestTypeDef#

# ListAccountRolesRequestTypeDef TypedDict usage example

from types_boto3_sso.type_defs import ListAccountRolesRequestTypeDef


def get_value() -> ListAccountRolesRequestTypeDef:
    return {
        "accessToken": ...,
    }


# ListAccountRolesRequestTypeDef definition

class ListAccountRolesRequestTypeDef(TypedDict):
    accessToken: str,
    accountId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

RoleInfoTypeDef#

# RoleInfoTypeDef TypedDict usage example

from types_boto3_sso.type_defs import RoleInfoTypeDef


def get_value() -> RoleInfoTypeDef:
    return {
        "roleName": ...,
    }


# RoleInfoTypeDef definition

class RoleInfoTypeDef(TypedDict):
    roleName: NotRequired[str],
    accountId: NotRequired[str],

ListAccountsRequestTypeDef#

# ListAccountsRequestTypeDef TypedDict usage example

from types_boto3_sso.type_defs import ListAccountsRequestTypeDef


def get_value() -> ListAccountsRequestTypeDef:
    return {
        "accessToken": ...,
    }


# ListAccountsRequestTypeDef definition

class ListAccountsRequestTypeDef(TypedDict):
    accessToken: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

LogoutRequestTypeDef#

# LogoutRequestTypeDef TypedDict usage example

from types_boto3_sso.type_defs import LogoutRequestTypeDef


def get_value() -> LogoutRequestTypeDef:
    return {
        "accessToken": ...,
    }


# LogoutRequestTypeDef definition

class LogoutRequestTypeDef(TypedDict):
    accessToken: str,

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from types_boto3_sso.type_defs import EmptyResponseMetadataTypeDef


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


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAccountsResponseTypeDef#

# ListAccountsResponseTypeDef TypedDict usage example

from types_boto3_sso.type_defs import ListAccountsResponseTypeDef


def get_value() -> ListAccountsResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListAccountsResponseTypeDef definition

class ListAccountsResponseTypeDef(TypedDict):
    accountList: List[AccountInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[AccountInfoTypeDef]
  2. See ResponseMetadataTypeDef

GetRoleCredentialsResponseTypeDef#

# GetRoleCredentialsResponseTypeDef TypedDict usage example

from types_boto3_sso.type_defs import GetRoleCredentialsResponseTypeDef


def get_value() -> GetRoleCredentialsResponseTypeDef:
    return {
        "roleCredentials": ...,
    }


# GetRoleCredentialsResponseTypeDef definition

class GetRoleCredentialsResponseTypeDef(TypedDict):
    roleCredentials: RoleCredentialsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RoleCredentialsTypeDef
  2. See ResponseMetadataTypeDef

ListAccountRolesRequestPaginateTypeDef#

# ListAccountRolesRequestPaginateTypeDef TypedDict usage example

from types_boto3_sso.type_defs import ListAccountRolesRequestPaginateTypeDef


def get_value() -> ListAccountRolesRequestPaginateTypeDef:
    return {
        "accessToken": ...,
    }


# ListAccountRolesRequestPaginateTypeDef definition

class ListAccountRolesRequestPaginateTypeDef(TypedDict):
    accessToken: str,
    accountId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAccountsRequestPaginateTypeDef#

# ListAccountsRequestPaginateTypeDef TypedDict usage example

from types_boto3_sso.type_defs import ListAccountsRequestPaginateTypeDef


def get_value() -> ListAccountsRequestPaginateTypeDef:
    return {
        "accessToken": ...,
    }


# ListAccountsRequestPaginateTypeDef definition

class ListAccountsRequestPaginateTypeDef(TypedDict):
    accessToken: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAccountRolesResponseTypeDef#

# ListAccountRolesResponseTypeDef TypedDict usage example

from types_boto3_sso.type_defs import ListAccountRolesResponseTypeDef


def get_value() -> ListAccountRolesResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListAccountRolesResponseTypeDef definition

class ListAccountRolesResponseTypeDef(TypedDict):
    roleList: List[RoleInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[RoleInfoTypeDef]
  2. See ResponseMetadataTypeDef