Skip to content

SSOAdminClient#

Index > SSOAdmin > SSOAdminClient

Auto-generated documentation for SSOAdmin type annotations stubs module mypy-boto3-sso-admin.

SSOAdminClient#

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

# SSOAdminClient usage example

from boto3.session import Session
from mypy_boto3_sso_admin.client import SSOAdminClient

def get_sso-admin_client() -> SSOAdminClient:
    return Session().client("sso-admin")

Exceptions#

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

# Exceptions.exceptions usage example

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

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.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_sso_admin.client import Exceptions

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

Methods#

attach_customer_managed_policy_reference_to_permission_set#

Attaches the specified customer managed policy to the specified PermissionSet.

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

# attach_customer_managed_policy_reference_to_permission_set method definition

def attach_customer_managed_policy_reference_to_permission_set(
    self,
    *,
    CustomerManagedPolicyReference: CustomerManagedPolicyReferenceTypeDef,  # (1)
    InstanceArn: str,
    PermissionSetArn: str,
) -> Dict[str, Any]:
    ...
  1. See CustomerManagedPolicyReferenceTypeDef
# attach_customer_managed_policy_reference_to_permission_set method usage example with argument unpacking

kwargs: AttachCustomerManagedPolicyReferenceToPermissionSetRequestRequestTypeDef = {  # (1)
    "CustomerManagedPolicyReference": ...,
    "InstanceArn": ...,
    "PermissionSetArn": ...,
}

parent.attach_customer_managed_policy_reference_to_permission_set(**kwargs)
  1. See AttachCustomerManagedPolicyReferenceToPermissionSetRequestRequestTypeDef

attach_managed_policy_to_permission_set#

Attaches an Amazon Web Services managed policy ARN to a permission set.

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

# attach_managed_policy_to_permission_set method definition

def attach_managed_policy_to_permission_set(
    self,
    *,
    InstanceArn: str,
    ManagedPolicyArn: str,
    PermissionSetArn: str,
) -> Dict[str, Any]:
    ...
# attach_managed_policy_to_permission_set method usage example with argument unpacking

kwargs: AttachManagedPolicyToPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "ManagedPolicyArn": ...,
    "PermissionSetArn": ...,
}

parent.attach_managed_policy_to_permission_set(**kwargs)
  1. See AttachManagedPolicyToPermissionSetRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("sso-admin").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 boto3.client("sso-admin").close method. boto3 documentation

# close method definition

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

create_account_assignment#

Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.

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

# create_account_assignment method definition

def create_account_assignment(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    PrincipalId: str,
    PrincipalType: PrincipalTypeType,  # (1)
    TargetId: str,
    TargetType: TargetTypeType,  # (2)
) -> CreateAccountAssignmentResponseTypeDef:  # (3)
    ...
  1. See PrincipalTypeType
  2. See TargetTypeType
  3. See CreateAccountAssignmentResponseTypeDef
# create_account_assignment method usage example with argument unpacking

kwargs: CreateAccountAssignmentRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "PrincipalId": ...,
    "PrincipalType": ...,
    "TargetId": ...,
    "TargetType": ...,
}

parent.create_account_assignment(**kwargs)
  1. See CreateAccountAssignmentRequestRequestTypeDef

create_application#

Creates an application in IAM Identity Center for the given application provider.

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

# create_application method definition

def create_application(
    self,
    *,
    ApplicationProviderArn: str,
    InstanceArn: str,
    Name: str,
    ClientToken: str = ...,
    Description: str = ...,
    PortalOptions: PortalOptionsTypeDef = ...,  # (1)
    Status: ApplicationStatusType = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateApplicationResponseTypeDef:  # (4)
    ...
  1. See PortalOptionsTypeDef
  2. See ApplicationStatusType
  3. See TagTypeDef
  4. See CreateApplicationResponseTypeDef
# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationProviderArn": ...,
    "InstanceArn": ...,
    "Name": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationRequestRequestTypeDef

create_application_assignment#

Grant application access to a user or group.

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

# create_application_assignment method definition

def create_application_assignment(
    self,
    *,
    ApplicationArn: str,
    PrincipalId: str,
    PrincipalType: PrincipalTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See PrincipalTypeType
# create_application_assignment method usage example with argument unpacking

kwargs: CreateApplicationAssignmentRequestRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "PrincipalId": ...,
    "PrincipalType": ...,
}

parent.create_application_assignment(**kwargs)
  1. See CreateApplicationAssignmentRequestRequestTypeDef

creat