SSOAdmin ******** Client ====== class SSOAdmin.Client A low-level client representing AWS Single Sign-On Admin (SSO Admin) IAM Identity Center is the Amazon Web Services solution for connecting your workforce users to Amazon Web Services managed applications and other Amazon Web Services resources. You can connect your existing identity provider and synchronize users and groups from your directory, or create and manage your users directly in IAM Identity Center. You can then use IAM Identity Center for either or both of the following: * User access to applications * User access to Amazon Web Services accounts This guide provides information about single sign-on operations that you can use for access to applications and Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide. Note: IAM Identity Center uses the "sso" and "identitystore" API namespaces. Many API operations for IAM Identity Center 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: Amazon Web Services 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 Amazon Web Services services. For more information about the Amazon Web Services 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_application * create_application_assignment * create_instance * create_instance_access_control_attribute_configuration * create_permission_set * create_trusted_token_issuer * delete_account_assignment * delete_application * delete_application_access_scope * delete_application_assignment * delete_application_authentication_method * delete_application_grant * delete_inline_policy_from_permission_set * delete_instance * delete_instance_access_control_attribute_configuration * delete_permission_set * delete_permissions_boundary_from_permission_set * delete_trusted_token_issuer * describe_account_assignment_creation_status * describe_account_assignment_deletion_status * describe_application * describe_application_assignment * describe_application_provider * describe_instance * describe_instance_access_control_attribute_configuration * describe_permission_set * describe_permission_set_provisioning_status * describe_trusted_token_issuer * detach_customer_managed_policy_reference_from_permission_set * detach_managed_policy_from_permission_set * get_application_access_scope * get_application_assignment_configuration * get_application_authentication_method * get_application_grant * 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_account_assignments_for_principal * list_accounts_for_provisioned_permission_set * list_application_access_scopes * list_application_assignments * list_application_assignments_for_principal * list_application_authentication_methods * list_application_grants * list_application_providers * list_applications * 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 * list_trusted_token_issuers * provision_permission_set * put_application_access_scope * put_application_assignment_configuration * put_application_authentication_method * put_application_grant * put_inline_policy_to_permission_set * put_permissions_boundary_to_permission_set * tag_resource * untag_resource * update_application * update_instance * update_instance_access_control_attribute_configuration * update_permission_set * update_trusted_token_issuer Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAccountAssignmentCreationStatus * ListAccountAssignmentDeletionStatus * ListAccountAssignments * ListAccountAssignmentsForPrincipal * ListAccountsForProvisionedPermissionSet * ListApplicationAccessScopes * ListApplicationAssignments * ListApplicationAssignmentsForPrincipal * ListApplicationAuthenticationMethods * ListApplicationGrants * ListApplicationProviders * ListApplications * ListCustomerManagedPolicyReferencesInPermissionSet * ListInstances * ListManagedPoliciesInPermissionSet * ListPermissionSetProvisioningStatus * ListPermissionSets * ListPermissionSetsProvisionedToAccount * ListTagsForResource * ListTrustedTokenIssuers SSOAdmin / Paginator / ListTagsForResource ListTagsForResource ******************* class 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' } ) Parameters: * **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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource with the tags to be listed. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 Amazon Web Services accounts. * **Key** *(string) --* The key for the tag. * **Value** *(string) --* The value of the tag. SSOAdmin / Paginator / ListPermissionSetProvisioningStatus ListPermissionSetProvisioningStatus *********************************** class 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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **Filter** (*dict*) -- Filters results based on the passed attribute value. * **Status** *(string) --* Filters the list operations result based on the status attribute. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / ListAccountsForProvisionedPermissionSet ListAccountsForProvisionedPermissionSet *************************************** class 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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed. * **ProvisioningStatus** (*string*) -- The permission set provisioning status for an Amazon Web Services account. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AccountIds': [ 'string', ], } **Response Structure** * *(dict) --* * **AccountIds** *(list) --* The list of Amazon Web Services "AccountIds". * *(string) --* SSOAdmin / Paginator / ListTrustedTokenIssuers ListTrustedTokenIssuers *********************** class SSOAdmin.Paginator.ListTrustedTokenIssuers paginator = client.get_paginator('list_trusted_token_issuers') paginate(**kwargs) Creates an iterator that will paginate through responses from "SSOAdmin.Client.list_trusted_token_issuers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the instance of IAM Identity Center with the trusted token issuer configurations that you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TrustedTokenIssuers': [ { 'TrustedTokenIssuerArn': 'string', 'Name': 'string', 'TrustedTokenIssuerType': 'OIDC_JWT' }, ], } **Response Structure** * *(dict) --* * **TrustedTokenIssuers** *(list) --* An array list of the trusted token issuer configurations. * *(dict) --* A structure that describes a trusted token issuer. * **TrustedTokenIssuerArn** *(string) --* The ARN of the trusted token issuer configuration in the instance of IAM Identity Center. * **Name** *(string) --* The name of the trusted token issuer configuration in the instance of IAM Identity Center. * **TrustedTokenIssuerType** *(string) --* The type of trusted token issuer. SSOAdmin / Paginator / ListApplicationAssignments ListApplicationAssignments ************************** class SSOAdmin.Paginator.ListApplicationAssignments paginator = client.get_paginator('list_application_assignments') paginate(**kwargs) Creates an iterator that will paginate through responses from "SSOAdmin.Client.list_application_assignments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ApplicationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ApplicationAssignments': [ { 'ApplicationArn': 'string', 'PrincipalId': 'string', 'PrincipalType': 'USER'|'GROUP' }, ], } **Response Structure** * *(dict) --* * **ApplicationAssignments** *(list) --* The list of users assigned to an application. * *(dict) --* A structure that describes an assignment of a principal to an application. * **ApplicationArn** *(string) --* The ARN of the application that has principals assigned. * **PrincipalId** *(string) --* The unique identifier of the principal assigned to the application. * **PrincipalType** *(string) --* The type of the principal assigned to the application. SSOAdmin / Paginator / ListAccountAssignments ListAccountAssignments ********************** class 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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **AccountId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Web Services account from which to list the assignments. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set from which to list assignments. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 Amazon Web Services account and permission set. * *(dict) --* The assignment that indicates a principal's limited access to a specified Amazon Web Services 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 Amazon Web Services account. * **PermissionSetArn** *(string) --* The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services 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 / ListAccountAssignmentCreationStatus ListAccountAssignmentCreationStatus *********************************** class SSOAdmin.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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **Filter** (*dict*) -- Filters results based on the passed attribute value. * **Status** *(string) --* Filters the list operations result based on the status attribute. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / ListApplicationGrants ListApplicationGrants ********************* class SSOAdmin.Paginator.ListApplicationGrants paginator = client.get_paginator('list_application_grants') paginate(**kwargs) Creates an iterator that will paginate through responses from "SSOAdmin.Client.list_application_grants()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ApplicationArn='string', PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application whose grants you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Grants': [ { 'GrantType': 'authorization_code'|'refresh_token'|'urn:ietf:params:oauth:grant-type:jwt-bearer'|'urn:ietf:params:oauth:grant-type:token-exchange', 'Grant': { 'AuthorizationCode': { 'RedirectUris': [ 'string', ] }, 'JwtBearer': { 'AuthorizedTokenIssuers': [ { 'TrustedTokenIssuerArn': 'string', 'AuthorizedAudiences': [ 'string', ] }, ] }, 'RefreshToken': {}, 'TokenExchange': {} } }, ], } **Response Structure** * *(dict) --* * **Grants** *(list) --* An array list of structures that describe the requested grants. * *(dict) --* A structure that defines a single grant and its configuration. * **GrantType** *(string) --* The type of the selected grant. * **Grant** *(dict) --* The configuration structure for the selected grant. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "AuthorizationCode", "JwtBearer", "RefreshToken", "TokenExchange". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **AuthorizationCode** *(dict) --* Configuration options for the "authorization_code" grant type. * **RedirectUris** *(list) --* A list of URIs that are valid locations to redirect a user's browser after the user is authorized. Note: RedirectUris is required when the grant type is "authorization_code". * *(string) --* * **JwtBearer** *(dict) --* Configuration options for the "urn:ietf:params:oauth:grant-type:jwt-bearer" grant type. * **AuthorizedTokenIssuers** *(list) --* A list of allowed token issuers trusted by the Identity Center instances for this application. Note: "AuthorizedTokenIssuers" is required when the grant type is "JwtBearerGrant". * *(dict) --* A structure that describes a trusted token issuer and associates it with a set of authorized audiences. * **TrustedTokenIssuerArn** *(string) --* The ARN of the trusted token issuer. * **AuthorizedAudiences** *(list) --* An array list of authorized audiences, or applications, that can consume the tokens generated by the associated trusted token issuer. * *(string) --* * **RefreshToken** *(dict) --* Configuration options for the "refresh_token" grant type. * **TokenExchange** *(dict) --* Configuration options for the "urn:ietf:params:oauth:grant-type:token-exchange" grant type. SSOAdmin / Paginator / ListAccountAssignmentDeletionStatus ListAccountAssignmentDeletionStatus *********************************** class 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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **Filter** (*dict*) -- Filters results based on the passed attribute value. * **Status** *(string) --* Filters the list operations result based on the status attribute. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / ListCustomerManagedPolicyReferencesInPermissionSet ListCustomerManagedPolicyReferencesInPermissionSet ************************************************** class 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_perm ission_set()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceArn='string', PermissionSetArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the "PermissionSet". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 Amazon Web Services 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 ListInstances ************* class 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' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Instances': [ { 'InstanceArn': 'string', 'IdentityStoreId': 'string', 'OwnerAccountId': 'string', 'Name': 'string', 'CreatedDate': datetime(2015, 1, 1), 'Status': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'ACTIVE' }, ], } **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 Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **IdentityStoreId** *(string) --* The identifier of the identity store that is connected to the Identity Center instance. * **OwnerAccountId** *(string) --* The Amazon Web Services account ID number of the owner of the Identity Center instance. * **Name** *(string) --* The name of the Identity Center instance. * **CreatedDate** *(datetime) --* The date and time that the Identity Center instance was created. * **Status** *(string) --* The current status of this Identity Center instance. SSOAdmin / Paginator / ListPermissionSets ListPermissionSets ****************** class 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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PermissionSets': [ 'string', ], } **Response Structure** * *(dict) --* * **PermissionSets** *(list) --* Defines the level of access on an Amazon Web Services account. * *(string) --* SSOAdmin / Paginator / ListApplicationAccessScopes ListApplicationAccessScopes *************************** class SSOAdmin.Paginator.ListApplicationAccessScopes paginator = client.get_paginator('list_application_access_scopes') paginate(**kwargs) Creates an iterator that will paginate through responses from "SSOAdmin.Client.list_application_access_scopes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ApplicationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Scopes': [ { 'Scope': 'string', 'AuthorizedTargets': [ 'string', ] }, ], } **Response Structure** * *(dict) --* * **Scopes** *(list) --* An array list of access scopes and their authorized targets that are associated with the application. * *(dict) --* A structure that describes an IAM Identity Center access scope and its authorized targets. * **Scope** *(string) --* The name of the access scope. * **AuthorizedTargets** *(list) --* An array list of ARNs of applications. * *(string) --* SSOAdmin / Paginator / ListApplicationAuthenticationMethods ListApplicationAuthenticationMethods ************************************ class SSOAdmin.Paginator.ListApplicationAuthenticationMethods paginator = client.get_paginator('list_application_authentication_methods') paginate(**kwargs) Creates an iterator that will paginate through responses from "SSOAdmin.Client.list_application_authentication_methods()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ApplicationArn='string', PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application with the authentication methods you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AuthenticationMethods': [ { 'AuthenticationMethodType': 'IAM', 'AuthenticationMethod': { 'Iam': { 'ActorPolicy': {...}|[...]|123|123.4|'string'|True|None } } }, ], } **Response Structure** * *(dict) --* * **AuthenticationMethods** *(list) --* An array list of authentication methods for the specified application. * *(dict) --* A structure that describes an authentication method and its type. * **AuthenticationMethodType** *(string) --* The type of authentication that is used by this method. * **AuthenticationMethod** *(dict) --* A structure that describes an authentication method. The contents of this structure is determined by the "AuthenticationMethodType". Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Iam". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Iam** *(dict) --* A structure that describes details for IAM authentication. * **ActorPolicy** (*document*) -- An IAM policy document in JSON. SSOAdmin / Paginator / ListPermissionSetsProvisionedToAccount ListPermissionSetsProvisionedToAccount ************************************** class 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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **AccountId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Web Services account from which to list the assignments. * **ProvisioningStatus** (*string*) -- The status object for the permission set provisioning operation. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PermissionSets': [ 'string', ] } **Response Structure** * *(dict) --* * **PermissionSets** *(list) --* Defines the level of access that an Amazon Web Services account has. * *(string) --* SSOAdmin / Paginator / ListApplications ListApplications **************** class SSOAdmin.Paginator.ListApplications paginator = client.get_paginator('list_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "SSOAdmin.Client.list_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceArn='string', Filter={ 'ApplicationAccount': 'string', 'ApplicationProvider': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **Filter** (*dict*) -- Filters response results. * **ApplicationAccount** *(string) --* An Amazon Web Services account ID number that filters the results in the response. * **ApplicationProvider** *(string) --* The ARN of an application provider that can filter the results in the response. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Applications': [ { 'ApplicationArn': 'string', 'ApplicationProviderArn': 'string', 'Name': 'string', 'ApplicationAccount': 'string', 'InstanceArn': 'string', 'Status': 'ENABLED'|'DISABLED', 'PortalOptions': { 'SignInOptions': { 'Origin': 'IDENTITY_CENTER'|'APPLICATION', 'ApplicationUrl': 'string' }, 'Visibility': 'ENABLED'|'DISABLED' }, 'Description': 'string', 'CreatedDate': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **Applications** *(list) --* Retrieves all applications associated with the instance. * *(dict) --* A structure that describes an application that uses IAM Identity Center for access management. * **ApplicationArn** *(string) --* The ARN of the application. * **ApplicationProviderArn** *(string) --* The ARN of the application provider for this application. * **Name** *(string) --* The name of the application. * **ApplicationAccount** *(string) --* The Amazon Web Services account ID number of the application. * **InstanceArn** *(string) --* The ARN of the instance of IAM Identity Center that is configured with this application. * **Status** *(string) --* The current status of the application in this instance of IAM Identity Center. * **PortalOptions** *(dict) --* A structure that describes the options for the access portal associated with this application. * **SignInOptions** *(dict) --* A structure that describes the sign-in options for the access portal. * **Origin** *(string) --* This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values: * "APPLICATION": IAM Identity Center redirects the customer to the configured "ApplicationUrl". * "IDENTITY_CENTER": IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application. * **ApplicationUrl** *(string) --* The URL that accepts authentication requests for an application. This is a required parameter if the "Origin" parameter is "APPLICATION". * **Visibility** *(string) --* Indicates whether this application is visible in the access portal. * **Description** *(string) --* The description of the application. * **CreatedDate** *(datetime) --* The date and time when the application was originally created. SSOAdmin / Paginator / ListManagedPoliciesInPermissionSet ListManagedPoliciesInPermissionSet ********************************** class 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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the PermissionSet whose managed policies will be listed. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 a list of managed policy ARNs that describe the associated Amazon Web Services managed policy. * **Name** *(string) --* The name of the Amazon Web Services managed policy. * **Arn** *(string) --* The ARN of the Amazon Web Services managed policy. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. SSOAdmin / Paginator / ListApplicationAssignmentsForPrincipal ListApplicationAssignmentsForPrincipal ************************************** class SSOAdmin.Paginator.ListApplicationAssignmentsForPrincipal paginator = client.get_paginator('list_application_assignments_for_principal') paginate(**kwargs) Creates an iterator that will paginate through responses from "SSOAdmin.Client.list_application_assignments_for_principal()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceArn='string', PrincipalId='string', PrincipalType='USER'|'GROUP', Filter={ 'ApplicationArn': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** Specifies the instance of IAM Identity Center that contains principal and applications. * **PrincipalId** (*string*) -- **[REQUIRED]** Specifies the unique identifier of the principal for which you want to retrieve its assignments. * **PrincipalType** (*string*) -- **[REQUIRED]** Specifies the type of the principal for which you want to retrieve its assignments. * **Filter** (*dict*) -- Filters the output to include only assignments associated with the application that has the specified ARN. * **ApplicationArn** *(string) --* The ARN of an application. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ApplicationAssignments': [ { 'ApplicationArn': 'string', 'PrincipalId': 'string', 'PrincipalType': 'USER'|'GROUP' }, ], } **Response Structure** * *(dict) --* * **ApplicationAssignments** *(list) --* An array list of the application assignments for the specified principal. * *(dict) --* A structure that describes an application to which a principal is assigned. * **ApplicationArn** *(string) --* The ARN of the application to which the specified principal is assigned. * **PrincipalId** *(string) --* The unique identifier of the principal assigned to the application. * **PrincipalType** *(string) --* The type of the principal assigned to the application. SSOAdmin / Paginator / ListApplicationProviders ListApplicationProviders ************************ class SSOAdmin.Paginator.ListApplicationProviders paginator = client.get_paginator('list_application_providers') paginate(**kwargs) Creates an iterator that will paginate through responses from "SSOAdmin.Client.list_application_providers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ApplicationProviders': [ { 'ApplicationProviderArn': 'string', 'FederationProtocol': 'SAML'|'OAUTH', 'DisplayData': { 'DisplayName': 'string', 'IconUrl': 'string', 'Description': 'string' }, 'ResourceServerConfig': { 'Scopes': { 'string': { 'LongDescription': 'string', 'DetailedTitle': 'string' } } } }, ], } **Response Structure** * *(dict) --* * **ApplicationProviders** *(list) --* An array list of structures that describe application providers. * *(dict) --* A structure that describes a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center. * **ApplicationProviderArn** *(string) --* The ARN of the application provider. * **FederationProtocol** *(string) --* The protocol that the application provider uses to perform federation. * **DisplayData** *(dict) --* A structure that describes how IAM Identity Center represents the application provider in the portal. * **DisplayName** *(string) --* The name of the application provider that appears in the portal. * **IconUrl** *(string) --* A URL that points to an icon that represents the application provider. * **Description** *(string) --* The description of the application provider that appears in the portal. * **ResourceServerConfig** *(dict) --* A structure that describes the application provider's resource server. * **Scopes** *(dict) --* A list of the IAM Identity Center access scopes that are associated with this resource server. * *(string) --* * *(dict) --* A structure that describes details for an IAM Identity Center access scope that is associated with a resource server. * **LongDescription** *(string) --* The description of an access scope for a resource server. * **DetailedTitle** *(string) --* The title of an access scope for a resource server. SSOAdmin / Paginator / ListAccountAssignmentsForPrincipal ListAccountAssignmentsForPrincipal ********************************** class SSOAdmin.Paginator.ListAccountAssignmentsForPrincipal paginator = client.get_paginator('list_account_assignments_for_principal') paginate(**kwargs) Creates an iterator that will paginate through responses from "SSOAdmin.Client.list_account_assignments_for_principal()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceArn='string', PrincipalId='string', PrincipalType='USER'|'GROUP', Filter={ 'AccountId': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the instance of IAM Identity Center that contains the principal. * **PrincipalId** (*string*) -- **[REQUIRED]** Specifies the principal for which you want to retrieve the list of account assignments. * **PrincipalType** (*string*) -- **[REQUIRED]** Specifies the type of the principal. * **Filter** (*dict*) -- Specifies an Amazon Web Services account ID number. Results are filtered to only those that match this ID number. * **AccountId** *(string) --* The ID number of an Amazon Web Services account that filters the results in the response. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AccountAssignments': [ { 'AccountId': 'string', 'PermissionSetArn': 'string', 'PrincipalId': 'string', 'PrincipalType': 'USER'|'GROUP' }, ], } **Response Structure** * *(dict) --* * **AccountAssignments** *(list) --* An array list of the account assignments for the principal. * *(dict) --* A structure that describes an assignment of an Amazon Web Services account to a principal and the permissions that principal has in the account. * **AccountId** *(string) --* The account ID number of the Amazon Web Services account. * **PermissionSetArn** *(string) --* The ARN of the IAM Identity Center permission set assigned to this principal for this Amazon Web Services account. * **PrincipalId** *(string) --* The ID of the principal. * **PrincipalType** *(string) --* The type of the principal. SSOAdmin / Client / create_permission_set create_permission_set ********************* SSOAdmin.Client.create_permission_set(**kwargs) Creates a permission set within a specified IAM Identity Center instance. Note: To grant users and groups access to Amazon Web Services account resources, use >>``<>``<<. 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' }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the PermissionSet. * **Description** (*string*) -- The description of the PermissionSet. * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **SessionDuration** (*string*) -- The length of time that the application user sessions are valid in the ISO-8601 standard. * **RelayState** (*string*) -- Used to redirect users within the application during the federation authentication process. * **Tags** (*list*) -- The tags to attach to the new PermissionSet. * *(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 Amazon Web Services accounts. * **Key** *(string) --* **[REQUIRED]** The key for the tag. * **Value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **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 Amazon Web Services 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 Amazon Web Services Service Namespaces in the *Amazon Web Services 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.ServiceQuotaExceededException" * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_applications list_applications ***************** SSOAdmin.Client.list_applications(**kwargs) Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the "applicationAccount" parameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required. See also: AWS API Documentation **Request Syntax** response = client.list_applications( InstanceArn='string', MaxResults=123, NextToken='string', Filter={ 'ApplicationAccount': 'string', 'ApplicationProvider': 'string' } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **MaxResults** (*integer*) -- Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the "NextToken" response element is returned with a value (not null). Include the specified value as the "NextToken" request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check "NextToken" after every operation to ensure that you receive all of the results. * **NextToken** (*string*) -- Specifies that you want to receive the next page of results. Valid only if you received a "NextToken" response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's "NextToken" response to request the next page of results. * **Filter** (*dict*) -- Filters response results. * **ApplicationAccount** *(string) --* An Amazon Web Services account ID number that filters the results in the response. * **ApplicationProvider** *(string) --* The ARN of an application provider that can filter the results in the response. Return type: dict Returns: **Response Syntax** { 'Applications': [ { 'ApplicationArn': 'string', 'ApplicationProviderArn': 'string', 'Name': 'string', 'ApplicationAccount': 'string', 'InstanceArn': 'string', 'Status': 'ENABLED'|'DISABLED', 'PortalOptions': { 'SignInOptions': { 'Origin': 'IDENTITY_CENTER'|'APPLICATION', 'ApplicationUrl': 'string' }, 'Visibility': 'ENABLED'|'DISABLED' }, 'Description': 'string', 'CreatedDate': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Applications** *(list) --* Retrieves all applications associated with the instance. * *(dict) --* A structure that describes an application that uses IAM Identity Center for access management. * **ApplicationArn** *(string) --* The ARN of the application. * **ApplicationProviderArn** *(string) --* The ARN of the application provider for this application. * **Name** *(string) --* The name of the application. * **ApplicationAccount** *(string) --* The Amazon Web Services account ID number of the application. * **InstanceArn** *(string) --* The ARN of the instance of IAM Identity Center that is configured with this application. * **Status** *(string) --* The current status of the application in this instance of IAM Identity Center. * **PortalOptions** *(dict) --* A structure that describes the options for the access portal associated with this application. * **SignInOptions** *(dict) --* A structure that describes the sign-in options for the access portal. * **Origin** *(string) --* This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values: * "APPLICATION": IAM Identity Center redirects the customer to the configured "ApplicationUrl". * "IDENTITY_CENTER": IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application. * **ApplicationUrl** *(string) --* The URL that accepts authentication requests for an application. This is a required parameter if the "Origin" parameter is "APPLICATION". * **Visibility** *(string) --* Indicates whether this application is visible in the access portal. * **Description** *(string) --* The description of the application. * **CreatedDate** *(datetime) --* The date and time when the application was originally created. * **NextToken** *(string) --* If present, this value indicates that more output is available than is included in the current response. Use this value in the "NextToken" request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the "NextToken" response element comes back as "null". This indicates that this is the last page of results. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / describe_account_assignment_creation_status describe_account_assignment_creation_status ******************************************* SSOAdmin.Client.describe_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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **AccountAssignmentCreationRequestId** (*string*) -- **[REQUIRED]** The identifier that is used to track the request operation progress. Return type: dict Returns: **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 Amazon Web Services account identifier, (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 Amazon Web Services Service Namespaces in the *Amazon Web Services 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / delete_permission_set delete_permission_set ********************* SSOAdmin.Client.delete_permission_set(**kwargs) Deletes the specified permission set. See also: AWS API Documentation **Request Syntax** response = client.delete_permission_set( InstanceArn='string', PermissionSetArn='string' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set that should be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / get_paginator get_paginator ************* SSOAdmin.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. SSOAdmin / Client / update_trusted_token_issuer update_trusted_token_issuer *************************** SSOAdmin.Client.update_trusted_token_issuer(**kwargs) Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration. Note: Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer. See also: AWS API Documentation **Request Syntax** response = client.update_trusted_token_issuer( TrustedTokenIssuerArn='string', Name='string', TrustedTokenIssuerConfiguration={ 'OidcJwtConfiguration': { 'ClaimAttributePath': 'string', 'IdentityStoreAttributePath': 'string', 'JwksRetrievalOption': 'OPEN_ID_DISCOVERY' } } ) Parameters: * **TrustedTokenIssuerArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the trusted token issuer configuration that you want to update. * **Name** (*string*) -- Specifies the updated name to be applied to the trusted token issuer configuration. * **TrustedTokenIssuerConfiguration** (*dict*) -- Specifies a structure with settings to apply to the specified trusted token issuer. The settings that you can provide are determined by the type of the trusted token issuer that you are updating. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "OidcJwtConfiguration". * **OidcJwtConfiguration** *(dict) --* A structure that describes an updated configuration for a trusted token issuer that uses OpenID Connect (OIDC) with JSON web tokens (JWT). * **ClaimAttributePath** *(string) --* The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by "IdentityStoreAttributePath" when a trusted token issuer token is exchanged for an IAM Identity Center token. * **IdentityStoreAttributePath** *(string) --* The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by "ClaimAttributePath" when a trusted token issuer token is exchanged for an IAM Identity Center token. * **JwksRetrievalOption** *(string) --* The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / describe_permission_set_provisioning_status describe_permission_set_provisioning_status ******************************************* SSOAdmin.Client.describe_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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **ProvisionPermissionSetRequestId** (*string*) -- **[REQUIRED]** The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow. Return type: dict Returns: **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 Amazon Web Services 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 Amazon Web Services Service Namespaces in the *Amazon Web Services 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / delete_account_assignment delete_account_assignment ************************* SSOAdmin.Client.delete_account_assignment(**kwargs) Deletes a principal's access from a specified Amazon Web Services account using a specified permission set. Note: After a successful response, call "DescribeAccountAssignmentDeletionStatus" 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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **TargetId** (*string*) -- **[REQUIRED]** TargetID is an Amazon Web Services account identifier, (For example, 123456789012). * **TargetType** (*string*) -- **[REQUIRED]** The entity type for which the assignment will be deleted. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set that will be used to remove access. * **PrincipalType** (*string*) -- **[REQUIRED]** The entity type for which the assignment will be deleted. * **PrincipalId** (*string*) -- **[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. Return type: dict Returns: **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 Amazon Web Services account identifier, (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 Amazon Web Services Service Namespaces in the *Amazon Web Services 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_account_assignments_for_principal list_account_assignments_for_principal ************************************** SSOAdmin.Client.list_account_assignments_for_principal(**kwargs) Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center. See also: AWS API Documentation **Request Syntax** response = client.list_account_assignments_for_principal( InstanceArn='string', PrincipalId='string', PrincipalType='USER'|'GROUP', Filter={ 'AccountId': 'string' }, NextToken='string', MaxResults=123 ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the instance of IAM Identity Center that contains the principal. * **PrincipalId** (*string*) -- **[REQUIRED]** Specifies the principal for which you want to retrieve the list of account assignments. * **PrincipalType** (*string*) -- **[REQUIRED]** Specifies the type of the principal. * **Filter** (*dict*) -- Specifies an Amazon Web Services account ID number. Results are filtered to only those that match this ID number. * **AccountId** *(string) --* The ID number of an Amazon Web Services account that filters the results in the response. * **NextToken** (*string*) -- Specifies that you want to receive the next page of results. Valid only if you received a "NextToken" response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's "NextToken" response to request the next page of results. * **MaxResults** (*integer*) -- Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the "NextToken" response element is returned with a value (not null). Include the specified value as the "NextToken" request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check "NextToken" after every operation to ensure that you receive all of the results. Return type: dict Returns: **Response Syntax** { 'AccountAssignments': [ { 'AccountId': 'string', 'PermissionSetArn': 'string', 'PrincipalId': 'string', 'PrincipalType': 'USER'|'GROUP' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **AccountAssignments** *(list) --* An array list of the account assignments for the principal. * *(dict) --* A structure that describes an assignment of an Amazon Web Services account to a principal and the permissions that principal has in the account. * **AccountId** *(string) --* The account ID number of the Amazon Web Services account. * **PermissionSetArn** *(string) --* The ARN of the IAM Identity Center permission set assigned to this principal for this Amazon Web Services account. * **PrincipalId** *(string) --* The ID of the principal. * **PrincipalType** *(string) --* The type of the principal. * **NextToken** *(string) --* If present, this value indicates that more output is available than is included in the current response. Use this value in the "NextToken" request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the "NextToken" response element comes back as "null". This indicates that this is the last page of results. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / delete_inline_policy_from_permission_set delete_inline_policy_from_permission_set **************************************** SSOAdmin.Client.delete_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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set that will be used to remove access. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / delete_trusted_token_issuer delete_trusted_token_issuer *************************** SSOAdmin.Client.delete_trusted_token_issuer(**kwargs) Deletes a trusted token issuer configuration from an instance of IAM Identity Center. Note: Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer. See also: AWS API Documentation **Request Syntax** response = client.delete_trusted_token_issuer( TrustedTokenIssuerArn='string' ) Parameters: **TrustedTokenIssuerArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the trusted token issuer configuration to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / provision_permission_set provision_permission_set ************************ SSOAdmin.Client.provision_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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set. * **TargetId** (*string*) -- TargetID is an Amazon Web Services account identifier, (For example, 123456789012). * **TargetType** (*string*) -- **[REQUIRED]** The entity type for which the assignment will be created. Return type: dict Returns: **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 Amazon Web Services 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 Amazon Web Services Service Namespaces in the *Amazon Web Services 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / can_paginate can_paginate ************ SSOAdmin.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. SSOAdmin / Client / describe_application_assignment describe_application_assignment ******************************* SSOAdmin.Client.describe_application_assignment(**kwargs) Retrieves a direct assignment of a user or group to an application. If the user doesn’t have a direct assignment to the application, the user may still have access to the application through a group. Therefore, don’t use this API to test access to an application for a user. Instead use ListApplicationAssignmentsForPrincipal. See also: AWS API Documentation **Request Syntax** response = client.describe_application_assignment( ApplicationArn='string', PrincipalId='string', PrincipalType='USER'|'GROUP' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PrincipalId** (*string*) -- **[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. * **PrincipalType** (*string*) -- **[REQUIRED]** The entity type for which the assignment will be created. Return type: dict Returns: **Response Syntax** { 'PrincipalType': 'USER'|'GROUP', 'PrincipalId': 'string', 'ApplicationArn': 'string' } **Response Structure** * *(dict) --* * **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. * **ApplicationArn** *(string) --* Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / create_trusted_token_issuer create_trusted_token_issuer *************************** SSOAdmin.Client.create_trusted_token_issuer(**kwargs) Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of Amazon Web Services. This trusted token issuer describes an external identity provider (IdP) that can generate claims or assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center can use these tokens for authentication. See also: AWS API Documentation **Request Syntax** response = client.create_trusted_token_issuer( InstanceArn='string', Name='string', TrustedTokenIssuerType='OIDC_JWT', TrustedTokenIssuerConfiguration={ 'OidcJwtConfiguration': { 'IssuerUrl': 'string', 'ClaimAttributePath': 'string', 'IdentityStoreAttributePath': 'string', 'JwksRetrievalOption': 'OPEN_ID_DISCOVERY' } }, ClientToken='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer configuration. * **Name** (*string*) -- **[REQUIRED]** Specifies the name of the new trusted token issuer configuration. * **TrustedTokenIssuerType** (*string*) -- **[REQUIRED]** Specifies the type of the new trusted token issuer. * **TrustedTokenIssuerConfiguration** (*dict*) -- **[REQUIRED]** Specifies settings that apply to the new trusted token issuer configuration. The settings that are available depend on what "TrustedTokenIssuerType" you specify. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "OidcJwtConfiguration". * **OidcJwtConfiguration** *(dict) --* A structure that describes the settings for a trusted token issuer that works with OpenID Connect (OIDC) by using JSON Web Tokens (JWT). * **IssuerUrl** *(string) --* **[REQUIRED]** The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates. * **ClaimAttributePath** *(string) --* **[REQUIRED]** The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by "IdentityStoreAttributePath" when a trusted token issuer token is exchanged for an IAM Identity Center token. * **IdentityStoreAttributePath** *(string) --* **[REQUIRED]** The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by "ClaimAttributePath" when a trusted token issuer token is exchanged for an IAM Identity Center token. * **JwksRetrievalOption** *(string) --* **[REQUIRED]** The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT. * **ClientToken** (*string*) -- Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same "ClientToken", but with different parameters, the retry fails with an "IdempotentParameterMismatch" error. This field is autopopulated if not provided. * **Tags** (*list*) -- Specifies tags to be attached to the new trusted token issuer configuration. * *(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 Amazon Web Services accounts. * **Key** *(string) --* **[REQUIRED]** The key for the tag. * **Value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** { 'TrustedTokenIssuerArn': 'string' } **Response Structure** * *(dict) --* * **TrustedTokenIssuerArn** *(string) --* The ARN of the new trusted token issuer configuration. **Exceptions** * "SSOAdmin.Client.exceptions.ServiceQuotaExceededException" * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / put_application_access_scope put_application_access_scope **************************** SSOAdmin.Client.put_application_access_scope(**kwargs) Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application. See also: AWS API Documentation **Request Syntax** response = client.put_application_access_scope( Scope='string', AuthorizedTargets=[ 'string', ], ApplicationArn='string' ) Parameters: * **Scope** (*string*) -- **[REQUIRED]** Specifies the name of the access scope to be associated with the specified targets. * **AuthorizedTargets** (*list*) -- Specifies an array list of ARNs that represent the authorized targets for this access scope. * *(string) --* * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application with the access scope with the targets to add or update. Returns: None **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / describe_instance_access_control_attribute_configuration describe_instance_access_control_attribute_configuration ******************************************************** SSOAdmin.Client.describe_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' ) Parameters: **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. Return type: dict Returns: **Response Syntax** { 'Status': 'ENABLED'|'CREATION_IN_PROGRESS'|'CREATION_FAILED', 'StatusReason': 'string', 'InstanceAccessControlAttributeConfiguration': { 'AccessControlAttributes': [ { 'Key': 'string', 'Value': { 'Source': [ 'string', ] } }, ] } } **Response Structure** * *(dict) --* * **Status** *(string) --* The status of the attribute configuration process. * **StatusReason** *(string) --* Provides more details about the current status of the specified attribute. * **InstanceAccessControlAttributeConfiguration** *(dict) --* Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC configuration. * **AccessControlAttributes** *(list) --* Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance. * *(dict) --* 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 Amazon Web Services 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. * **Key** *(string) --* 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. * **Value** *(dict) --* The value used for mapping a specified attribute to an identity source. * **Source** *(list) --* The identity source to use when mapping a specified attribute to IAM Identity Center. * *(string) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / list_account_assignments list_account_assignments ************************ SSOAdmin.Client.list_account_assignments(**kwargs) Lists the assignee of the specified Amazon Web Services 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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **AccountId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Web Services account from which to list the assignments. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set from which to list assignments. * **MaxResults** (*integer*) -- The maximum number of results to display for the assignment. * **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. Return type: dict Returns: **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 Amazon Web Services account and permission set. * *(dict) --* The assignment that indicates a principal's limited access to a specified Amazon Web Services 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 Amazon Web Services account. * **PermissionSetArn** *(string) --* The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / get_application_authentication_method get_application_authentication_method ************************************* SSOAdmin.Client.get_application_authentication_method(**kwargs) Retrieves details about an authentication method used by an application. See also: AWS API Documentation **Request Syntax** response = client.get_application_authentication_method( ApplicationArn='string', AuthenticationMethodType='IAM' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. * **AuthenticationMethodType** (*string*) -- **[REQUIRED]** Specifies the type of authentication method for which you want details. Return type: dict Returns: **Response Syntax** { 'AuthenticationMethod': { 'Iam': { 'ActorPolicy': {...}|[...]|123|123.4|'string'|True|None } } } **Response Structure** * *(dict) --* * **AuthenticationMethod** *(dict) --* A structure that contains details about the requested authentication method. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Iam". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Iam** *(dict) --* A structure that describes details for IAM authentication. * **ActorPolicy** (*document*) -- An IAM policy document in JSON. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / get_inline_policy_for_permission_set get_inline_policy_for_permission_set ************************************ SSOAdmin.Client.get_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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set. Return type: dict Returns: **Response Syntax** { 'InlinePolicy': 'string' } **Response Structure** * *(dict) --* * **InlinePolicy** *(string) --* The inline policy that is attached to the permission set. Note: For "Length Constraints", if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / delete_instance_access_control_attribute_configuration delete_instance_access_control_attribute_configuration ****************************************************** SSOAdmin.Client.delete_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' ) Parameters: **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_permission_sets_provisioned_to_account list_permission_sets_provisioned_to_account ******************************************* SSOAdmin.Client.list_permission_sets_provisioned_to_account(**kwargs) Lists all the permission sets that are provisioned to a specified Amazon Web Services 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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **AccountId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Web Services account from which to list the assignments. * **ProvisioningStatus** (*string*) -- The status object for the permission set provisioning operation. * **MaxResults** (*integer*) -- The maximum number of results to display for the assignment. * **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. Return type: dict Returns: **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 Amazon Web Services account has. * *(string) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / create_account_assignment create_account_assignment ************************* SSOAdmin.Client.create_account_assignment(**kwargs) Assigns access to a principal for a specified Amazon Web Services 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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **TargetId** (*string*) -- **[REQUIRED]** TargetID is an Amazon Web Services account identifier, (For example, 123456789012). * **TargetType** (*string*) -- **[REQUIRED]** The entity type for which the assignment will be created. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set that the admin wants to grant the principal access to. * **PrincipalType** (*string*) -- **[REQUIRED]** The entity type for which the assignment will be created. * **PrincipalId** (*string*) -- **[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. Return type: dict Returns: **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 Amazon Web Services account identifier, (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 Amazon Web Services Service Namespaces in the *Amazon Web Services 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.ServiceQuotaExceededException" * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_permission_sets list_permission_sets ******************** SSOAdmin.Client.list_permission_sets(**kwargs) Lists the PermissionSets in an IAM Identity Center instance. See also: AWS API Documentation **Request Syntax** response = client.list_permission_sets( InstanceArn='string', NextToken='string', MaxResults=123 ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services 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. * **MaxResults** (*integer*) -- The maximum number of results to display for the assignment. Return type: dict Returns: **Response Syntax** { 'PermissionSets': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PermissionSets** *(list) --* Defines the level of access on an Amazon Web Services account. * *(string) --* * **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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / delete_permissions_boundary_from_permission_set delete_permissions_boundary_from_permission_set *********************************************** SSOAdmin.Client.delete_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' ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the "PermissionSet". Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_permission_set_provisioning_status list_permission_set_provisioning_status *************************************** SSOAdmin.Client.list_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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **MaxResults** (*integer*) -- The maximum number of results to display for the assignment. * **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. * **Filter** (*dict*) -- Filters results based on the passed attribute value. * **Status** *(string) --* Filters the list operations result based on the status attribute. Return type: dict Returns: **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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / list_tags_for_resource list_tags_for_resource ********************** SSOAdmin.Client.list_tags_for_resource(**kwargs) Lists 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' ) Parameters: * **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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource with the tags to be listed. * **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. Return type: dict Returns: **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 Amazon Web Services 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / list_account_assignment_creation_status list_account_assignment_creation_status *************************************** SSOAdmin.Client.list_account_assignment_creation_status(**kwargs) Lists the status of the Amazon Web Services 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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **MaxResults** (*integer*) -- The maximum number of results to display for the assignment. * **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. * **Filter** (*dict*) -- Filters results based on the passed attribute value. * **Status** *(string) --* Filters the list operations result based on the status attribute. Return type: dict Returns: **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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / list_trusted_token_issuers list_trusted_token_issuers ************************** SSOAdmin.Client.list_trusted_token_issuers(**kwargs) Lists all the trusted token issuers configured in an instance of IAM Identity Center. See also: AWS API Documentation **Request Syntax** response = client.list_trusted_token_issuers( InstanceArn='string', MaxResults=123, NextToken='string' ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the instance of IAM Identity Center with the trusted token issuer configurations that you want to list. * **MaxResults** (*integer*) -- Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the "NextToken" response element is returned with a value (not null). Include the specified value as the "NextToken" request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check "NextToken" after every operation to ensure that you receive all of the results. * **NextToken** (*string*) -- Specifies that you want to receive the next page of results. Valid only if you received a "NextToken" response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's "NextToken" response to request the next page of results. Return type: dict Returns: **Response Syntax** { 'TrustedTokenIssuers': [ { 'TrustedTokenIssuerArn': 'string', 'Name': 'string', 'TrustedTokenIssuerType': 'OIDC_JWT' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TrustedTokenIssuers** *(list) --* An array list of the trusted token issuer configurations. * *(dict) --* A structure that describes a trusted token issuer. * **TrustedTokenIssuerArn** *(string) --* The ARN of the trusted token issuer configuration in the instance of IAM Identity Center. * **Name** *(string) --* The name of the trusted token issuer configuration in the instance of IAM Identity Center. * **TrustedTokenIssuerType** *(string) --* The type of trusted token issuer. * **NextToken** *(string) --* If present, this value indicates that more output is available than is included in the current response. Use this value in the "NextToken" request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the "NextToken" response element comes back as "null". This indicates that this is the last page of results. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / create_instance create_instance *************** SSOAdmin.Client.create_instance(**kwargs) 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. You can create only one instance per account and across all Amazon Web Services Regions. The CreateInstance request is rejected if the following apply: * The instance is created within the organization management account. * An instance already exists in the same account. See also: AWS API Documentation **Request Syntax** response = client.create_instance( Name='string', ClientToken='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **Name** (*string*) -- The name of the instance of IAM Identity Center. * **ClientToken** (*string*) -- Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same "ClientToken", but with different parameters, the retry fails with an "IdempotentParameterMismatch" error. This field is autopopulated if not provided. * **Tags** (*list*) -- Specifies tags to be attached to the instance of IAM Identity Center. * *(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 Amazon Web Services accounts. * **Key** *(string) --* **[REQUIRED]** The key for the tag. * **Value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** { 'InstanceArn': 'string' } **Response Structure** * *(dict) --* * **InstanceArn** *(string) --* The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. **Exceptions** * "SSOAdmin.Client.exceptions.ServiceQuotaExceededException" * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / untag_resource untag_resource ************** SSOAdmin.Client.untag_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', ] ) Parameters: * **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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource with the tags to be listed. * **TagKeys** (*list*) -- **[REQUIRED]** The keys of tags that are attached to the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / create_application_assignment create_application_assignment ***************************** SSOAdmin.Client.create_application_assignment(**kwargs) Grant application access to a user or group. See also: AWS API Documentation **Request Syntax** response = client.create_application_assignment( ApplicationArn='string', PrincipalId='string', PrincipalType='USER'|'GROUP' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** The ARN of the application for which the assignment is created. * **PrincipalId** (*string*) -- **[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. * **PrincipalType** (*string*) -- **[REQUIRED]** The entity type for which the assignment will be created. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ServiceQuotaExceededException" * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / detach_customer_managed_policy_reference_from_permission_set detach_customer_managed_policy_reference_from_permission_set ************************************************************ SSOAdmin.Client.detach_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' } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the "PermissionSet". * **CustomerManagedPolicyReference** (*dict*) -- **[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 Amazon Web Services account where you want to deploy your permission set. * **Name** *(string) --* **[REQUIRED]** 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*. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_managed_policies_in_permission_set list_managed_policies_in_permission_set *************************************** SSOAdmin.Client.list_managed_policies_in_permission_set(**kwargs) Lists the Amazon Web Services 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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the PermissionSet whose managed policies will be listed. * **MaxResults** (*integer*) -- The maximum number of results to display for the PermissionSet. * **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. Return type: dict Returns: **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 a list of managed policy ARNs that describe the associated Amazon Web Services managed policy. * **Name** *(string) --* The name of the Amazon Web Services managed policy. * **Arn** *(string) --* The ARN of the Amazon Web Services managed policy. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / attach_managed_policy_to_permission_set attach_managed_policy_to_permission_set *************************************** SSOAdmin.Client.attach_managed_policy_to_permission_set(**kwargs) Attaches an Amazon Web Services 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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the PermissionSet that the managed policy should be attached to. * **ManagedPolicyArn** (*string*) -- **[REQUIRED]** The Amazon Web Services managed policy ARN to be attached to a permission set. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ServiceQuotaExceededException" * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / describe_permission_set describe_permission_set *********************** SSOAdmin.Client.describe_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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set. Return type: dict Returns: **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 Amazon Web Services 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 Amazon Web Services Service Namespaces in the *Amazon Web Services 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / get_waiter get_waiter ********** SSOAdmin.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" SSOAdmin / Client / get_permissions_boundary_for_permission_set get_permissions_boundary_for_permission_set ******************************************* SSOAdmin.Client.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' ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the "PermissionSet". Return type: dict Returns: **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 Amazon Web Services 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 Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions boundary. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / describe_instance describe_instance ***************** SSOAdmin.Client.describe_instance(**kwargs) Returns the details of an instance of IAM Identity Center. The status can be one of the following: * "CREATE_IN_PROGRESS" - The instance is in the process of being created. When the instance is ready for use, DescribeInstance returns the status of "ACTIVE". While the instance is in the "CREATE_IN_PROGRESS" state, you can call only DescribeInstance and DeleteInstance operations. * "DELETE_IN_PROGRESS" - The instance is being deleted. Returns "AccessDeniedException" after the delete operation completes. * "ACTIVE" - The instance is active. See also: AWS API Documentation **Request Syntax** response = client.describe_instance( InstanceArn='string' ) Parameters: **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the instance of IAM Identity Center under which the operation will run. Return type: dict Returns: **Response Syntax** { 'InstanceArn': 'string', 'IdentityStoreId': 'string', 'OwnerAccountId': 'string', 'Name': 'string', 'CreatedDate': datetime(2015, 1, 1), 'Status': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'ACTIVE' } **Response Structure** * *(dict) --* * **InstanceArn** *(string) --* The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **IdentityStoreId** *(string) --* The identifier of the identity store that is connected to the instance of IAM Identity Center. * **OwnerAccountId** *(string) --* The identifier of the Amazon Web Services account for which the instance was created. * **Name** *(string) --* Specifies the instance name. * **CreatedDate** *(datetime) --* The date the instance was created. * **Status** *(string) --* The status of the instance. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / update_instance update_instance *************** SSOAdmin.Client.update_instance(**kwargs) Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.update_instance( Name='string', InstanceArn='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** Updates the instance name. * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_application_grants list_application_grants *********************** SSOAdmin.Client.list_application_grants(**kwargs) List the grants associated with an application. See also: AWS API Documentation **Request Syntax** response = client.list_application_grants( ApplicationArn='string', NextToken='string' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application whose grants you want to list. * **NextToken** (*string*) -- Specifies that you want to receive the next page of results. Valid only if you received a "NextToken" response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's "NextToken" response to request the next page of results. Return type: dict Returns: **Response Syntax** { 'Grants': [ { 'GrantType': 'authorization_code'|'refresh_token'|'urn:ietf:params:oauth:grant-type:jwt-bearer'|'urn:ietf:params:oauth:grant-type:token-exchange', 'Grant': { 'AuthorizationCode': { 'RedirectUris': [ 'string', ] }, 'JwtBearer': { 'AuthorizedTokenIssuers': [ { 'TrustedTokenIssuerArn': 'string', 'AuthorizedAudiences': [ 'string', ] }, ] }, 'RefreshToken': {}, 'TokenExchange': {} } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Grants** *(list) --* An array list of structures that describe the requested grants. * *(dict) --* A structure that defines a single grant and its configuration. * **GrantType** *(string) --* The type of the selected grant. * **Grant** *(dict) --* The configuration structure for the selected grant. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "AuthorizationCode", "JwtBearer", "RefreshToken", "TokenExchange". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **AuthorizationCode** *(dict) --* Configuration options for the "authorization_code" grant type. * **RedirectUris** *(list) --* A list of URIs that are valid locations to redirect a user's browser after the user is authorized. Note: RedirectUris is required when the grant type is "authorization_code". * *(string) --* * **JwtBearer** *(dict) --* Configuration options for the "urn:ietf:params:oauth :grant-type:jwt-bearer" grant type. * **AuthorizedTokenIssuers** *(list) --* A list of allowed token issuers trusted by the Identity Center instances for this application. Note: "AuthorizedTokenIssuers" is required when the grant type is "JwtBearerGrant". * *(dict) --* A structure that describes a trusted token issuer and associates it with a set of authorized audiences. * **TrustedTokenIssuerArn** *(string) --* The ARN of the trusted token issuer. * **AuthorizedAudiences** *(list) --* An array list of authorized audiences, or applications, that can consume the tokens generated by the associated trusted token issuer. * *(string) --* * **RefreshToken** *(dict) --* Configuration options for the "refresh_token" grant type. * **TokenExchange** *(dict) --* Configuration options for the "urn:ietf:params:oauth :grant-type:token-exchange" grant type. * **NextToken** *(string) --* If present, this value indicates that more output is available than is included in the current response. Use this value in the "NextToken" request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the "NextToken" response element comes back as "null". This indicates that this is the last page of results. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / get_application_assignment_configuration get_application_assignment_configuration **************************************** SSOAdmin.Client.get_application_assignment_configuration(**kwargs) Retrieves the configuration of PutApplicationAssignmentConfiguration. See also: AWS API Documentation **Request Syntax** response = client.get_application_assignment_configuration( ApplicationArn='string' ) Parameters: **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. Return type: dict Returns: **Response Syntax** { 'AssignmentRequired': True|False } **Response Structure** * *(dict) --* * **AssignmentRequired** *(boolean) --* If "AssignmentsRequired" is "true" (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If "false", all users have access to the application. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / delete_application_assignment delete_application_assignment ***************************** SSOAdmin.Client.delete_application_assignment(**kwargs) Revoke application access to an application by deleting application assignments for a user or group. See also: AWS API Documentation **Request Syntax** response = client.delete_application_assignment( ApplicationArn='string', PrincipalId='string', PrincipalType='USER'|'GROUP' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. * **PrincipalId** (*string*) -- **[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. * **PrincipalType** (*string*) -- **[REQUIRED]** The entity type for which the assignment will be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / describe_trusted_token_issuer describe_trusted_token_issuer ***************************** SSOAdmin.Client.describe_trusted_token_issuer(**kwargs) Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration. See also: AWS API Documentation **Request Syntax** response = client.describe_trusted_token_issuer( TrustedTokenIssuerArn='string' ) Parameters: **TrustedTokenIssuerArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the trusted token issuer configuration that you want details about. Return type: dict Returns: **Response Syntax** { 'TrustedTokenIssuerArn': 'string', 'Name': 'string', 'TrustedTokenIssuerType': 'OIDC_JWT', 'TrustedTokenIssuerConfiguration': { 'OidcJwtConfiguration': { 'IssuerUrl': 'string', 'ClaimAttributePath': 'string', 'IdentityStoreAttributePath': 'string', 'JwksRetrievalOption': 'OPEN_ID_DISCOVERY' } } } **Response Structure** * *(dict) --* * **TrustedTokenIssuerArn** *(string) --* The ARN of the trusted token issuer configuration. * **Name** *(string) --* The name of the trusted token issuer configuration. * **TrustedTokenIssuerType** *(string) --* The type of the trusted token issuer. * **TrustedTokenIssuerConfiguration** *(dict) --* A structure the describes the settings that apply of this trusted token issuer. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "OidcJwtConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **OidcJwtConfiguration** *(dict) --* A structure that describes the settings for a trusted token issuer that works with OpenID Connect (OIDC) by using JSON Web Tokens (JWT). * **IssuerUrl** *(string) --* The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates. * **ClaimAttributePath** *(string) --* The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by "IdentityStoreAttributePath" when a trusted token issuer token is exchanged for an IAM Identity Center token. * **IdentityStoreAttributePath** *(string) --* The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by "ClaimAttributePath" when a trusted token issuer token is exchanged for an IAM Identity Center token. * **JwksRetrievalOption** *(string) --* The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / put_application_authentication_method put_application_authentication_method ************************************* SSOAdmin.Client.put_application_authentication_method(**kwargs) Adds or updates an authentication method for an application. See also: AWS API Documentation **Request Syntax** response = client.put_application_authentication_method( ApplicationArn='string', AuthenticationMethodType='IAM', AuthenticationMethod={ 'Iam': { 'ActorPolicy': {...}|[...]|123|123.4|'string'|True|None } } ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application with the authentication method to add or update. * **AuthenticationMethodType** (*string*) -- **[REQUIRED]** Specifies the type of the authentication method that you want to add or update. * **AuthenticationMethod** (*dict*) -- **[REQUIRED]** Specifies a structure that describes the authentication method to add or update. The structure type you provide is determined by the "AuthenticationMethodType" parameter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Iam". * **Iam** *(dict) --* A structure that describes details for IAM authentication. * **ActorPolicy** (*document*) -- **[REQUIRED]** An IAM policy document in JSON. Returns: None **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / put_application_grant put_application_grant ********************* SSOAdmin.Client.put_application_grant(**kwargs) Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0. A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms to obtain tokens. These tokens are used by your applications to gain access to Amazon Web Services resources on behalf of users. The following elements are within these exchanges: * **Requester** - The application requesting access to Amazon Web Services resources. * **Subject** - Typically the user that is requesting access to Amazon Web Services resources. * **Grant** - Conceptually, a grant is authorization to access Amazon Web Services resources. These grants authorize token generation for authenticating access to the requester and for the request to make requests on behalf of the subjects. There are four types of grants: * **AuthorizationCode** - Allows an application to request authorization through a series of user-agent redirects. * **JWT bearer** - Authorizes an application to exchange a JSON Web Token that came from an external identity provider. To learn more, see RFC 6479. * **Refresh token** - Enables application to request new access tokens to replace expiring or expired access tokens. * **Exchange token** - A grant that requests tokens from the authorization server by providing a ‘subject’ token with access scope authorizing trusted identity propagation to this application. To learn more, see RFC 8693. * **Authorization server** - IAM Identity Center requests tokens. User credentials are never shared directly within these exchanges. Instead, applications use grants to request access tokens from IAM Identity Center. For more information, see RFC 6479. **Use cases** * Connecting to custom applications. * Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT tokens. See also: AWS API Documentation **Request Syntax** response = client.put_application_grant( ApplicationArn='string', GrantType='authorization_code'|'refresh_token'|'urn:ietf:params:oauth:grant-type:jwt-bearer'|'urn:ietf:params:oauth:grant-type:token-exchange', Grant={ 'AuthorizationCode': { 'RedirectUris': [ 'string', ] }, 'JwtBearer': { 'AuthorizedTokenIssuers': [ { 'TrustedTokenIssuerArn': 'string', 'AuthorizedAudiences': [ 'string', ] }, ] }, 'RefreshToken': {} , 'TokenExchange': {} } ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application to update. * **GrantType** (*string*) -- **[REQUIRED]** Specifies the type of grant to update. * **Grant** (*dict*) -- **[REQUIRED]** Specifies a structure that describes the grant to update. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "AuthorizationCode", "JwtBearer", "RefreshToken", "TokenExchange". * **AuthorizationCode** *(dict) --* Configuration options for the "authorization_code" grant type. * **RedirectUris** *(list) --* A list of URIs that are valid locations to redirect a user's browser after the user is authorized. Note: RedirectUris is required when the grant type is "authorization_code". * *(string) --* * **JwtBearer** *(dict) --* Configuration options for the "urn:ietf:params:oauth:grant- type:jwt-bearer" grant type. * **AuthorizedTokenIssuers** *(list) --* A list of allowed token issuers trusted by the Identity Center instances for this application. Note: "AuthorizedTokenIssuers" is required when the grant type is "JwtBearerGrant". * *(dict) --* A structure that describes a trusted token issuer and associates it with a set of authorized audiences. * **TrustedTokenIssuerArn** *(string) --* The ARN of the trusted token issuer. * **AuthorizedAudiences** *(list) --* An array list of authorized audiences, or applications, that can consume the tokens generated by the associated trusted token issuer. * *(string) --* * **RefreshToken** *(dict) --* Configuration options for the "refresh_token" grant type. * **TokenExchange** *(dict) --* Configuration options for the "urn:ietf:params:oauth:grant- type:token-exchange" grant type. Returns: None **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / update_instance_access_control_attribute_configuration update_instance_access_control_attribute_configuration ****************************************************** SSOAdmin.Client.update_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', ] } }, ] } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. * **InstanceAccessControlAttributeConfiguration** (*dict*) -- **[REQUIRED]** Updates the attributes for your ABAC configuration. * **AccessControlAttributes** *(list) --* **[REQUIRED]** Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance. * *(dict) --* 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 Amazon Web Services 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. * **Key** *(string) --* **[REQUIRED]** 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. * **Value** *(dict) --* **[REQUIRED]** The value used for mapping a specified attribute to an identity source. * **Source** *(list) --* **[REQUIRED]** The identity source to use when mapping a specified attribute to IAM Identity Center. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / describe_account_assignment_deletion_status describe_account_assignment_deletion_status ******************************************* SSOAdmin.Client.describe_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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **AccountAssignmentDeletionRequestId** (*string*) -- **[REQUIRED]** The identifier that is used to track the request operation progress. Return type: dict Returns: **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 Amazon Web Services account identifier, (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 Amazon Web Services Service Namespaces in the *Amazon Web Services 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / put_permissions_boundary_to_permission_set put_permissions_boundary_to_permission_set ****************************************** SSOAdmin.Client.put_permissions_boundary_to_permission_set(**kwargs) Attaches an Amazon Web Services 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' } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the "PermissionSet". * **PermissionsBoundary** (*dict*) -- **[REQUIRED]** The permissions boundary that you want to attach to a "PermissionSet". * **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 Amazon Web Services account where you want to deploy your permission set. * **Name** *(string) --* **[REQUIRED]** 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 Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions boundary. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / update_permission_set update_permission_set ********************* SSOAdmin.Client.update_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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set. * **Description** (*string*) -- The description of the PermissionSet. * **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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_application_providers list_application_providers ************************** SSOAdmin.Client.list_application_providers(**kwargs) Lists the application providers configured in the IAM Identity Center identity store. See also: AWS API Documentation **Request Syntax** response = client.list_application_providers( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the "NextToken" response element is returned with a value (not null). Include the specified value as the "NextToken" request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check "NextToken" after every operation to ensure that you receive all of the results. * **NextToken** (*string*) -- Specifies that you want to receive the next page of results. Valid only if you received a "NextToken" response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's "NextToken" response to request the next page of results. Return type: dict Returns: **Response Syntax** { 'ApplicationProviders': [ { 'ApplicationProviderArn': 'string', 'FederationProtocol': 'SAML'|'OAUTH', 'DisplayData': { 'DisplayName': 'string', 'IconUrl': 'string', 'Description': 'string' }, 'ResourceServerConfig': { 'Scopes': { 'string': { 'LongDescription': 'string', 'DetailedTitle': 'string' } } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ApplicationProviders** *(list) --* An array list of structures that describe application providers. * *(dict) --* A structure that describes a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center. * **ApplicationProviderArn** *(string) --* The ARN of the application provider. * **FederationProtocol** *(string) --* The protocol that the application provider uses to perform federation. * **DisplayData** *(dict) --* A structure that describes how IAM Identity Center represents the application provider in the portal. * **DisplayName** *(string) --* The name of the application provider that appears in the portal. * **IconUrl** *(string) --* A URL that points to an icon that represents the application provider. * **Description** *(string) --* The description of the application provider that appears in the portal. * **ResourceServerConfig** *(dict) --* A structure that describes the application provider's resource server. * **Scopes** *(dict) --* A list of the IAM Identity Center access scopes that are associated with this resource server. * *(string) --* * *(dict) --* A structure that describes details for an IAM Identity Center access scope that is associated with a resource server. * **LongDescription** *(string) --* The description of an access scope for a resource server. * **DetailedTitle** *(string) --* The title of an access scope for a resource server. * **NextToken** *(string) --* If present, this value indicates that more output is available than is included in the current response. Use this value in the "NextToken" request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the "NextToken" response element comes back as "null". This indicates that this is the last page of results. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / list_customer_managed_policy_references_in_permission_set list_customer_managed_policy_references_in_permission_set ********************************************************* SSOAdmin.Client.list_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' ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the "PermissionSet". * **MaxResults** (*integer*) -- The maximum number of results to display for the list call. * **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. Return type: dict Returns: **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 Amazon Web Services 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / list_accounts_for_provisioned_permission_set list_accounts_for_provisioned_permission_set ******************************************** SSOAdmin.Client.list_accounts_for_provisioned_permission_set(**kwargs) Lists all the Amazon Web Services 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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed. * **ProvisioningStatus** (*string*) -- The permission set provisioning status for an Amazon Web Services account. * **MaxResults** (*integer*) -- The maximum number of results to display for the PermissionSet. * **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. Return type: dict Returns: **Response Syntax** { 'AccountIds': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **AccountIds** *(list) --* The list of Amazon Web Services "AccountIds". * *(string) --* * **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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / list_instances list_instances ************** SSOAdmin.Client.list_instances(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_instances( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of results to display for the 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. Return type: dict Returns: **Response Syntax** { 'Instances': [ { 'InstanceArn': 'string', 'IdentityStoreId': 'string', 'OwnerAccountId': 'string', 'Name': 'string', 'CreatedDate': datetime(2015, 1, 1), 'Status': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'ACTIVE' }, ], '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 Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **IdentityStoreId** *(string) --* The identifier of the identity store that is connected to the Identity Center instance. * **OwnerAccountId** *(string) --* The Amazon Web Services account ID number of the owner of the Identity Center instance. * **Name** *(string) --* The name of the Identity Center instance. * **CreatedDate** *(datetime) --* The date and time that the Identity Center instance was created. * **Status** *(string) --* The current status of this 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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / update_application update_application ****************** SSOAdmin.Client.update_application(**kwargs) Updates application properties. See also: AWS API Documentation **Request Syntax** response = client.update_application( ApplicationArn='string', Name='string', Description='string', Status='ENABLED'|'DISABLED', PortalOptions={ 'SignInOptions': { 'Origin': 'IDENTITY_CENTER'|'APPLICATION', 'ApplicationUrl': 'string' } } ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **Name** (*string*) -- Specifies the updated name for the application. * **Description** (*string*) -- The description of the . * **Status** (*string*) -- Specifies whether the application is enabled or disabled. * **PortalOptions** (*dict*) -- A structure that describes the options for the portal associated with an application. * **SignInOptions** *(dict) --* A structure that describes the sign-in options for an application portal. * **Origin** *(string) --* **[REQUIRED]** This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values: * "APPLICATION": IAM Identity Center redirects the customer to the configured "ApplicationUrl". * "IDENTITY_CENTER": IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application. * **ApplicationUrl** *(string) --* The URL that accepts authentication requests for an application. This is a required parameter if the "Origin" parameter is "APPLICATION". Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / describe_application_provider describe_application_provider ***************************** SSOAdmin.Client.describe_application_provider(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.describe_application_provider( ApplicationProviderArn='string' ) Parameters: **ApplicationProviderArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application provider for which you want details. Return type: dict Returns: **Response Syntax** { 'ApplicationProviderArn': 'string', 'FederationProtocol': 'SAML'|'OAUTH', 'DisplayData': { 'DisplayName': 'string', 'IconUrl': 'string', 'Description': 'string' }, 'ResourceServerConfig': { 'Scopes': { 'string': { 'LongDescription': 'string', 'DetailedTitle': 'string' } } } } **Response Structure** * *(dict) --* * **ApplicationProviderArn** *(string) --* The ARN of the application provider. * **FederationProtocol** *(string) --* The protocol used to federate to the application provider. * **DisplayData** *(dict) --* A structure with details about the display data for the application provider. * **DisplayName** *(string) --* The name of the application provider that appears in the portal. * **IconUrl** *(string) --* A URL that points to an icon that represents the application provider. * **Description** *(string) --* The description of the application provider that appears in the portal. * **ResourceServerConfig** *(dict) --* A structure with details about the receiving application. * **Scopes** *(dict) --* A list of the IAM Identity Center access scopes that are associated with this resource server. * *(string) --* * *(dict) --* A structure that describes details for an IAM Identity Center access scope that is associated with a resource server. * **LongDescription** *(string) --* The description of an access scope for a resource server. * **DetailedTitle** *(string) --* The title of an access scope for a resource server. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / list_application_assignments list_application_assignments **************************** SSOAdmin.Client.list_application_assignments(**kwargs) Lists Amazon Web Services account users that are assigned to an application. See also: AWS API Documentation **Request Syntax** response = client.list_application_assignments( ApplicationArn='string', MaxResults=123, NextToken='string' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. * **MaxResults** (*integer*) -- Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the "NextToken" response element is returned with a value (not null). Include the specified value as the "NextToken" request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check "NextToken" after every operation to ensure that you receive all of the results. * **NextToken** (*string*) -- Specifies that you want to receive the next page of results. Valid only if you received a "NextToken" response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's "NextToken" response to request the next page of results. Return type: dict Returns: **Response Syntax** { 'ApplicationAssignments': [ { 'ApplicationArn': 'string', 'PrincipalId': 'string', 'PrincipalType': 'USER'|'GROUP' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ApplicationAssignments** *(list) --* The list of users assigned to an application. * *(dict) --* A structure that describes an assignment of a principal to an application. * **ApplicationArn** *(string) --* The ARN of the application that has principals assigned. * **PrincipalId** *(string) --* The unique identifier of the principal assigned to the application. * **PrincipalType** *(string) --* The type of the principal assigned to the application. * **NextToken** *(string) --* If present, this value indicates that more output is available than is included in the current response. Use this value in the "NextToken" request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the "NextToken" response element comes back as "null". This indicates that this is the last page of results. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / close close ***** SSOAdmin.Client.close() Closes underlying endpoint connections. SSOAdmin / Client / get_application_access_scope get_application_access_scope **************************** SSOAdmin.Client.get_application_access_scope(**kwargs) Retrieves the authorized targets for an IAM Identity Center access scope for an application. See also: AWS API Documentation **Request Syntax** response = client.get_application_access_scope( ApplicationArn='string', Scope='string' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application with the access scope that you want to retrieve. * **Scope** (*string*) -- **[REQUIRED]** Specifies the name of the access scope for which you want the authorized targets. Return type: dict Returns: **Response Syntax** { 'Scope': 'string', 'AuthorizedTargets': [ 'string', ] } **Response Structure** * *(dict) --* * **Scope** *(string) --* The name of the access scope that can be used with the authorized targets. * **AuthorizedTargets** *(list) --* An array of authorized targets associated with this access scope. * *(string) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / attach_customer_managed_policy_reference_to_permission_set attach_customer_managed_policy_reference_to_permission_set ********************************************************** SSOAdmin.Client.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' } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the "PermissionSet". * **CustomerManagedPolicyReference** (*dict*) -- **[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 Amazon Web Services account where you want to deploy your permission set. * **Name** *(string) --* **[REQUIRED]** 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*. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ServiceQuotaExceededException" * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_application_assignments_for_principal list_application_assignments_for_principal ****************************************** SSOAdmin.Client.list_application_assignments_for_principal(**kwargs) Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account. See also: AWS API Documentation **Request Syntax** response = client.list_application_assignments_for_principal( InstanceArn='string', PrincipalId='string', PrincipalType='USER'|'GROUP', Filter={ 'ApplicationArn': 'string' }, NextToken='string', MaxResults=123 ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** Specifies the instance of IAM Identity Center that contains principal and applications. * **PrincipalId** (*string*) -- **[REQUIRED]** Specifies the unique identifier of the principal for which you want to retrieve its assignments. * **PrincipalType** (*string*) -- **[REQUIRED]** Specifies the type of the principal for which you want to retrieve its assignments. * **Filter** (*dict*) -- Filters the output to include only assignments associated with the application that has the specified ARN. * **ApplicationArn** *(string) --* The ARN of an application. * **NextToken** (*string*) -- Specifies that you want to receive the next page of results. Valid only if you received a "NextToken" response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's "NextToken" response to request the next page of results. * **MaxResults** (*integer*) -- Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the "NextToken" response element is returned with a value (not null). Include the specified value as the "NextToken" request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check "NextToken" after every operation to ensure that you receive all of the results. Return type: dict Returns: **Response Syntax** { 'ApplicationAssignments': [ { 'ApplicationArn': 'string', 'PrincipalId': 'string', 'PrincipalType': 'USER'|'GROUP' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ApplicationAssignments** *(list) --* An array list of the application assignments for the specified principal. * *(dict) --* A structure that describes an application to which a principal is assigned. * **ApplicationArn** *(string) --* The ARN of the application to which the specified principal is assigned. * **PrincipalId** *(string) --* The unique identifier of the principal assigned to the application. * **PrincipalType** *(string) --* The type of the principal assigned to the application. * **NextToken** *(string) --* If present, this value indicates that more output is available than is included in the current response. Use this value in the "NextToken" request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the "NextToken" response element comes back as "null". This indicates that this is the last page of results. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / put_application_assignment_configuration put_application_assignment_configuration **************************************** SSOAdmin.Client.put_application_assignment_configuration(**kwargs) Configure how users gain access to an application. If "AssignmentsRequired" is "true" (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If "false", all users have access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access if "AssignmentsRequired" is set to "true". See also: AWS API Documentation **Request Syntax** response = client.put_application_assignment_configuration( ApplicationArn='string', AssignmentRequired=True|False ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **AssignmentRequired** (*boolean*) -- **[REQUIRED]** If "AssignmentsRequired" is "true" (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If "false", all users have access to the application. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / describe_application describe_application ******************** SSOAdmin.Client.describe_application(**kwargs) Retrieves the details of an application associated with an instance of IAM Identity Center. See also: AWS API Documentation **Request Syntax** response = client.describe_application( ApplicationArn='string' ) Parameters: **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. Return type: dict Returns: **Response Syntax** { 'ApplicationArn': 'string', 'ApplicationProviderArn': 'string', 'Name': 'string', 'ApplicationAccount': 'string', 'InstanceArn': 'string', 'Status': 'ENABLED'|'DISABLED', 'PortalOptions': { 'SignInOptions': { 'Origin': 'IDENTITY_CENTER'|'APPLICATION', 'ApplicationUrl': 'string' }, 'Visibility': 'ENABLED'|'DISABLED' }, 'Description': 'string', 'CreatedDate': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **ApplicationArn** *(string) --* Specifies the ARN of the application. * **ApplicationProviderArn** *(string) --* The ARN of the application provider under which the operation will run. * **Name** *(string) --* The application name. * **ApplicationAccount** *(string) --* The account ID. * **InstanceArn** *(string) --* The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **Status** *(string) --* Specifies whether the application is enabled or disabled. * **PortalOptions** *(dict) --* A structure that describes the options for the portal associated with an application. * **SignInOptions** *(dict) --* A structure that describes the sign-in options for the access portal. * **Origin** *(string) --* This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values: * "APPLICATION": IAM Identity Center redirects the customer to the configured "ApplicationUrl". * "IDENTITY_CENTER": IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application. * **ApplicationUrl** *(string) --* The URL that accepts authentication requests for an application. This is a required parameter if the "Origin" parameter is "APPLICATION". * **Visibility** *(string) --* Indicates whether this application is visible in the access portal. * **Description** *(string) --* The description of the . * **CreatedDate** *(datetime) --* The date the application was created. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / delete_instance delete_instance *************** SSOAdmin.Client.delete_instance(**kwargs) Deletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance. See also: AWS API Documentation **Request Syntax** response = client.delete_instance( InstanceArn='string' ) Parameters: **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the instance of IAM Identity Center under which the operation will run. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_account_assignment_deletion_status list_account_assignment_deletion_status *************************************** SSOAdmin.Client.list_account_assignment_deletion_status(**kwargs) Lists the status of the Amazon Web Services 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' } ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **MaxResults** (*integer*) -- The maximum number of results to display for the assignment. * **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. * **Filter** (*dict*) -- Filters results based on the passed attribute value. * **Status** *(string) --* Filters the list operations result based on the status attribute. Return type: dict Returns: **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.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / put_inline_policy_to_permission_set put_inline_policy_to_permission_set *********************************** SSOAdmin.Client.put_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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the permission set. * **InlinePolicy** (*string*) -- **[REQUIRED]** The inline policy to attach to a PermissionSet. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ServiceQuotaExceededException" * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_application_access_scopes list_application_access_scopes ****************************** SSOAdmin.Client.list_application_access_scopes(**kwargs) Lists the access scopes and authorized targets associated with an application. See also: AWS API Documentation **Request Syntax** response = client.list_application_access_scopes( ApplicationArn='string', MaxResults=123, NextToken='string' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. * **MaxResults** (*integer*) -- Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the "NextToken" response element is returned with a value (not null). Include the specified value as the "NextToken" request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check "NextToken" after every operation to ensure that you receive all of the results. * **NextToken** (*string*) -- Specifies that you want to receive the next page of results. Valid only if you received a "NextToken" response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's "NextToken" response to request the next page of results. Return type: dict Returns: **Response Syntax** { 'Scopes': [ { 'Scope': 'string', 'AuthorizedTargets': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Scopes** *(list) --* An array list of access scopes and their authorized targets that are associated with the application. * *(dict) --* A structure that describes an IAM Identity Center access scope and its authorized targets. * **Scope** *(string) --* The name of the access scope. * **AuthorizedTargets** *(list) --* An array list of ARNs of applications. * *(string) --* * **NextToken** *(string) --* If present, this value indicates that more output is available than is included in the current response. Use this value in the "NextToken" request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the "NextToken" response element comes back as "null". This indicates that this is the last page of results. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / detach_managed_policy_from_permission_set detach_managed_policy_from_permission_set ***************************************** SSOAdmin.Client.detach_managed_policy_from_permission_set(**kwargs) Detaches the attached Amazon Web Services 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' ) Parameters: * **InstanceArn** (*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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **PermissionSetArn** (*string*) -- **[REQUIRED]** The ARN of the PermissionSet from which the policy should be detached. * **ManagedPolicyArn** (*string*) -- **[REQUIRED]** The Amazon Web Services managed policy ARN to be detached from a permission set. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / delete_application delete_application ****************** SSOAdmin.Client.delete_application(**kwargs) Deletes the association with the application. The connected service resource still exists. See also: AWS API Documentation **Request Syntax** response = client.delete_application( ApplicationArn='string' ) Parameters: **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / create_application create_application ****************** SSOAdmin.Client.create_application(**kwargs) Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider. Note: This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more information on these application types, see Amazon Web Services managed applications. See also: AWS API Documentation **Request Syntax** response = client.create_application( InstanceArn='string', ApplicationProviderArn='string', Name='string', Description='string', PortalOptions={ 'SignInOptions': { 'Origin': 'IDENTITY_CENTER'|'APPLICATION', 'ApplicationUrl': 'string' }, 'Visibility': 'ENABLED'|'DISABLED' }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], Status='ENABLED'|'DISABLED', ClientToken='string' ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **ApplicationProviderArn** (*string*) -- **[REQUIRED]** The ARN of the application provider under which the operation will run. * **Name** (*string*) -- **[REQUIRED]** The name of the . * **Description** (*string*) -- The description of the . * **PortalOptions** (*dict*) -- A structure that describes the options for the portal associated with an application. * **SignInOptions** *(dict) --* A structure that describes the sign-in options for the access portal. * **Origin** *(string) --* **[REQUIRED]** This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values: * "APPLICATION": IAM Identity Center redirects the customer to the configured "ApplicationUrl". * "IDENTITY_CENTER": IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application. * **ApplicationUrl** *(string) --* The URL that accepts authentication requests for an application. This is a required parameter if the "Origin" parameter is "APPLICATION". * **Visibility** *(string) --* Indicates whether this application is visible in the access portal. * **Tags** (*list*) -- Specifies tags to be attached to the application. * *(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 Amazon Web Services accounts. * **Key** *(string) --* **[REQUIRED]** The key for the tag. * **Value** *(string) --* **[REQUIRED]** The value of the tag. * **Status** (*string*) -- Specifies whether the application is enabled or disabled. * **ClientToken** (*string*) -- Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same "ClientToken", but with different parameters, the retry fails with an "IdempotentParameterMismatch" error. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ApplicationArn': 'string' } **Response Structure** * *(dict) --* * **ApplicationArn** *(string) --* Specifies the ARN of the application. **Exceptions** * "SSOAdmin.Client.exceptions.ServiceQuotaExceededException" * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / delete_application_access_scope delete_application_access_scope ******************************* SSOAdmin.Client.delete_application_access_scope(**kwargs) Deletes an IAM Identity Center access scope from an application. See also: AWS API Documentation **Request Syntax** response = client.delete_application_access_scope( ApplicationArn='string', Scope='string' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application with the access scope to delete. * **Scope** (*string*) -- **[REQUIRED]** Specifies the name of the access scope to remove from the application. Returns: None **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / get_application_grant get_application_grant ********************* SSOAdmin.Client.get_application_grant(**kwargs) Retrieves details about an application grant. See also: AWS API Documentation **Request Syntax** response = client.get_application_grant( ApplicationArn='string', GrantType='authorization_code'|'refresh_token'|'urn:ietf:params:oauth:grant-type:jwt-bearer'|'urn:ietf:params:oauth:grant-type:token-exchange' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application that contains the grant. * **GrantType** (*string*) -- **[REQUIRED]** Specifies the type of grant. Return type: dict Returns: **Response Syntax** { 'Grant': { 'AuthorizationCode': { 'RedirectUris': [ 'string', ] }, 'JwtBearer': { 'AuthorizedTokenIssuers': [ { 'TrustedTokenIssuerArn': 'string', 'AuthorizedAudiences': [ 'string', ] }, ] }, 'RefreshToken': {}, 'TokenExchange': {} } } **Response Structure** * *(dict) --* * **Grant** *(dict) --* A structure that describes the requested grant. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "AuthorizationCode", "JwtBearer", "RefreshToken", "TokenExchange". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **AuthorizationCode** *(dict) --* Configuration options for the "authorization_code" grant type. * **RedirectUris** *(list) --* A list of URIs that are valid locations to redirect a user's browser after the user is authorized. Note: RedirectUris is required when the grant type is "authorization_code". * *(string) --* * **JwtBearer** *(dict) --* Configuration options for the "urn:ietf:params:oauth :grant-type:jwt-bearer" grant type. * **AuthorizedTokenIssuers** *(list) --* A list of allowed token issuers trusted by the Identity Center instances for this application. Note: "AuthorizedTokenIssuers" is required when the grant type is "JwtBearerGrant". * *(dict) --* A structure that describes a trusted token issuer and associates it with a set of authorized audiences. * **TrustedTokenIssuerArn** *(string) --* The ARN of the trusted token issuer. * **AuthorizedAudiences** *(list) --* An array list of authorized audiences, or applications, that can consume the tokens generated by the associated trusted token issuer. * *(string) --* * **RefreshToken** *(dict) --* Configuration options for the "refresh_token" grant type. * **TokenExchange** *(dict) --* Configuration options for the "urn:ietf:params:oauth :grant-type:token-exchange" grant type. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / tag_resource tag_resource ************ SSOAdmin.Client.tag_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' }, ] ) Parameters: * **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 Amazon Web Services Service Namespaces in the *Amazon Web Services General Reference*. * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource with the tags to be listed. * **Tags** (*list*) -- **[REQUIRED]** 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 Amazon Web Services accounts. * **Key** *(string) --* **[REQUIRED]** The key for the tag. * **Value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ServiceQuotaExceededException" * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / create_instance_access_control_attribute_configuration create_instance_access_control_attribute_configuration ****************************************************** SSOAdmin.Client.create_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', ] } }, ] } ) Parameters: * **InstanceArn** (*string*) -- **[REQUIRED]** The ARN of the IAM Identity Center instance under which the operation will be executed. * **InstanceAccessControlAttributeConfiguration** (*dict*) -- **[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. * **AccessControlAttributes** *(list) --* **[REQUIRED]** Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance. * *(dict) --* 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 Amazon Web Services 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. * **Key** *(string) --* **[REQUIRED]** 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. * **Value** *(dict) --* **[REQUIRED]** The value used for mapping a specified attribute to an identity source. * **Source** *(list) --* **[REQUIRED]** The identity source to use when mapping a specified attribute to IAM Identity Center. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / delete_application_authentication_method delete_application_authentication_method **************************************** SSOAdmin.Client.delete_application_authentication_method(**kwargs) Deletes an authentication method from an application. See also: AWS API Documentation **Request Syntax** response = client.delete_application_authentication_method( ApplicationArn='string', AuthenticationMethodType='IAM' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application with the authentication method to delete. * **AuthenticationMethodType** (*string*) -- **[REQUIRED]** Specifies the authentication method type to delete from the application. Returns: None **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException" SSOAdmin / Client / list_application_authentication_methods list_application_authentication_methods *************************************** SSOAdmin.Client.list_application_authentication_methods(**kwargs) Lists all of the authentication methods supported by the specified application. See also: AWS API Documentation **Request Syntax** response = client.list_application_authentication_methods( ApplicationArn='string', NextToken='string' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application with the authentication methods you want to list. * **NextToken** (*string*) -- Specifies that you want to receive the next page of results. Valid only if you received a "NextToken" response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's "NextToken" response to request the next page of results. Return type: dict Returns: **Response Syntax** { 'AuthenticationMethods': [ { 'AuthenticationMethodType': 'IAM', 'AuthenticationMethod': { 'Iam': { 'ActorPolicy': {...}|[...]|123|123.4|'string'|True|None } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **AuthenticationMethods** *(list) --* An array list of authentication methods for the specified application. * *(dict) --* A structure that describes an authentication method and its type. * **AuthenticationMethodType** *(string) --* The type of authentication that is used by this method. * **AuthenticationMethod** *(dict) --* A structure that describes an authentication method. The contents of this structure is determined by the "AuthenticationMethodType". Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Iam". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **Iam** *(dict) --* A structure that describes details for IAM authentication. * **ActorPolicy** (*document*) -- An IAM policy document in JSON. * **NextToken** *(string) --* If present, this value indicates that more output is available than is included in the current response. Use this value in the "NextToken" request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the "NextToken" response element comes back as "null". This indicates that this is the last page of results. **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" SSOAdmin / Client / delete_application_grant delete_application_grant ************************ SSOAdmin.Client.delete_application_grant(**kwargs) Deletes a grant from an application. See also: AWS API Documentation **Request Syntax** response = client.delete_application_grant( ApplicationArn='string', GrantType='authorization_code'|'refresh_token'|'urn:ietf:params:oauth:grant-type:jwt-bearer'|'urn:ietf:params:oauth:grant-type:token-exchange' ) Parameters: * **ApplicationArn** (*string*) -- **[REQUIRED]** Specifies the ARN of the application with the grant to delete. * **GrantType** (*string*) -- **[REQUIRED]** Specifies the type of grant to delete from the application. Returns: None **Exceptions** * "SSOAdmin.Client.exceptions.ThrottlingException" * "SSOAdmin.Client.exceptions.InternalServerException" * "SSOAdmin.Client.exceptions.ResourceNotFoundException" * "SSOAdmin.Client.exceptions.AccessDeniedException" * "SSOAdmin.Client.exceptions.ValidationException" * "SSOAdmin.Client.exceptions.ConflictException"