Skip to content

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.client("sso-admin") boto3 documentation

Usage example
from aioboto3.session import Session
from types_aiobotocore_sso_admin.client import SSOAdminClient

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

Exceptions

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

Usage example
async with session.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)
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.client("sso-admin").attach_customer_managed_policy_reference_to_permission_set method. boto3 documentation

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
Usage example with kwargs
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 Amazon Web Services managed policy ARN to a permission set.

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

Method definition
await def attach_managed_policy_to_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    ManagedPolicyArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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.client("sso-admin").can_paginate method. boto3 documentation

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

close

Closes underlying endpoint connections.

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

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

create_account_assignment

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

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

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
Usage example with kwargs
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 Amazon Web Services SSO instance.

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

Method definition
await def create_instance_access_control_attribute_configuration(
    self,
    *,
    InstanceArn: str,
    InstanceAccessControlAttributeConfiguration: InstanceAccessControlAttributeConfigurationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See InstanceAccessControlAttributeConfigurationTypeDef
Usage example with kwargs
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 Amazon Web Services SSO instance.

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

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
Usage example with kwargs
kwargs: CreatePermissionSetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "InstanceArn": ...,
}

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

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

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
Usage example with kwargs
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.client("sso-admin").delete_inline_policy_from_permission_set method. boto3 documentation

Method definition
await def delete_inline_policy_from_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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 Amazon Web Services SSO instance and deletes all of the attribute mappings that have been configured.

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

Method definition
await def delete_instance_access_control_attribute_configuration(
    self,
    *,
    InstanceArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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.client("sso-admin").delete_permission_set method. boto3 documentation

Method definition
await def delete_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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.client("sso-admin").delete_permissions_boundary_from_permission_set method. boto3 documentation

Method definition
await def delete_permissions_boundary_from_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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.client("sso-admin").describe_account_assignment_creation_status method. boto3 documentation

Method definition
await def describe_account_assignment_creation_status(
    self,
    *,
    InstanceArn: str,
    AccountAssignmentCreationRequestId: str,
) -> DescribeAccountAssignmentCreationStatusResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountAssignmentCreationStatusResponseTypeDef
Usage example with kwargs
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.client("sso-admin").describe_account_assignment_deletion_status method. boto3 documentation

Method definition
await def describe_account_assignment_deletion_status(
    self,
    *,
    InstanceArn: str,
    AccountAssignmentDeletionRequestId: str,
) -> DescribeAccountAssignmentDeletionStatusResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountAssignmentDeletionStatusResponseTypeDef
Usage example with kwargs
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 Amazon Web Services SSO identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified Amazon Web Services SSO instance.

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

Method definition
await def describe_instance_access_control_attribute_configuration(
    self,
    *,
    InstanceArn: str,
) -> DescribeInstanceAccessControlAttributeConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeInstanceAccessControlAttributeConfigurationResponseTypeDef
Usage example with kwargs
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.client("sso-admin").describe_permission_set method. boto3 documentation

Method definition
await def describe_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> DescribePermissionSetResponseTypeDef:  # (1)
    ...
  1. See DescribePermissionSetResponseTypeDef
Usage example with kwargs
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.client("sso-admin").describe_permission_set_provisioning_status method. boto3 documentation

Method definition
await def describe_permission_set_provisioning_status(
    self,
    *,
    InstanceArn: str,
    ProvisionPermissionSetRequestId: str,
) -> DescribePermissionSetProvisioningStatusResponseTypeDef:  # (1)
    ...
  1. See DescribePermissionSetProvisioningStatusResponseTypeDef
Usage example with kwargs
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.client("sso-admin").detach_customer_managed_policy_reference_from_permission_set method. boto3 documentation

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
Usage example with kwargs
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 Amazon Web Services managed policy ARN from the specified permission set.

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

Method definition
await def detach_managed_policy_from_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    ManagedPolicyArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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.client("sso-admin").generate_presigned_url method. boto3 documentation

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.client("sso-admin").get_inline_policy_for_permission_set method. boto3 documentation

Method definition
await def get_inline_policy_for_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> GetInlinePolicyForPermissionSetResponseTypeDef:  # (1)
    ...
  1. See GetInlinePolicyForPermissionSetResponseTypeDef
Usage example with kwargs
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.client("sso-admin").get_permissions_boundary_for_permission_set method. boto3 documentation

Method definition
await def get_permissions_boundary_for_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
) -> GetPermissionsBoundaryForPermissionSetResponseTypeDef:  # (1)
    ...
  1. See GetPermissionsBoundaryForPermissionSetResponseTypeDef
