SSOOIDCClient

Index > SSOOIDC > SSOOIDCClient

Auto-generated documentation for SSOOIDC type annotations stubs module types-aiobotocore-sso-oidc.

SSOOIDCClient

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

SSOOIDCClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_sso_oidc.client import SSOOIDCClient

session = get_session()
async with session.create_client("sso-oidc") as client:
    client: SSOOIDCClient

Exceptions

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

SSOOIDCClient.exceptions usage example

async with session.create_client("sso-oidc") as client:
    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)

SSOOIDCClient usage type checking example

from types_aiobotocore_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 session.create_client("sso-oidc").can_paginate method. boto3 documentation

# can_paginate method definition

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

close

Closes underlying endpoint connections.

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

# close method definition

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

create_token

Creates and returns an access token for the authorized client.

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

# create_token method definition

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

1. See CreateTokenResponseTypeDef

# create_token method usage example with argument unpacking

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

parent.create_token(**kwargs)

1. See CreateTokenRequestRequestTypeDef

generate_presigned_url

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

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

# generate_presigned_url method definition

await 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 session.create_client("sso-oidc").register_client method. boto3 documentation

# register_client method definition

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

1. See RegisterClientResponseTypeDef

# register_client method usage example with argument unpacking

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

parent.register_client(**kwargs)

1. 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 session.create_client("sso-oidc").start_device_authorization method. boto3 documentation

# start_device_authorization method definition

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

1. See StartDeviceAuthorizationResponseTypeDef

# start_device_authorization method usage example with argument unpacking

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

parent.start_device_authorization(**kwargs)

1. See StartDeviceAuthorizationRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.create_client("sso-oidc").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> SSOOIDCClient:
    ...

__aexit__

Type annotations and code completion for session.create_client("sso-oidc").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...