SSOAdminClient

Index > SSOAdmin > SSOAdminClient

Auto-generated documentation for SSOAdmin type annotations stubs module types-aiobotocore-sso-admin.

SSOAdminClient

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

SSOAdminClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_sso_admin.client import SSOAdminClient

session = get_session()
async with session.create_client("sso-admin") as client:
    client: SSOAdminClient

Exceptions

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

SSOAdminClient.exceptions usage example

async with session.create_client("sso-admin") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ClientError,
        client.ConflictException,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ServiceQuotaExceededException,
        client.ThrottlingException,
        client.ValidationException,
    ) as e:
        print(e)

SSOAdminClient usage type checking example

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

# attach_customer_managed_policy_reference_to_permission_set method definition

await 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: AttachCustomerManagedPolicyReferenceToPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "CustomerManagedPolicyReference": ...,
}

parent.attach_customer_managed_policy_reference_to_permission_set(**kwargs)

1. See AttachCustomerManagedPolicyReferenceToPermissionSetRequestRequestTypeDef

attach_managed_policy_to_permission_set

Attaches an AWS managed policy ARN to a permission set.

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

# attach_managed_policy_to_permission_set method definition

await 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: AttachManagedPolicyToPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "ManagedPolicyArn": ...,
}

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 session.create_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 session.create_client("sso-admin").close method. boto3 documentation

# close method definition

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

create_account_assignment

Assigns access to a principal for a specified AWS account using a specified permission set.

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

# create_account_assignment method definition

await 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: CreateAccountAssignmentRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "TargetId": ...,
    "TargetType": ...,
    "PermissionSetArn": ...,
    "PrincipalType": ...,
    "PrincipalId": ...,
}

parent.create_account_assignment(**kwargs)

1. See CreateAccountAssignmentRequestRequestTypeDef

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 session.create_client("sso-admin").create_instance_access_control_attribute_configuration method. boto3 documentation

# create_instance_access_control_attribute_configuration method definition

await def create_instance_access_control_attribute_configuration(
    self,
    *,
    InstanceArn: str,
    InstanceAccessControlAttributeConfiguration: InstanceAccessControlAttributeConfigurationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See InstanceAccessControlAttributeConfigurationTypeDef

# create_instance_access_control_attribute_configuration method usage example with argument unpacking

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

parent.create_instance_access_control_attribute_configuration(**kwargs)

1. See CreateInstanceAccessControlAttributeConfigurationRequestRequestTypeDef

create_permission_set

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

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

# create_permission_set method definition

await def create_permission_set(
    self,
    *,
    Name: str,
    InstanceArn: str,
    Description: str = ...,
    SessionDuration: str = ...,
    RelayState: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreatePermissionSetResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreatePermissionSetResponseTypeDef

# create_permission_set method usage example with argument unpacking

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

parent.create_permission_set(**kwargs)

1. See CreatePermissionSetRequestRequestTypeDef

delete_account_assignment

Deletes a principal's access from a specified AWS account using a specified permission set.

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

# delete_account_assignment method definition

await 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: DeleteAccountAssignmentRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "TargetId": ...,
    "TargetType": ...,
    "PermissionSetArn": ...,
    "PrincipalType": ...,
    "PrincipalId": ...,
}

parent.delete_account_assignment(**kwargs)

1. See DeleteAccountAssignmentRequestRequestTypeDef

delete_inline_policy_from_permission_set

Deletes the inline policy from a specified permission set.

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

# delete_inline_policy_from_permission_set method definition

await 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: DeleteInlinePolicyFromPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
}

parent.delete_inline_policy_from_permission_set(**kwargs)

1. See DeleteInlinePolicyFromPermissionSetRequestRequestTypeDef

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 session.create_client("sso-admin").delete_instance_access_control_attribute_configuration method. boto3 documentation

# delete_instance_access_control_attribute_configuration method definition

await 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: DeleteInstanceAccessControlAttributeConfigurationRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.delete_instance_access_control_attribute_configuration(**kwargs)

1. See DeleteInstanceAccessControlAttributeConfigurationRequestRequestTypeDef

delete_permission_set

Deletes the specified permission set.

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

# delete_permission_set method definition

await def delete_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> Dict[str, Any]:
    ...

# delete_permission_set method usage example with argument unpacking

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

parent.delete_permission_set(**kwargs)

1. See DeletePermissionSetRequestRequestTypeDef

delete_permissions_boundary_from_permission_set

Deletes the permissions boundary from a specified PermissionSet.

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

# delete_permissions_boundary_from_permission_set method definition

await 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: DeletePermissionsBoundaryFromPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
}

parent.delete_permissions_boundary_from_permission_set(**kwargs)

1. See DeletePermissionsBoundaryFromPermissionSetRequestRequestTypeDef

describe_account_assignment_creation_status

Describes the status of the assignment creation request.

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

# describe_account_assignment_creation_status method definition

await 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: DescribeAccountAssignmentCreationStatusRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "AccountAssignmentCreationRequestId": ...,
}

parent.describe_account_assignment_creation_status(**kwargs)

1. See DescribeAccountAssignmentCreationStatusRequestRequestTypeDef

