Skip to content

Type definitions#

Index > SignInService > Type definitions

Auto-generated documentation for SignInService type annotations stubs module mypy-boto3-signin.

AccessTokenTypeDef#

# AccessTokenTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import AccessTokenTypeDef


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


# AccessTokenTypeDef definition

class AccessTokenTypeDef(TypedDict):
    accessKeyId: str,
    secretAccessKey: str,
    sessionToken: str,

CreateOAuth2TokenRequestBodyTypeDef#

# CreateOAuth2TokenRequestBodyTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import CreateOAuth2TokenRequestBodyTypeDef


def get_value() -> CreateOAuth2TokenRequestBodyTypeDef:
    return {
        "clientId": ...,
    }


# CreateOAuth2TokenRequestBodyTypeDef definition

class CreateOAuth2TokenRequestBodyTypeDef(TypedDict):
    clientId: str,
    grantType: str,
    code: NotRequired[str],
    redirectUri: NotRequired[str],
    codeVerifier: NotRequired[str],
    refreshToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_signin.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],

DeleteConsoleAuthorizationConfigurationInputTypeDef#

# DeleteConsoleAuthorizationConfigurationInputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import DeleteConsoleAuthorizationConfigurationInputTypeDef


def get_value() -> DeleteConsoleAuthorizationConfigurationInputTypeDef:
    return {
        "targetId": ...,
    }


# DeleteConsoleAuthorizationConfigurationInputTypeDef definition

class DeleteConsoleAuthorizationConfigurationInputTypeDef(TypedDict):
    targetId: NotRequired[str],

DeleteResourcePermissionStatementInputTypeDef#

# DeleteResourcePermissionStatementInputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import DeleteResourcePermissionStatementInputTypeDef


def get_value() -> DeleteResourcePermissionStatementInputTypeDef:
    return {
        "statementId": ...,
    }


# DeleteResourcePermissionStatementInputTypeDef definition

class DeleteResourcePermissionStatementInputTypeDef(TypedDict):
    statementId: str,
    clientToken: NotRequired[str],

GetConsoleAuthorizationConfigurationInputTypeDef#

# GetConsoleAuthorizationConfigurationInputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import GetConsoleAuthorizationConfigurationInputTypeDef


def get_value() -> GetConsoleAuthorizationConfigurationInputTypeDef:
    return {
        "targetId": ...,
    }


# GetConsoleAuthorizationConfigurationInputTypeDef definition

class GetConsoleAuthorizationConfigurationInputTypeDef(TypedDict):
    targetId: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import PaginatorConfigTypeDef


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


# PaginatorConfigTypeDef definition

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

ListResourcePermissionStatementsInputTypeDef#

# ListResourcePermissionStatementsInputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import ListResourcePermissionStatementsInputTypeDef


def get_value() -> ListResourcePermissionStatementsInputTypeDef:
    return {
        "maxResults": ...,
    }


# ListResourcePermissionStatementsInputTypeDef definition

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

PermissionStatementSummaryTypeDef#

# PermissionStatementSummaryTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import PermissionStatementSummaryTypeDef


def get_value() -> PermissionStatementSummaryTypeDef:
    return {
        "sid": ...,
    }


# PermissionStatementSummaryTypeDef definition

class PermissionStatementSummaryTypeDef(TypedDict):
    sid: str,
    condition: NotRequired[dict[str, dict[str, list[str]]]],

PolicyStatementTypeDef#

# PolicyStatementTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import PolicyStatementTypeDef


def get_value() -> PolicyStatementTypeDef:
    return {
        "effect": ...,
    }


# PolicyStatementTypeDef definition

class PolicyStatementTypeDef(TypedDict):
    effect: NotRequired[str],
    principal: NotRequired[dict[str, str]],
    action: NotRequired[list[str]],
    resource: NotRequired[str],
    condition: NotRequired[dict[str, dict[str, list[str]]]],

PutConsoleAuthorizationConfigurationInputTypeDef#

# PutConsoleAuthorizationConfigurationInputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import PutConsoleAuthorizationConfigurationInputTypeDef


def get_value() -> PutConsoleAuthorizationConfigurationInputTypeDef:
    return {
        "targetId": ...,
    }


# PutConsoleAuthorizationConfigurationInputTypeDef definition

class PutConsoleAuthorizationConfigurationInputTypeDef(TypedDict):
    targetId: NotRequired[str],

PutResourcePermissionStatementInputTypeDef#

# PutResourcePermissionStatementInputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import PutResourcePermissionStatementInputTypeDef


def get_value() -> PutResourcePermissionStatementInputTypeDef:
    return {
        "sourceVpc": ...,
    }


# PutResourcePermissionStatementInputTypeDef definition

class PutResourcePermissionStatementInputTypeDef(TypedDict):
    sourceVpc: NotRequired[str],
    signinSourceVpce: NotRequired[str],
    consoleSourceVpce: NotRequired[str],
    vpcSourceIp: NotRequired[str],
    sourceIp: NotRequired[str],
    requestedRegion: NotRequired[str],
    excludedPrincipal: NotRequired[str],
    clientToken: NotRequired[str],

CreateOAuth2TokenResponseBodyTypeDef#

# CreateOAuth2TokenResponseBodyTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import CreateOAuth2TokenResponseBodyTypeDef


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


# CreateOAuth2TokenResponseBodyTypeDef definition

