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#

can_paginate#

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:
    ...

generate_presigned_url#

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

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,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    CustomerManagedPolicyReference: CustomerManagedPolicyReferenceTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See CustomerManagedPolicyReferenceTypeDef
# attach_customer_managed_policy_reference_to_permission_set method usage example with argument unpacking

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

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

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,
    PermissionSetArn: str,
    ManagedPolicyArn: str,
) -> Dict[str, Any]:
    ...
# attach_managed_policy_to_permission_set method usage example with argument unpacking

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

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

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,
    TargetId: str,
    TargetType: TargetTypeType,  # (1)
    PermissionSetArn: str,
    PrincipalType: PrincipalTypeType,  # (2)
    PrincipalId: str,
) -> CreateAccountAssignmentResponseTypeDef:  # (3)
    ...
  1. See TargetTypeType
  2. See PrincipalTypeType
  3. See CreateAccountAssignmentResponseTypeDef
# create_account_assignment method usage example with argument unpacking

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

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

create_application#

Creates an OAuth 2.0 customer managed 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,
    *,
    InstanceArn: str,
    ApplicationProviderArn: str,
    Name: str,
    Description: str = ...,
    PortalOptions: PortalOptionsTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    Status: ApplicationStatusType = ...,  # (3)
    ClientToken: str = ...,
) -> CreateApplicationResponseTypeDef:  # (4)
    ...
  1. See PortalOptionsTypeDef
  2. See Sequence[TagTypeDef]
  3. See ApplicationStatusType
  4. See CreateApplicationResponseTypeDef
# create_application method usage example with argument unpacking

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

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

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: CreateApplicationAssignmentRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "PrincipalId": ...,
    "PrincipalType": ...,
}

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

create_instance#

Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not managed by Organizations or a member Amazon Web Services account in an organization.

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

# create_instance method definition