describe_account_assignment_deletion_status

Describes the status of the assignment deletion request.

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

# describe_account_assignment_deletion_status method definition

await 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: DescribeAccountAssignmentDeletionStatusRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "AccountAssignmentDeletionRequestId": ...,
}

parent.describe_account_assignment_deletion_status(**kwargs)

1. See DescribeAccountAssignmentDeletionStatusRequestRequestTypeDef

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 session.create_client("sso-admin").describe_instance_access_control_attribute_configuration method. boto3 documentation

# describe_instance_access_control_attribute_configuration method definition

await 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: DescribeInstanceAccessControlAttributeConfigurationRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.describe_instance_access_control_attribute_configuration(**kwargs)

1. See DescribeInstanceAccessControlAttributeConfigurationRequestRequestTypeDef

describe_permission_set

Gets the details of the permission set.

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

# describe_permission_set method definition

await def describe_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> DescribePermissionSetResponseTypeDef:  # (1)
    ...

1. See DescribePermissionSetResponseTypeDef

# describe_permission_set method usage example with argument unpacking

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

parent.describe_permission_set(**kwargs)

1. See DescribePermissionSetRequestRequestTypeDef

describe_permission_set_provisioning_status

Describes the status for the given permission set provisioning request.

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

# describe_permission_set_provisioning_status method definition

await 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: DescribePermissionSetProvisioningStatusRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "ProvisionPermissionSetRequestId": ...,
}

parent.describe_permission_set_provisioning_status(**kwargs)

1. See DescribePermissionSetProvisioningStatusRequestRequestTypeDef

detach_customer_managed_policy_reference_from_permission_set

Detaches the specified customer managed policy from the specified PermissionSet.

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

# detach_customer_managed_policy_reference_from_permission_set method definition

await 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: DetachCustomerManagedPolicyReferenceFromPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "CustomerManagedPolicyReference": ...,
}

parent.detach_customer_managed_policy_reference_from_permission_set(**kwargs)

1. See DetachCustomerManagedPolicyReferenceFromPermissionSetRequestRequestTypeDef

detach_managed_policy_from_permission_set

Detaches the attached AWS managed policy ARN from the specified permission set.

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

# detach_managed_policy_from_permission_set method definition

await 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: DetachManagedPolicyFromPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "ManagedPolicyArn": ...,
}

parent.detach_managed_policy_from_permission_set(**kwargs)

1. See DetachManagedPolicyFromPermissionSetRequestRequestTypeDef

generate_presigned_url

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

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

get_inline_policy_for_permission_set

Obtains the inline policy assigned to the permission set.

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

# get_inline_policy_for_permission_set method definition

await 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: GetInlinePolicyForPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
}

parent.get_inline_policy_for_permission_set(**kwargs)

1. See GetInlinePolicyForPermissionSetRequestRequestTypeDef

get_permissions_boundary_for_permission_set

Obtains the permissions boundary for a specified PermissionSet.

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

# get_permissions_boundary_for_permission_set method definition

await 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: GetPermissionsBoundaryForPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
}

parent.get_permissions_boundary_for_permission_set(**kwargs)

1. See GetPermissionsBoundaryForPermissionSetRequestRequestTypeDef

list_account_assignment_creation_status

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

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

# list_account_assignment_creation_status method definition

await 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: ListAccountAssignmentCreationStatusRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.list_account_assignment_creation_status(**kwargs)

1. See ListAccountAssignmentCreationStatusRequestRequestTypeDef

list_account_assignment_deletion_status

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

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

# list_account_assignment_deletion_status method definition

await 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: ListAccountAssignmentDeletionStatusRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.list_account_assignment_deletion_status(**kwargs)

1. See ListAccountAssignmentDeletionStatusRequestRequestTypeDef

list_account_assignments

Lists the assignee of the specified AWS account with the specified permission set.

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

# list_account_assignments method definition

await 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: ListAccountAssignmentsRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "AccountId": ...,
    "PermissionSetArn": ...,
}

parent.list_account_assignments(**kwargs)

1. See ListAccountAssignmentsRequestRequestTypeDef

list_accounts_for_provisioned_permission_set

Lists all the AWS accounts where the specified permission set is provisioned.

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

# list_accounts_for_provisioned_permission_set method definition

await 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: ListAccountsForProvisionedPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
}

parent.list_accounts_for_provisioned_permission_set(**kwargs)

1. See ListAccountsForProvisionedPermissionSetRequestRequestTypeDef

list_customer_managed_policy_references_in_permission_set

Lists all customer managed policies attached to a specified PermissionSet.

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

# list_customer_managed_policy_references_in_permission_set method definition

await 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: ListCustomerManagedPolicyReferencesInPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
}

parent.list_customer_managed_policy_references_in_permission_set(**kwargs)

1. See ListCustomerManagedPolicyReferencesInPermissionSetRequestRequestTypeDef

list_instances

Lists the IAM Identity Center instances that the caller has access to.

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

# list_instances method definition