class CreateOAuth2TokenResponseBodyTypeDef(TypedDict):
    accessToken: AccessTokenTypeDef,  # (1)
    tokenType: str,
    expiresIn: int,
    refreshToken: str,
    idToken: NotRequired[str],
  1. See AccessTokenTypeDef

CreateOAuth2TokenRequestTypeDef#

# CreateOAuth2TokenRequestTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import CreateOAuth2TokenRequestTypeDef


def get_value() -> CreateOAuth2TokenRequestTypeDef:
    return {
        "tokenInput": ...,
    }


# CreateOAuth2TokenRequestTypeDef definition

class CreateOAuth2TokenRequestTypeDef(TypedDict):
    tokenInput: CreateOAuth2TokenRequestBodyTypeDef,  # (1)
  1. See CreateOAuth2TokenRequestBodyTypeDef

DeleteConsoleAuthorizationConfigurationOutputTypeDef#

# DeleteConsoleAuthorizationConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import DeleteConsoleAuthorizationConfigurationOutputTypeDef


def get_value() -> DeleteConsoleAuthorizationConfigurationOutputTypeDef:
    return {
        "targetId": ...,
    }


# DeleteConsoleAuthorizationConfigurationOutputTypeDef definition

class DeleteConsoleAuthorizationConfigurationOutputTypeDef(TypedDict):
    targetId: str,
    scope: str,
    consoleAuthorizationEnabled: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetConsoleAuthorizationConfigurationOutputTypeDef#

# GetConsoleAuthorizationConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import GetConsoleAuthorizationConfigurationOutputTypeDef


def get_value() -> GetConsoleAuthorizationConfigurationOutputTypeDef:
    return {
        "targetId": ...,
    }


# GetConsoleAuthorizationConfigurationOutputTypeDef definition

class GetConsoleAuthorizationConfigurationOutputTypeDef(TypedDict):
    targetId: str,
    scope: str,
    consoleAuthorizationEnabled: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutConsoleAuthorizationConfigurationOutputTypeDef#

# PutConsoleAuthorizationConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import PutConsoleAuthorizationConfigurationOutputTypeDef


def get_value() -> PutConsoleAuthorizationConfigurationOutputTypeDef:
    return {
        "targetId": ...,
    }


# PutConsoleAuthorizationConfigurationOutputTypeDef definition

class PutConsoleAuthorizationConfigurationOutputTypeDef(TypedDict):
    targetId: str,
    scope: str,
    consoleAuthorizationEnabled: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutResourcePermissionStatementOutputTypeDef#

# PutResourcePermissionStatementOutputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import PutResourcePermissionStatementOutputTypeDef


def get_value() -> PutResourcePermissionStatementOutputTypeDef:
    return {
        "statementId": ...,
    }


# PutResourcePermissionStatementOutputTypeDef definition

class PutResourcePermissionStatementOutputTypeDef(TypedDict):
    statementId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListResourcePermissionStatementsInputPaginateTypeDef#

# ListResourcePermissionStatementsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import ListResourcePermissionStatementsInputPaginateTypeDef


def get_value() -> ListResourcePermissionStatementsInputPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListResourcePermissionStatementsInputPaginateTypeDef definition

class ListResourcePermissionStatementsInputPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListResourcePermissionStatementsOutputTypeDef#

# ListResourcePermissionStatementsOutputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import ListResourcePermissionStatementsOutputTypeDef


def get_value() -> ListResourcePermissionStatementsOutputTypeDef:
    return {
        "permissionStatements": ...,
    }


# ListResourcePermissionStatementsOutputTypeDef definition

class ListResourcePermissionStatementsOutputTypeDef(TypedDict):
    permissionStatements: list[PermissionStatementSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[PermissionStatementSummaryTypeDef]
  2. See ResponseMetadataTypeDef

SigninResourceBasedPolicyTypeDef#

# SigninResourceBasedPolicyTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import SigninResourceBasedPolicyTypeDef


def get_value() -> SigninResourceBasedPolicyTypeDef:
    return {
        "version": ...,
    }


# SigninResourceBasedPolicyTypeDef definition

class SigninResourceBasedPolicyTypeDef(TypedDict):
    version: NotRequired[str],
    statement: NotRequired[list[PolicyStatementTypeDef]],  # (1)
  1. See list[PolicyStatementTypeDef]

CreateOAuth2TokenResponseTypeDef#

# CreateOAuth2TokenResponseTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import CreateOAuth2TokenResponseTypeDef


def get_value() -> CreateOAuth2TokenResponseTypeDef:
    return {
        "tokenOutput": ...,
    }


# CreateOAuth2TokenResponseTypeDef definition

class CreateOAuth2TokenResponseTypeDef(TypedDict):
    tokenOutput: CreateOAuth2TokenResponseBodyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CreateOAuth2TokenResponseBodyTypeDef
  2. See ResponseMetadataTypeDef

GetResourcePolicyOutputTypeDef#

# GetResourcePolicyOutputTypeDef TypedDict usage example

from mypy_boto3_signin.type_defs import GetResourcePolicyOutputTypeDef


def get_value() -> GetResourcePolicyOutputTypeDef:
    return {
        "signinResourceBasedPolicy": ...,
    }


# GetResourcePolicyOutputTypeDef definition

class GetResourcePolicyOutputTypeDef(TypedDict):
    signinResourceBasedPolicy: SigninResourceBasedPolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SigninResourceBasedPolicyTypeDef
  2. See ResponseMetadataTypeDef