def create_instance(
    self,
    *,
    Name: str = ...,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateInstanceResponseTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreateInstanceResponseTypeDef
# create_instance method usage example with argument unpacking

kwargs: CreateInstanceRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_instance(**kwargs)
  1. See CreateInstanceRequestTypeDef

create_instance_access_control_attribute_configuration#

Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance.

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

# create_instance_access_control_attribute_configuration method definition

def create_instance_access_control_attribute_configuration(
    self,
    *,
    InstanceArn: str,
    InstanceAccessControlAttributeConfiguration: InstanceAccessControlAttributeConfigurationUnionTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See InstanceAccessControlAttributeConfigurationUnionTypeDef
# create_instance_access_control_attribute_configuration method usage example with argument unpacking

kwargs: CreateInstanceAccessControlAttributeConfigurationRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "InstanceAccessControlAttributeConfiguration": ...,
}

parent.create_instance_access_control_attribute_configuration(**kwargs)
  1. See CreateInstanceAccessControlAttributeConfigurationRequestTypeDef

create_permission_set#

Creates a permission set within a specified IAM Identity Center instance.

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

# create_permission_set method definition

def create_permission_set(
    self,
    *,
    Name: str,
    InstanceArn: str,
    Description: str = ...,
    SessionDuration: str = ...,
    RelayState: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreatePermissionSetResponseTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreatePermissionSetResponseTypeDef
# create_permission_set method usage example with argument unpacking

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

parent.create_permission_set(**kwargs)
  1. See CreatePermissionSetRequestTypeDef

create_trusted_token_issuer#

Creates a connection to a trusted token issuer in an instance of IAM Identity Center.

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

# create_trusted_token_issuer method definition

def create_trusted_token_issuer(
    self,
    *,
    InstanceArn: str,
    Name: str,
    TrustedTokenIssuerType: TrustedTokenIssuerTypeType,  # (1)
    TrustedTokenIssuerConfiguration: TrustedTokenIssuerConfigurationTypeDef,  # (2)
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateTrustedTokenIssuerResponseTypeDef:  # (4)
    ...
  1. See TrustedTokenIssuerTypeType
  2. See TrustedTokenIssuerConfigurationTypeDef
  3. See Sequence[TagTypeDef]
  4. See CreateTrustedTokenIssuerResponseTypeDef
# create_trusted_token_issuer method usage example with argument unpacking

kwargs: CreateTrustedTokenIssuerRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "Name": ...,
    "TrustedTokenIssuerType": ...,
    "TrustedTokenIssuerConfiguration": ...,
}

parent.create_trusted_token_issuer(**kwargs)
  1. See CreateTrustedTokenIssuerRequestTypeDef

delete_account_assignment#

Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.

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

# delete_account_assignment method definition

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

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

parent.delete_account_assignment(**kwargs)
  1. See DeleteAccountAssignmentRequestTypeDef

delete_application#

Deletes the association with the application.

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

# delete_application method definition

def delete_application(
    self,
    *,
    ApplicationArn: str,
) -> Dict[str, Any]:
    ...
# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationRequestTypeDef

delete_application_access_scope#

Deletes an IAM Identity Center access scope from an application.

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

# delete_application_access_scope method definition

def delete_application_access_scope(
    self,
    *,
    ApplicationArn: str,
    Scope: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_application_access_scope method usage example with argument unpacking

kwargs: DeleteApplicationAccessScopeRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "Scope": ...,
}

parent.delete_application_access_scope(**kwargs)
  1. See DeleteApplicationAccessScopeRequestTypeDef

delete_application_assignment#

Revoke application access to an application by deleting application assignments for a user or group.

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

# delete_application_assignment method definition

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

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

parent.delete_application_assignment(**kwargs)
  1. See DeleteApplicationAssignmentRequestTypeDef

delete_application_authentication_method#

Deletes an authentication method from an application.

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

# delete_application_authentication_method method definition

def delete_application_authentication_method(
    self,
    *,
    ApplicationArn: str,
    AuthenticationMethodType: AuthenticationMethodTypeType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See AuthenticationMethodTypeType
  2. See EmptyResponseMetadataTypeDef
# delete_application_authentication_method method usage example with argument unpacking

kwargs: DeleteApplicationAuthenticationMethodRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "AuthenticationMethodType": ...,
}

parent.delete_application_authentication_method(**kwargs)
  1. See DeleteApplicationAuthenticationMethodRequestTypeDef

delete_application_grant#

Deletes a grant from an application.

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

# delete_application_grant method definition

def delete_application_grant(
    self,
    *,
    ApplicationArn: str,
    GrantType: GrantTypeType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See GrantTypeType
  2. See EmptyResponseMetadataTypeDef
# delete_application_grant method usage example with argument unpacking

kwargs: DeleteApplicationGrantRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "GrantType": ...,
}

parent.delete_application_grant(**kwargs)
  1. See DeleteApplicationGrantRequestTypeDef

delete_inline_policy_from_permission_set#

Deletes the inline policy from a specified permission set.

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

# delete_inline_policy_from_permission_set method definition

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

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

parent.delete_inline_policy_from_permission_set(**kwargs)
  1. See DeleteInlinePolicyFromPermissionSetRequestTypeDef

delete_instance#

Deletes the instance of IAM Identity Center.

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

# delete_instance method definition

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

kwargs: DeleteInstanceRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.delete_instance(**kwargs)
  1. See DeleteInstanceRequestTypeDef

delete_instance_access_control_attribute_configuration#

Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured.

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

# delete_instance_access_control_attribute_configuration method definition

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

kwargs: DeleteInstanceAccessControlAttributeConfigurationRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.delete_instance_access_control_attribute_configuration(**kwargs)
  1. See DeleteInstanceAccessControlAttributeConfigurationRequestTypeDef

delete_permission_set#

Deletes the specified permission set.

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

# delete_permission_set method definition

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

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

parent.delete_permission_set(**kwargs)
  1. See DeletePermissionSetRequestTypeDef

delete_permissions_boundary_from_permission_set#

Deletes the permissions boundary from a specified PermissionSet.

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

# delete_permissions_boundary_from_permission_set method definition

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

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

parent.delete_permissions_boundary_from_permission_set(**kwargs)
  1. See DeletePermissionsBoundaryFromPermissionSetRequestTypeDef

delete_trusted_token_issuer#

Deletes a trusted token issuer configuration from an instance of IAM Identity Center.

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

# delete_trusted_token_issuer method definition

def delete_trusted_token_issuer(
    self,
    *,
    TrustedTokenIssuerArn: str,
) -> Dict[str, Any]:
    ...
# delete_trusted_token_issuer method usage example with argument unpacking

kwargs: DeleteTrustedTokenIssuerRequestTypeDef = {  # (1)
    "TrustedTokenIssuerArn": ...,
}

parent.delete_trusted_token_issuer(**kwargs)
  1. See DeleteTrustedTokenIssuerRequestTypeDef

describe_account_assignment_creation_status#

Describes the status of the assignment creation request.

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

# describe_account_assignment_creation_status method definition

def describe_account_assignment_creation_status(
    self,
    *,
    InstanceArn: str,
    AccountAssignmentCreationRequestId: str,
) -> DescribeAccountAssignmentCreationStatusResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountAssignmentCreationStatusResponseTypeDef
# describe_account_assignment_creation_status method usage example with argument unpacking

kwargs: DescribeAccountAssignmentCreationStatusRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "AccountAssignmentCreationRequestId": ...,
}

parent.describe_account_assignment_creation_status(**kwargs)
  1. See DescribeAccountAssignmentCreationStatusRequestTypeDef

describe_account_assignment_deletion_status#

Describes the status of the assignment deletion request.

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

# describe_account_assignment_deletion_status method definition

def describe_account_assignment_deletion_status(
    self,
    *,
    InstanceArn: str,
    AccountAssignmentDeletionRequestId: str,
) -> DescribeAccountAssignmentDeletionStatusResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountAssignmentDeletionStatusResponseTypeDef
# describe_account_assignment_deletion_status method usage example with argument unpacking

kwargs: DescribeAccountAssignmentDeletionStatusRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "AccountAssignmentDeletionRequestId": ...,
}