await def list_instances(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInstancesResponseTypeDef:  # (1)
    ...

1. See ListInstancesResponseTypeDef

# list_instances method usage example with argument unpacking

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

parent.list_instances(**kwargs)

1. See ListInstancesRequestRequestTypeDef

list_managed_policies_in_permission_set

Lists the AWS managed policy that is attached to a specified permission set.

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

# list_managed_policies_in_permission_set method definition

await 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: ListManagedPoliciesInPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
}

parent.list_managed_policies_in_permission_set(**kwargs)

1. See ListManagedPoliciesInPermissionSetRequestRequestTypeDef

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 session.create_client("sso-admin").list_permission_set_provisioning_status method. boto3 documentation

# list_permission_set_provisioning_status method definition

await 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: ListPermissionSetProvisioningStatusRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.list_permission_set_provisioning_status(**kwargs)

1. See ListPermissionSetProvisioningStatusRequestRequestTypeDef

list_permission_sets

Lists the PermissionSets in an IAM Identity Center instance.

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

# list_permission_sets method definition

await 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: ListPermissionSetsRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
}

parent.list_permission_sets(**kwargs)

1. See ListPermissionSetsRequestRequestTypeDef

list_permission_sets_provisioned_to_account

Lists all the permission sets that are provisioned to a specified AWS account.

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

# list_permission_sets_provisioned_to_account method definition

await 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: ListPermissionSetsProvisionedToAccountRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "AccountId": ...,
}

parent.list_permission_sets_provisioned_to_account(**kwargs)

1. See ListPermissionSetsProvisionedToAccountRequestRequestTypeDef

list_tags_for_resource

Lists the tags that are attached to a specified resource.

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

# list_tags_for_resource method definition

await def list_tags_for_resource(
    self,
    *,
    InstanceArn: str,
    ResourceArn: str,
    NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

provision_permission_set

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

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

# provision_permission_set method definition

await 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: ProvisionPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "TargetType": ...,
}

parent.provision_permission_set(**kwargs)

1. See ProvisionPermissionSetRequestRequestTypeDef

put_inline_policy_to_permission_set

Attaches an inline policy to a permission set.

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

# put_inline_policy_to_permission_set method definition

await 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: PutInlinePolicyToPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "InlinePolicy": ...,
}

parent.put_inline_policy_to_permission_set(**kwargs)

1. See PutInlinePolicyToPermissionSetRequestRequestTypeDef

put_permissions_boundary_to_permission_set

Attaches an AWS managed or customer managed policy to the specified PermissionSet as a permissions boundary.

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

# put_permissions_boundary_to_permission_set method definition

await 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: PutPermissionsBoundaryToPermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
    "PermissionsBoundary": ...,
}

parent.put_permissions_boundary_to_permission_set(**kwargs)

1. See PutPermissionsBoundaryToPermissionSetRequestRequestTypeDef

tag_resource

Associates a set of tags with a specified resource.

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

# tag_resource method definition

await def tag_resource(
    self,
    *,
    InstanceArn: str,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Disassociates a set of tags from a specified resource.

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

# untag_resource method definition

await def untag_resource(
    self,
    *,
    InstanceArn: str,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

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 session.create_client("sso-admin").update_instance_access_control_attribute_configuration method. boto3 documentation

# update_instance_access_control_attribute_configuration method definition

await def update_instance_access_control_attribute_configuration(
    self,
    *,
    InstanceArn: str,
    InstanceAccessControlAttributeConfiguration: InstanceAccessControlAttributeConfigurationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See InstanceAccessControlAttributeConfigurationTypeDef

# update_instance_access_control_attribute_configuration method usage example with argument unpacking

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

parent.update_instance_access_control_attribute_configuration(**kwargs)

1. See UpdateInstanceAccessControlAttributeConfigurationRequestRequestTypeDef

update_permission_set

Updates an existing permission set.

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

# update_permission_set method definition

await 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: UpdatePermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
}

parent.update_permission_set(**kwargs)

1. See UpdatePermissionSetRequestRequestTypeDef

__aenter__

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

# __aenter__ method definition

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

__aexit__

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

# __aexit__ method definition

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

get_paginator

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

• client.get_paginator("list_account_assignment_creation_status") -> ListAccountAssignmentCreationStatusPaginator
• client.get_paginator("list_account_assignment_deletion_status") -> ListAccountAssignmentDeletionStatusPaginator
• client.get_paginator("list_account_assignments") -> ListAccountAssignmentsPaginator
• client.get_paginator("list_accounts_for_provisioned_permission_set") -> ListAccountsForProvisionedPermissionSetPaginator
• client.get_paginator("list_customer_managed_policy_references_in_permission_set") -> ListCustomerManagedPolicyReferencesInPermissionSetPaginator
• client.get_paginator("list_instances") -> ListInstancesPaginator
• client.get_paginator("list_managed_policies_in_permission_set") -> ListManagedPoliciesInPermissionSetPaginator
• client.get_paginator("list_permission_set_provisioning_status") -> ListPermissionSetProvisioningStatusPaginator
• client.get_paginator("list_permission_sets") -> ListPermissionSetsPaginator
• client.get_paginator("list_permission_sets_provisioned_to_account") -> ListPermissionSetsProvisionedToAccountPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator