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
# SSOAdminClient 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.
# SSOAdminClient.exceptions usage example
async with session.client("sso-admin") as client:
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)
# SSOAdminClient.exceptions 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
# attach_customer_managed_policy_reference_to_permission_set method definition
await def attach_customer_managed_policy_reference_to_permission_set(
self,
*,
CustomerManagedPolicyReference: CustomerManagedPolicyReferenceTypeDef, # (1)
InstanceArn: str,
PermissionSetArn: str,
) -> Dict[str, Any]:
...
# attach_customer_managed_policy_reference_to_permission_set method usage example with argument unpacking
kwargs: AttachCustomerManagedPolicyReferenceToPermissionSetRequestRequestTypeDef = { # (1)
"CustomerManagedPolicyReference": ...,
"InstanceArn": ...,
"PermissionSetArn": ...,
}
parent.attach_customer_managed_policy_reference_to_permission_set(**kwargs)
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
# attach_managed_policy_to_permission_set method definition
await def attach_managed_policy_to_permission_set(
self,
*,
InstanceArn: str,
ManagedPolicyArn: str,
PermissionSetArn: str,
) -> Dict[str, Any]:
...
# attach_managed_policy_to_permission_set method usage example with argument unpacking
kwargs: AttachManagedPolicyToPermissionSetRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"ManagedPolicyArn": ...,
"PermissionSetArn": ...,
}
parent.attach_managed_policy_to_permission_set(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.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.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 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
# create_account_assignment method definition
await def create_account_assignment(
self,
*,
InstanceArn: str,
PermissionSetArn: str,
PrincipalId: str,
PrincipalType: PrincipalTypeType, # (1)
TargetId: str,
TargetType: TargetTypeType, # (2)
) -> CreateAccountAssignmentResponseTypeDef: # (3)
...
# create_account_assignment method usage example with argument unpacking
kwargs: CreateAccountAssignmentRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"PermissionSetArn": ...,
"PrincipalId": ...,
"PrincipalType": ...,
"TargetId": ...,
"TargetType": ...,
}
parent.create_account_assignment(**kwargs)
create_application#
Creates an application in IAM Identity Center for the given application provider.
Type annotations and code completion for session.client("sso-admin").create_application
method.
boto3 documentation
# create_application method definition
await def create_application(
self,
*,
ApplicationProviderArn: str,
InstanceArn: str,
Name: str,
ClientToken: str = ...,
Description: str = ...,
PortalOptions: PortalOptionsTypeDef = ..., # (1)
Status: ApplicationStatusType = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateApplicationResponseTypeDef: # (4)
...
- See PortalOptionsTypeDef
- See ApplicationStatusType
- See TagTypeDef
- See CreateApplicationResponseTypeDef
# create_application method usage example with argument unpacking
kwargs: CreateApplicationRequestRequestTypeDef = { # (1)
"ApplicationProviderArn": ...,
"InstanceArn": ...,
"Name": ...,
}
parent.create_application(**kwargs)
create_application_assignment#
Grant application access to a user or group.
Type annotations and code completion for session.client("sso-admin").create_application_assignment
method.
boto3 documentation
# create_application_assignment method definition
await def create_application_assignment(
self,
*,
ApplicationArn: str,
PrincipalId: str,
PrincipalType: PrincipalTypeType, # (1)
) -> Dict[str, Any]:
...
# create_application_assignment method usage example with argument unpacking
kwargs: CreateApplicationAssignmentRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"PrincipalId": ...,
"PrincipalType": ...,
}
parent.create_application_assignment(**kwargs)
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 session.client("sso-admin").create_instance
method.
boto3 documentation
# create_instance method definition
await def create_instance(
self,
*,
ClientToken: str = ...,
Name: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateInstanceResponseTypeDef: # (2)
...
# create_instance method usage example with argument unpacking
kwargs: CreateInstanceRequestRequestTypeDef = { # (1)
"ClientToken": ...,
}
parent.create_instance(**kwargs)
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.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,
*,
InstanceAccessControlAttributeConfiguration: InstanceAccessControlAttributeConfigurationTypeDef, # (1)
InstanceArn: str,
) -> Dict[str, Any]:
...
# create_instance_access_control_attribute_configuration method usage example with argument unpacking
kwargs: CreateInstanceAccessControlAttributeConfigurationRequestRequestTypeDef = { # (1)
"InstanceAccessControlAttributeConfiguration": ...,
"InstanceArn": ...,
}
parent.create_instance_access_control_attribute_configuration(**kwargs)
create_permission_set#
Creates a permission set within a specified IAM Identity Center instance.
Type annotations and code completion for session.client("sso-admin").create_permission_set
method.
boto3 documentation
# create_permission_set method definition
await def create_permission_set(
self,
*,
InstanceArn: str,
Name: str,
Description: str = ...,
RelayState: str = ...,
SessionDuration: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreatePermissionSetResponseTypeDef: # (2)
...
# create_permission_set method usage example with argument unpacking
kwargs: CreatePermissionSetRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"Name": ...,
}
parent.create_permission_set(**kwargs)
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 session.client("sso-admin").create_trusted_token_issuer
method.
boto3 documentation
# create_trusted_token_issuer method definition
await def create_trusted_token_issuer(
self,
*,
InstanceArn: str,
Name: str,
TrustedTokenIssuerConfiguration: TrustedTokenIssuerConfigurationTypeDef, # (1)
TrustedTokenIssuerType: TrustedTokenIssuerTypeType, # (2)
ClientToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateTrustedTokenIssuerResponseTypeDef: # (4)
...
- See TrustedTokenIssuerConfigurationTypeDef
- See TrustedTokenIssuerTypeType
- See TagTypeDef
- See CreateTrustedTokenIssuerResponseTypeDef
# create_trusted_token_issuer method usage example with argument unpacking
kwargs: CreateTrustedTokenIssuerRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"Name": ...,
"TrustedTokenIssuerConfiguration": ...,
"TrustedTokenIssuerType": ...,
}
parent.create_trusted_token_issuer(**kwargs)
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
# delete_account_assignment method definition
await def delete_account_assignment(
self,
*,
InstanceArn: str,
PermissionSetArn: str,
PrincipalId: str,
PrincipalType: PrincipalTypeType, # (1)
TargetId: str,
TargetType: TargetTypeType, # (2)
) -> DeleteAccountAssignmentResponseTypeDef: # (3)
...
# delete_account_assignment method usage example with argument unpacking
kwargs: DeleteAccountAssignmentRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"PermissionSetArn": ...,
"PrincipalId": ...,
"PrincipalType": ...,
"TargetId": ...,
"TargetType": ...,
}
parent.delete_account_assignment(**kwargs)
delete_application#
Deletes the association with the application.
Type annotations and code completion for session.client("sso-admin").delete_application
method.
boto3 documentation
# delete_application method definition
await def delete_application(
self,
*,
ApplicationArn: str,
) -> Dict[str, Any]:
...
# delete_application method usage example with argument unpacking
kwargs: DeleteApplicationRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
}
parent.delete_application(**kwargs)
delete_application_access_scope#
Deletes an IAM Identity Center access scope from an application.
Type annotations and code completion for session.client("sso-admin").delete_application_access_scope
method.
boto3 documentation
# delete_application_access_scope method definition
await def delete_application_access_scope(
self,
*,
ApplicationArn: str,
Scope: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_application_access_scope method usage example with argument unpacking
kwargs: DeleteApplicationAccessScopeRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"Scope": ...,
}
parent.delete_application_access_scope(**kwargs)
delete_application_assignment#
Revoke application access to an application by deleting application assignments for a user or group.
Type annotations and code completion for session.client("sso-admin").delete_application_assignment
method.
boto3 documentation
# delete_application_assignment method definition
await def delete_application_assignment(
self,
*,
ApplicationArn: str,
PrincipalId: str,
PrincipalType: PrincipalTypeType, # (1)
) -> Dict[str, Any]:
...
# delete_application_assignment method usage example with argument unpacking
kwargs: DeleteApplicationAssignmentRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"PrincipalId": ...,
"PrincipalType": ...,
}
parent.delete_application_assignment(**kwargs)
delete_application_authentication_method#
Deletes an authentication method from an application.
Type annotations and code completion for session.client("sso-admin").delete_application_authentication_method
method.
boto3 documentation
# delete_application_authentication_method method definition
await def delete_application_authentication_method(
self,
*,
ApplicationArn: str,
AuthenticationMethodType: AuthenticationMethodTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# delete_application_authentication_method method usage example with argument unpacking
kwargs: DeleteApplicationAuthenticationMethodRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"AuthenticationMethodType": ...,
}
parent.delete_application_authentication_method(**kwargs)
delete_application_grant#
Deletes a grant from an application.
Type annotations and code completion for session.client("sso-admin").delete_application_grant
method.
boto3 documentation
# delete_application_grant method definition
await def delete_application_grant(
self,
*,
ApplicationArn: str,
GrantType: GrantTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# delete_application_grant method usage example with argument unpacking
kwargs: DeleteApplicationGrantRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"GrantType": ...,
}
parent.delete_application_grant(**kwargs)
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
# 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)
delete_instance#
Deletes the instance of IAM Identity Center.
Type annotations and code completion for session.client("sso-admin").delete_instance
method.
boto3 documentation
# delete_instance method definition
await def delete_instance(
self,
*,
InstanceArn: str,
) -> Dict[str, Any]:
...
# delete_instance method usage example with argument unpacking
kwargs: DeleteInstanceRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
}
parent.delete_instance(**kwargs)
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.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)
delete_permission_set#
Deletes the specified permission set.
Type annotations and code completion for session.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)
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
# 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)
delete_trusted_token_issuer#
Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
Type annotations and code completion for session.client("sso-admin").delete_trusted_token_issuer
method.
boto3 documentation
# delete_trusted_token_issuer method definition
await def delete_trusted_token_issuer(
self,
*,
TrustedTokenIssuerArn: str,
) -> Dict[str, Any]:
...
# delete_trusted_token_issuer method usage example with argument unpacking
kwargs: DeleteTrustedTokenIssuerRequestRequestTypeDef = { # (1)
"TrustedTokenIssuerArn": ...,
}
parent.delete_trusted_token_issuer(**kwargs)
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
# describe_account_assignment_creation_status method definition
await def describe_account_assignment_creation_status(
self,
*,
AccountAssignmentCreationRequestId: str,
InstanceArn: str,
) -> DescribeAccountAssignmentCreationStatusResponseTypeDef: # (1)
...
# describe_account_assignment_creation_status method usage example with argument unpacking
kwargs: DescribeAccountAssignmentCreationStatusRequestRequestTypeDef = { # (1)
"AccountAssignmentCreationRequestId": ...,
"InstanceArn": ...,
}
parent.describe_account_assignment_creation_status(**kwargs)
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
# describe_account_assignment_deletion_status method definition
await def describe_account_assignment_deletion_status(
self,
*,
AccountAssignmentDeletionRequestId: str,
InstanceArn: str,
) -> DescribeAccountAssignmentDeletionStatusResponseTypeDef: # (1)
...
# describe_account_assignment_deletion_status method usage example with argument unpacking
kwargs: DescribeAccountAssignmentDeletionStatusRequestRequestTypeDef = { # (1)
"AccountAssignmentDeletionRequestId": ...,
"InstanceArn": ...,
}
parent.describe_account_assignment_deletion_status(**kwargs)
describe_application#
Retrieves the details of an application associated with an instance of IAM Identity Center.
Type annotations and code completion for session.client("sso-admin").describe_application
method.
boto3 documentation
# describe_application method definition
await def describe_application(
self,
*,
ApplicationArn: str,
) -> DescribeApplicationResponseTypeDef: # (1)
...
# describe_application method usage example with argument unpacking
kwargs: DescribeApplicationRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
}
parent.describe_application(**kwargs)
describe_application_assignment#
Retrieves a direct assignment of a user or group to an application.
Type annotations and code completion for session.client("sso-admin").describe_application_assignment
method.
boto3 documentation
# describe_application_assignment method definition
await def describe_application_assignment(
self,
*,
ApplicationArn: str,
PrincipalId: str,
PrincipalType: PrincipalTypeType, # (1)
) -> DescribeApplicationAssignmentResponseTypeDef: # (2)
...
# describe_application_assignment method usage example with argument unpacking
kwargs: DescribeApplicationAssignmentRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"PrincipalId": ...,
"PrincipalType": ...,
}
parent.describe_application_assignment(**kwargs)
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 session.client("sso-admin").describe_application_provider
method.
boto3 documentation
# describe_application_provider method definition
await def describe_application_provider(
self,
*,
ApplicationProviderArn: str,
) -> DescribeApplicationProviderResponseTypeDef: # (1)
...
# describe_application_provider method usage example with argument unpacking
kwargs: DescribeApplicationProviderRequestRequestTypeDef = { # (1)
"ApplicationProviderArn": ...,
}
parent.describe_application_provider(**kwargs)
describe_instance#
Returns the details of an instance of IAM Identity Center.
Type annotations and code completion for session.client("sso-admin").describe_instance
method.
boto3 documentation
# describe_instance method definition
await def describe_instance(
self,
*,
InstanceArn: str,
) -> DescribeInstanceResponseTypeDef: # (1)
...
# describe_instance method usage example with argument unpacking
kwargs: DescribeInstanceRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
}
parent.describe_instance(**kwargs)
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.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)
...
# describe_instance_access_control_attribute_configuration method usage example with argument unpacking
kwargs: DescribeInstanceAccessControlAttributeConfigurationRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
}
parent.describe_instance_access_control_attribute_configuration(**kwargs)
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
# describe_permission_set method definition
await def describe_permission_set(
self,
*,
InstanceArn: str,
PermissionSetArn: str,
) -> DescribePermissionSetResponseTypeDef: # (1)
...
# describe_permission_set method usage example with argument unpacking
kwargs: DescribePermissionSetRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"PermissionSetArn": ...,
}
parent.describe_permission_set(**kwargs)
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
# describe_permission_set_provisioning_status method definition
await def describe_permission_set_provisioning_status(
self,
*,
InstanceArn: str,
ProvisionPermissionSetRequestId: str,
) -> DescribePermissionSetProvisioningStatusResponseTypeDef: # (1)
...
# describe_permission_set_provisioning_status method usage example with argument unpacking
kwargs: DescribePermissionSetProvisioningStatusRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"ProvisionPermissionSetRequestId": ...,
}
parent.describe_permission_set_provisioning_status(**kwargs)
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 session.client("sso-admin").describe_trusted_token_issuer
method.
boto3 documentation
# describe_trusted_token_issuer method definition
await def describe_trusted_token_issuer(
self,
*,
TrustedTokenIssuerArn: str,
) -> DescribeTrustedTokenIssuerResponseTypeDef: # (1)
...
# describe_trusted_token_issuer method usage example with argument unpacking
kwargs: DescribeTrustedTokenIssuerRequestRequestTypeDef = { # (1)
"TrustedTokenIssuerArn": ...,
}
parent.describe_trusted_token_issuer(**kwargs)
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
# detach_customer_managed_policy_reference_from_permission_set method definition
await def detach_customer_managed_policy_reference_from_permission_set(
self,
*,
CustomerManagedPolicyReference: CustomerManagedPolicyReferenceTypeDef, # (1)
InstanceArn: str,
PermissionSetArn: str,
) -> Dict[str, Any]:
...
# detach_customer_managed_policy_reference_from_permission_set method usage example with argument unpacking
kwargs: DetachCustomerManagedPolicyReferenceFromPermissionSetRequestRequestTypeDef = { # (1)
"CustomerManagedPolicyReference": ...,
"InstanceArn": ...,
"PermissionSetArn": ...,
}
parent.detach_customer_managed_policy_reference_from_permission_set(**kwargs)
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
# detach_managed_policy_from_permission_set method definition
await def detach_managed_policy_from_permission_set(
self,
*,
InstanceArn: str,
ManagedPolicyArn: str,
PermissionSetArn: str,
) -> Dict[str, Any]:
...
# detach_managed_policy_from_permission_set method usage example with argument unpacking
kwargs: DetachManagedPolicyFromPermissionSetRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"ManagedPolicyArn": ...,
"PermissionSetArn": ...,
}
parent.detach_managed_policy_from_permission_set(**kwargs)
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
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_application_access_scope#
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
Type annotations and code completion for session.client("sso-admin").get_application_access_scope
method.
boto3 documentation
# get_application_access_scope method definition
await def get_application_access_scope(
self,
*,
ApplicationArn: str,
Scope: str,
) -> GetApplicationAccessScopeResponseTypeDef: # (1)
...
# get_application_access_scope method usage example with argument unpacking
kwargs: GetApplicationAccessScopeRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"Scope": ...,
}
parent.get_application_access_scope(**kwargs)
get_application_assignment_configuration#
Retrieves the configuration of PutApplicationAssignmentConfiguration.
Type annotations and code completion for session.client("sso-admin").get_application_assignment_configuration
method.
boto3 documentation
# get_application_assignment_configuration method definition
await def get_application_assignment_configuration(
self,
*,
ApplicationArn: str,
) -> GetApplicationAssignmentConfigurationResponseTypeDef: # (1)
...
# get_application_assignment_configuration method usage example with argument unpacking
kwargs: GetApplicationAssignmentConfigurationRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
}
parent.get_application_assignment_configuration(**kwargs)
get_application_authentication_method#
Retrieves details about an authentication method used by an application.
Type annotations and code completion for session.client("sso-admin").get_application_authentication_method
method.
boto3 documentation
# get_application_authentication_method method definition
await def get_application_authentication_method(
self,
*,
ApplicationArn: str,
AuthenticationMethodType: AuthenticationMethodTypeType, # (1)
) -> GetApplicationAuthenticationMethodResponseTypeDef: # (2)
...
# get_application_authentication_method method usage example with argument unpacking
kwargs: GetApplicationAuthenticationMethodRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"AuthenticationMethodType": ...,
}
parent.get_application_authentication_method(**kwargs)
get_application_grant#
Retrieves details about an application grant.
Type annotations and code completion for session.client("sso-admin").get_application_grant
method.
boto3 documentation
# get_application_grant method definition
await def get_application_grant(
self,
*,
ApplicationArn: str,
GrantType: GrantTypeType, # (1)
) -> GetApplicationGrantResponseTypeDef: # (2)
...
# get_application_grant method usage example with argument unpacking
kwargs: GetApplicationGrantRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"GrantType": ...,
}
parent.get_application_grant(**kwargs)
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
# get_inline_policy_for_permission_set method definition
await def get_inline_policy_for_permission_set(
self,
*,
InstanceArn: str,
PermissionSetArn: str,
) -> GetInlinePolicyForPermissionSetResponseTypeDef: # (1)
...
# 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)
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
# get_permissions_boundary_for_permission_set method definition
await def get_permissions_boundary_for_permission_set(
self,
*,
InstanceArn: str,
PermissionSetArn: str,
) -> GetPermissionsBoundaryForPermissionSetResponseTypeDef: # (1)
...
# 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)
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 session.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,
Filter: OperationStatusFilterTypeDef = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAccountAssignmentCreationStatusResponseTypeDef: # (2)
...
# list_account_assignment_creation_status method usage example with argument unpacking
kwargs: ListAccountAssignmentCreationStatusRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
}
parent.list_account_assignment_creation_status(**kwargs)
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 session.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,
Filter: OperationStatusFilterTypeDef = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAccountAssignmentDeletionStatusResponseTypeDef: # (2)
...
# list_account_assignment_deletion_status method usage example with argument unpacking
kwargs: ListAccountAssignmentDeletionStatusRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
}
parent.list_account_assignment_deletion_status(**kwargs)
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
# list_account_assignments method definition
await def list_account_assignments(
self,
*,
AccountId: str,
InstanceArn: str,
PermissionSetArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAccountAssignmentsResponseTypeDef: # (1)
...
# list_account_assignments method usage example with argument unpacking
kwargs: ListAccountAssignmentsRequestRequestTypeDef = { # (1)
"AccountId": ...,
"InstanceArn": ...,
"PermissionSetArn": ...,
}
parent.list_account_assignments(**kwargs)
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 session.client("sso-admin").list_account_assignments_for_principal
method.
boto3 documentation
# list_account_assignments_for_principal method definition
await def list_account_assignments_for_principal(
self,
*,
InstanceArn: str,
PrincipalId: str,
PrincipalType: PrincipalTypeType, # (1)
Filter: ListAccountAssignmentsFilterTypeDef = ..., # (2)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAccountAssignmentsForPrincipalResponseTypeDef: # (3)
...
- See PrincipalTypeType
- See ListAccountAssignmentsFilterTypeDef
- See ListAccountAssignmentsForPrincipalResponseTypeDef
# list_account_assignments_for_principal method usage example with argument unpacking
kwargs: ListAccountAssignmentsForPrincipalRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"PrincipalId": ...,
"PrincipalType": ...,
}
parent.list_account_assignments_for_principal(**kwargs)
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
# list_accounts_for_provisioned_permission_set method definition
await def list_accounts_for_provisioned_permission_set(
self,
*,
InstanceArn: str,
PermissionSetArn: str,
MaxResults: int = ...,
NextToken: str = ...,
ProvisioningStatus: ProvisioningStatusType = ..., # (1)
) -> ListAccountsForProvisionedPermissionSetResponseTypeDef: # (2)
...
# 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)
list_application_access_scopes#
Lists the access scopes and authorized targets associated with an application.
Type annotations and code completion for session.client("sso-admin").list_application_access_scopes
method.
boto3 documentation
# list_application_access_scopes method definition
await def list_application_access_scopes(
self,
*,
ApplicationArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListApplicationAccessScopesResponseTypeDef: # (1)
...
# list_application_access_scopes method usage example with argument unpacking
kwargs: ListApplicationAccessScopesRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
}
parent.list_application_access_scopes(**kwargs)
list_application_assignments#
Lists Amazon Web Services account users that are assigned to an application.
Type annotations and code completion for session.client("sso-admin").list_application_assignments
method.
boto3 documentation
# list_application_assignments method definition
await def list_application_assignments(
self,
*,
ApplicationArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListApplicationAssignmentsResponseTypeDef: # (1)
...
# list_application_assignments method usage example with argument unpacking
kwargs: ListApplicationAssignmentsRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
}
parent.list_application_assignments(**kwargs)
list_application_assignments_for_principal#
Lists the applications to which a specified principal is assigned.
Type annotations and code completion for session.client("sso-admin").list_application_assignments_for_principal
method.
boto3 documentation
# list_application_assignments_for_principal method definition
await def list_application_assignments_for_principal(
self,
*,
InstanceArn: str,
PrincipalId: str,
PrincipalType: PrincipalTypeType, # (1)
Filter: ListApplicationAssignmentsFilterTypeDef = ..., # (2)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListApplicationAssignmentsForPrincipalResponseTypeDef: # (3)
...
- See PrincipalTypeType
- See ListApplicationAssignmentsFilterTypeDef
- See ListApplicationAssignmentsForPrincipalResponseTypeDef
# list_application_assignments_for_principal method usage example with argument unpacking
kwargs: ListApplicationAssignmentsForPrincipalRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"PrincipalId": ...,
"PrincipalType": ...,
}
parent.list_application_assignments_for_principal(**kwargs)
list_application_authentication_methods#
Lists all of the authentication methods supported by the specified application.
Type annotations and code completion for session.client("sso-admin").list_application_authentication_methods
method.
boto3 documentation
# list_application_authentication_methods method definition
await def list_application_authentication_methods(
self,
*,
ApplicationArn: str,
NextToken: str = ...,
) -> ListApplicationAuthenticationMethodsResponseTypeDef: # (1)
...
# list_application_authentication_methods method usage example with argument unpacking
kwargs: ListApplicationAuthenticationMethodsRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
}
parent.list_application_authentication_methods(**kwargs)
list_application_grants#
List the grants associated with an application.
Type annotations and code completion for session.client("sso-admin").list_application_grants
method.
boto3 documentation
# list_application_grants method definition
await def list_application_grants(
self,
*,
ApplicationArn: str,
NextToken: str = ...,
) -> ListApplicationGrantsResponseTypeDef: # (1)
...
# list_application_grants method usage example with argument unpacking
kwargs: ListApplicationGrantsRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
}
parent.list_application_grants(**kwargs)
list_application_providers#
Lists the application providers configured in the IAM Identity Center identity store.
Type annotations and code completion for session.client("sso-admin").list_application_providers
method.
boto3 documentation
# list_application_providers method definition
await def list_application_providers(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListApplicationProvidersResponseTypeDef: # (1)
...
# list_application_providers method usage example with argument unpacking
kwargs: ListApplicationProvidersRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_application_providers(**kwargs)
list_applications#
Lists all applications associated with the instance of IAM Identity Center.
Type annotations and code completion for session.client("sso-admin").list_applications
method.
boto3 documentation
# list_applications method definition
await def list_applications(
self,
*,
InstanceArn: str,
Filter: ListApplicationsFilterTypeDef = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListApplicationsResponseTypeDef: # (2)
...
# list_applications method usage example with argument unpacking
kwargs: ListApplicationsRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
}
parent.list_applications(**kwargs)
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
# 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)
...
# 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)
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 session.client("sso-admin").list_instances
method.
boto3 documentation
# list_instances method definition
await def list_instances(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListInstancesResponseTypeDef: # (1)
...
# list_instances method usage example with argument unpacking
kwargs: ListInstancesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_instances(**kwargs)
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
# 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)
...
# 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)
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.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,
Filter: OperationStatusFilterTypeDef = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListPermissionSetProvisioningStatusResponseTypeDef: # (2)
...
# list_permission_set_provisioning_status method usage example with argument unpacking
kwargs: ListPermissionSetProvisioningStatusRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
}
parent.list_permission_set_provisioning_status(**kwargs)
list_permission_sets#
Lists the PermissionSets in an IAM Identity Center instance.
Type annotations and code completion for session.client("sso-admin").list_permission_sets
method.
boto3 documentation
# list_permission_sets method definition
await def list_permission_sets(
self,
*,
InstanceArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListPermissionSetsResponseTypeDef: # (1)
...
# list_permission_sets method usage example with argument unpacking
kwargs: ListPermissionSetsRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
}
parent.list_permission_sets(**kwargs)
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
# list_permission_sets_provisioned_to_account method definition
await def list_permission_sets_provisioned_to_account(
self,
*,
AccountId: str,
InstanceArn: str,
MaxResults: int = ...,
NextToken: str = ...,
ProvisioningStatus: ProvisioningStatusType = ..., # (1)
) -> ListPermissionSetsProvisionedToAccountResponseTypeDef: # (2)
...
# list_permission_sets_provisioned_to_account method usage example with argument unpacking
kwargs: ListPermissionSetsProvisionedToAccountRequestRequestTypeDef = { # (1)
"AccountId": ...,
"InstanceArn": ...,
}
parent.list_permission_sets_provisioned_to_account(**kwargs)
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
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
InstanceArn: str = ...,
NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_trusted_token_issuers#
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
Type annotations and code completion for session.client("sso-admin").list_trusted_token_issuers
method.
boto3 documentation
# list_trusted_token_issuers method definition
await def list_trusted_token_issuers(
self,
*,
InstanceArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTrustedTokenIssuersResponseTypeDef: # (1)
...
# list_trusted_token_issuers method usage example with argument unpacking
kwargs: ListTrustedTokenIssuersRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
}
parent.list_trusted_token_issuers(**kwargs)
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
# provision_permission_set method definition
await def provision_permission_set(
self,
*,
InstanceArn: str,
PermissionSetArn: str,
TargetType: ProvisionTargetTypeType, # (1)
TargetId: str = ...,
) -> ProvisionPermissionSetResponseTypeDef: # (2)
...
# provision_permission_set method usage example with argument unpacking
kwargs: ProvisionPermissionSetRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"PermissionSetArn": ...,
"TargetType": ...,
}
parent.provision_permission_set(**kwargs)
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 session.client("sso-admin").put_application_access_scope
method.
boto3 documentation
# put_application_access_scope method definition
await def put_application_access_scope(
self,
*,
ApplicationArn: str,
Scope: str,
AuthorizedTargets: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# put_application_access_scope method usage example with argument unpacking
kwargs: PutApplicationAccessScopeRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"Scope": ...,
}
parent.put_application_access_scope(**kwargs)
put_application_assignment_configuration#
Configure how users gain access to an application.
Type annotations and code completion for session.client("sso-admin").put_application_assignment_configuration
method.
boto3 documentation
# put_application_assignment_configuration method definition
await def put_application_assignment_configuration(
self,
*,
ApplicationArn: str,
AssignmentRequired: bool,
) -> Dict[str, Any]:
...
# put_application_assignment_configuration method usage example with argument unpacking
kwargs: PutApplicationAssignmentConfigurationRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"AssignmentRequired": ...,
}
parent.put_application_assignment_configuration(**kwargs)
put_application_authentication_method#
Adds or updates an authentication method for an application.
Type annotations and code completion for session.client("sso-admin").put_application_authentication_method
method.
boto3 documentation
# put_application_authentication_method method definition
await def put_application_authentication_method(
self,
*,
ApplicationArn: str,
AuthenticationMethod: AuthenticationMethodTypeDef, # (1)
AuthenticationMethodType: AuthenticationMethodTypeType, # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
# put_application_authentication_method method usage example with argument unpacking
kwargs: PutApplicationAuthenticationMethodRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"AuthenticationMethod": ...,
"AuthenticationMethodType": ...,
}
parent.put_application_authentication_method(**kwargs)
put_application_grant#
Adds a grant to an application.
Type annotations and code completion for session.client("sso-admin").put_application_grant
method.
boto3 documentation
# put_application_grant method definition
await def put_application_grant(
self,
*,
ApplicationArn: str,
Grant: GrantTypeDef, # (1)
GrantType: GrantTypeType, # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
- See GrantTypeDef
- See GrantTypeType
- See EmptyResponseMetadataTypeDef
# put_application_grant method usage example with argument unpacking
kwargs: PutApplicationGrantRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
"Grant": ...,
"GrantType": ...,
}
parent.put_application_grant(**kwargs)
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
# put_inline_policy_to_permission_set method definition
await def put_inline_policy_to_permission_set(
self,
*,
InlinePolicy: str,
InstanceArn: str,
PermissionSetArn: str,
) -> Dict[str, Any]:
...
# put_inline_policy_to_permission_set method usage example with argument unpacking
kwargs: PutInlinePolicyToPermissionSetRequestRequestTypeDef = { # (1)
"InlinePolicy": ...,
"InstanceArn": ...,
"PermissionSetArn": ...,
}
parent.put_inline_policy_to_permission_set(**kwargs)
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
# 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]:
...
# 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)
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
# tag_resource method definition
await def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
InstanceArn: str = ...,
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
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
# untag_resource method definition
await def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
InstanceArn: str = ...,
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_application#
Updates application properties.
Type annotations and code completion for session.client("sso-admin").update_application
method.
boto3 documentation
# update_application method definition
await def update_application(
self,
*,
ApplicationArn: str,
Description: str = ...,
Name: str = ...,
PortalOptions: UpdateApplicationPortalOptionsTypeDef = ..., # (1)
Status: ApplicationStatusType = ..., # (2)
) -> Dict[str, Any]:
...
# update_application method usage example with argument unpacking
kwargs: UpdateApplicationRequestRequestTypeDef = { # (1)
"ApplicationArn": ...,
}
parent.update_application(**kwargs)
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 session.client("sso-admin").update_instance
method.
boto3 documentation
# update_instance method definition
await def update_instance(
self,
*,
InstanceArn: str,
Name: str,
) -> Dict[str, Any]:
...
# update_instance method usage example with argument unpacking
kwargs: UpdateInstanceRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"Name": ...,
}
parent.update_instance(**kwargs)
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.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,
*,
InstanceAccessControlAttributeConfiguration: InstanceAccessControlAttributeConfigurationTypeDef, # (1)
InstanceArn: str,
) -> Dict[str, Any]:
...
# update_instance_access_control_attribute_configuration method usage example with argument unpacking
kwargs: UpdateInstanceAccessControlAttributeConfigurationRequestRequestTypeDef = { # (1)
"InstanceAccessControlAttributeConfiguration": ...,
"InstanceArn": ...,
}
parent.update_instance_access_control_attribute_configuration(**kwargs)
update_permission_set#
Updates an existing permission set.
Type annotations and code completion for session.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 = ...,
RelayState: str = ...,
SessionDuration: str = ...,
) -> Dict[str, Any]:
...
# update_permission_set method usage example with argument unpacking
kwargs: UpdatePermissionSetRequestRequestTypeDef = { # (1)
"InstanceArn": ...,
"PermissionSetArn": ...,
}
parent.update_permission_set(**kwargs)
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 session.client("sso-admin").update_trusted_token_issuer
method.
boto3 documentation
# update_trusted_token_issuer method definition
await def update_trusted_token_issuer(
self,
*,
TrustedTokenIssuerArn: str,
Name: str = ...,
TrustedTokenIssuerConfiguration: TrustedTokenIssuerUpdateConfigurationTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
# update_trusted_token_issuer method usage example with argument unpacking
kwargs: UpdateTrustedTokenIssuerRequestRequestTypeDef = { # (1)
"TrustedTokenIssuerArn": ...,
}
parent.update_trusted_token_issuer(**kwargs)
__aenter__#
Type annotations and code completion for session.client("sso-admin").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> SSOAdminClient:
...
__aexit__#
Type annotations and code completion for session.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.client("sso-admin").get_paginator
method with overloads.
client.get_paginator("list_account_assignment_creation_status")
-> ListAccountAssignmentCreationStatusPaginatorclient.get_paginator("list_account_assignment_deletion_status")
-> ListAccountAssignmentDeletionStatusPaginatorclient.get_paginator("list_account_assignments")
-> ListAccountAssignmentsPaginatorclient.get_paginator("list_account_assignments_for_principal")
-> ListAccountAssignmentsForPrincipalPaginatorclient.get_paginator("list_accounts_for_provisioned_permission_set")
-> ListAccountsForProvisionedPermissionSetPaginatorclient.get_paginator("list_application_access_scopes")
-> ListApplicationAccessScopesPaginatorclient.get_paginator("list_application_assignments")
-> ListApplicationAssignmentsPaginatorclient.get_paginator("list_application_assignments_for_principal")
-> ListApplicationAssignmentsForPrincipalPaginatorclient.get_paginator("list_application_authentication_methods")
-> ListApplicationAuthenticationMethodsPaginatorclient.get_paginator("list_application_grants")
-> ListApplicationGrantsPaginatorclient.get_paginator("list_application_providers")
-> ListApplicationProvidersPaginatorclient.get_paginator("list_applications")
-> ListApplicationsPaginatorclient.get_paginator("list_customer_managed_policy_references_in_permission_set")
-> ListCustomerManagedPolicyReferencesInPermissionSetPaginatorclient.get_paginator("list_instances")
-> ListInstancesPaginatorclient.get_paginator("list_managed_policies_in_permission_set")
-> ListManagedPoliciesInPermissionSetPaginatorclient.get_paginator("list_permission_set_provisioning_status")
-> ListPermissionSetProvisioningStatusPaginatorclient.get_paginator("list_permission_sets")
-> ListPermissionSetsPaginatorclient.get_paginator("list_permission_sets_provisioned_to_account")
-> ListPermissionSetsProvisionedToAccountPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginatorclient.get_paginator("list_trusted_token_issuers")
-> ListTrustedTokenIssuersPaginator