parent.describe_account_assignment_deletion_status(**kwargs)
  1. See DescribeAccountAssignmentDeletionStatusRequestTypeDef

describe_application#

Retrieves the details of an application associated with an instance of IAM Identity Center.

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

# describe_application method definition

def describe_application(
    self,
    *,
    ApplicationArn: str,
) -> DescribeApplicationResponseTypeDef:  # (1)
    ...
  1. See DescribeApplicationResponseTypeDef
# describe_application method usage example with argument unpacking

kwargs: DescribeApplicationRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
}

parent.describe_application(**kwargs)
  1. See DescribeApplicationRequestTypeDef

describe_application_assignment#

Retrieves a direct assignment of a user or group to an application.

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

# describe_application_assignment method definition

def describe_application_assignment(
    self,
    *,
    ApplicationArn: str,
    PrincipalId: str,
    PrincipalType: PrincipalTypeType,  # (1)
) -> DescribeApplicationAssignmentResponseTypeDef:  # (2)
    ...
  1. See PrincipalTypeType
  2. See DescribeApplicationAssignmentResponseTypeDef
# describe_application_assignment method usage example with argument unpacking

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

parent.describe_application_assignment(**kwargs)
  1. See DescribeApplicationAssignmentRequestTypeDef

describe_application_provider#

Retrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.

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

# describe_application_provider method definition

def describe_application_provider(
    self,
    *,
    ApplicationProviderArn: str,
) -> DescribeApplicationProviderResponseTypeDef:  # (1)
    ...
  1. See DescribeApplicationProviderResponseTypeDef
# describe_application_provider method usage example with argument unpacking

kwargs: DescribeApplicationProviderRequestTypeDef = {  # (1)
    "ApplicationProviderArn": ...,
}

parent.describe_application_provider(**kwargs)
  1. See DescribeApplicationProviderRequestTypeDef

describe_instance#

Returns the details of an instance of IAM Identity Center.

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

# describe_instance method definition

def describe_instance(
    self,
    *,
    InstanceArn: str,
) -> DescribeInstanceResponseTypeDef:  # (1)
    ...
  1. See DescribeInstanceResponseTypeDef
# describe_instance method usage example with argument unpacking

kwargs: DescribeInstanceRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.describe_instance(**kwargs)
  1. See DescribeInstanceRequestTypeDef

describe_instance_access_control_attribute_configuration#

Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance.

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

# describe_instance_access_control_attribute_configuration method definition

def describe_instance_access_control_attribute_configuration(
    self,
    *,
    InstanceArn: str,
) -> DescribeInstanceAccessControlAttributeConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeInstanceAccessControlAttributeConfigurationResponseTypeDef
# describe_instance_access_control_attribute_configuration method usage example with argument unpacking

kwargs: DescribeInstanceAccessControlAttributeConfigurationRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.describe_instance_access_control_attribute_configuration(**kwargs)
  1. See DescribeInstanceAccessControlAttributeConfigurationRequestTypeDef

describe_permission_set#

Gets the details of the permission set.

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

# describe_permission_set method definition

def describe_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> DescribePermissionSetResponseTypeDef:  # (1)
    ...
  1. See DescribePermissionSetResponseTypeDef
# describe_permission_set method usage example with argument unpacking

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

parent.describe_permission_set(**kwargs)
  1. See DescribePermissionSetRequestTypeDef

describe_permission_set_provisioning_status#

Describes the status for the given permission set provisioning request.

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

# describe_permission_set_provisioning_status method definition

def describe_permission_set_provisioning_status(
    self,
    *,
    InstanceArn: str,
    ProvisionPermissionSetRequestId: str,
) -> DescribePermissionSetProvisioningStatusResponseTypeDef:  # (1)
    ...
  1. See DescribePermissionSetProvisioningStatusResponseTypeDef
# describe_permission_set_provisioning_status method usage example with argument unpacking

kwargs: DescribePermissionSetProvisioningStatusRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "ProvisionPermissionSetRequestId": ...,
}

parent.describe_permission_set_provisioning_status(**kwargs)
  1. See DescribePermissionSetProvisioningStatusRequestTypeDef

describe_trusted_token_issuer#

Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center.

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

