SignInServiceClient#
Index > SignInService > SignInServiceClient
Auto-generated documentation for SignInService type annotations stubs module mypy-boto3-signin.
SignInServiceClient#
Type annotations and code completion for boto3.client("signin").
boto3 documentation
# SignInServiceClient usage example
from boto3.session import Session
from mypy_boto3_signin.client import SignInServiceClient
def get_signin_client() -> SignInServiceClient:
return Session().client("signin")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("signin").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("signin")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.TooManyRequestsError,
client.exceptions.ValidationException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_signin.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
can_paginate#
Type annotations and code completion for boto3.client("signin").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...generate_presigned_url#
Type annotations and code completion for boto3.client("signin").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...create_o_auth2_token#
CreateOAuth2Token API.
Type annotations and code completion for boto3.client("signin").create_o_auth2_token method.
boto3 documentation
# create_o_auth2_token method definition
def create_o_auth2_token(
self,
*,
tokenInput: CreateOAuth2TokenRequestBodyTypeDef, # (1)
) -> CreateOAuth2TokenResponseTypeDef: # (2)
...# create_o_auth2_token method usage example with argument unpacking
kwargs: CreateOAuth2TokenRequestTypeDef = { # (1)
"tokenInput": ...,
}
parent.create_o_auth2_token(**kwargs)delete_console_authorization_configuration#
Delete console authorization configuration with automatic scope detection.
Type annotations and code completion for boto3.client("signin").delete_console_authorization_configuration method.
boto3 documentation
# delete_console_authorization_configuration method definition
def delete_console_authorization_configuration(
self,
*,
targetId: str = ...,
) -> DeleteConsoleAuthorizationConfigurationOutputTypeDef: # (1)
...# delete_console_authorization_configuration method usage example with argument unpacking
kwargs: DeleteConsoleAuthorizationConfigurationInputTypeDef = { # (1)
"targetId": ...,
}
parent.delete_console_authorization_configuration(**kwargs)delete_resource_permission_statement#
Remove a permission statement from the account's SignIn resource-based policy.
Type annotations and code completion for boto3.client("signin").delete_resource_permission_statement method.
boto3 documentation
# delete_resource_permission_statement method definition
def delete_resource_permission_statement(
self,
*,
statementId: str,
clientToken: str = ...,
) -> dict[str, Any]:
...# delete_resource_permission_statement method usage example with argument unpacking
kwargs: DeleteResourcePermissionStatementInputTypeDef = { # (1)
"statementId": ...,
}
parent.delete_resource_permission_statement(**kwargs)get_console_authorization_configuration#
Get console authorization configuration with automatic scope detection.
Type annotations and code completion for boto3.client("signin").get_console_authorization_configuration method.
boto3 documentation
# get_console_authorization_configuration method definition
def get_console_authorization_configuration(
self,
*,
targetId: str = ...,
) -> GetConsoleAuthorizationConfigurationOutputTypeDef: # (1)
...# get_console_authorization_configuration method usage example with argument unpacking
kwargs: GetConsoleAuthorizationConfigurationInputTypeDef = { # (1)
"targetId": ...,
}
parent.get_console_authorization_configuration(**kwargs)get_resource_policy#
Retrieve the account's consolidated SignIn resource-based policy.
Type annotations and code completion for boto3.client("signin").get_resource_policy method.
boto3 documentation
# get_resource_policy method definition
def get_resource_policy(
self,
) -> GetResourcePolicyOutputTypeDef: # (1)
...list_resource_permission_statements#
Retrieve all permission statements in the account's SignIn resource-based policy.
Type annotations and code completion for boto3.client("signin").list_resource_permission_statements method.
boto3 documentation
# list_resource_permission_statements method definition
def list_resource_permission_statements(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListResourcePermissionStatementsOutputTypeDef: # (1)
...# list_resource_permission_statements method usage example with argument unpacking
kwargs: ListResourcePermissionStatementsInputTypeDef = { # (1)
"maxResults": ...,
}
parent.list_resource_permission_statements(**kwargs)put_console_authorization_configuration#
Enable console authorization configuration with automatic scope detection.
Type annotations and code completion for boto3.client("signin").put_console_authorization_configuration method.
boto3 documentation
# put_console_authorization_configuration method definition
def put_console_authorization_configuration(
self,
*,
targetId: str = ...,
) -> PutConsoleAuthorizationConfigurationOutputTypeDef: # (1)
...# put_console_authorization_configuration method usage example with argument unpacking
kwargs: PutConsoleAuthorizationConfigurationInputTypeDef = { # (1)
"targetId": ...,
}
parent.put_console_authorization_configuration(**kwargs)put_resource_permission_statement#
Create a permission statement in the account's SignIn resource-based policy.
Type annotations and code completion for boto3.client("signin").put_resource_permission_statement method.
boto3 documentation
# put_resource_permission_statement method definition
def put_resource_permission_statement(
self,
*,
sourceVpc: str = ...,
signinSourceVpce: str = ...,
consoleSourceVpce: str = ...,
vpcSourceIp: str = ...,
sourceIp: str = ...,
requestedRegion: str = ...,
excludedPrincipal: str = ...,
clientToken: str = ...,
) -> PutResourcePermissionStatementOutputTypeDef: # (1)
...# put_resource_permission_statement method usage example with argument unpacking
kwargs: PutResourcePermissionStatementInputTypeDef = { # (1)
"sourceVpc": ...,
}
parent.put_resource_permission_statement(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("signin").get_paginator method with overloads.
client.get_paginator("list_resource_permission_statements")-> ListResourcePermissionStatementsPaginator