Table of Contents
SSOAdmin.Client¶A low-level client representing AWS Single Sign-On Admin (SSO Admin)
AWS IAM Identity Center (successor to AWS Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across AWS accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in AWS, for organizations of any size and type.
Note
Although AWS Single Sign-On was renamed, the sso and identitystore API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see IAM Identity Center rename.
This reference guide provides information on single sign-on operations which could be used for access management of AWS accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
Note
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
import boto3
client = boto3.client('sso-admin')
These are the available methods:
attach_customer_managed_policy_reference_to_permission_set()attach_managed_policy_to_permission_set()can_paginate()close()create_account_assignment()create_instance_access_control_attribute_configuration()create_permission_set()delete_account_assignment()delete_inline_policy_from_permission_set()delete_instance_access_control_attribute_configuration()delete_permission_set()delete_permissions_boundary_from_permission_set()describe_account_assignment_creation_status()describe_account_assignment_deletion_status()describe_instance_access_control_attribute_configuration()describe_permission_set()describe_permission_set_provisioning_status()detach_customer_managed_policy_reference_from_permission_set()detach_managed_policy_from_permission_set()get_inline_policy_for_permission_set()get_paginator()get_permissions_boundary_for_permission_set()get_waiter()list_account_assignment_creation_status()list_account_assignment_deletion_status()list_account_assignments()list_accounts_for_provisioned_permission_set()list_customer_managed_policy_references_in_permission_set()list_instances()list_managed_policies_in_permission_set()list_permission_set_provisioning_status()list_permission_sets()list_permission_sets_provisioned_to_account()list_tags_for_resource()provision_permission_set()put_inline_policy_to_permission_set()put_permissions_boundary_to_permission_set()tag_resource()untag_resource()update_instance_access_control_attribute_configuration()update_permission_set()attach_customer_managed_policy_reference_to_permission_set(**kwargs)¶Attaches the specified customer managed policy to the specified PermissionSet.
See also: AWS API Documentation
Request Syntax
response = client.attach_customer_managed_policy_reference_to_permission_set(
InstanceArn='string',
PermissionSetArn='string',
CustomerManagedPolicyReference={
'Name': 'string',
'Path': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
[REQUIRED]
The ARN of the PermissionSet .
[REQUIRED]
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ServiceQuotaExceededExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptionattach_managed_policy_to_permission_set(**kwargs)¶Attaches an AWS managed policy ARN to a permission set.
Note
If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this operation. Calling ProvisionPermissionSet applies the corresponding IAM policy updates to all assigned accounts.
See also: AWS API Documentation
Request Syntax
response = client.attach_managed_policy_to_permission_set(
InstanceArn='string',
PermissionSetArn='string',
ManagedPolicyArn='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the PermissionSet that the managed policy should be attached to.
[REQUIRED]
The AWS managed policy ARN to be attached to a permission set.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ServiceQuotaExceededExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_account_assignment(**kwargs)¶Assigns access to a principal for a specified AWS account using a specified permission set.
Note
The term principal here refers to a user or group that is defined in IAM Identity Center.
Note
As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call ProvisionPermissionSet to make these updates.
Note
After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment creation request.
See also: AWS API Documentation
Request Syntax
response = client.create_account_assignment(
InstanceArn='string',
TargetId='string',
TargetType='AWS_ACCOUNT',
PermissionSetArn='string',
PrincipalType='USER'|'GROUP',
PrincipalId='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
[REQUIRED]
The entity type for which the assignment will be created.
[REQUIRED]
The ARN of the permission set that the admin wants to grant the principal access to.
[REQUIRED]
The entity type for which the assignment will be created.
[REQUIRED]
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
dict
Response Syntax
{
'AccountAssignmentCreationStatus': {
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'FailureReason': 'string',
'TargetId': 'string',
'TargetType': 'AWS_ACCOUNT',
'PermissionSetArn': 'string',
'PrincipalType': 'USER'|'GROUP',
'PrincipalId': 'string',
'CreatedDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AccountAssignmentCreationStatus (dict) --
The status object for the account assignment creation operation.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
FailureReason (string) --
The message that contains an error or exception in case of an operation failure.
TargetId (string) --
TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
TargetType (string) --
The entity type for which the assignment will be created.
PermissionSetArn (string) --
The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
PrincipalType (string) --
The entity type for which the assignment will be created.
PrincipalId (string) --
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
CreatedDate (datetime) --
The date that the permission set was created.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ServiceQuotaExceededExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptioncreate_instance_access_control_attribute_configuration(**kwargs)¶Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide .
Note
After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate that InstanceAccessControlAttributeConfiguration was created.
See also: AWS API Documentation
Request Syntax
response = client.create_instance_access_control_attribute_configuration(
InstanceArn='string',
InstanceAccessControlAttributeConfiguration={
'AccessControlAttributes': [
{
'Key': 'string',
'Value': {
'Source': [
'string',
]
}
},
]
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
[REQUIRED]
Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When using an external identity provider as an identity source, you can pass attributes through the SAML assertion. Doing so provides an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center will replace the attribute value with the value from the IAM Identity Center identity store.
Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance.
These are IAM Identity Center identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permissions policies that determine who can access your AWS resources based upon the configured attribute values. When you enable ABAC and specify AccessControlAttributes , IAM Identity Center passes the attribute values of the authenticated user into IAM for use in policy evaluation.
The name of the attribute associated with your identities in your identity source. This is used to map a specified attribute in your identity source with an attribute in IAM Identity Center.
The value used for mapping a specified attribute to an identity source.
The identity source to use when mapping a specified attribute to IAM Identity Center.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.ConflictExceptioncreate_permission_set(**kwargs)¶Creates a permission set within a specified IAM Identity Center instance.
Note
To grant users and groups access to AWS account resources, use CreateAccountAssignment .
See also: AWS API Documentation
Request Syntax
response = client.create_permission_set(
Name='string',
Description='string',
InstanceArn='string',
SessionDuration='string',
RelayState='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the PermissionSet.
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
The tags to attach to the new PermissionSet.
A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that IAM Identity Center creates in AWS accounts.
The key for the tag.
The value of the tag.
dict
Response Syntax
{
'PermissionSet': {
'Name': 'string',
'PermissionSetArn': 'string',
'Description': 'string',
'CreatedDate': datetime(2015, 1, 1),
'SessionDuration': 'string',
'RelayState': 'string'
}
}
Response Structure
(dict) --
PermissionSet (dict) --
Defines the level of access on an AWS account.
Name (string) --
The name of the permission set.
PermissionSetArn (string) --
The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
Description (string) --
The description of the PermissionSet.
CreatedDate (datetime) --
The date that the permission set was created.
SessionDuration (string) --
The length of time that the application user sessions are valid for in the ISO-8601 standard.
RelayState (string) --
Used to redirect users within the application during the federation authentication process.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ServiceQuotaExceededExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptiondelete_account_assignment(**kwargs)¶Deletes a principal's access from a specified AWS account using a specified permission set.
Note
After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment deletion request.
See also: AWS API Documentation
Request Syntax
response = client.delete_account_assignment(
InstanceArn='string',
TargetId='string',
TargetType='AWS_ACCOUNT',
PermissionSetArn='string',
PrincipalType='USER'|'GROUP',
PrincipalId='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
[REQUIRED]
The entity type for which the assignment will be deleted.
[REQUIRED]
The ARN of the permission set that will be used to remove access.
[REQUIRED]
The entity type for which the assignment will be deleted.
[REQUIRED]
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
dict
Response Syntax
{
'AccountAssignmentDeletionStatus': {
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'FailureReason': 'string',
'TargetId': 'string',
'TargetType': 'AWS_ACCOUNT',
'PermissionSetArn': 'string',
'PrincipalType': 'USER'|'GROUP',
'PrincipalId': 'string',
'CreatedDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AccountAssignmentDeletionStatus (dict) --
The status object for the account assignment deletion operation.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
FailureReason (string) --
The message that contains an error or exception in case of an operation failure.
TargetId (string) --
TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
TargetType (string) --
The entity type for which the assignment will be created.
PermissionSetArn (string) --
The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
PrincipalType (string) --
The entity type for which the assignment will be created.
PrincipalId (string) --
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
CreatedDate (datetime) --
The date that the permission set was created.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptiondelete_inline_policy_from_permission_set(**kwargs)¶Deletes the inline policy from a specified permission set.
See also: AWS API Documentation
Request Syntax
response = client.delete_inline_policy_from_permission_set(
InstanceArn='string',
PermissionSetArn='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the permission set that will be used to remove access.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptiondelete_instance_access_control_attribute_configuration(**kwargs)¶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. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_instance_access_control_attribute_configuration(
InstanceArn='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.ConflictExceptiondelete_permission_set(**kwargs)¶Deletes the specified permission set.
See also: AWS API Documentation
Request Syntax
response = client.delete_permission_set(
InstanceArn='string',
PermissionSetArn='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the permission set that should be deleted.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptiondelete_permissions_boundary_from_permission_set(**kwargs)¶Deletes the permissions boundary from a specified PermissionSet.
See also: AWS API Documentation
Request Syntax
response = client.delete_permissions_boundary_from_permission_set(
InstanceArn='string',
PermissionSetArn='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
[REQUIRED]
The ARN of the PermissionSet .
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptiondescribe_account_assignment_creation_status(**kwargs)¶Describes the status of the assignment creation request.
See also: AWS API Documentation
Request Syntax
response = client.describe_account_assignment_creation_status(
InstanceArn='string',
AccountAssignmentCreationRequestId='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The identifier that is used to track the request operation progress.
dict
Response Syntax
{
'AccountAssignmentCreationStatus': {
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'FailureReason': 'string',
'TargetId': 'string',
'TargetType': 'AWS_ACCOUNT',
'PermissionSetArn': 'string',
'PrincipalType': 'USER'|'GROUP',
'PrincipalId': 'string',
'CreatedDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AccountAssignmentCreationStatus (dict) --
The status object for the account assignment creation operation.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
FailureReason (string) --
The message that contains an error or exception in case of an operation failure.
TargetId (string) --
TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
TargetType (string) --
The entity type for which the assignment will be created.
PermissionSetArn (string) --
The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
PrincipalType (string) --
The entity type for which the assignment will be created.
PrincipalId (string) --
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
CreatedDate (datetime) --
The date that the permission set was created.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptiondescribe_account_assignment_deletion_status(**kwargs)¶Describes the status of the assignment deletion request.
See also: AWS API Documentation
Request Syntax
response = client.describe_account_assignment_deletion_status(
InstanceArn='string',
AccountAssignmentDeletionRequestId='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The identifier that is used to track the request operation progress.
dict
Response Syntax
{
'AccountAssignmentDeletionStatus': {
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'FailureReason': 'string',
'TargetId': 'string',
'TargetType': 'AWS_ACCOUNT',
'PermissionSetArn': 'string',
'PrincipalType': 'USER'|'GROUP',
'PrincipalId': 'string',
'CreatedDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AccountAssignmentDeletionStatus (dict) --
The status object for the account assignment deletion operation.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
FailureReason (string) --
The message that contains an error or exception in case of an operation failure.
TargetId (string) --
TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
TargetType (string) --
The entity type for which the assignment will be created.
PermissionSetArn (string) --
The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
PrincipalType (string) --
The entity type for which the assignment will be created.
PrincipalId (string) --
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
CreatedDate (datetime) --
The date that the permission set was created.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptiondescribe_instance_access_control_attribute_configuration(**kwargs)¶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. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_instance_access_control_attribute_configuration(
InstanceArn='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
{
'Status': 'ENABLED'|'CREATION_IN_PROGRESS'|'CREATION_FAILED',
'StatusReason': 'string',
'InstanceAccessControlAttributeConfiguration': {
'AccessControlAttributes': [
{
'Key': 'string',
'Value': {
'Source': [
'string',
]
}
},
]
}
}
Response Structure
The status of the attribute configuration process.
Provides more details about the current status of the specified attribute.
Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC configuration.
Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance.
These are IAM Identity Center identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permissions policies that determine who can access your AWS resources based upon the configured attribute values. When you enable ABAC and specify AccessControlAttributes , IAM Identity Center passes the attribute values of the authenticated user into IAM for use in policy evaluation.
The name of the attribute associated with your identities in your identity source. This is used to map a specified attribute in your identity source with an attribute in IAM Identity Center.
The value used for mapping a specified attribute to an identity source.
The identity source to use when mapping a specified attribute to IAM Identity Center.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptiondescribe_permission_set(**kwargs)¶Gets the details of the permission set.
See also: AWS API Documentation
Request Syntax
response = client.describe_permission_set(
InstanceArn='string',
PermissionSetArn='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the permission set.
dict
Response Syntax
{
'PermissionSet': {
'Name': 'string',
'PermissionSetArn': 'string',
'Description': 'string',
'CreatedDate': datetime(2015, 1, 1),
'SessionDuration': 'string',
'RelayState': 'string'
}
}
Response Structure
(dict) --
PermissionSet (dict) --
Describes the level of access on an AWS account.
Name (string) --
The name of the permission set.
PermissionSetArn (string) --
The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
Description (string) --
The description of the PermissionSet.
CreatedDate (datetime) --
The date that the permission set was created.
SessionDuration (string) --
The length of time that the application user sessions are valid for in the ISO-8601 standard.
RelayState (string) --
Used to redirect users within the application during the federation authentication process.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptiondescribe_permission_set_provisioning_status(**kwargs)¶Describes the status for the given permission set provisioning request.
See also: AWS API Documentation
Request Syntax
response = client.describe_permission_set_provisioning_status(
InstanceArn='string',
ProvisionPermissionSetRequestId='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.
dict
Response Syntax
{
'PermissionSetProvisioningStatus': {
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'AccountId': 'string',
'PermissionSetArn': 'string',
'FailureReason': 'string',
'CreatedDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
PermissionSetProvisioningStatus (dict) --
The status object for the permission set provisioning operation.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
AccountId (string) --
The identifier of the AWS account from which to list the assignments.
PermissionSetArn (string) --
The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
FailureReason (string) --
The message that contains an error or exception in case of an operation failure.
CreatedDate (datetime) --
The date that the permission set was created.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptiondetach_customer_managed_policy_reference_from_permission_set(**kwargs)¶Detaches the specified customer managed policy from the specified PermissionSet.
See also: AWS API Documentation
Request Syntax
response = client.detach_customer_managed_policy_reference_from_permission_set(
InstanceArn='string',
PermissionSetArn='string',
CustomerManagedPolicyReference={
'Name': 'string',
'Path': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
[REQUIRED]
The ARN of the PermissionSet .
[REQUIRED]
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptiondetach_managed_policy_from_permission_set(**kwargs)¶Detaches the attached AWS managed policy ARN from the specified permission set.
See also: AWS API Documentation
Request Syntax
response = client.detach_managed_policy_from_permission_set(
InstanceArn='string',
PermissionSetArn='string',
ManagedPolicyArn='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the PermissionSet from which the policy should be detached.
[REQUIRED]
The AWS managed policy ARN to be detached from a permission set.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptionget_inline_policy_for_permission_set(**kwargs)¶Obtains the inline policy assigned to the permission set.
See also: AWS API Documentation
Request Syntax
response = client.get_inline_policy_for_permission_set(
InstanceArn='string',
PermissionSetArn='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the permission set.
dict
Response Syntax
{
'InlinePolicy': 'string'
}
Response Structure
(dict) --
InlinePolicy (string) --
The inline policy that is attached to the permission set.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_permissions_boundary_for_permission_set(**kwargs)¶Obtains the permissions boundary for a specified PermissionSet.
See also: AWS API Documentation
Request Syntax
response = client.get_permissions_boundary_for_permission_set(
InstanceArn='string',
PermissionSetArn='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
[REQUIRED]
The ARN of the PermissionSet .
dict
Response Syntax
{
'PermissionsBoundary': {
'CustomerManagedPolicyReference': {
'Name': 'string',
'Path': 'string'
},
'ManagedPolicyArn': 'string'
}
}
Response Structure
(dict) --
PermissionsBoundary (dict) --
The permissions boundary attached to the specified permission set.
CustomerManagedPolicyReference (dict) --
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
Name (string) --
The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
Path (string) --
The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
ManagedPolicyArn (string) --
The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_account_assignment_creation_status(**kwargs)¶Lists the status of the AWS account assignment creation requests for a specified IAM Identity Center instance.
See also: AWS API Documentation
Request Syntax
response = client.list_account_assignment_creation_status(
InstanceArn='string',
MaxResults=123,
NextToken='string',
Filter={
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
Filters results based on the passed attribute value.
Filters the list operations result based on the status attribute.
dict
Response Syntax
{
'AccountAssignmentsCreationStatus': [
{
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'CreatedDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AccountAssignmentsCreationStatus (list) --
The status object for the account assignment creation operation.
(dict) --
Provides information about the AccountAssignment creation request.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
CreatedDate (datetime) --
The date that the permission set was created.
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionlist_account_assignment_deletion_status(**kwargs)¶Lists the status of the AWS account assignment deletion requests for a specified IAM Identity Center instance.
See also: AWS API Documentation
Request Syntax
response = client.list_account_assignment_deletion_status(
InstanceArn='string',
MaxResults=123,
NextToken='string',
Filter={
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
Filters results based on the passed attribute value.
Filters the list operations result based on the status attribute.
dict
Response Syntax
{
'AccountAssignmentsDeletionStatus': [
{
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'CreatedDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AccountAssignmentsDeletionStatus (list) --
The status object for the account assignment deletion operation.
(dict) --
Provides information about the AccountAssignment creation request.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
CreatedDate (datetime) --
The date that the permission set was created.
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionlist_account_assignments(**kwargs)¶Lists the assignee of the specified AWS account with the specified permission set.
See also: AWS API Documentation
Request Syntax
response = client.list_account_assignments(
InstanceArn='string',
AccountId='string',
PermissionSetArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The identifier of the AWS account from which to list the assignments.
[REQUIRED]
The ARN of the permission set from which to list assignments.
dict
Response Syntax
{
'AccountAssignments': [
{
'AccountId': 'string',
'PermissionSetArn': 'string',
'PrincipalType': 'USER'|'GROUP',
'PrincipalId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AccountAssignments (list) --
The list of assignments that match the input AWS account and permission set.
(dict) --
The assignment that indicates a principal's limited access to a specified AWS account with a specified permission set.
Note
The term principal here refers to a user or group that is defined in IAM Identity Center.
AccountId (string) --
The identifier of the AWS account.
PermissionSetArn (string) --
The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
PrincipalType (string) --
The entity type for which the assignment will be created.
PrincipalId (string) --
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionlist_accounts_for_provisioned_permission_set(**kwargs)¶Lists all the AWS accounts where the specified permission set is provisioned.
See also: AWS API Documentation
Request Syntax
response = client.list_accounts_for_provisioned_permission_set(
InstanceArn='string',
PermissionSetArn='string',
ProvisioningStatus='LATEST_PERMISSION_SET_PROVISIONED'|'LATEST_PERMISSION_SET_NOT_PROVISIONED',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the PermissionSet from which the associated AWS accounts will be listed.
dict
Response Syntax
{
'AccountIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
AccountIds (list) --
The list of AWS AccountIds .
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionlist_customer_managed_policy_references_in_permission_set(**kwargs)¶Lists all customer managed policies attached to a specified PermissionSet.
See also: AWS API Documentation
Request Syntax
response = client.list_customer_managed_policy_references_in_permission_set(
InstanceArn='string',
PermissionSetArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
[REQUIRED]
The ARN of the PermissionSet .
dict
Response Syntax
{
'CustomerManagedPolicyReferences': [
{
'Name': 'string',
'Path': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CustomerManagedPolicyReferences (list) --
Specifies the names and paths of the customer managed policies that you have attached to your permission set.
(dict) --
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
Name (string) --
The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
Path (string) --
The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionlist_instances(**kwargs)¶Lists the IAM Identity Center instances that the caller has access to.
See also: AWS API Documentation
Request Syntax
response = client.list_instances(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Instances': [
{
'InstanceArn': 'string',
'IdentityStoreId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Instances (list) --
Lists the IAM Identity Center instances that the caller has access to.
(dict) --
Provides information about the IAM Identity Center instance.
InstanceArn (string) --
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
IdentityStoreId (string) --
The identifier of the identity store that is connected to the IAM Identity Center instance.
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Exceptions
SSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ValidationExceptionlist_managed_policies_in_permission_set(**kwargs)¶Lists the AWS managed policy that is attached to a specified permission set.
See also: AWS API Documentation
Request Syntax
response = client.list_managed_policies_in_permission_set(
InstanceArn='string',
PermissionSetArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the PermissionSet whose managed policies will be listed.
dict
Response Syntax
{
'AttachedManagedPolicies': [
{
'Name': 'string',
'Arn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AttachedManagedPolicies (list) --
An array of the AttachedManagedPolicy data type object.
(dict) --
A structure that stores the details of the AWS managed policy.
Name (string) --
The name of the AWS managed policy.
Arn (string) --
The ARN of the AWS managed policy. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionlist_permission_set_provisioning_status(**kwargs)¶Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
See also: AWS API Documentation
Request Syntax
response = client.list_permission_set_provisioning_status(
InstanceArn='string',
MaxResults=123,
NextToken='string',
Filter={
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
Filters results based on the passed attribute value.
Filters the list operations result based on the status attribute.
dict
Response Syntax
{
'PermissionSetsProvisioningStatus': [
{
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'CreatedDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PermissionSetsProvisioningStatus (list) --
The status object for the permission set provisioning operation.
(dict) --
Provides information about the permission set provisioning status.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
CreatedDate (datetime) --
The date that the permission set was created.
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionlist_permission_sets(**kwargs)¶Lists the PermissionSet s in an IAM Identity Center instance.
See also: AWS API Documentation
Request Syntax
response = client.list_permission_sets(
InstanceArn='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
dict
Response Syntax
{
'PermissionSets': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
PermissionSets (list) --
Defines the level of access on an AWS account.
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionlist_permission_sets_provisioned_to_account(**kwargs)¶Lists all the permission sets that are provisioned to a specified AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_permission_sets_provisioned_to_account(
InstanceArn='string',
AccountId='string',
ProvisioningStatus='LATEST_PERMISSION_SET_PROVISIONED'|'LATEST_PERMISSION_SET_NOT_PROVISIONED',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The identifier of the AWS account from which to list the assignments.
dict
Response Syntax
{
'NextToken': 'string',
'PermissionSets': [
'string',
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
PermissionSets (list) --
Defines the level of access that an AWS account has.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionLists the tags that are attached to a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
InstanceArn='string',
ResourceArn='string',
NextToken='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the resource with the tags to be listed.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tags (list) --
A set of key-value pairs that are used to manage the resource.
(dict) --
A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that IAM Identity Center creates in AWS accounts.
Key (string) --
The key for the tag.
Value (string) --
The value of the tag.
NextToken (string) --
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionprovision_permission_set(**kwargs)¶The process by which a specified permission set is provisioned to the specified target.
See also: AWS API Documentation
Request Syntax
response = client.provision_permission_set(
InstanceArn='string',
PermissionSetArn='string',
TargetId='string',
TargetType='AWS_ACCOUNT'|'ALL_PROVISIONED_ACCOUNTS'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the permission set.
[REQUIRED]
The entity type for which the assignment will be created.
dict
Response Syntax
{
'PermissionSetProvisioningStatus': {
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'AccountId': 'string',
'PermissionSetArn': 'string',
'FailureReason': 'string',
'CreatedDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
PermissionSetProvisioningStatus (dict) --
The status object for the permission set provisioning operation.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
AccountId (string) --
The identifier of the AWS account from which to list the assignments.
PermissionSetArn (string) --
The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
FailureReason (string) --
The message that contains an error or exception in case of an operation failure.
CreatedDate (datetime) --
The date that the permission set was created.
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptionput_inline_policy_to_permission_set(**kwargs)¶Attaches an inline policy to a permission set.
Note
If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts.
See also: AWS API Documentation
Request Syntax
response = client.put_inline_policy_to_permission_set(
InstanceArn='string',
PermissionSetArn='string',
InlinePolicy='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the permission set.
[REQUIRED]
The inline policy to attach to a PermissionSet.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ServiceQuotaExceededExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptionput_permissions_boundary_to_permission_set(**kwargs)¶Attaches an AWS managed or customer managed policy to the specified PermissionSet as a permissions boundary.
See also: AWS API Documentation
Request Syntax
response = client.put_permissions_boundary_to_permission_set(
InstanceArn='string',
PermissionSetArn='string',
PermissionsBoundary={
'CustomerManagedPolicyReference': {
'Name': 'string',
'Path': 'string'
},
'ManagedPolicyArn': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
[REQUIRED]
The ARN of the PermissionSet .
[REQUIRED]
The permissions boundary that you want to attach to a PermissionSet .
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptiontag_resource(**kwargs)¶Associates a set of tags with a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
InstanceArn='string',
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the resource with the tags to be listed.
[REQUIRED]
A set of key-value pairs that are used to manage the resource.
A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that IAM Identity Center creates in AWS accounts.
The key for the tag.
The value of the tag.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ServiceQuotaExceededExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptionuntag_resource(**kwargs)¶Disassociates a set of tags from a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
InstanceArn='string',
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the resource with the tags to be listed.
[REQUIRED]
The keys of tags that are attached to the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptionupdate_instance_access_control_attribute_configuration(**kwargs)¶Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide .
See also: AWS API Documentation
Request Syntax
response = client.update_instance_access_control_attribute_configuration(
InstanceArn='string',
InstanceAccessControlAttributeConfiguration={
'AccessControlAttributes': [
{
'Key': 'string',
'Value': {
'Source': [
'string',
]
}
},
]
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
[REQUIRED]
Updates the attributes for your ABAC configuration.
Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance.
These are IAM Identity Center identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permissions policies that determine who can access your AWS resources based upon the configured attribute values. When you enable ABAC and specify AccessControlAttributes , IAM Identity Center passes the attribute values of the authenticated user into IAM for use in policy evaluation.
The name of the attribute associated with your identities in your identity source. This is used to map a specified attribute in your identity source with an attribute in IAM Identity Center.
The value used for mapping a specified attribute to an identity source.
The identity source to use when mapping a specified attribute to IAM Identity Center.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.ConflictExceptionupdate_permission_set(**kwargs)¶Updates an existing permission set.
See also: AWS API Documentation
Request Syntax
response = client.update_permission_set(
InstanceArn='string',
PermissionSetArn='string',
Description='string',
SessionDuration='string',
RelayState='string'
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the permission set.
dict
Response Syntax
{}
Response Structure
Exceptions
SSOAdmin.Client.exceptions.ResourceNotFoundExceptionSSOAdmin.Client.exceptions.InternalServerExceptionSSOAdmin.Client.exceptions.ThrottlingExceptionSSOAdmin.Client.exceptions.ValidationExceptionSSOAdmin.Client.exceptions.AccessDeniedExceptionSSOAdmin.Client.exceptions.ConflictExceptionThe available paginators are:
SSOAdmin.Paginator.ListAccountAssignmentCreationStatusSSOAdmin.Paginator.ListAccountAssignmentDeletionStatusSSOAdmin.Paginator.ListAccountAssignmentsSSOAdmin.Paginator.ListAccountsForProvisionedPermissionSetSSOAdmin.Paginator.ListCustomerManagedPolicyReferencesInPermissionSetSSOAdmin.Paginator.ListInstancesSSOAdmin.Paginator.ListManagedPoliciesInPermissionSetSSOAdmin.Paginator.ListPermissionSetProvisioningStatusSSOAdmin.Paginator.ListPermissionSetsSSOAdmin.Paginator.ListPermissionSetsProvisionedToAccountSSOAdmin.Paginator.ListTagsForResourceSSOAdmin.Paginator.ListAccountAssignmentCreationStatus¶paginator = client.get_paginator('list_account_assignment_creation_status')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_account_assignment_creation_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceArn='string',
Filter={
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
Filters results based on the passed attribute value.
Filters the list operations result based on the status attribute.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AccountAssignmentsCreationStatus': [
{
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'CreatedDate': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
AccountAssignmentsCreationStatus (list) --
The status object for the account assignment creation operation.
(dict) --
Provides information about the AccountAssignment creation request.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
CreatedDate (datetime) --
The date that the permission set was created.
SSOAdmin.Paginator.ListAccountAssignmentDeletionStatus¶paginator = client.get_paginator('list_account_assignment_deletion_status')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_account_assignment_deletion_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceArn='string',
Filter={
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
Filters results based on the passed attribute value.
Filters the list operations result based on the status attribute.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AccountAssignmentsDeletionStatus': [
{
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'CreatedDate': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
AccountAssignmentsDeletionStatus (list) --
The status object for the account assignment deletion operation.
(dict) --
Provides information about the AccountAssignment creation request.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
CreatedDate (datetime) --
The date that the permission set was created.
SSOAdmin.Paginator.ListAccountAssignments¶paginator = client.get_paginator('list_account_assignments')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_account_assignments().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceArn='string',
AccountId='string',
PermissionSetArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The identifier of the AWS account from which to list the assignments.
[REQUIRED]
The ARN of the permission set from which to list assignments.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AccountAssignments': [
{
'AccountId': 'string',
'PermissionSetArn': 'string',
'PrincipalType': 'USER'|'GROUP',
'PrincipalId': 'string'
},
],
}
Response Structure
(dict) --
AccountAssignments (list) --
The list of assignments that match the input AWS account and permission set.
(dict) --
The assignment that indicates a principal's limited access to a specified AWS account with a specified permission set.
Note
The term principal here refers to a user or group that is defined in IAM Identity Center.
AccountId (string) --
The identifier of the AWS account.
PermissionSetArn (string) --
The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
PrincipalType (string) --
The entity type for which the assignment will be created.
PrincipalId (string) --
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
SSOAdmin.Paginator.ListAccountsForProvisionedPermissionSet¶paginator = client.get_paginator('list_accounts_for_provisioned_permission_set')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_accounts_for_provisioned_permission_set().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceArn='string',
PermissionSetArn='string',
ProvisioningStatus='LATEST_PERMISSION_SET_PROVISIONED'|'LATEST_PERMISSION_SET_NOT_PROVISIONED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the PermissionSet from which the associated AWS accounts will be listed.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AccountIds': [
'string',
],
}
Response Structure
(dict) --
AccountIds (list) --
The list of AWS AccountIds .
SSOAdmin.Paginator.ListCustomerManagedPolicyReferencesInPermissionSet¶paginator = client.get_paginator('list_customer_managed_policy_references_in_permission_set')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_customer_managed_policy_references_in_permission_set().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceArn='string',
PermissionSetArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed.
[REQUIRED]
The ARN of the PermissionSet .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CustomerManagedPolicyReferences': [
{
'Name': 'string',
'Path': 'string'
},
],
}
Response Structure
(dict) --
CustomerManagedPolicyReferences (list) --
Specifies the names and paths of the customer managed policies that you have attached to your permission set.
(dict) --
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
Name (string) --
The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
Path (string) --
The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
SSOAdmin.Paginator.ListInstances¶paginator = client.get_paginator('list_instances')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Instances': [
{
'InstanceArn': 'string',
'IdentityStoreId': 'string'
},
],
}
Response Structure
Lists the IAM Identity Center instances that the caller has access to.
Provides information about the IAM Identity Center instance.
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
The identifier of the identity store that is connected to the IAM Identity Center instance.
SSOAdmin.Paginator.ListManagedPoliciesInPermissionSet¶paginator = client.get_paginator('list_managed_policies_in_permission_set')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_managed_policies_in_permission_set().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceArn='string',
PermissionSetArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the PermissionSet whose managed policies will be listed.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AttachedManagedPolicies': [
{
'Name': 'string',
'Arn': 'string'
},
],
}
Response Structure
(dict) --
AttachedManagedPolicies (list) --
An array of the AttachedManagedPolicy data type object.
(dict) --
A structure that stores the details of the AWS managed policy.
Name (string) --
The name of the AWS managed policy.
Arn (string) --
The ARN of the AWS managed policy. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
SSOAdmin.Paginator.ListPermissionSetProvisioningStatus¶paginator = client.get_paginator('list_permission_set_provisioning_status')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_permission_set_provisioning_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceArn='string',
Filter={
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
Filters results based on the passed attribute value.
Filters the list operations result based on the status attribute.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PermissionSetsProvisioningStatus': [
{
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'RequestId': 'string',
'CreatedDate': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
PermissionSetsProvisioningStatus (list) --
The status object for the permission set provisioning operation.
(dict) --
Provides information about the permission set provisioning status.
Status (string) --
The status of the permission set provisioning process.
RequestId (string) --
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
CreatedDate (datetime) --
The date that the permission set was created.
SSOAdmin.Paginator.ListPermissionSets¶paginator = client.get_paginator('list_permission_sets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_permission_sets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PermissionSets': [
'string',
],
}
Response Structure
(dict) --
PermissionSets (list) --
Defines the level of access on an AWS account.
SSOAdmin.Paginator.ListPermissionSetsProvisionedToAccount¶paginator = client.get_paginator('list_permission_sets_provisioned_to_account')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_permission_sets_provisioned_to_account().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceArn='string',
AccountId='string',
ProvisioningStatus='LATEST_PERMISSION_SET_PROVISIONED'|'LATEST_PERMISSION_SET_NOT_PROVISIONED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The identifier of the AWS account from which to list the assignments.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PermissionSets': [
'string',
]
}
Response Structure
(dict) --
PermissionSets (list) --
Defines the level of access that an AWS account has.
SSOAdmin.Paginator.ListTagsForResource¶paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSOAdmin.Client.list_tags_for_resource().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceArn='string',
ResourceArn='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
[REQUIRED]
The ARN of the resource with the tags to be listed.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
}
Response Structure
(dict) --
Tags (list) --
A set of key-value pairs that are used to manage the resource.
(dict) --
A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that IAM Identity Center creates in AWS accounts.
Key (string) --
The key for the tag.
Value (string) --
The value of the tag.