# describe_trusted_token_issuer method definition

def describe_trusted_token_issuer(
    self,
    *,
    TrustedTokenIssuerArn: str,
) -> DescribeTrustedTokenIssuerResponseTypeDef:  # (1)
    ...
  1. See DescribeTrustedTokenIssuerResponseTypeDef
# describe_trusted_token_issuer method usage example with argument unpacking

kwargs: DescribeTrustedTokenIssuerRequestTypeDef = {  # (1)
    "TrustedTokenIssuerArn": ...,
}

parent.describe_trusted_token_issuer(**kwargs)
  1. See DescribeTrustedTokenIssuerRequestTypeDef

detach_customer_managed_policy_reference_from_permission_set#

Detaches the specified customer managed policy from the specified PermissionSet.

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

# detach_customer_managed_policy_reference_from_permission_set method definition

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

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

parent.detach_customer_managed_policy_reference_from_permission_set(**kwargs)
  1. See DetachCustomerManagedPolicyReferenceFromPermissionSetRequestTypeDef

detach_managed_policy_from_permission_set#

Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.

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

# detach_managed_policy_from_permission_set method definition

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

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

parent.detach_managed_policy_from_permission_set(**kwargs)
  1. See DetachManagedPolicyFromPermissionSetRequestTypeDef

get_application_access_scope#

Retrieves the authorized targets for an IAM Identity Center access scope for an application.

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

# get_application_access_scope method definition

def get_application_access_scope(
    self,
    *,
    ApplicationArn: str,
    Scope: str,
) -> GetApplicationAccessScopeResponseTypeDef:  # (1)
    ...
  1. See GetApplicationAccessScopeResponseTypeDef
# get_application_access_scope method usage example with argument unpacking

kwargs: GetApplicationAccessScopeRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "Scope": ...,
}

parent.get_application_access_scope(**kwargs)
  1. See GetApplicationAccessScopeRequestTypeDef

get_application_assignment_configuration#

Retrieves the configuration of PutApplicationAssignmentConfiguration.

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

# get_application_assignment_configuration method definition

def get_application_assignment_configuration(
    self,
    *,
    ApplicationArn: str,
) -> GetApplicationAssignmentConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetApplicationAssignmentConfigurationResponseTypeDef
# get_application_assignment_configuration method usage example with argument unpacking

kwargs: GetApplicationAssignmentConfigurationRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
}

parent.get_application_assignment_configuration(**kwargs)
  1. See GetApplicationAssignmentConfigurationRequestTypeDef

get_application_authentication_method#

Retrieves details about an authentication method used by an application.

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

# get_application_authentication_method method definition

def get_application_authentication_method(
    self,
    *,
    ApplicationArn: str,
    AuthenticationMethodType: AuthenticationMethodTypeType,  # (1)
) -> GetApplicationAuthenticationMethodResponseTypeDef:  # (2)
    ...
  1. See AuthenticationMethodTypeType
  2. See GetApplicationAuthenticationMethodResponseTypeDef
# get_application_authentication_method method usage example with argument unpacking

kwargs: GetApplicationAuthenticationMethodRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "AuthenticationMethodType": ...,
}

parent.get_application_authentication_method(**kwargs)
  1. See GetApplicationAuthenticationMethodRequestTypeDef

get_application_grant#

Retrieves details about an application grant.

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

# get_application_grant method definition

def get_application_grant(
    self,
    *,
    ApplicationArn: str,
    GrantType: GrantTypeType,  # (1)
) -> GetApplicationGrantResponseTypeDef:  # (2)
    ...
  1. See GrantTypeType
  2. See GetApplicationGrantResponseTypeDef
# get_application_grant method usage example with argument unpacking

kwargs: GetApplicationGrantRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "GrantType": ...,
}

parent.get_application_grant(**kwargs)
  1. See GetApplicationGrantRequestTypeDef

get_inline_policy_for_permission_set#

Obtains the inline policy assigned to the permission set.

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

# get_inline_policy_for_permission_set method definition

def get_inline_policy_for_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> GetInlinePolicyForPermissionSetResponseTypeDef:  # (1)
    ...
  1. See GetInlinePolicyForPermissionSetResponseTypeDef
# get_inline_policy_for_permission_set method usage example with argument unpacking

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

parent.get_inline_policy_for_permission_set(**kwargs)
  1. See GetInlinePolicyForPermissionSetRequestTypeDef

get_permissions_boundary_for_permission_set#

Obtains the permissions boundary for a specified PermissionSet.

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

# get_permissions_boundary_for_permission_set method definition

def get_permissions_boundary_for_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> GetPermissionsBoundaryForPermissionSetResponseTypeDef:  # (1)
    ...
  1. See GetPermissionsBoundaryForPermissionSetResponseTypeDef