Usage example with kwargs
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 Amazon Web Services account assignment creation requests for a specified Amazon Web Services SSO instance.

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

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

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

list_account_assignment_deletion_status

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

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

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

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

list_account_assignments

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

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

Method definition
await def list_account_assignments(
    self,
    *,
    InstanceArn: str,
    AccountId: str,
    PermissionSetArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAccountAssignmentsResponseTypeDef:  # (1)
    ...
  1. See ListAccountAssignmentsResponseTypeDef
Usage example with kwargs
kwargs: ListAccountAssignmentsRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "AccountId": ...,
    "PermissionSetArn": ...,
}

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

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

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
Usage example with kwargs
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.client("sso-admin").list_customer_managed_policy_references_in_permission_set method. boto3 documentation

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

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

list_instances

Lists the Amazon Web Services SSO instances that the caller has access to.

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

Method definition
await def list_instances(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInstancesResponseTypeDef:  # (1)
    ...
  1. See ListInstancesResponseTypeDef
Usage example with kwargs
kwargs: ListInstancesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

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

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

Method definition
await def list_managed_policies_in_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListManagedPoliciesInPermissionSetResponseTypeDef:  # (1)
    ...
  1. See ListManagedPoliciesInPermissionSetResponseTypeDef
Usage example with kwargs
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 Amazon Web Services SSO instance.

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

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

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

list_permission_sets

Lists the PermissionSet s in an Amazon Web Services SSO instance.

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

Method definition
await def list_permission_sets(
    self,
    *,
    InstanceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPermissionSetsResponseTypeDef:  # (1)
    ...
  1. See ListPermissionSetsResponseTypeDef
Usage example with kwargs
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 Amazon Web Services account.

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

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
Usage example with kwargs
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.client("sso-admin").list_tags_for_resource method. boto3 documentation

Method definition
await def list_tags_for_resource(
    self,
    *,
    InstanceArn: str,
    ResourceArn: str,
    NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
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.client("sso-admin").provision_permission_set method. boto3 documentation

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
Usage example with kwargs
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.client("sso-admin").put_inline_policy_to_permission_set method. boto3 documentation

Method definition
await def put_inline_policy_to_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    InlinePolicy: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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 Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.

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

Method definition
await def put_permissions_boundary_to_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    PermissionsBoundary: PermissionsBoundaryTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See PermissionsBoundaryTypeDef
Usage example with kwargs
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.client("sso-admin").tag_resource method. boto3 documentation

Method definition
await def tag_resource(
    self,
    *,
    InstanceArn: str,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
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.client("sso-admin").untag_resource method. boto3 documentation

Method definition
await def untag_resource(
    self,
    *,
    InstanceArn: str,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "ResourceArn": ...,
    "TagKeys": ...,
}

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

update_instance_access_control_attribute_configuration

Updates the Amazon Web Services SSO identity store attributes that you can use with the Amazon Web Services SSO instance for attributes-based access control (ABAC).

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

Method definition
await def update_instance_access_control_attribute_configuration(
    self,
    *,
    InstanceArn: str,
    InstanceAccessControlAttributeConfiguration: InstanceAccessControlAttributeConfigurationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See InstanceAccessControlAttributeConfigurationTypeDef
Usage example with kwargs
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.client("sso-admin").update_permission_set method. boto3 documentation

Method definition
await def update_permission_set(
    self,
    *,
    InstanceArn: str,
    PermissionSetArn: str,
    Description: str = ...,
    SessionDuration: str = ...,
    RelayState: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdatePermissionSetRequestRequestTypeDef = {  # (1)
    "InstanceArn": ...,
    "PermissionSetArn": ...,
}

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

__aenter__

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

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

__aexit__

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

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.client("sso-admin").get_paginator method with overloads.