SSOOIDCClient

Index > SSOOIDC > SSOOIDCClient

Auto-generated documentation for SSOOIDC type annotations stubs module mypy-boto3-sso-oidc.

SSOOIDCClient

Type annotations and code completion for boto3.client("sso-oidc"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_sso_oidc.client import SSOOIDCClient

def get_sso-oidc_client() -> SSOOIDCClient:
    return Session().client("sso-oidc")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("sso-oidc").exceptions structure.

Usage example

client = boto3.client("sso-oidc")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.AuthorizationPendingException,
    client.ClientError,
    client.ExpiredTokenException,
    client.InternalServerException,
    client.InvalidClientException,
    client.InvalidClientMetadataException,
    client.InvalidGrantException,
    client.InvalidRequestException,
    client.InvalidScopeException,
    client.SlowDownException,
    client.UnauthorizedClientException,
    client.UnsupportedGrantTypeException,
) as e:
    print(e)

Type checking example

from mypy_boto3_sso_oidc.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("sso-oidc").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("sso-oidc").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

create_token

Creates and returns an access token for the authorized client.

Type annotations and code completion for boto3.client("sso-oidc").create_token method. boto3 documentation

Method definition

def create_token(
    self,
    *,
    clientId: str,
    clientSecret: str,
    grantType: str,
    deviceCode: str = ...,
    code: str = ...,
    refreshToken: str = ...,
    scope: Sequence[str] = ...,
    redirectUri: str = ...,
) -> CreateTokenResponseTypeDef:  # (1)
    ...

See CreateTokenResponseTypeDef

Usage example with kwargs

kwargs: CreateTokenRequestRequestTypeDef = {  # (1)
    "clientId": ...,
    "clientSecret": ...,
    "grantType": ...,
}

parent.create_token(**kwargs)

See CreateTokenRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("sso-oidc").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

register_client

Registers a client with IAM Identity Center.

Type annotations and code completion for boto3.client("sso-oidc").register_client method. boto3 documentation

Method definition

def register_client(
    self,
    *,
    clientName: str,
    clientType: str,
    scopes: Sequence[str] = ...,
) -> RegisterClientResponseTypeDef:  # (1)
    ...

See RegisterClientResponseTypeDef

Usage example with kwargs

kwargs: RegisterClientRequestRequestTypeDef = {  # (1)
    "clientName": ...,
    "clientType": ...,
}

parent.register_client(**kwargs)

See RegisterClientRequestRequestTypeDef

start_device_authorization

Initiates device authorization by requesting a pair of verification codes from the authorization service.

Type annotations and code completion for boto3.client("sso-oidc").start_device_authorization method. boto3 documentation

Method definition

def start_device_authorization(
    self,
    *,
    clientId: str,
    clientSecret: str,
    startUrl: str,
) -> StartDeviceAuthorizationResponseTypeDef:  # (1)
    ...

See StartDeviceAuthorizationResponseTypeDef

Usage example with kwargs

kwargs: StartDeviceAuthorizationRequestRequestTypeDef = {  # (1)
    "clientId": ...,
    "clientSecret": ...,
    "startUrl": ...,
}

parent.start_device_authorization(**kwargs)

See StartDeviceAuthorizationRequestRequestTypeDef