# get_permissions_boundary_for_permission_set method usage example with argument unpacking

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

parent.get_permissions_boundary_for_permission_set(**kwargs)
  1. See GetPermissionsBoundaryForPermissionSetRequestTypeDef

list_account_assignment_creation_status#

Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.

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

# list_account_assignment_creation_status method definition

def list_account_assignment_creation_status(
    self,
    *,
    InstanceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filter: OperationStatusFilterTypeDef = ...,  # (1)
) -> ListAccountAssignmentCreationStatusResponseTypeDef:  # (2)
    ...
  1. See OperationStatusFilterTypeDef
  2. See ListAccountAssignmentCreationStatusResponseTypeDef
# list_account_assignment_creation_status method usage example with argument unpacking

kwargs: ListAccountAssignmentCreationStatusRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.list_account_assignment_creation_status(**kwargs)
  1. See ListAccountAssignmentCreationStatusRequestTypeDef

list_account_assignment_deletion_status#

Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.

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

# list_account_assignment_deletion_status method definition

def list_account_assignment_deletion_status(
    self,
    *,
    InstanceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filter: OperationStatusFilterTypeDef = ...,  # (1)
) -> ListAccountAssignmentDeletionStatusResponseTypeDef:  # (2)
    ...
  1. See OperationStatusFilterTypeDef
  2. See ListAccountAssignmentDeletionStatusResponseTypeDef
# list_account_assignment_deletion_status method usage example with argument unpacking

kwargs: ListAccountAssignmentDeletionStatusRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.list_account_assignment_deletion_status(**kwargs)
  1. See ListAccountAssignmentDeletionStatusRequestTypeDef

list_account_assignments#

Lists the assignee of the specified Amazon Web Services account with the specified permission set.

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

# list_account_assignments method definition

def list_account_assignments(
    self,
    *,
    InstanceArn: str,
    AccountId: str,
    PermissionSetArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAccountAssignmentsResponseTypeDef:  # (1)
    ...
  1. See ListAccountAssignmentsResponseTypeDef
# list_account_assignments method usage example with argument unpacking

kwargs: ListAccountAssignmentsRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "AccountId": ...,
    "PermissionSetArn": ...,
}

parent.list_account_assignments(**kwargs)
  1. See ListAccountAssignmentsRequestTypeDef

list_account_assignments_for_principal#

Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.

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

# list_account_assignments_for_principal method definition

def list_account_assignments_for_principal(
    self,
    *,
    InstanceArn: str,
    PrincipalId: str,
    PrincipalType: PrincipalTypeType,  # (1)
    Filter: ListAccountAssignmentsFilterTypeDef = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAccountAssignmentsForPrincipalResponseTypeDef:  # (3)
    ...
  1. See PrincipalTypeType
  2. See ListAccountAssignmentsFilterTypeDef
  3. See ListAccountAssignmentsForPrincipalResponseTypeDef
# list_account_assignments_for_principal method usage example with argument unpacking

kwargs: ListAccountAssignmentsForPrincipalRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PrincipalId": ...,
    "PrincipalType": ...,
}

parent.list_account_assignments_for_principal(**kwargs)
  1. See ListAccountAssignmentsForPrincipalRequestTypeDef

list_accounts_for_provisioned_permission_set#

Lists all the Amazon Web Services accounts where the specified permission set is provisioned.

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

# list_accounts_for_provisioned_permission_set method definition

def list_accounts_for_provisioned_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    ProvisioningStatus: ProvisioningStatusType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAccountsForProvisionedPermissionSetResponseTypeDef:  # (2)
    ...
  1. See ProvisioningStatusType
  2. See ListAccountsForProvisionedPermissionSetResponseTypeDef
# list_accounts_for_provisioned_permission_set method usage example with argument unpacking

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

parent.list_accounts_for_provisioned_permission_set(**kwargs)
  1. See ListAccountsForProvisionedPermissionSetRequestTypeDef

list_application_access_scopes#

Lists the access scopes and authorized targets associated with an application.

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

# list_application_access_scopes method definition

def list_application_access_scopes(
    self,
    *,
    ApplicationArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListApplicationAccessScopesResponseTypeDef:  # (1)
    ...
  1. See ListApplicationAccessScopesResponseTypeDef
# list_application_access_scopes method usage example with argument unpacking

kwargs: ListApplicationAccessScopesRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
}

parent.list_application_access_scopes(**kwargs)
  1. See ListApplicationAccessScopesRequestTypeDef

list_application_assignments#

Lists Amazon Web Services account users that are assigned to an application.

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

# list_application_assignments method definition

def list_application_assignments(
    self,
    *,
    ApplicationArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListApplicationAssignmentsResponseTypeDef:  # (1)
    ...
  1. See ListApplicationAssignmentsResponseTypeDef
# list_application_assignments method usage example with argument unpacking

kwargs: ListApplicationAssignmentsRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
}

parent.list_application_assignments(**kwargs)
  1. See ListApplicationAssignmentsRequestTypeDef

list_application_assignments_for_principal#

Lists the applications to which a specified principal is assigned.

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

# list_application_assignments_for_principal method definition

def list_application_assignments_for_principal(
    self,
    *,
    InstanceArn: str,
    PrincipalId: str,
    PrincipalType: PrincipalTypeType,  # (1)
    Filter: ListApplicationAssignmentsFilterTypeDef = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListApplicationAssignmentsForPrincipalResponseTypeDef:  # (3)
    ...
  1. See PrincipalTypeType
  2. See ListApplicationAssignmentsFilterTypeDef
  3. See ListApplicationAssignmentsForPrincipalResponseTypeDef
# list_application_assignments_for_principal method usage example with argument unpacking

kwargs: ListApplicationAssignmentsForPrincipalRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PrincipalId": ...,
    "PrincipalType": ...,
}

parent.list_application_assignments_for_principal(**kwargs)
  1. See ListApplicationAssignmentsForPrincipalRequestTypeDef

list_application_authentication_methods#

Lists all of the authentication methods supported by the specified application.

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

# list_application_authentication_methods method definition

def list_application_authentication_methods(
    self,
    *,
    ApplicationArn: str,
    NextToken: str = ...,
) -> ListApplicationAuthenticationMethodsResponseTypeDef:  # (1)
    ...
  1. See ListApplicationAuthenticationMethodsResponseTypeDef
# list_application_authentication_methods method usage example with argument unpacking

kwargs: ListApplicationAuthenticationMethodsRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
}

parent.list_application_authentication_methods(**kwargs)
  1. See ListApplicationAuthenticationMethodsRequestTypeDef

list_application_grants#

List the grants associated with an application.

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

# list_application_grants method definition

def list_application_grants(
    self,
    *,
    ApplicationArn: str,
    NextToken: str = ...,
) -> ListApplicationGrantsResponseTypeDef:  # (1)
    ...
  1. See ListApplicationGrantsResponseTypeDef
# list_application_grants method usage example with argument unpacking

kwargs: ListApplicationGrantsRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
}

parent.list_application_grants(**kwargs)
  1. See ListApplicationGrantsRequestTypeDef

list_application_providers#

Lists the application providers configured in the IAM Identity Center identity store.

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

# list_application_providers method definition

def list_application_providers(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListApplicationProvidersResponseTypeDef:  # (1)
    ...
  1. See ListApplicationProvidersResponseTypeDef
# list_application_providers method usage example with argument unpacking

kwargs: ListApplicationProvidersRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_application_providers(**kwargs)
  1. See ListApplicationProvidersRequestTypeDef

list_applications#

Lists all applications associated with the instance of IAM Identity Center.

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

# list_applications method definition

def list_applications(
    self,
    *,
    InstanceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filter: ListApplicationsFilterTypeDef = ...,  # (1)
) -> ListApplicationsResponseTypeDef:  # (2)
    ...
  1. See ListApplicationsFilterTypeDef
  2. See ListApplicationsResponseTypeDef
# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.list_applications(**kwargs)
  1. See ListApplicationsRequestTypeDef

list_customer_managed_policy_references_in_permission_set#

Lists all customer managed policies attached to a specified PermissionSet.

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

# list_customer_managed_policy_references_in_permission_set method definition

def list_customer_managed_policy_references_in_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCustomerManagedPolicyReferencesInPermissionSetResponseTypeDef:  # (1)
    ...
  1. See ListCustomerManagedPolicyReferencesInPermissionSetResponseTypeDef
# list_customer_managed_policy_references_in_permission_set method usage example with argument unpacking

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

parent.list_customer_managed_policy_references_in_permission_set(**kwargs)
  1. See ListCustomerManagedPolicyReferencesInPermissionSetRequestTypeDef

list_instances#

Lists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.

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

# list_instances method definition

def list_instances(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInstancesResponseTypeDef:  # (1)
    ...
  1. See ListInstancesResponseTypeDef
# list_instances method usage example with argument unpacking

kwargs: ListInstancesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_instances(**kwargs)
  1. See ListInstancesRequestTypeDef

list_managed_policies_in_permission_set#

Lists the Amazon Web Services managed policy that is attached to a specified permission set.

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

# list_managed_policies_in_permission_set method definition

def list_managed_policies_in_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListManagedPoliciesInPermissionSetResponseTypeDef:  # (1)
    ...
  1. See ListManagedPoliciesInPermissionSetResponseTypeDef
# list_managed_policies_in_permission_set method usage example with argument unpacking

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

parent.list_managed_policies_in_permission_set(**kwargs)
  1. See ListManagedPoliciesInPermissionSetRequestTypeDef

list_permission_set_provisioning_status#

Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.

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

# list_permission_set_provisioning_status method definition

def list_permission_set_provisioning_status(
    self,
    *,
    InstanceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filter: OperationStatusFilterTypeDef = ...,  # (1)
) -> ListPermissionSetProvisioningStatusResponseTypeDef:  # (2)
    ...
  1. See OperationStatusFilterTypeDef
  2. See ListPermissionSetProvisioningStatusResponseTypeDef
# list_permission_set_provisioning_status method usage example with argument unpacking

kwargs: ListPermissionSetProvisioningStatusRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.list_permission_set_provisioning_status(**kwargs)
  1. See ListPermissionSetProvisioningStatusRequestTypeDef

list_permission_sets#

Lists the PermissionSets in an IAM Identity Center instance.

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

# list_permission_sets method definition

def list_permission_sets(
    self,
    *,
    InstanceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPermissionSetsResponseTypeDef:  # (1)
    ...
  1. See ListPermissionSetsResponseTypeDef
# list_permission_sets method usage example with argument unpacking

kwargs: ListPermissionSetsRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.list_permission_sets(**kwargs)
  1. See ListPermissionSetsRequestTypeDef

list_permission_sets_provisioned_to_account#

Lists all the permission sets that are provisioned to a specified Amazon Web Services account.

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

# list_permission_sets_provisioned_to_account method definition

def list_permission_sets_provisioned_to_account(
    self,
    *,
    InstanceArn: str,
    AccountId: str,
    ProvisioningStatus: ProvisioningStatusType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPermissionSetsProvisionedToAccountResponseTypeDef:  # (2)
    ...
  1. See ProvisioningStatusType
  2. See ListPermissionSetsProvisionedToAccountResponseTypeDef
# list_permission_sets_provisioned_to_account method usage example with argument unpacking

kwargs: ListPermissionSetsProvisionedToAccountRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "AccountId": ...,
}

parent.list_permission_sets_provisioned_to_account(**kwargs)
  1. See ListPermissionSetsProvisionedToAccountRequestTypeDef

list_tags_for_resource#

Lists the tags that are attached to a specified resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
    InstanceArn: str = ...,
    NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

list_trusted_token_issuers#

Lists all the trusted token issuers configured in an instance of IAM Identity Center.

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

# list_trusted_token_issuers method definition

def list_trusted_token_issuers(
    self,
    *,
    InstanceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTrustedTokenIssuersResponseTypeDef:  # (1)
    ...
  1. See ListTrustedTokenIssuersResponseTypeDef
# list_trusted_token_issuers method usage example with argument unpacking

kwargs: ListTrustedTokenIssuersRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.list_trusted_token_issuers(**kwargs)
  1. See ListTrustedTokenIssuersRequestTypeDef

provision_permission_set#

The process by which a specified permission set is provisioned to the specified target.

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

# provision_permission_set method definition

def provision_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    TargetType: ProvisionTargetTypeType,  # (1)
    TargetId: str = ...,
) -> ProvisionPermissionSetResponseTypeDef:  # (2)
    ...
  1. See ProvisionTargetTypeType
  2. See ProvisionPermissionSetResponseTypeDef
# provision_permission_set method usage example with argument unpacking

kwargs: ProvisionPermissionSetRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "TargetType": ...,
}

parent.provision_permission_set(**kwargs)
  1. See ProvisionPermissionSetRequestTypeDef

put_application_access_scope#

Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.

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

# put_application_access_scope method definition

def put_application_access_scope(
    self,
    *,
    Scope: str,
    ApplicationArn: str,
    AuthorizedTargets: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# put_application_access_scope method usage example with argument unpacking

kwargs: PutApplicationAccessScopeRequestTypeDef = {  # (1)
    "Scope": ...,
    "ApplicationArn": ...,
}

parent.put_application_access_scope(**kwargs)
  1. See PutApplicationAccessScopeRequestTypeDef

put_application_assignment_configuration#

Configure how users gain access to an application.

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

# put_application_assignment_configuration method definition

def put_application_assignment_configuration(
    self,
    *,
    ApplicationArn: str,
    AssignmentRequired: bool,
) -> Dict[str, Any]:
    ...
# put_application_assignment_configuration method usage example with argument unpacking

kwargs: PutApplicationAssignmentConfigurationRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "AssignmentRequired": ...,
}

parent.put_application_assignment_configuration(**kwargs)
  1. See PutApplicationAssignmentConfigurationRequestTypeDef

put_application_authentication_method#

Adds or updates an authentication method for an application.

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

# put_application_authentication_method method definition

def put_application_authentication_method(
    self,
    *,
    ApplicationArn: str,
    AuthenticationMethodType: AuthenticationMethodTypeType,  # (1)
    AuthenticationMethod: AuthenticationMethodUnionTypeDef,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See AuthenticationMethodTypeType
  2. See AuthenticationMethodUnionTypeDef
  3. See EmptyResponseMetadataTypeDef
# put_application_authentication_method method usage example with argument unpacking

kwargs: PutApplicationAuthenticationMethodRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "AuthenticationMethodType": ...,
    "AuthenticationMethod": ...,
}

parent.put_application_authentication_method(**kwargs)
  1. See PutApplicationAuthenticationMethodRequestTypeDef

put_application_grant#

Creates a configuration for an application to use grants.

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

# put_application_grant method definition

def put_application_grant(
    self,
    *,
    ApplicationArn: str,
    GrantType: GrantTypeType,  # (1)
    Grant: GrantUnionTypeDef,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See GrantTypeType
  2. See GrantUnionTypeDef
  3. See EmptyResponseMetadataTypeDef
# put_application_grant method usage example with argument unpacking

kwargs: PutApplicationGrantRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
    "GrantType": ...,
    "Grant": ...,
}

parent.put_application_grant(**kwargs)
  1. See PutApplicationGrantRequestTypeDef

put_inline_policy_to_permission_set#

Attaches an inline policy to a permission set.

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

# put_inline_policy_to_permission_set method definition

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

kwargs: PutInlinePolicyToPermissionSetRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "InlinePolicy": ...,
}

parent.put_inline_policy_to_permission_set(**kwargs)
  1. See PutInlinePolicyToPermissionSetRequestTypeDef

put_permissions_boundary_to_permission_set#

Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.

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

# put_permissions_boundary_to_permission_set method definition

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

kwargs: PutPermissionsBoundaryToPermissionSetRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "PermissionsBoundary": ...,
}

parent.put_permissions_boundary_to_permission_set(**kwargs)
  1. See PutPermissionsBoundaryToPermissionSetRequestTypeDef

tag_resource#

Associates a set of tags with a specified resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
    InstanceArn: str = ...,
) -> Dict[str, Any]:
    ...
  1. See Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Disassociates a set of tags from a specified resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
    InstanceArn: str = ...,
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_application#

Updates application properties.

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

# update_application method definition

def update_application(
    self,
    *,
    ApplicationArn: str,
    Name: str = ...,
    Description: str = ...,
    Status: ApplicationStatusType = ...,  # (1)
    PortalOptions: UpdateApplicationPortalOptionsTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See ApplicationStatusType
  2. See UpdateApplicationPortalOptionsTypeDef
# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
}

parent.update_application(**kwargs)
  1. See UpdateApplicationRequestTypeDef

update_instance#

Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.

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

# update_instance method definition

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

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

parent.update_instance(**kwargs)
  1. See UpdateInstanceRequestTypeDef

update_instance_access_control_attribute_configuration#

Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC).

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

# update_instance_access_control_attribute_configuration method definition

def update_instance_access_control_attribute_configuration(
    self,
    *,
    InstanceArn: str,
    InstanceAccessControlAttributeConfiguration: InstanceAccessControlAttributeConfigurationUnionTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See InstanceAccessControlAttributeConfigurationUnionTypeDef
# update_instance_access_control_attribute_configuration method usage example with argument unpacking

kwargs: UpdateInstanceAccessControlAttributeConfigurationRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "InstanceAccessControlAttributeConfiguration": ...,
}

parent.update_instance_access_control_attribute_configuration(**kwargs)
  1. See UpdateInstanceAccessControlAttributeConfigurationRequestTypeDef

update_permission_set#

Updates an existing permission set.

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

# update_permission_set method definition

def update_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    Description: str = ...,
    SessionDuration: str = ...,
    RelayState: str = ...,
) -> Dict[str, Any]:
    ...
# update_permission_set method usage example with argument unpacking

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

parent.update_permission_set(**kwargs)
  1. See UpdatePermissionSetRequestTypeDef

update_trusted_token_issuer#

Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.

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

# update_trusted_token_issuer method definition

def update_trusted_token_issuer(
    self,
    *,
    TrustedTokenIssuerArn: str,
    Name: str = ...,
    TrustedTokenIssuerConfiguration: TrustedTokenIssuerUpdateConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See TrustedTokenIssuerUpdateConfigurationTypeDef
# update_trusted_token_issuer method usage example with argument unpacking

kwargs: UpdateTrustedTokenIssuerRequestTypeDef = {  # (1)
    "TrustedTokenIssuerArn": ...,
}

parent.update_trusted_token_issuer(**kwargs)
  1. See UpdateTrustedTokenIssuerRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("sso-admin").get_paginator method with overloads.